Skip to content

[WIP] [Zod Plugin] Variable used before declaration in OpenAPI schema with circular references #2675

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

[WIP] [Zod Plugin] Variable used before declaration in OpenAPI schema with circular references #2675

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a6cbb35
Initial plan
Copilot Sep 22, 2025
a33db32
Changes before error encountered
Copilot Sep 22, 2025
c0dec23
Changes before error encountered
Copilot Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 44 additions & 16 deletions packages/openapi-ts-tests/zod/v4/__snapshots__/2.0.x/mini/default/zod.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,9 @@ export const zModelWithProperties = z.object({
string: z.optional(z.string()),
number: z.optional(z.number()),
boolean: z.optional(z.boolean()),
reference: z.optional(zModelWithString),
get reference(): z.ZodMiniOptional {
return z.optional(zModelWithString);
},
'property with space': z.optional(z.string()),
default: z.optional(z.string()),
try: z.optional(z.string()),
Expand All @@ -283,14 +285,18 @@ export const zModelWithProperties = z.object({
* This is a model with one property containing a reference
*/
export const zModelWithReference = z.object({
prop: z.optional(zModelWithProperties)
get prop(): z.ZodMiniOptional {
return z.optional(zModelWithProperties);
}
});

/**
* This is a model with one property containing an array
*/
export const zModelWithArray = z.object({
prop: z.optional(z.array(zModelWithString)),
get prop(): z.ZodMiniOptional {
return z.optional(z.array(zModelWithString));
},
propWithFile: z.optional(z.array(z.string())),
propWithNumber: z.optional(z.array(z.number()))
});
Expand Down Expand Up @@ -328,7 +334,9 @@ export const zModelWithNestedProperties = z.object({
* This is a model with duplicated properties
*/
export const zModelWithDuplicateProperties = z.object({
prop: z.optional(zModelWithString)
get prop(): z.ZodMiniOptional {
return z.optional(zModelWithString);
}
});

/**
Expand All @@ -344,25 +352,39 @@ export const zModelWithOrderedProperties = z.object({
* This is a model with duplicated imports
*/
export const zModelWithDuplicateImports = z.object({
propA: z.optional(zModelWithString),
propB: z.optional(zModelWithString),
propC: z.optional(zModelWithString)
get propA(): z.ZodMiniOptional {
return z.optional(zModelWithString);
},
get propB(): z.ZodMiniOptional {
return z.optional(zModelWithString);
},
get propC(): z.ZodMiniOptional {
return z.optional(zModelWithString);
}
});

/**
* This is a model that extends another model
*/
export const zModelThatExtends = z.intersection(zModelWithString, z.object({
propExtendsA: z.optional(z.string()),
propExtendsB: z.optional(zModelWithString)
export const zModelThatExtends = z.intersection(zModelWithString, z.lazy(() => {
return z.object({
propExtendsA: z.optional(z.string()),
get propExtendsB(): z.ZodMiniOptional {
return z.optional(zModelWithString);
}
});
}));

/**
* This is a model that extends another model
*/
export const zModelThatExtendsExtends = z.intersection(z.intersection(zModelWithString, zModelThatExtends), z.object({
propExtendsC: z.optional(z.string()),
propExtendsD: z.optional(zModelWithString)
export const zModelThatExtendsExtends = z.intersection(z.intersection(zModelWithString, zModelThatExtends), z.lazy(() => {
return z.object({
propExtendsC: z.optional(z.string()),
get propExtendsD(): z.ZodMiniOptional {
return z.optional(zModelWithString);
}
});
}));

export const zDefault = z.object({
Expand Down Expand Up @@ -414,7 +436,9 @@ export const zModelWithPropertiesWritable = z.object({
string: z.optional(z.string()),
number: z.optional(z.number()),
boolean: z.optional(z.boolean()),
reference: z.optional(zModelWithString),
get reference(): z.ZodMiniOptional {
return z.optional(zModelWithString);
},
'property with space': z.optional(z.string()),
default: z.optional(z.string()),
try: z.optional(z.string())
Expand Down Expand Up @@ -678,7 +702,9 @@ export const zCallWithResponsesResponse = z.union([
z.object({
'@namespace.string': z.optional(z.readonly(z.string())),
'@namespace.integer': z.optional(z.readonly(z.int())),
value: z.optional(z.readonly(z.array(zModelWithString)))
get value(): z.ZodMiniOptional {
return z.optional(z.readonly(z.array(zModelWithString)));
}
}),
zModelThatExtends,
zModelThatExtendsExtends
Expand Down Expand Up @@ -772,7 +798,9 @@ export const zNonAsciiæøåÆøÅöôêÊ字符串Data = z.object({
export const zNonAsciiæøåÆøÅöôêÊ字符串Response = zNonAsciiStringæøåÆøÅöôêÊ字符串;

export const zPostApiVbyApiVersionBodyData = z.object({
body: zParameterActivityParams,
get body() {
return zParameterActivityParams;
},
path: z.optional(z.never()),
query: z.optional(z.never())
});
Expand Down
76 changes: 51 additions & 25 deletions packages/openapi-ts-tests/zod/v4/__snapshots__/2.0.x/v3/default/zod.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,13 +265,15 @@ export const zModelWithNestedEnums = z.object({
/**
* This is a model with one nested property
*/
export const zModelWithProperties = z.object({
export const zModelWithProperties: z.AnyZodObject = z.object({
required: z.string(),
requiredAndReadOnly: z.string().readonly(),
string: z.string().optional(),
number: z.number().optional(),
boolean: z.boolean().optional(),
reference: zModelWithString.optional(),
get reference() {
return zModelWithString.optional();
},
'property with space': z.string().optional(),
default: z.string().optional(),
try: z.string().optional(),
Expand All @@ -282,15 +284,19 @@ export const zModelWithProperties = z.object({
/**
* This is a model with one property containing a reference
*/
export const zModelWithReference = z.object({
prop: zModelWithProperties.optional()
export const zModelWithReference: z.AnyZodObject = z.object({
get prop() {
return zModelWithProperties.optional();
}
});

/**
* This is a model with one property containing an array
*/
export const zModelWithArray = z.object({
prop: z.array(zModelWithString).optional(),
export const zModelWithArray: z.AnyZodObject = z.object({
get prop() {
return z.array(zModelWithString).optional();
},
propWithFile: z.array(z.string()).optional(),
propWithNumber: z.array(z.number()).optional()
});
Expand All @@ -306,9 +312,11 @@ export const zModelWithDictionary = z.object({
* This is a model with one property containing a circular reference
*/
export const zModelWithCircularReference: z.AnyZodObject = z.object({
prop: z.lazy(() => {
return zModelWithCircularReference;
}).optional()
get prop(): z.ZodTypeAny {
return z.lazy(() => {
return zModelWithCircularReference;
}).optional();
}
});

/**
Expand All @@ -325,8 +333,10 @@ export const zModelWithNestedProperties = z.object({
/**
* This is a model with duplicated properties
*/
export const zModelWithDuplicateProperties = z.object({
prop: zModelWithString.optional()
export const zModelWithDuplicateProperties: z.AnyZodObject = z.object({
get prop() {
return zModelWithString.optional();
}
});

/**
Expand All @@ -341,26 +351,36 @@ export const zModelWithOrderedProperties = z.object({
/**
* This is a model with duplicated imports
*/
export const zModelWithDuplicateImports = z.object({
propA: zModelWithString.optional(),
propB: zModelWithString.optional(),
propC: zModelWithString.optional()
export const zModelWithDuplicateImports: z.AnyZodObject = z.object({
get propA() {
return zModelWithString.optional();
},
get propB() {
return zModelWithString.optional();
},
get propC() {
return zModelWithString.optional();
}
});

/**
* This is a model that extends another model
*/
export const zModelThatExtends = zModelWithString.and(z.object({
export const zModelThatExtends: z.ZodTypeAny = zModelWithString.and(z.object({
propExtendsA: z.string().optional(),
propExtendsB: zModelWithString.optional()
get propExtendsB() {
return zModelWithString.optional();
}
}));

/**
* This is a model that extends another model
*/
export const zModelThatExtendsExtends = zModelWithString.and(zModelThatExtends).and(z.object({
export const zModelThatExtendsExtends: z.ZodTypeAny = zModelWithString.and(zModelThatExtends).and(z.object({
propExtendsC: z.string().optional(),
propExtendsD: zModelWithString.optional()
get propExtendsD() {
return zModelWithString.optional();
}
}));

export const zDefault = z.object({
Expand Down Expand Up @@ -407,12 +427,14 @@ export const zFailureFailure = z.object({
/**
* This is a model with one nested property
*/
export const zModelWithPropertiesWritable = z.object({
export const zModelWithPropertiesWritable: z.AnyZodObject = z.object({
required: z.string(),
string: z.string().optional(),
number: z.number().optional(),
boolean: z.boolean().optional(),
reference: zModelWithString.optional(),
get reference() {
return zModelWithString.optional();
},
'property with space': z.string().optional(),
default: z.string().optional(),
try: z.string().optional()
Expand Down Expand Up @@ -672,11 +694,13 @@ export const zCallWithResponsesData = z.object({
query: z.never().optional()
});

export const zCallWithResponsesResponse = z.union([
export const zCallWithResponsesResponse: z.ZodTypeAny = z.union([
z.object({
'@namespace.string': z.string().readonly().optional(),
'@namespace.integer': z.number().int().readonly().optional(),
value: z.array(zModelWithString).readonly().optional()
get value() {
return z.array(zModelWithString).readonly().optional();
}
}),
zModelThatExtends,
zModelThatExtendsExtends
Expand Down Expand Up @@ -769,8 +793,10 @@ export const zNonAsciiæøåÆøÅöôêÊ字符串Data = z.object({
*/
export const zNonAsciiæøåÆøÅöôêÊ字符串Response = zNonAsciiStringæøåÆøÅöôêÊ字符串;

export const zPostApiVbyApiVersionBodyData = z.object({
body: zParameterActivityParams,
export const zPostApiVbyApiVersionBodyData: z.AnyZodObject = z.object({
get body() {
return zParameterActivityParams;
},
path: z.never().optional(),
query: z.never().optional()
});
Expand Down
Loading