bump zod to 3.22 and add support for ZodReadonly

anatine · Dec 13, 2023 · f143c27 · f143c27
1 parent cbea74d
commit f143c27
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 12 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -77,10 +77,9 @@
     "tslib": "^2.6.0",
     "typescript": "5.1.6",
     "validator": "^13.9.0",
-    "zod": "^3.21.4"
+    "zod": "^3.22.4"
   },
   "workspaces": [
     "packages/**"
   ]
 }
-
diff --git a/packages/zod-openapi/src/lib/zod-openapi.spec.ts b/packages/zod-openapi/src/lib/zod-openapi.spec.ts
@@ -961,4 +961,35 @@ describe('zodOpenapi', () => {
       maximum: 10,
     } satisfies SchemaObject);
   });
+  test('should work with ZodReadonly', () => {
+    expect(generateSchema(z.object({ field: z.string() })))
+      .toMatchInlineSnapshot(`
+      Object {
+        "properties": Object {
+          "field": Object {
+            "type": "string",
+          },
+        },
+        "required": Array [
+          "field",
+        ],
+        "type": "object",
+      }
+    `);
+
+    expect(generateSchema(z.object({ field: z.string() }).readonly()))
+      .toMatchInlineSnapshot(`
+      Object {
+        "properties": Object {
+          "field": Object {
+            "type": "string",
+          },
+        },
+        "required": Array [
+          "field",
+        ],
+        "type": "object",
+      }
+    `);
+  });
 });
diff --git a/packages/zod-openapi/src/lib/zod-openapi.ts b/packages/zod-openapi/src/lib/zod-openapi.ts
@@ -521,6 +521,18 @@ function parsePipeline({
   return generateSchema(zodRef._def.in, useOutput);
 }
 
+function parseReadonly({
+  zodRef,
+  useOutput,
+  schemas,
+}: ParsingArgs<z.ZodReadonly<z.ZodAny>>): SchemaObject {
+  return merge(
+    generateSchema(zodRef._def.innerType, useOutput),
+    zodRef.description ? { description: zodRef.description } : {},
+    ...schemas
+  );
+}
+
 const workerMap = {
   ZodObject: parseObject,
   ZodRecord: parseRecord,
@@ -556,6 +568,7 @@ const workerMap = {
   ZodUnknown: catchAllParser,
   ZodVoid: catchAllParser,
   ZodPipeline: parsePipeline,
+  ZodReadonly: parseReadonly,
 };
 type WorkerKeys = keyof typeof workerMap;