Implementing unref() helper (#2581)

RobinTail · web-flow · commit ab4ec0dd9da9 · 2025-04-26T08:17:22.000+02:00
colinhacks/zod#4275 Extracting that into a helper.
diff --git a/express-zod-api/src/documentation-helpers.ts b/express-zod-api/src/documentation-helpers.ts
@@ -167,7 +167,7 @@ const intersect = (
   children: Array<JSONSchema.BaseSchema>,
 ): JSONSchema.ObjectSchema => {
   const [left, right] = children
-    .map(({ _ref, ...rest }) => (_ref ? { ...rest, ..._ref } : rest))
+    .map(unref)
     .filter(
       (schema): schema is JSONSchema.ObjectSchema => schema.type === "object",
     )
@@ -204,7 +204,8 @@ const isSupportedType = (subject: string): subject is SchemaObjectType =>
 export const onDateIn: Overrider = ({ jsonSchema }, ctx) => {
   if (ctx.isResponse)
     throw new DocumentationError("Please use ez.dateOut() for output.", ctx);
-  delete jsonSchema._ref; // undo default
+  unref(jsonSchema);
+  delete jsonSchema.anyOf; // undo default
   Object.assign(jsonSchema, {
     description: "YYYY-MM-DDTHH:mm:ss.sssZ",
     type: "string",
@@ -295,13 +296,14 @@ export const onPipeline: Overrider = ({ zodSchema, jsonSchema }, ctx) => {
 };
 
 export const onRaw: Overrider = ({ jsonSchema }) => {
-  if (!jsonSchema._ref) return;
-  if (jsonSchema._ref.type !== "object") return;
-  const objSchema = jsonSchema._ref as JSONSchema.ObjectSchema;
+  unref(jsonSchema);
+  if (jsonSchema.type !== "object") return;
+  const objSchema = jsonSchema as JSONSchema.ObjectSchema;
   if (!objSchema.properties) return;
   if (!("raw" in objSchema.properties)) return;
-  delete jsonSchema._ref; // undo
   Object.assign(jsonSchema, objSchema.properties.raw);
+  delete jsonSchema.properties; // undo default
+  delete jsonSchema.required;
 };
 
 const enumerateExamples = (examples: unknown[]): ExamplesObject | undefined =>
@@ -476,6 +478,18 @@ const fixReferences = (
   return subject as SchemaObject; // @todo ideally, there should be a method to ensure that
 };
 
+/** @link https://github.com/colinhacks/zod/issues/4275 */
+const unref = (
+  subject: JSONSchema.BaseSchema,
+): Omit<JSONSchema.BaseSchema, "_ref"> => {
+  while (subject._ref) {
+    const copy = { ...subject._ref };
+    delete subject._ref;
+    Object.assign(subject, copy);
+  }
+  return subject;
+};
+
 const depict = (
   subject: $ZodType,
   { ctx, rules = overrides }: { ctx: OpenAPIContext; rules?: BrandHandling },
diff --git a/express-zod-api/tests/documentation-helpers.spec.ts b/express-zod-api/tests/documentation-helpers.spec.ts
@@ -135,10 +135,8 @@ describe("Documentation helpers", () => {
   describe("onRaw()", () => {
     test("should extract the raw property", () => {
       const jsonSchema: JSONSchema.BaseSchema = {
-        _ref: {
-          type: "object",
-          properties: { raw: { format: "binary", type: "string" } },
-        },
+        type: "object",
+        properties: { raw: { format: "binary", type: "string" } },
       };
       onRaw({ zodSchema: z.never(), jsonSchema }, requestCtx);
       expect(jsonSchema).toMatchSnapshot();
@@ -496,7 +494,7 @@ describe("Documentation helpers", () => {
 
   describe("onDateIn", () => {
     test("should set type:string, pattern and format", () => {
-      const jsonSchema: JSONSchema.BaseSchema = { _ref: { anyOf: [] } };
+      const jsonSchema: JSONSchema.BaseSchema = { anyOf: [] };
       onDateIn({ zodSchema: z.never(), jsonSchema }, requestCtx);
       expect(jsonSchema).toMatchSnapshot();
     });
