Merge pull request #174 from asteasolutions/task/#173-add-support-for…

…-readonly

#173 Added support for ZodReadonly

README.md

@@ -509,6 +509,7 @@ The list of all supported types as of now is:
   - including `.catchall` resulting in the respective `additionalProperties` schema
 - `ZodOptional`
 - `ZodPipeline`
+- `ZodReadonly`
 - `ZodRecord`
 - `ZodString`
   - adding `format` for `.datetime()`, `.uuid()`, `.email()` and `.url()` and `pattern` for `.regex()` is also supported
@@ -528,7 +529,7 @@ You can still register such schemas on your own by providing a `type` via the `.
 
 1. `z.nullable(schema)` [does not generate a $ref for underlying registered schemas](https://github.com/asteasolutions/zod-to-openapi/issues/141).
   - This is an implementation limitation.
-  - However you can simply use `schema.nullable()` which has the exact same effect `zod` wise but it is also fully supported on our end. 
+  - However you can simply use `schema.nullable()` which has the exact same effect `zod` wise but it is also fully supported on our end.
 
 ## Technologies
 

package.json

@@ -43,7 +43,7 @@
     "ts-jest": "^29.0.3",
     "typescript": "^5.2.2",
     "yaml": "^2.2.2",
-    "zod": "^3.20.2"
+    "zod": "^3.22.0"
   },
   "author": "Astea Solutions <info@asteasolutions.com>",
   "license": "MIT"

spec/modifiers/readonly.spec.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+import { expectSchema } from '../lib/helpers';
+
+describe('readonly', () => {
+  it('supports readonly', () => {
+    expectSchema([z.string().readonly().openapi('ReadonlyString')], {
+      ReadonlyString: {
+        type: 'string',
+      },
+    });
+  });
+});

src/lib/zod-is-type.ts

@@ -18,6 +18,7 @@ type ZodTypes = {
   ZodObject: z.AnyZodObject;
   ZodOptional: z.ZodOptional<any>;
   ZodPipeline: z.ZodPipeline<any, any>;
+  ZodReadonly: z.ZodReadonly<any>;
   ZodRecord: z.ZodRecord;
   ZodSchema: z.ZodSchema;
   ZodString: z.ZodString;

src/openapi-generator.ts

@@ -1188,7 +1188,7 @@ export class OpenAPIGenerator {
       return this.unwrapChained(schema.unwrap());
     }
 
-    if (isZodType(schema, 'ZodDefault')) {
+    if (isZodType(schema, 'ZodDefault') || isZodType(schema, 'ZodReadonly')) {
       return this.unwrapChained(schema._def.innerType);
     }