@acaldas/graphql-codegen-typescript-validation-schema
Version:
GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema
258 lines (257 loc) • 11.4 kB
JavaScript
import { DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
import { buildApi, formatDirectiveConfig } from '../directive';
import { BaseSchemaVisitor } from '../schema_visitor';
import { isInput, isListType, isNamedType, isNonNullType, ObjectTypeDefinitionBuilder } from './../graphql';
export class YupSchemaVisitor extends BaseSchemaVisitor {
constructor(schema, config) {
super(schema, config);
}
importValidationSchema() {
return `import * as yup from 'yup'`;
}
initialEmit() {
if (!this.config.withObjectType)
return '\n' + this.enumDeclarations.join('\n');
return ('\n' +
this.enumDeclarations.join('\n') +
'\n' +
new DeclarationBlock({})
.asKind('function')
.withName('union<T extends {}>(...schemas: ReadonlyArray<yup.Schema<T>>): yup.MixedSchema<T>')
.withBlock([
indent('return yup.mixed<T>().test({'),
indent('test: (value) => schemas.some((schema) => schema.isValidSync(value))', 2),
indent('}).defined()'),
].join('\n')).string);
}
get InputObjectTypeDefinition() {
return {
leave: (node) => {
const visitor = this.createVisitor('input');
const name = visitor.convertName(node.name.value);
this.importTypes.push(name);
return this.buildInputFields(node.fields ?? [], visitor, name);
},
};
}
get ObjectTypeDefinition() {
return {
leave: ObjectTypeDefinitionBuilder(this.config.withObjectType, (node) => {
const visitor = this.createVisitor('output');
const name = visitor.convertName(node.name.value);
this.importTypes.push(name);
// Building schema for field arguments.
const argumentBlocks = this.buildObjectTypeDefinitionArguments(node, visitor);
const appendArguments = argumentBlocks ? '\n' + argumentBlocks : '';
// Building schema for fields.
const shape = node.fields
?.map(field => {
const fieldSchema = generateFieldYupSchema(this.config, visitor, field, 2);
return isNonNullType(field.type) ? fieldSchema : `${fieldSchema}.optional()`;
})
.join(',\n');
switch (this.config.validationSchemaExportType) {
case 'const':
return (new DeclarationBlock({})
.export()
.asKind('const')
.withName(`${name}Schema: yup.ObjectSchema<${name}>`)
.withContent([
`yup.object({`,
indent(`__typename: yup.string<'${node.name.value}'>().optional(),`, 2),
shape,
'})',
].join('\n')).string + appendArguments);
case 'function':
default:
return (new DeclarationBlock({})
.export()
.asKind('function')
.withName(`${name}Schema(): yup.ObjectSchema<${name}>`)
.withBlock([
indent(`return yup.object({`),
indent(`__typename: yup.string<'${node.name.value}'>().optional(),`, 2),
shape,
indent('})'),
].join('\n')).string + appendArguments);
}
}),
};
}
get EnumTypeDefinition() {
return {
leave: (node) => {
const visitor = this.createVisitor('both');
const enumname = visitor.convertName(node.name.value);
this.importTypes.push(enumname);
// hoise enum declarations
if (this.config.enumsAsTypes) {
const enums = node.values?.map(enumOption => `'${enumOption.name.value}'`);
this.enumDeclarations.push(new DeclarationBlock({})
.export()
.asKind('const')
.withName(`${enumname}Schema`)
.withContent(`yup.string().oneOf([${enums?.join(', ')}]).defined()`).string);
}
else {
const values = node.values
?.map(enumOption => `${enumname}.${visitor.convertName(enumOption.name, {
useTypesPrefix: false,
transformUnderscore: true,
})}`)
.join(', ');
this.enumDeclarations.push(new DeclarationBlock({})
.export()
.asKind('const')
.withName(`${enumname}Schema`)
.withContent(`yup.string<${enumname}>().oneOf([${values}]).defined()`).string);
}
},
};
}
get UnionTypeDefinition() {
return {
leave: (node) => {
if (!node.types || !this.config.withObjectType)
return;
const visitor = this.createVisitor('output');
const unionName = visitor.convertName(node.name.value);
this.importTypes.push(unionName);
const unionElements = node.types
?.map(t => {
const element = visitor.convertName(t.name.value);
const typ = visitor.getType(t.name.value);
if (typ?.astNode?.kind === 'EnumTypeDefinition') {
return `${element}Schema`;
}
switch (this.config.validationSchemaExportType) {
case 'const':
return `${element}Schema`;
case 'function':
default:
return `${element}Schema()`;
}
})
.join(', ');
switch (this.config.validationSchemaExportType) {
case 'const':
return new DeclarationBlock({})
.export()
.asKind('const')
.withName(`${unionName}Schema: yup.MixedSchema<${unionName}>`)
.withContent(`union<${unionName}>(${unionElements})`).string;
case 'function':
default:
return new DeclarationBlock({})
.export()
.asKind('function')
.withName(`${unionName}Schema(): yup.MixedSchema<${unionName}>`)
.withBlock(indent(`return union<${unionName}>(${unionElements})`)).string;
}
},
};
}
buildInputFields(fields, visitor, name) {
const shape = fields
?.map(field => {
const fieldSchema = generateFieldYupSchema(this.config, visitor, field, 2);
return isNonNullType(field.type) ? fieldSchema : `${fieldSchema}.optional()`;
})
.join(',\n');
switch (this.config.validationSchemaExportType) {
case 'const':
return new DeclarationBlock({})
.export()
.asKind('const')
.withName(`${name}Schema: yup.ObjectSchema<${name}>`)
.withContent(['yup.object({', shape, '})'].join('\n')).string;
case 'function':
default:
return new DeclarationBlock({})
.export()
.asKind('function')
.withName(`${name}Schema(): yup.ObjectSchema<${name}>`)
.withBlock([indent(`return yup.object({`), shape, indent('})')].join('\n')).string;
}
}
}
const generateFieldYupSchema = (config, visitor, field, indentCount) => {
let gen = generateFieldTypeYupSchema(config, visitor, field.type);
if (config.directives && field.directives) {
const formatted = formatDirectiveConfig(config.directives);
gen += buildApi(formatted, field.directives);
}
return indent(`${field.name.value}: ${maybeLazy(field.type, gen)}`, indentCount);
};
const generateFieldTypeYupSchema = (config, visitor, type, parentType) => {
if (isListType(type)) {
const gen = generateFieldTypeYupSchema(config, visitor, type.type, type);
if (!isNonNullType(parentType)) {
return `yup.array(${maybeLazy(type.type, gen)}).defined().nullable()`;
}
return `yup.array(${maybeLazy(type.type, gen)}).defined()`;
}
if (isNonNullType(type)) {
const gen = generateFieldTypeYupSchema(config, visitor, type.type, type);
return maybeLazy(type.type, gen);
}
if (isNamedType(type)) {
const gen = generateNameNodeYupSchema(config, visitor, type.name);
if (isNonNullType(parentType)) {
if (visitor.shouldEmitAsNotAllowEmptyString(type.name.value)) {
return `${gen}.required()`;
}
return `${gen}.nonNullable()`;
}
const typ = visitor.getType(type.name.value);
if (typ?.astNode?.kind === 'InputObjectTypeDefinition') {
return `${gen}`;
}
return `${gen}.nullable()`;
}
console.warn('unhandled type:', type);
return '';
};
const generateNameNodeYupSchema = (config, visitor, node) => {
const converter = visitor.getNameNodeConverter(node);
switch (converter?.targetKind) {
case 'InputObjectTypeDefinition':
case 'ObjectTypeDefinition':
case 'UnionTypeDefinition':
// using switch-case rather than if-else to allow for future expansion
switch (config.validationSchemaExportType) {
case 'const':
return `${converter.convertName()}Schema`;
case 'function':
default:
return `${converter.convertName()}Schema()`;
}
case 'EnumTypeDefinition':
return `${converter.convertName()}Schema`;
default:
return yup4Scalar(config, visitor, node.value);
}
};
const maybeLazy = (type, schema) => {
if (isNamedType(type) && isInput(type.name.value)) {
// https://github.com/jquense/yup/issues/1283#issuecomment-786559444
return `yup.lazy(() => ${schema})`;
}
return schema;
};
const yup4Scalar = (config, visitor, scalarName) => {
if (config.scalarSchemas?.[scalarName]) {
return `${config.scalarSchemas[scalarName]}.defined()`;
}
const tsType = visitor.getScalarType(scalarName);
switch (tsType) {
case 'string':
return `yup.string().defined()`;
case 'number':
return `yup.number().defined()`;
case 'boolean':
return `yup.boolean().defined()`;
}
console.warn('unhandled name:', scalarName);
return `yup.mixed()`;
};