Code Monkey home page Code Monkey logo

prisma-joi-generator's Introduction

Prisma Joi Generator

npm version npm HitCount npm

Automatically generate Joi 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.

Buy Me A Coffee

Table of Contents

Supported Prisma Versions

Prisma 4

  • 0.2.0 and higher

Prisma 2/3

  • 0.1.1 and lower

Installation

Using npm:

 npm install prisma-joi-generator

Using yarn:

 yarn add prisma-joi-generator

Usage

1- Star this repo 😉

2- Add the generator to your Prisma schema

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

3- 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 the following files

Joi Schemas

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

import { PostCreateSchema } from './prisma/generated/schemas';

app.post('/blog', async (req, res, next) => {
  const { body } = req;
  const result = PostCreateSchema.validate(body);
});

Additional Options

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

Use additional options in the schema.prisma

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

prisma-joi-generator's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

prisma-joi-generator's Issues

FrontEnd Form Validation

Thanks for your work, I've been looking for a way to have one source of truth for both frontend and backend validation from Prisma and this looks very promising!

Would it be possible to have a "frontend mode" where all the validation rules are put into one file / one file per Model, to be used for form validation? 👍

Break up generated Joi files into sub-directories by Table name

Problem

I am using the prisma-joi-generator to create Joi validator objects automatically and import them into my Koa.js project. I then use the Joi object to validate my API inputs. All of this works great. However, when I deploy the code to Google App Engine to test my API. Google throws an error stating too many files in a single directory. I have over 70 tables in my database and this generator creates 1300+ files.

Suggested solution

Break up the generated files by Table-name sub-directory. For example, if the table name is Post then the sub-directory would be ./generated/post/Post*.ts

Prisma 5 support

Problem

Got this error on NestJS with Prisma v5 and latest version of prisma-joi-generator :

/home/.../api/src/generated/validation/schemas/enums/QueryMode.schema.ts:3
export const QueryModeSchema = Joi.string().valid(...["default","insensitive"])
                                   ^
TypeError: Cannot read properties of undefined (reading 'string')
    at Object.<anonymous> (/home/.../api/src/generated/validation/schemas/enums/QueryMode.schema.ts:3:36)
    at Module._compile (node:internal/modules/cjs/loader:1241:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1295:10)
    at Module.load (node:internal/modules/cjs/loader:1091:32)
    at Function.Module._load (node:internal/modules/cjs/loader:938:12)
    at Module.require (node:internal/modules/cjs/loader:1115:19)
    at require (node:internal/modules/helpers:130:18)
    at Object.<anonymous> (/home/.../api/src/generated/validation/schemas/objects/StringFilter.schema.ts:3:1)
    at Module._compile (node:internal/modules/cjs/loader:1241:14)
    at Object.Module._extensions..js (node:internal/modules/cjs/loader:1295:10)

Is prisma-joi-generator supporting Prisma v5 ?

Suggested solution

Alternatives

Additional context

Output validation

Hello, thank you for the library.
Do you plan to support return types?

Support for Prisma 4.x

It works perfectly on 3.15.2, but throws this error after running pnpm prisma generate on 4.0.0 :

Environment variables loaded from .env
Prisma schema loaded from src/api/database/schema.prisma
Error: 
✔ Generated Prisma Client (4.0.0 | library) to ./node_modules/.pnpm/@[email protected][email protected]/node_modules/@prisma/client in 53ms

TypeError: Cannot read properties of undefined (reading 'enumTypes')
    at Object.generate [as onGenerate] (.../node_modules/.pnpm/[email protected][email protected]/node_modules/prisma-joi-generator/lib/prisma-generator.js:45:36)
    at async LineStream.<anonymous> (.../node_modules/.pnpm/@[email protected]/node_modules/@prisma/generator-helper/dist/generatorHandler.js:33:24)

Make the path shorten

Problem

The generated pathes are tooooooooo looooooong, so please shorten them.

Suggested solution

Maybe we can use a single letter to be the folder name, then give the best practice document for the definition of the folder.. just a thouths.

Provide option to turn-on or off specific types of generated Joi files.

Problem

I need the ability to turn on or off specific generated Joi files. For example, *Upsert* and *Unchecked* I will never use. These files just create added files generated without any addition purpose. The problem comes in when you have a large database with many relationships and foreign relationships. Deployment systems like Docker/Google App Engine and Amazon Beanstalk have max file limits.

Suggested solution

In addition to break up the outputted files into directory named by table-name. Provide a list of flags that can turn on and off specific generated file-types. The files I care most about is *Create* and *Update* for my REST API.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.