@anatine/graphql-zod-validation
v0.9.1
Published
GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema
Downloads
239
Maintainers
Readme
@anatine/graphql-zod-validation
Fork for type support
This codebase is taken direction from GraphQL code generator
Used to generate validation schema from the following libraries.
NOTE
This module has additional support for generating type
objects from GraphQL
Useful when using the expected validation type (or one extended) to validate data before returning to your resolver.
Quick Start
Start by installing this plugin and write simple plugin config;
npm i @anatine/graphql-zod-validation
generates:
path/to/graphql.ts:
plugins:
- typescript
- '@anatine/graphql-zod-validation' # specify to use this plugin
config:
# You can put the config for typescript plugin here
# see: https://www.graphql-code-generator.com/plugins/typescript
strictScalars: true
# You can also write the config for this plugin together
schema: yup # or zod
You can check example directory if you want to see more complex config example or how is generated some files.
The Q&A for each schema is written in the README in the respective example directory.
Config API Reference
schema
type: ValidationSchema
default: 'yup'
Specify generete validation schema you want.
You can specify yup
or zod
or myzod
.
generates:
path/to/graphql.ts:
plugins:
- typescript
- '@anatine/graphql-zod-validation'
config:
schema: yup
importFrom
type: string
When provided, import types from the generated typescript types file path. if not given, omit import statement.
generates:
path/to/graphql.ts:
plugins:
- typescript
path/to/validation.ts:
plugins:
- '@anatine/graphql-zod-validation'
config:
importFrom: ./graphql # path for generated ts code
Then the generator generates code with import statement like below.
import { GeneratedInput } from './graphql'
/* generates validation schema here */
typesPrefix
type: string
default: (empty)
Prefixes all import types from generated typescript type.
generates:
path/to/graphql.ts:
plugins:
- typescript
path/to/validation.ts:
plugins:
- '@anatine/graphql-zod-validation'
config:
typesPrefix: I
importFrom: ./graphql # path for generated ts code
Then the generator generates code with import statement like below.
import { IGeneratedInput } from './graphql'
/* generates validation schema here */
typesSuffix
type: string
default: (empty)
Suffixes all import types from generated typescript type.
generates:
path/to/graphql.ts:
plugins:
- typescript
path/to/validation.ts:
plugins:
- '@anatine/graphql-zod-validation'
config:
typesSuffix: I
importFrom: ./graphql # path for generated ts code
Then the generator generates code with import statement like below.
import { GeneratedInputI } from './graphql'
/* generates validation schema here */
enumsAsTypes
type: boolean
default: false
Generates enum as TypeScript type
instead of enum
.
notAllowEmptyString
type: boolean
default: false
Generates validation string schema as do not allow empty characters by default.
scalarSchemas
type: ScalarSchemas
Extends or overrides validation schema for the built-in scalars and custom GraphQL scalars.
useObjectTypes
type: boolean
default: false
When enabled, object types type
will also be converted via codegen.
yup schema
config:
schema: yup
scalarSchemas:
Date: yup.date()
Email: yup.string().email()
zod schema
config:
schema: zod
useObjectTypes: true
scalarSchemas:
Date: z.date()
Email: z.string().email()
directives
type: DirectiveConfig
Generates validation schema with more API based on directive schema. For example, yaml config and GraphQL schema is here.
input ExampleInput {
email: String! @required(msg: "Hello, World!") @constraint(minLength: 50, format: "email")
message: String! @constraint(startsWith: "Hello")
}
yup schema extended
generates:
path/to/graphql.ts:
plugins:
- typescript
- '@anatine/graphql-zod-validation'
config:
schema: yup
directives:
# Write directives like
#
# directive:
# arg1: schemaApi
# arg2: ["schemaApi2", "Hello $1"]
#
# See more examples in `./tests/directive.spec.ts`
# https://github.com/Code-Hex/graphql-codegen-typescript-validation-schema/blob/main/tests/directive.spec.ts
required:
msg: required
constraint:
minLength: min
# Replace $1 with specified `startsWith` argument value of the constraint directive
startsWith: ["matches", "/^$1/"]
format:
email: email
Then generates yup validation schema like below.
export function ExampleInputSchema(): yup.SchemaOf<ExampleInput> {
return yup.object({
email: yup.string().defined().required("Hello, World!").min(50).email(),
message: yup.string().defined().matches(/^Hello/)
})
}
zod schema extended
generates:
path/to/graphql.ts:
plugins:
- typescript
- typescript-validation-schema
config:
schema: zod
directives:
# Write directives like
#
# directive:
# arg1: schemaApi
# arg2: ["schemaApi2", "Hello $1"]
#
# See more examples in `./tests/directive.spec.ts`
# https://github.com/Code-Hex/graphql-codegen-typescript-validation-schema/blob/main/tests/directive.spec.ts
constraint:
minLength: min
# Replace $1 with specified `startsWith` argument value of the constraint directive
startsWith: ["regex", "/^$1/", "message"]
format:
email: email
Then generates zod validation schema like below.
export function ExampleInputSchema(): z.ZodSchema<ExampleInput> {
return z.object({
email: z.string().min(50).email(),
message: z.string().regex(/^Hello/, "message")
})
}
other schema
Please see example directory.