Skip to content

conte-ltd/prisma-zod-generator

 
 

Repository files navigation

Prisma Zod Generator

npm version npm HitCount npm

Automatically generate Zod schemas from your Prisma Schema, and use them to validate your API endpoints or any other use you have. Updates every time npx prisma generate runs.

Table of Contents

Supported Prisma Versions

Prisma 4

  • 0.3.0 and higher

Prisma 2/3

  • 0.2.0 and lower

Installation

Using npm:

 npm install @conte-ltd/prisma-zod-generator

Using yarn:

 yarn add @conte-ltd/prisma-zod-generator

Usage

1- Star this repo 😉

2- Add the generator to your Prisma schema

generator zod {
  provider = "prisma-zod-generator"
}

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?
  likes     BigInt
}

will generate the following files

Zod Schemas

5- Use generated schemas somewhere in your API logic, like middleware or decorator

import { PostCreateOneSchema } from './src/generated/schemas';

app.post('/blog', async (req, res, next) => {
  const { body } = req;
  await PostCreateOneSchema.parse(body);
});

Additional Options

Option  Description Type  Default
output Output directory for the generated zod schemas string ./generated/schemas

Use additional options in the schema.prisma

generator zod {
  provider   = "prisma-zod-generator"
  output     = "./generated-zod-schemas"
}

About

Prisma 2+ generator to emit Zod schemas from your Prisma schema

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.4%
  • Shell 1.4%
  • JavaScript 0.2%