Promise Labs Fork of Prisma Typebox Generator

A generator, which takes a Prisma 2 schema.prisma and generates a typebox snippets.

Getting Started

1. Install

npm:

npm install prisma-typebox-generator --save-dev

yarn:

yarn add -D prisma-typebox-generator

2. Add the generator to the schema

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

With a custom output path (default=./typebox)

generator typebox {
  provider = "prisma-typebox-generator"
  output = "custom-output-path"
}

3. Run generation

prisma:

prisma generate

nexus with prisma plugin:

nexus build

Supported Node Versions

Node Version	Support
(Maintenance LTS) 10	✔️
(Active LTS) 12	✔️
(Current) 14	✔️

Examples

This generator converts a prisma schema like this:

datasource db {
	provider = "postgresql"
	url      = env("DATABASE_URL")
}

model User {
    id          Int      @id @default(autoincrement())
    createdAt   DateTime @default(now())
    email       String   @unique
    weight      Float?
    is18        Boolean?
    name        String?
    successorId Int?
    successor   User?    @relation("BlogOwnerHistory", fields: [successorId], references: [id])
    predecessor User?    @relation("BlogOwnerHistory")
    role        Role     @default(USER)
    posts       Post[]
    keywords    String[]
    biography   Json
}

model Post {
    id     Int   @id @default(autoincrement())
    user   User? @relation(fields: [userId], references: [id])
    userId Int?
}

enum Role {
    USER
    ADMIN
}

License: MIT

Copyright (c) 2022 Ade Yahya Prasetyo

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Promise Labs Changes

• Added generate.sh file so that the generator can be run without needed to build it locally first
• Added additionalProperties: false to the generated typebox schema to prevent arbitrary properties
• Added $id to all schema names to prevent duplicate names and unblock AJV compilation
• Changed output to use single quotes instead of double quotes for strings
• Moved model IDs and file names to unify around underscores
• Removed unnecessary Examples code