fix: readonly support for Zod and TypeScript

examples/advanced/petStore.yaml

@@ -831,9 +831,11 @@ components:
           type: integer
           format: int64
           example: 10
+          readOnly: true
         name:
           type: string
           example: doggie
+          writeOnly: true
         category:
           $ref: "#/components/schemas/Category"
         photoUrls:

examples/advanced/src/gen/models/ts/Pet.ts

@@ -12,7 +12,7 @@ export type Pet = {
    * @type integer | undefined int64
    * @example 10
    */
-  id?: number
+  readonly id?: number
   /**
    * @type string
    * @example doggie

examples/advanced/src/gen/zod/petSchema.ts

@@ -4,7 +4,7 @@ import { categorySchema } from './categorySchema'
 import { tagSchema } from './tagSchema'
 
 export const petSchema = z.object({
-  id: z.number().optional(),
+  id: z.number().readonly().optional(),
   name: z.string(),
   category: z.lazy(() => categorySchema).optional(),
   photoUrls: z.array(z.string()),

packages/parser/src/codegen.ts

@@ -112,17 +112,24 @@ export function createUnionDeclaration({ nodes, withParentheses }: { nodes: Arra
 }
 
 export function createPropertySignature({
-  modifiers,
+  readOnly,
+  modifiers = [],
   name,
   questionToken,
   type,
 }: {
+  readOnly?: boolean
   modifiers?: Array<ts.Modifier>
   name: ts.PropertyName | string
   questionToken?: ts.QuestionToken | boolean
   type?: ts.TypeNode
 }) {
-  return factory.createPropertySignature(modifiers, propertyName(name), createQuestionToken(questionToken), type)
+  return factory.createPropertySignature(
+    [...modifiers, readOnly ? factory.createToken(ts.SyntaxKind.ReadonlyKeyword) : undefined].filter(Boolean) as Array<ts.Modifier>,
+    propertyName(name),
+    createQuestionToken(questionToken),
+    type,
+  )
 }
 
 export function createParameterSignature(

packages/swagger-ts/src/generators/TypeGenerator.ts

@@ -141,6 +141,7 @@ export class TypeGenerator extends SchemaGenerator<Options, OpenAPIV3.SchemaObje
         questionToken: ['questionToken', 'questionTokenAndUndefined'].includes(optionalType) && !isRequired,
         name,
         type: type as ts.TypeNode,
+        readOnly: schema.readOnly,
       })
       if (this.options.withJSDocs) {
         return appendJSDocToNode({

packages/swagger-zod/src/generators/ZodGenerator.ts

@@ -119,6 +119,10 @@ export class ZodGenerator extends SchemaGenerator<Options, OpenAPIV3.SchemaObjec
           validationFunctions.push({ keyword: zodKeywords.uuid })
         }
 
+        if (schema.readOnly) {
+          validationFunctions.push({ keyword: zodKeywords.readOnly })
+        }
+
         if (schema.default !== undefined && !Array.isArray(schema.default)) {
           if (typeof schema.default === 'string') {
             validationFunctions.push({ keyword: zodKeywords.default, args: `'${schema.default}'` })

packages/swagger-zod/src/parsers/zodParser.ts

@@ -26,6 +26,7 @@ export const zodKeywords = {
   max: 'max',
   optional: 'optional',
   catchall: 'catchall',
+  readOnly: 'readOnly',
 
   // custom ones
   ref: 'ref',
@@ -62,6 +63,7 @@ export const zodKeywordMapper: Record<ZodKeyword, string> = {
   max: '.max',
   optional: '.optional',
   catchall: '.catchall',
+  readOnly: '.readonly',
 
   // custom ones
   ref: 'ref',
@@ -119,6 +121,7 @@ type ZodMetaEmail = { keyword: typeof zodKeywords.email }
 type ZodMetaUuid = { keyword: typeof zodKeywords.uuid }
 
 type ZodMetaUrl = { keyword: typeof zodKeywords.url }
+type ZodMetaReadOnly = { keyword: typeof zodKeywords.readOnly }
 
 export type ZodMeta =
   | ZodMetaAny
@@ -149,6 +152,7 @@ export type ZodMeta =
   | ZodMetaUuid
   | ZodMetaLiteral
   | ZodMetaUrl
+  | ZodMetaReadOnly
 
 /**
  *