Home

Awesome

npm version npm HitCount npm

<p align="center"> <a href="https://github.com/omar-dulaimi/prisma-trpc-generator"> <img src="https://raw.githubusercontent.com/omar-dulaimi/prisma-trpc-generator/master/logo.png" alt="Logo" width="200" height="200"/> </a> <h3 align="center">Prisma tRPC Generator</h3> <p align="center"> A Prisma generator that automates creating your tRPC routers from your Prisma schema. <br /> <a href="https://github.com/omar-dulaimi/prisma-trpc-generator#additional-options"><strong>Explore the options »</strong></a> <br /> <br /> <a href="https://github.com/omar-dulaimi/prisma-trpc-generator/issues/new?template=bug_report.yml">Report Bug</a> · <a href="https://github.com/omar-dulaimi/prisma-trpc-generator/issues/new?template=feature_request.md">Request Feature</a> </p> </p> <p align="center"> <a href="https://www.buymeacoffee.com/omardulaimi"> <img src="https://cdn.buymeacoffee.com/buttons/default-black.png" alt="Buy Me A Coffee" height="41" width="174"/> </a> </p>

Table of Contents

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

Prisma 2/3

Supported tRPC Versions

tRPC 10

tRPC 9

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

tRPC Routers

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

OptionDescriptionTypeDefault
outputOutput directory for the generated routers and zod schemasstring./generated
withMiddlewareAttaches a global middleware that runs before all proceduresboolean or stringtrue
outputOutput directory for the generated routers and zod schemasstring./generated
withZodUse Zod for input validationbooleantrue
withShieldGenerates a tRPC Shield to use as a permissions layerboolean or stringtrue
contextPathSets the context path used in your routersstring../../../../src/context
trpcOptionsPathSets the tRPC instance optionsstring../../../../src/trpcOptions
isGenerateSelectEnables the generation of Select related schemas and the select propertybooleanfalse
isGenerateIncludeEnables the generation of Include related schemas and the include propertybooleanfalse
showModelNameInProcedureWhen disabled, the generated procedure no longer includes the name of the Prisma modelbooleantrue
generateModelActionsEnables the generation of specific model actionsstringaggregate,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"
}