Prisma tRPC Generator

A Prisma generator that automates creating your tRPC routers from your Prisma schema.
Explore the options »

Report Bug · Request Feature

About The Project
Supported Prisma Versions
- Prisma 4
- Prisma 2/3
Supported tRPC Versions
- tRPC 10
- tRPC 9
Installation
Usage
Customizations
- Skipping entire models
Additional Options

About The Project

Automatically generate fully implemented tRPC routers from your Prisma Schema. This includes routers, app router and of course all input schemas using Zod. Updates every time npx prisma generate runs.

Supported Prisma Versions

Prisma 4

0.2.0 and higher

Prisma 2/3

0.1.12 and lower

Supported tRPC Versions

tRPC 10

0.8.0 and higher

tRPC 9

0.7.2 and lower

Installation

Using npm:

 npm install prisma-trpc-generator

Using yarn:

 yarn add prisma-trpc-generator

Usage

1- Star this repo 😉

2- Add the generator to your Prisma schema

generator trpc {
  provider          = "prisma-trpc-generator"
  withZod           = true
  withMiddleware    = false
  withShield        = false
  contextPath       = "../src/context"
  trpcOptionsPath   = "../src/trpcOptions"
}

3- Enable strict mode in tsconfig as it is required by Zod, and considered a Typescript best practice

{
  "compilerOptions": {
    "strict": true
  }
}

4- Running npx prisma generate for the following schema.prisma

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
  posts Post[]
}

model Post {
  id        Int      @id @default(autoincrement())
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
  title     String
  content   String?
  published Boolean  @default(false)
  viewCount Int      @default(0)
  author    User?    @relation(fields: [authorId], references: [id])
  authorId  Int?
}

will generate

5- Make sure you have a valid Context file, as specified in contextPath option. The official Context for reference.

6- Optionally, you can specify a trpcOptionsPath to set various tRPC options (like transformer, error formatter, etc). Find about all possible options here.

import { ZodError } from 'zod';

export default {
  errorFormatter({ shape, error }) {
    return {
      ...shape,
      data: {
        ...shape.data,
        zodError:
          error.code === 'BAD_REQUEST' && error.cause instanceof ZodError
            ? error.cause.flatten()
            : null,
      },
    };
  },
};

Customizations

Skipping entire models

/// @@Gen.model(hide: true)
model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

Additional Options

Option	Description	Type	Default
`output`	Output directory for the generated routers and zod schemas	`string`	`./generated`
`withMiddleware`	Attaches a global middleware that runs before all procedures	`boolean or string`	`true`
`output`	Output directory for the generated routers and zod schemas	`string`	`./generated`
`withZod`	Use Zod for input validation	`boolean`	`true`
`withShield`	Generates a tRPC Shield to use as a permissions layer	`boolean or string`	`true`
`contextPath`	Sets the context path used in your routers	`string`	`../../../../src/context`
`trpcOptionsPath`	Sets the tRPC instance options	`string`	`../../../../src/trpcOptions`
`isGenerateSelect`	Enables the generation of Select related schemas and the select property	`boolean`	`false`
`isGenerateInclude`	Enables the generation of Include related schemas and the include property	`boolean`	`false`
`showModelNameInProcedure`	When disabled, the generated procedure no longer includes the name of the Prisma model	`boolean`	`true`
`generateModelActions`	Enables the generation of specific model actions	`string`	`aggregate,aggregateRaw,count,create,createMany,delete,deleteMany,findFirst,findFirstOrThrow,findMany,findRaw,findUnique,findUniqueOrThrow,groupBy,update,updateMany,upsert`

Use additional options in the schema.prisma

generator trpc {
  provider           = "prisma-trpc-generator"
  output             = "./trpc"
  withMiddleware     = "../middleware"
  withZod            = false
  withShield         = false
  contextPath        = "../context"
  trpcOptionsPath    = "../trpcOptions"
  isGenerateSelect   = true
  isGenerateInclude  = true
  showModelNameInProcedure  = false
  generateModelActions = "aggregate,aggregateRaw,count,create,createMany,delete,deleteMany,findFirst,findFirstOrThrow,findMany,findRaw,findUnique,findUniqueOrThrow,groupBy,update,updateMany,upsert"
}

omar-dulaimi/prisma-trpc-generator

omar-dulaimi

Reviews

Repository Details