Prisma Generator Pothos Codegen
This is a prisma generator that auto generate all input types for Crud Operations to Pothos. Use it as args for crud operations.
And generate all crud operations automatically. Optionally you can disable crud generation inside configs file. Just set: configs.crud.disabled to true
The roadmap:
- Generator code for all input fields.
- Generator for all
Objects,QueriesandMutations. Something likeprisma-toolsdo with Prisma and Nexus.
Getting Started
Install
yarn add prisma-generator-pothos-codegen or npm install prisma-generator-pothos-codegen
Usage
Add generator
generator client {
provider = "prisma-client-js"
}
generator nexusPrisma {
provider = "prisma-generator-pothos-codegen"
generatorConfigPath = "../src/schema/configs.ts"
}
/// This is a user!
model User {
/// This is an id!
id String @id
}
Add scalar types to builder
import { Scalars } from 'prisma-generator-pothos-codegen'
import { Prisma } from '.prisma/client'
export const builder = new SchemaBuilder<{
Scalars: Scalars<Prisma.Decimal, Prisma.InputJsonValue | null, Prisma.InputJsonValue>,
}>({
...
});
Import inputs from the generated file, and add as args.
import * as Inputs from './generated/inputs'
builder.queryFields((t) => ({
findManyUser: t.field({
type: [User],
args: {
where: t.arg({ type: Inputs.UserWhereInput }),
orderBy: t.arg({ type: [Inputs.UserOrderByWithRelationInput] }),
cursor: t.arg({ type: Inputs.UserWhereUniqueInput }),
take: t.arg({ type: 'Int' }),
skip: t.arg({ type: 'Int' }),
distinct: t.arg({ type: [Inputs.UserScalarFieldEnum] }),
},
resolve: async (root, args) => {
const user = await db.user.findMany({
where: args.where || undefined,
cursor: args.cursor || undefined,
take: args.take || undefined,
distinct: args.distinct || undefined,
skip: args.skip || undefined,
orderBy: args.orderBy || undefined,
})
return user
}
}),
}))
The generator currently supports a few options:
| Key | Default Value | Description |
|---|---|---|
| generatorConfigPath | ../src/schema/configs.ts | Path to the configs file, from the schema path. |
Click to see configs options
{
inputs?: {
prismaImporter?: string // default: import { Prisma } from ".prisma/client"
builderImporter?: string // default: import { builder } from "./builder"
excludeInputs?: string[] // default: undefined
excludeScalars?: string[] // default: undefined
outputFilePath?: string // path to generate file, from project root
replacer?: (generated: string, position: ReplacerPosition) => string // a function to replace generated source
},
crud?: {
disabled?: boolean // disable generaton of crud. default: false
includeResolversExact?: string[] // generate only resolvers with name in the list. default: undefined. ie: ['createOneUser']
includeResolversContain?: string[] // generate only resolvers with name included in the list. default: undefined. ie: ['User'].
excludeResolversExact?: string[] // default: undefined. ie: ['createOneComment']
excludeResolversContain?: string[] // default: undefined. ie: ['createOne']
resolversImports?: string // default: what to import inside resolver
dbCaller?: string // how to call prisma. default: context.db
inputsImporter?: string // default: import * as Inputs from "@/generated/inputs";
builderImporter?: string // default: import { builder } from "./builder"
outputFolderPath?: string // path to generate files, from project root. default: ./generated
replacer?: (generated: string, position: ReplacerPosition) => string // a function to replace generated source
},
global?: {
replacer?: (generated: string, position: ReplacerPosition) => string // a function to replace generated source
}
}
See example: click here
The tested environments:
| Prisma Version | Database | State |
|---|---|---|
| 3.12 - 4.00 | Postgres - Sqlite |
|
Example
Check for the example for a running sample 
Disclosures
Models with only relations
- We create a custom scalar
NEVERthat avoids this error:Input Object type FollowUpdateManyMutationInput must define one or more fields.from Graphql. if you have models that are relations-only. Like N-N fields withoutno relation fieldsor id-only models, we set field_of some operations to this scalar. If you fill this fake property, the operation will result in a error.
BigInt rename
- As
BigIntis reserved, we exportBigintfor the BigInt scalar.
Publishing
- Run
npm run build - Run
npm run pub
31 Dec 24, 2022
3 May 18, 2022
2 Mar 31, 2022
4 May 3, 2022
14 Jan 3, 2023
60 Dec 28, 2022
356 Dec 29, 2022
16 Dec 6, 2022
1 Jan 10, 2022
27 Dec 9, 2022
9 Dec 24, 2022
2 Nov 2, 2022
10 Sep 13, 2022
6 Dec 12, 2022