Error using recursion in lazy function

[pincman]

code

const baseCollectionSchema = z.object({
    id: z.string(),
    name: z.string(),
    slug: z.string().or(z.null()),
    path: z.string(),
    depth: z.number(),
    numchild: z.number(),
});

type Collection = z.infer<typeof baseCollectionSchema> & {
    children?: Collection[];
};

const collectionSchema: z.ZodType<Collection> = baseCollectionSchema
    .extend({
        children: z
            .lazy(() => z.array(collectionSchema))
            .optional()
            .openapi({
                type: 'array',
                items: {
                    $ref: '#/components/schemas/Collection',
                },
            }),
    })
    .openapi({ ref: 'Collection' });

error

Error: The schema at createSchema > array items > property: children > optional > lazy schema > array items needs to be registered because it's circularly referenced
    at Array.reduce (<anonymous>)
    at <unknown> (src/server/auth/utils.ts:30:10)
  28 |         handler(c.req.raw as any, (c.res as any).raw, resolve as any);
  29 |     });
> 30 |     await next();
     |          ^
  31 | };

[samchungy]

G'day. I tried to reproduce this but couldn't quite do it:

import { z } from "zod";
import { createSchema } from "zod-openapi";
import "zod-openapi/extend";

const baseCollectionSchema = z.object({
  id: z.string(),
  name: z.string(),
  slug: z.string().or(z.null()),
  path: z.string(),
  depth: z.number(),
  numchild: z.number(),
});

type Collection = z.infer<typeof baseCollectionSchema> & {
  children?: Collection[];
};

const collectionSchema: z.ZodType<Collection> = baseCollectionSchema
  .extend({
    children: z.lazy(() => z.array(collectionSchema)).optional(),
  })
  .openapi({ ref: "Collection" });

console.log(JSON.stringify(createSchema(collectionSchema), null, 2));

{
  "schema": {
    "$ref": "#/components/schemas/Collection"
  },
  "components": {
    "Collection": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "slug": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "path": {
          "type": "string"
        },
        "depth": {
          "type": "number"
        },
        "numchild": {
          "type": "number"
        },
        "children": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/Collection"
          }
        }
      },
      "required": [
        "id",
        "name",
        "slug",
        "path",
        "depth",
        "numchild"
      ]
    }
  }
}

[samchungy]

What versions are you running?

https://codesandbox.io/p/sandbox/typescript-playground-export-forked-l5v9q9?file=%2Findex.ts%3A1%2C1-25%2C1

[pincman]

I run the module in hono and use the latest version

[samchungy]

Strange, could you provide a reproduction? As you can see, I can't seem to replicate the behaviour

[samchungy]

Lazy is now natively supported as of v5