feat: generate zod.literal when schema has const value (orval-labs#2199)

Author: lukemorales

packages/zod/src/index.ts

@@ -68,7 +68,7 @@ const possibleSchemaTypes = [
   'array',
 ];
 
-const resolveZodType = (schema: SchemaObject) => {
+const resolveZodType = (schema: SchemaObject | SchemaObject31) => {
   const schemaTypeValue = schema.type;
   const type = Array.isArray(schemaTypeValue)
     ? schemaTypeValue.find((t) => possibleSchemaTypes.includes(t))
@@ -128,7 +128,7 @@ type DateTimeOptions = {
 };
 
 export const generateZodValidationSchemaDefinition = (
-  schema: SchemaObject | undefined,
+  schema: SchemaObject | SchemaObject31 | undefined,
   context: ContextSpecs,
   name: string,
   strict: boolean,
@@ -156,7 +156,7 @@ export const generateZodValidationSchemaDefinition = (
   const type = resolveZodType(schema);
   const required = rules?.required ?? false;
   const nullable =
-    schema.nullable ??
+    ('nullable' in schema && schema.nullable) ||
     (Array.isArray(schema.type) && schema.type.includes('null'));
   const min = schema.minimum ?? schema.minLength ?? schema.minItems;
   const max = schema.maximum ?? schema.maxLength ?? schema.maxItems;
@@ -299,11 +299,19 @@ export const generateZodValidationSchemaDefinition = (
 
       if (isZodV4) {
         if (!schema.format) {
-          functions.push([type as string, undefined]);
+          if ('const' in schema) {
+            functions.push(['literal', `"${schema.const}"`]);
+          } else {
+            functions.push([type as string, undefined]);
+          }
           break;
         }
       } else {
-        functions.push([type as string, undefined]);
+        if ('const' in schema) {
+          functions.push(['literal', `"${schema.const}"`]);
+        } else {
+          functions.push([type as string, undefined]);
+        }
       }
 
       if (schema.format === 'date') {

packages/zod/src/zod.test.ts

@@ -8,7 +8,7 @@ import {
   type ZodValidationSchemaDefinition,
 } from '.';
 
-import { ContextSpecs, GeneratorOptions } from '@orval/core';
+import { ContextSpecs } from '@orval/core';
 
 const queryParams: ZodValidationSchemaDefinition = {
   functions: [
@@ -1453,3 +1453,95 @@ describe('generateZodWithEdgeCases', () => {
     );
   });
 });
+
+const schemaWithLiteralProperty = {
+  pathRoute: '/cats',
+  context: {
+    specKey: 'cat',
+    specs: {
+      cat: {
+        openapi: '3.0.0',
+        info: {
+          version: '1.0.0',
+          title: 'Cats',
+        },
+        paths: {
+          '/cats': {
+            post: {
+              operationId: 'xyz',
+              requestBody: {
+                required: true,
+                content: {
+                  'application/json': {
+                    schema: {
+                      type: 'object',
+                      properties: {
+                        type: {
+                          type: 'string',
+                          const: 'WILD',
+                        },
+                      },
+                    },
+                  },
+                },
+              },
+              responses: {
+                '200': {},
+              },
+            },
+          },
+        },
+      },
+    },
+    output: {
+      override: {
+        zod: {
+          generateEachHttpStatus: false,
+        },
+      },
+    },
+  },
+};
+
+describe('generateZodWithLiteralProperty', () => {
+  it('correctly handles literal as a property name', async () => {
+    const result = await generateZod(
+      {
+        pathRoute: '/cats',
+        verb: 'post',
+        operationName: 'test',
+        override: {
+          zod: {
+            strict: {
+              param: false,
+              body: false,
+              response: false,
+              query: false,
+              header: false,
+            },
+            generate: {
+              param: false,
+              body: true,
+              response: true,
+              query: false,
+              header: false,
+            },
+            coerce: {
+              param: false,
+              body: false,
+              response: false,
+              query: false,
+              header: false,
+            },
+          },
+        },
+      },
+      schemaWithLiteralProperty,
+      {},
+    );
+
+    expect(result.implementation).toBe(
+      'export const testBody = zod.object({\n  "type": zod.literal("WILD").optional()\n})\n\n',
+    );
+  });
+});

tests/specifications/example-v3-1.yaml

@@ -28,6 +28,9 @@ components:
           title: Example tuple
         example_const:
           const: this_is_a_const
+        example_string_const:
+          type: string
+          const: this_is_a_string_const
         example_enum:
           type: string
           enum:

tests/specifications/typed-arrays-tuples-v3-1.yaml

@@ -51,6 +51,9 @@ components:
           type: array
         example_const:
           const: this_is_a_const
+        example_string_const:
+          type: string
+          const: this_is_a_string_const
         example_enum:
           type: string
           enum: