Skip to content

Commit c94ef9e

Browse files
nickthegrootbtoo
nickthegroot
authored and
btoo
committed
🐛 Fix #599: add lazy support for potential self-referential types
also include unit tests
1 parent caffe57 commit c94ef9e

File tree

12 files changed

+95
-81
lines changed

12 files changed

+95
-81
lines changed

‎example/myzod/schemas.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ export function UserSchema(): myzod.Type<User> {
120120
createdAt: definedNonNullAnySchema.optional().nullable(),
121121
email: myzod.string().optional().nullable(),
122122
id: myzod.string().optional().nullable(),
123-
kind: UserKindSchema().optional().nullable(),
123+
kind: myzod.lazy(() => UserKindSchema().optional().nullable()),
124124
name: myzod.string().optional().nullable(),
125125
password: myzod.string().optional().nullable(),
126126
updatedAt: definedNonNullAnySchema.optional().nullable()

‎example/valibot/schemas.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ export function UserSchema(): v.GenericSchema<User> {
118118
createdAt: v.nullish(v.any()),
119119
email: v.nullish(v.string()),
120120
id: v.nullish(v.string()),
121-
kind: v.nullish(UserKindSchema()),
121+
kind: v.lazy(() => v.nullish(UserKindSchema())),
122122
name: v.nullish(v.string()),
123123
password: v.nullish(v.string()),
124124
updatedAt: v.nullish(v.any())

‎example/yup/schemas.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ export function UserSchema(): yup.ObjectSchema<User> {
124124
createdAt: yup.mixed().nullable().optional(),
125125
email: yup.string().defined().nullable().optional(),
126126
id: yup.string().defined().nullable().optional(),
127-
kind: UserKindSchema().nullable().optional(),
127+
kind: yup.lazy(() => UserKindSchema().nullable()).optional(),
128128
name: yup.string().defined().nullable().optional(),
129129
password: yup.string().defined().nullable().optional(),
130130
updatedAt: yup.mixed().nullable().optional()

‎example/zod/schemas.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ export function UserSchema(): z.ZodObject<Properties<User>> {
128128
createdAt: definedNonNullAnySchema.nullish(),
129129
email: z.string().nullish(),
130130
id: z.string().nullish(),
131-
kind: UserKindSchema().nullish(),
131+
kind: z.lazy(() => UserKindSchema().nullish()),
132132
name: z.string().nullish(),
133133
password: z.string().nullish(),
134134
updatedAt: definedNonNullAnySchema.nullish()

‎src/myzod/index.ts‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ import type { Visitor } from '../visitor.js';
1616
import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
1717
import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
1818
import {
19+
isEnumType,
20+
isScalarType,
1921
Kind,
2022
} from 'graphql';
2123
import { buildApi, formatDirectiveConfig } from '../directive.js';
2224
import {
2325
escapeGraphQLCharacters,
2426
InterfaceTypeDefinitionBuilder,
25-
isInput,
2627
isListType,
2728
isNamedType,
2829
isNonNullType,
@@ -262,22 +263,22 @@ export class MyZodSchemaVisitor extends BaseSchemaVisitor {
262263

263264
function generateFieldMyZodSchema(config: ValidationSchemaPluginConfig, visitor: Visitor, field: InputValueDefinitionNode | FieldDefinitionNode, indentCount: number): string {
264265
const gen = generateFieldTypeMyZodSchema(config, visitor, field, field.type);
265-
return indent(`${field.name.value}: ${maybeLazy(field.type, gen)}`, indentCount);
266+
return indent(`${field.name.value}: ${maybeLazy(visitor, field.type, gen)}`, indentCount);
266267
}
267268

268269
function generateFieldTypeMyZodSchema(config: ValidationSchemaPluginConfig, visitor: Visitor, field: InputValueDefinitionNode | FieldDefinitionNode, type: TypeNode, parentType?: TypeNode): string {
269270
if (isListType(type)) {
270271
const gen = generateFieldTypeMyZodSchema(config, visitor, field, type.type, type);
271272
if (!isNonNullType(parentType)) {
272-
const arrayGen = `myzod.array(${maybeLazy(type.type, gen)})`;
273+
const arrayGen = `myzod.array(${maybeLazy(visitor, type.type, gen)})`;
273274
const maybeLazyGen = applyDirectives(config, field, arrayGen);
274275
return `${maybeLazyGen}.optional().nullable()`;
275276
}
276-
return `myzod.array(${maybeLazy(type.type, gen)})`;
277+
return `myzod.array(${maybeLazy(visitor, type.type, gen)})`;
277278
}
278279
if (isNonNullType(type)) {
279280
const gen = generateFieldTypeMyZodSchema(config, visitor, field, type.type, type);
280-
return maybeLazy(type.type, gen);
281+
return maybeLazy(visitor, type.type, gen);
281282
}
282283
if (isNamedType(type)) {
283284
const gen = generateNameNodeMyZodSchema(config, visitor, type.name);
@@ -358,11 +359,14 @@ function generateNameNodeMyZodSchema(config: ValidationSchemaPluginConfig, visit
358359
}
359360
}
360361

361-
function maybeLazy(type: TypeNode, schema: string): string {
362-
if (isNamedType(type) && isInput(type.name.value))
363-
return `myzod.lazy(() => ${schema})`;
362+
function maybeLazy(visitor: Visitor, type: TypeNode, schema: string): string {
363+
if (!isNamedType(type)) {
364+
return schema;
365+
}
364366

365-
return schema;
367+
const schemaType = visitor.getType(type.name.value);
368+
const isComplexType = !isScalarType(schemaType) && !isEnumType(schemaType);
369+
return isComplexType ? `myzod.lazy(() => ${schema})` : schema;
366370
}
367371

368372
function myzod4Scalar(config: ValidationSchemaPluginConfig, visitor: Visitor, scalarName: string): string {

‎src/valibot/index.ts‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ import type {
1010
TypeNode,
1111
UnionTypeDefinitionNode,
1212
} from 'graphql';
13+
import { isEnumType, isScalarType } from 'graphql';
1314
import type { ValidationSchemaPluginConfig } from '../config.js';
1415
import type { Visitor } from '../visitor.js';
1516

1617
import { DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
1718
import { buildApiForValibot, formatDirectiveConfig } from '../directive.js';
1819
import {
1920
InterfaceTypeDefinitionBuilder,
20-
isInput,
2121
isListType,
2222
isNamedType,
2323
isNonNullType,
@@ -205,21 +205,21 @@ export class ValibotSchemaVisitor extends BaseSchemaVisitor {
205205

206206
function generateFieldValibotSchema(config: ValidationSchemaPluginConfig, visitor: Visitor, field: InputValueDefinitionNode | FieldDefinitionNode, indentCount: number): string {
207207
const gen = generateFieldTypeValibotSchema(config, visitor, field, field.type);
208-
return indent(`${field.name.value}: ${maybeLazy(field.type, gen)}`, indentCount);
208+
return indent(`${field.name.value}: ${maybeLazy(visitor, field.type, gen)}`, indentCount);
209209
}
210210

211211
function generateFieldTypeValibotSchema(config: ValidationSchemaPluginConfig, visitor: Visitor, field: InputValueDefinitionNode | FieldDefinitionNode, type: TypeNode, parentType?: TypeNode): string {
212212
if (isListType(type)) {
213213
const gen = generateFieldTypeValibotSchema(config, visitor, field, type.type, type);
214-
const arrayGen = `v.array(${maybeLazy(type.type, gen)})`;
214+
const arrayGen = `v.array(${maybeLazy(visitor, type.type, gen)})`;
215215
if (!isNonNullType(parentType))
216216
return `v.nullish(${arrayGen})`;
217217

218218
return arrayGen;
219219
}
220220
if (isNonNullType(type)) {
221221
const gen = generateFieldTypeValibotSchema(config, visitor, field, type.type, type);
222-
return maybeLazy(type.type, gen);
222+
return maybeLazy(visitor, type.type, gen);
223223
}
224224
if (isNamedType(type)) {
225225
const gen = generateNameNodeValibotSchema(config, visitor, type.name);
@@ -283,11 +283,14 @@ function generateNameNodeValibotSchema(config: ValidationSchemaPluginConfig, vis
283283
}
284284
}
285285

286-
function maybeLazy(type: TypeNode, schema: string): string {
287-
if (isNamedType(type) && isInput(type.name.value))
288-
return `v.lazy(() => ${schema})`;
286+
function maybeLazy(visitor: Visitor, type: TypeNode, schema: string): string {
287+
if (!isNamedType(type)) {
288+
return schema;
289+
}
289290

290-
return schema;
291+
const schemaType = visitor.getType(type.name.value);
292+
const isComplexType = !isScalarType(schemaType) && !isEnumType(schemaType);
293+
return isComplexType ? `v.lazy(() => ${schema})` : schema;
291294
}
292295

293296
function valibot4Scalar(config: ValidationSchemaPluginConfig, visitor: Visitor, scalarName: string): string {

‎src/yup/index.ts‎

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ import type { Visitor } from '../visitor.js';
1616
import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
1717
import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
1818
import {
19+
isEnumType,
20+
isScalarType,
1921
Kind,
2022
} from 'graphql';
2123
import { buildApi, formatDirectiveConfig } from '../directive.js';
2224
import {
2325
escapeGraphQLCharacters,
2426
InterfaceTypeDefinitionBuilder,
25-
isInput,
2627
isListType,
2728
isNamedType,
2829
isNonNullType,
@@ -324,20 +325,20 @@ function generateFieldYupSchema(config: ValidationSchemaPluginConfig, visitor: V
324325
const formatted = formatDirectiveConfig(config.directives);
325326
gen += buildApi(formatted, field.directives);
326327
}
327-
return indent(`${field.name.value}: ${maybeLazy(field.type, gen)}`, indentCount);
328+
return indent(`${field.name.value}: ${maybeLazy(visitor, field.type, gen)}`, indentCount);
328329
}
329330

330331
function generateFieldTypeYupSchema(config: ValidationSchemaPluginConfig, visitor: Visitor, type: TypeNode, parentType?: TypeNode): string {
331332
if (isListType(type)) {
332333
const gen = generateFieldTypeYupSchema(config, visitor, type.type, type);
333334
if (!isNonNullType(parentType))
334-
return `yup.array(${maybeLazy(type.type, gen)}).defined().nullable()`;
335+
return `yup.array(${maybeLazy(visitor, type.type, gen)}).defined().nullable()`;
335336

336-
return `yup.array(${maybeLazy(type.type, gen)}).defined()`;
337+
return `yup.array(${maybeLazy(visitor, type.type, gen)}).defined()`;
337338
}
338339
if (isNonNullType(type)) {
339340
const gen = generateFieldTypeYupSchema(config, visitor, type.type, type);
340-
return maybeLazy(type.type, gen);
341+
return maybeLazy(visitor, type.type, gen);
341342
}
342343
if (isNamedType(type)) {
343344
const gen = generateNameNodeYupSchema(config, visitor, type.name);
@@ -380,12 +381,14 @@ function generateNameNodeYupSchema(config: ValidationSchemaPluginConfig, visitor
380381
}
381382
}
382383

383-
function maybeLazy(type: TypeNode, schema: string): string {
384-
if (isNamedType(type) && isInput(type.name.value)) {
385-
// https://github.com/jquense/yup/issues/1283#issuecomment-786559444
386-
return `yup.lazy(() => ${schema})`;
384+
function maybeLazy(visitor: Visitor, type: TypeNode, schema: string): string {
385+
if (!isNamedType(type)) {
386+
return schema;
387387
}
388-
return schema;
388+
389+
const schemaType = visitor.getType(type.name.value);
390+
const isComplexType = !isScalarType(schemaType) && !isEnumType(schemaType);
391+
return isComplexType ? `yup.lazy(() => ${schema})` : schema;
389392
}
390393

391394
function yup4Scalar(config: ValidationSchemaPluginConfig, visitor: Visitor, scalarName: string): string {

‎src/zod/index.ts‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ import type { Visitor } from '../visitor.js';
1616
import { resolveExternalModuleAndFn } from '@graphql-codegen/plugin-helpers';
1717
import { convertNameParts, DeclarationBlock, indent } from '@graphql-codegen/visitor-plugin-common';
1818
import {
19+
isEnumType,
20+
isScalarType,
1921
Kind,
2022
} from 'graphql';
2123
import { buildApi, formatDirectiveConfig } from '../directive.js';
2224
import {
2325
escapeGraphQLCharacters,
2426
InterfaceTypeDefinitionBuilder,
25-
isInput,
2627
isListType,
2728
isNamedType,
2829
isNonNullType,
@@ -278,22 +279,22 @@ export class ZodSchemaVisitor extends BaseSchemaVisitor {
278279

279280
function generateFieldZodSchema(config: ValidationSchemaPluginConfig, visitor: Visitor, field: InputValueDefinitionNode | FieldDefinitionNode, indentCount: number): string {
280281
const gen = generateFieldTypeZodSchema(config, visitor, field, field.type);
281-
return indent(`${field.name.value}: ${maybeLazy(field.type, gen)}`, indentCount);
282+
return indent(`${field.name.value}: ${maybeLazy(visitor, field.type, gen)}`, indentCount);
282283
}
283284

284285
function generateFieldTypeZodSchema(config: ValidationSchemaPluginConfig, visitor: Visitor, field: InputValueDefinitionNode | FieldDefinitionNode, type: TypeNode, parentType?: TypeNode): string {
285286
if (isListType(type)) {
286287
const gen = generateFieldTypeZodSchema(config, visitor, field, type.type, type);
287288
if (!isNonNullType(parentType)) {
288-
const arrayGen = `z.array(${maybeLazy(type.type, gen)})`;
289+
const arrayGen = `z.array(${maybeLazy(visitor, type.type, gen)})`;
289290
const maybeLazyGen = applyDirectives(config, field, arrayGen);
290291
return `${maybeLazyGen}.nullish()`;
291292
}
292-
return `z.array(${maybeLazy(type.type, gen)})`;
293+
return `z.array(${maybeLazy(visitor, type.type, gen)})`;
293294
}
294295
if (isNonNullType(type)) {
295296
const gen = generateFieldTypeZodSchema(config, visitor, field, type.type, type);
296-
return maybeLazy(type.type, gen);
297+
return maybeLazy(visitor, type.type, gen);
297298
}
298299
if (isNamedType(type)) {
299300
const gen = generateNameNodeZodSchema(config, visitor, type.name);
@@ -374,11 +375,14 @@ function generateNameNodeZodSchema(config: ValidationSchemaPluginConfig, visitor
374375
}
375376
}
376377

377-
function maybeLazy(type: TypeNode, schema: string): string {
378-
if (isNamedType(type) && isInput(type.name.value))
379-
return `z.lazy(() => ${schema})`;
378+
function maybeLazy(visitor: Visitor, type: TypeNode, schema: string): string {
379+
if (!isNamedType(type)) {
380+
return schema;
381+
}
380382

381-
return schema;
383+
const schemaType = visitor.getType(type.name.value);
384+
const isComplexType = !isScalarType(schemaType) && !isEnumType(schemaType);
385+
return isComplexType ? `z.lazy(() => ${schema})` : schema;
382386
}
383387

384388
function zod4Scalar(config: ValidationSchemaPluginConfig, visitor: Visitor, scalarName: string): string {

‎tests/myzod.spec.ts‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -830,15 +830,15 @@ describe('myzod', () => {
830830
export function BookSchema(): myzod.Type<Book> {
831831
return myzod.object({
832832
__typename: myzod.literal('Book').optional(),
833-
author: AuthorSchema().optional().nullable(),
833+
author: myzod.lazy(() => AuthorSchema().optional().nullable()),
834834
title: myzod.string().optional().nullable()
835835
})
836836
}
837837
838838
export function AuthorSchema(): myzod.Type<Author> {
839839
return myzod.object({
840840
__typename: myzod.literal('Author').optional(),
841-
books: myzod.array(BookSchema().nullable()).optional().nullable(),
841+
books: myzod.array(myzod.lazy(() => BookSchema().nullable())).optional().nullable(),
842842
name: myzod.string().optional().nullable()
843843
})
844844
}
@@ -1075,7 +1075,7 @@ describe('myzod', () => {
10751075
export function GeometrySchema(): myzod.Type<Geometry> {
10761076
return myzod.object({
10771077
__typename: myzod.literal('Geometry').optional(),
1078-
shape: ShapeSchema().optional().nullable()
1078+
shape: myzod.lazy(() => ShapeSchema().optional().nullable())
10791079
})
10801080
}
10811081
"
@@ -1196,7 +1196,7 @@ describe('myzod', () => {
11961196
11971197
export const GeometrySchema: myzod.Type<Geometry> = myzod.object({
11981198
__typename: myzod.literal('Geometry').optional(),
1199-
shape: ShapeSchema.optional().nullable()
1199+
shape: myzod.lazy(() => ShapeSchema.optional().nullable())
12001200
});
12011201
"
12021202
`)
@@ -1317,14 +1317,14 @@ describe('myzod', () => {
13171317
"
13181318
export function BookSchema(): myzod.Type<Book> {
13191319
return myzod.object({
1320-
author: AuthorSchema().optional().nullable(),
1320+
author: myzod.lazy(() => AuthorSchema().optional().nullable()),
13211321
title: myzod.string().optional().nullable()
13221322
})
13231323
}
13241324
13251325
export function AuthorSchema(): myzod.Type<Author> {
13261326
return myzod.object({
1327-
books: myzod.array(BookSchema().nullable()).optional().nullable(),
1327+
books: myzod.array(myzod.lazy(() => BookSchema().nullable())).optional().nullable(),
13281328
name: myzod.string().optional().nullable()
13291329
})
13301330
}
@@ -1369,15 +1369,15 @@ describe('myzod', () => {
13691369
export function BookSchema(): myzod.Type<Book> {
13701370
return myzod.object({
13711371
title: myzod.string(),
1372-
author: AuthorSchema()
1372+
author: myzod.lazy(() => AuthorSchema())
13731373
})
13741374
}
13751375
13761376
export function TextbookSchema(): myzod.Type<Textbook> {
13771377
return myzod.object({
13781378
__typename: myzod.literal('Textbook').optional(),
13791379
title: myzod.string(),
1380-
author: AuthorSchema(),
1380+
author: myzod.lazy(() => AuthorSchema()),
13811381
courses: myzod.array(myzod.string())
13821382
})
13831383
}
@@ -1386,15 +1386,15 @@ describe('myzod', () => {
13861386
return myzod.object({
13871387
__typename: myzod.literal('ColoringBook').optional(),
13881388
title: myzod.string(),
1389-
author: AuthorSchema(),
1389+
author: myzod.lazy(() => AuthorSchema()),
13901390
colors: myzod.array(myzod.string())
13911391
})
13921392
}
13931393
13941394
export function AuthorSchema(): myzod.Type<Author> {
13951395
return myzod.object({
13961396
__typename: myzod.literal('Author').optional(),
1397-
books: myzod.array(BookSchema()).optional().nullable(),
1397+
books: myzod.array(myzod.lazy(() => BookSchema())).optional().nullable(),
13981398
name: myzod.string().optional().nullable()
13991399
})
14001400
}

0 commit comments

Comments
 (0)