fix

malcolm-kee · malcolm-kee · commit 08c9e76c550f · 2026-04-04T20:24:41.000+11:00
diff --git a/packages/openapi-ts-tests/faker/v10/__snapshots__/3.0.x/faker-circular/@faker-js/faker.gen.ts b/packages/openapi-ts-tests/faker/v10/__snapshots__/3.0.x/faker-circular/@faker-js/faker.gen.ts
@@ -2,7 +2,7 @@
 
 import { faker, type Faker } from '@faker-js/faker';
 
-import type { Bar, Baz, Comment, Corge, Department, Employee, Foo, Member, Org, Project, Quux, Qux, TreeNode } from '../types.gen';
+import type { Bar, Baz, Comment, Corge, Department, Employee, Foo, Member, Org, Project, Quux, Qux, TreeNode, Wrapper } from '../types.gen';
 
 export type Options = {
     faker?: Faker;
@@ -33,6 +33,14 @@ export const fakeTreeNode = (options: Options = {}, _callDepth = 0): TreeNode =>
     };
 };
 
+export const fakeWrapper = (options?: Options): Wrapper => {
+    const f = options?.faker ?? faker;
+    return {
+        label: f.string.sample(),
+        tree: fakeTreeNode(options)
+    };
+};
+
 export const fakeComment = (options: Options = {}, _callDepth = 0): Comment => {
     const f = options?.faker ?? faker;
     return {
diff --git a/packages/openapi-ts-tests/faker/v10/__snapshots__/3.0.x/faker-circular/index.ts b/packages/openapi-ts-tests/faker/v10/__snapshots__/3.0.x/faker-circular/index.ts
@@ -1,3 +1,3 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export type { Bar, Baz, ClientOptions, Comment, Corge, Department, Employee, Foo, Member, Org, Project, Quux, Qux, TreeNode } from './types.gen';
+export type { Bar, Baz, ClientOptions, Comment, Corge, Department, Employee, Foo, Member, Org, Project, Quux, Qux, TreeNode, Wrapper } from './types.gen';
diff --git a/packages/openapi-ts-tests/faker/v10/__snapshots__/3.0.x/faker-circular/types.gen.ts b/packages/openapi-ts-tests/faker/v10/__snapshots__/3.0.x/faker-circular/types.gen.ts
@@ -67,6 +67,11 @@ export type Project = {
     department?: Department;
 };
 
+export type Wrapper = {
+    label: string;
+    tree: TreeNode;
+};
+
 export type Comment = {
     id: string;
     text: string;
diff --git a/packages/openapi-ts-tests/faker/v10/__snapshots__/3.1.x/faker-circular/@faker-js/faker.gen.ts b/packages/openapi-ts-tests/faker/v10/__snapshots__/3.1.x/faker-circular/@faker-js/faker.gen.ts
@@ -2,7 +2,7 @@
 
 import { faker, type Faker } from '@faker-js/faker';
 
-import type { Comment, Department, Employee, Member, Org, Project, TreeNode } from '../types.gen';
+import type { Comment, Department, Employee, Member, Org, Pair, Project, TreeNode, Wrapper } from '../types.gen';
 
 export type Options = {
     faker?: Faker;
@@ -33,6 +33,18 @@ export const fakeTreeNode = (options: Options = {}, _callDepth = 0): TreeNode =>
     };
 };
 
+export const fakeWrapper = (options?: Options): Wrapper => {
+    const f = options?.faker ?? faker;
+    return {
+        label: f.string.sample(),
+        tree: fakeTreeNode(options)
+    };
+};
+
+export const fakePair = (options?: Options): Pair => ({
+    nodes: [fakeTreeNode(options), fakeTreeNode(options)]
+});
+
 export const fakeComment = (options: Options = {}, _callDepth = 0): Comment => {
     const f = options?.faker ?? faker;
     return {
diff --git a/packages/openapi-ts-tests/faker/v10/__snapshots__/3.1.x/faker-circular/index.ts b/packages/openapi-ts-tests/faker/v10/__snapshots__/3.1.x/faker-circular/index.ts
@@ -1,3 +1,3 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export type { ClientOptions, Comment, Department, Employee, Member, Org, Project, TreeNode } from './types.gen';
+export type { ClientOptions, Comment, Department, Employee, Member, Org, Pair, Project, TreeNode, Wrapper } from './types.gen';
diff --git a/packages/openapi-ts-tests/faker/v10/__snapshots__/3.1.x/faker-circular/types.gen.ts b/packages/openapi-ts-tests/faker/v10/__snapshots__/3.1.x/faker-circular/types.gen.ts
@@ -40,6 +40,18 @@ export type Project = {
     department?: Department;
 };
 
+export type Wrapper = {
+    label: string;
+    tree: TreeNode;
+};
+
+export type Pair = {
+    nodes: [
+        TreeNode,
+        TreeNode
+    ];
+};
+
 export type Comment = {
     id: string;
     text: string;
diff --git a/packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/mini/circular/zod.gen.ts b/packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/mini/circular/zod.gen.ts
@@ -8,6 +8,11 @@ export const zTreeNode = z.object({
     children: z.optional(z.array(z.lazy((): any => zTreeNode)))
 });
 
+export const zWrapper = z.object({
+    label: z.string(),
+    tree: zTreeNode
+});
+
 export const zComment = z.object({
     id: z.string(),
     text: z.string(),
diff --git a/packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/v3/circular/zod.gen.ts b/packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/v3/circular/zod.gen.ts
@@ -8,6 +8,11 @@ export const zTreeNode: z.AnyZodObject = z.object({
     children: z.array(z.lazy(() => zTreeNode)).optional()
 });
 
+export const zWrapper = z.object({
+    label: z.string(),
+    tree: zTreeNode
+});
+
 export const zComment: z.AnyZodObject = z.object({
     id: z.string(),
     text: z.string(),
diff --git a/packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/v4/circular/zod.gen.ts b/packages/openapi-ts-tests/zod/v3/__snapshots__/3.0.x/v4/circular/zod.gen.ts
@@ -8,6 +8,11 @@ export const zTreeNode = z.object({
     children: z.array(z.lazy((): any => zTreeNode)).optional()
 });
 
+export const zWrapper = z.object({
+    label: z.string(),
+    tree: zTreeNode
+});
+
 export const zComment = z.object({
     id: z.string(),
     text: z.string(),
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/mini/circular/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/mini/circular/zod.gen.ts
@@ -8,6 +8,11 @@ export const zTreeNode = z.object({
     children: z.optional(z.array(z.lazy((): any => zTreeNode)))
 });
 
+export const zWrapper = z.object({
+    label: z.string(),
+    tree: zTreeNode
+});
+
 export const zComment = z.object({
     id: z.string(),
     text: z.string(),
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v3/circular/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v3/circular/zod.gen.ts
@@ -8,6 +8,11 @@ export const zTreeNode: z.AnyZodObject = z.object({
     children: z.array(z.lazy(() => zTreeNode)).optional()
 });
 
+export const zWrapper = z.object({
+    label: z.string(),
+    tree: zTreeNode
+});
+
 export const zComment: z.AnyZodObject = z.object({
     id: z.string(),
     text: z.string(),
diff --git a/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v4/circular/zod.gen.ts b/packages/openapi-ts-tests/zod/v4/__snapshots__/3.0.x/v4/circular/zod.gen.ts
@@ -8,6 +8,11 @@ export const zTreeNode = z.object({
     children: z.array(z.lazy((): any => zTreeNode)).optional()
 });
 
+export const zWrapper = z.object({
+    label: z.string(),
+    tree: zTreeNode
+});
+
 export const zComment = z.object({
     id: z.string(),
     text: z.string(),
diff --git a/packages/openapi-ts/src/plugins/@faker-js/faker/v10/walker.ts b/packages/openapi-ts/src/plugins/@faker-js/faker/v10/walker.ts
@@ -206,7 +206,11 @@ export function createVisitor(
       };
 
       const refSymbol = ctx.plugin.referenceSymbol(query);
-      const isCircularRef = fakerCtx.circularPointers.has($ref);
+      // Only emit depth-aware call sites when the enclosing schema is itself
+      // circular — `_callDepth` is only declared as a parameter for circular
+      // schemas.  Non-circular schemas that reference a circular one just call
+      // it normally; the circular schema starts its own depth tracking from 0.
+      const isCircularRef = fakerCtx.isCircularSchema && fakerCtx.circularPointers.has($ref);
 
       return {
         expression: isCircularRef
@@ -229,15 +233,18 @@ export function createVisitor(
       const elements: Array<Expression> = [];
       let anyChildUsesFaker = false;
       let anyChildUsesAccessor = false;
+      let anyChildHasCircularRef = false;
       for (let i = 0; i < (schema.items?.length ?? 0); i++) {
         const item = schema.items![i]!;
         const result = walk(item, childContext(ctx, 'items', i));
         elements.push(result.expression);
         if (result.usesFaker) anyChildUsesFaker = true;
         if (result.usesAccessor) anyChildUsesAccessor = true;
+        if (result.hasCircularRef) anyChildHasCircularRef = true;
       }
       return {
         expression: $.array(...elements),
+        hasCircularRef: anyChildHasCircularRef,
         usesAccessor: anyChildUsesAccessor,
         usesFaker: anyChildUsesFaker,
       };
diff --git a/specs/3.0.x/circular.yaml b/specs/3.0.x/circular.yaml
@@ -133,6 +133,18 @@ components:
         - id
         - name
 
+    # Non-circular schema referencing a circular schema (feedback #2)
+    Wrapper:
+      type: object
+      properties:
+        label:
+          type: string
+        tree:
+          $ref: '#/components/schemas/TreeNode'
+      required:
+        - label
+        - tree
+
     # Nullable circular reference (required property, nullable type)
     Comment:
       type: object
diff --git a/specs/3.1.x/circular.yaml b/specs/3.1.x/circular.yaml
@@ -94,6 +94,32 @@ components:
         - id
         - name
 
+    # Non-circular schema referencing a circular schema (feedback #2)
+    Wrapper:
+      type: object
+      properties:
+        label:
+          type: string
+        tree:
+          $ref: '#/components/schemas/TreeNode'
+      required:
+        - label
+        - tree
+
+    # Tuple containing a $ref to a circular schema (feedback #3)
+    Pair:
+      type: object
+      properties:
+        nodes:
+          type: array
+          prefixItems:
+            - $ref: '#/components/schemas/TreeNode'
+            - $ref: '#/components/schemas/TreeNode'
+          minItems: 2
+          maxItems: 2
+      required:
+        - nodes
+
     # Nullable circular reference (required property, nullable type)
     Comment:
       type: object

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`// This file is auto-generated by @hey-api/openapi-ts`
`2`	`2`
`3`		`-export type { Bar, Baz, ClientOptions, Comment, Corge, Department, Employee, Foo, Member, Org, Project, Quux, Qux, TreeNode } from './types.gen';`
	`3`	`+export type { Bar, Baz, ClientOptions, Comment, Corge, Department, Employee, Foo, Member, Org, Project, Quux, Qux, TreeNode, Wrapper } from './types.gen';`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`// This file is auto-generated by @hey-api/openapi-ts`
`2`	`2`
`3`		`-export type { ClientOptions, Comment, Department, Employee, Member, Org, Project, TreeNode } from './types.gen';`
	`3`	`+export type { ClientOptions, Comment, Department, Employee, Member, Org, Pair, Project, TreeNode, Wrapper } from './types.gen';`