feat(zod): add useBrandedTypes option to append .brand() to generated schemas

docs/content/docs/reference/configuration/output.mdx

@@ -817,6 +817,7 @@ export default defineConfig({
             header: true,
           },
           generateEachHttpStatus: true,
+          useBrandedTypes: true,
         },
       },
     },
@@ -854,6 +855,14 @@ Add preprocess functions to schemas.
 
 Configure Zod datetime/time validation options.
 
+### useBrandedTypes
+
+**Type:** `boolean`
+
+**Default:** `false`
+
+Append [`.brand()`](https://zod.dev/api?id=branded-types) to generated Zod schemas using the schema name as the brand identifier. For array request/response bodies, only the top-level array wrapper schema is branded — the exported `*Item` helper schema is not branded.
+
 ---
 
 ## override.angular

packages/angular/src/http-client.test.ts

@@ -93,6 +93,7 @@ const createOutput = (
           response: false,
         },
         generateEachHttpStatus: false,
+        useBrandedTypes: false,
         dateTimeOptions: {},
         timeOptions: {},
       },

packages/angular/src/http-resource.test.ts

@@ -103,6 +103,7 @@ const createOutput = (
           response: false,
         },
         generateEachHttpStatus: false,
+        useBrandedTypes: false,
         dateTimeOptions: {},
         timeOptions: {},
       },

packages/core/src/test-utils/context.ts

@@ -112,6 +112,7 @@ export function createTestContextSpec({
           response: false,
         },
         generateEachHttpStatus: false,
+        useBrandedTypes: false,
         dateTimeOptions: {},
         timeOptions: { precision: 3 },
       },

packages/core/src/types.ts

@@ -606,6 +606,7 @@ export interface ZodOptions {
   dateTimeOptions?: ZodDateTimeOptions;
   timeOptions?: ZodTimeOptions;
   generateEachHttpStatus?: boolean;
+  useBrandedTypes?: boolean;
 }
 
 export type ZodCoerceType = 'string' | 'number' | 'boolean' | 'bigint' | 'date';
@@ -640,6 +641,7 @@ export interface NormalizedZodOptions {
     response?: NormalizedMutator;
   };
   generateEachHttpStatus: boolean;
+  useBrandedTypes: boolean;
   dateTimeOptions: ZodDateTimeOptions;
   timeOptions: ZodTimeOptions;
 }

packages/mock/src/faker/getters/combine.test.ts

@@ -107,6 +107,7 @@ function createMockContext(): ContextSpec {
             response: false,
           },
           generateEachHttpStatus: false,
+          useBrandedTypes: false,
           dateTimeOptions: {},
           timeOptions: { precision: 3 },
         },

packages/orval/src/utils/options.ts

@@ -385,6 +385,8 @@ export async function normalizeOptions(
           },
           generateEachHttpStatus:
             outputOptions.override?.zod?.generateEachHttpStatus ?? false,
+          useBrandedTypes:
+            outputOptions.override?.zod?.useBrandedTypes ?? false,
           dateTimeOptions: outputOptions.override?.zod?.dateTimeOptions ?? {},
           timeOptions: outputOptions.override?.zod?.timeOptions ?? {},
         },
@@ -706,6 +708,7 @@ function normalizeOperationsAndTags(
                         : {}),
                     },
                     generateEachHttpStatus: zod.generateEachHttpStatus ?? false,
+                    useBrandedTypes: zod.useBrandedTypes ?? false,
                     dateTimeOptions: zod.dateTimeOptions ?? {},
                     timeOptions: zod.timeOptions ?? {},
                   },

packages/solid-start/src/index.test.ts

@@ -112,6 +112,7 @@ function makeOutput(useDates = false): ContextSpec['output'] {
           response: false,
         },
         generateEachHttpStatus: false,
+        useBrandedTypes: false,
         dateTimeOptions: {},
         timeOptions: { precision: 3 },
       },

packages/zod/src/index.ts

@@ -1733,21 +1733,33 @@ const generateZodRoute = async (
 
   const pascalOperationName = pascal(operationName);
 
+  const useBrandedTypes = override.zod.useBrandedTypes;
+  const brand = (name: string) =>
+    useBrandedTypes
+      ? isZodV4
+        ? `.brand("${name}")`
+        : `.brand<"${name}">()`
+      : '';
+
   return {
     implementation: [
       ...(inputParams.consts ? [inputParams.consts] : []),
       ...(inputParams.zod
-        ? [`export const ${pascalOperationName}Params = ${inputParams.zod}`]
+        ? [
+            `export const ${pascalOperationName}Params = ${inputParams.zod}${brand(`${pascalOperationName}Params`)}`,
+          ]
         : []),
       ...(inputQueryParams.consts ? [inputQueryParams.consts] : []),
       ...(inputQueryParams.zod
         ? [
-            `export const ${pascalOperationName}QueryParams = ${inputQueryParams.zod}`,
+            `export const ${pascalOperationName}QueryParams = ${inputQueryParams.zod}${brand(`${pascalOperationName}QueryParams`)}`,
           ]
         : []),
       ...(inputHeaders.consts ? [inputHeaders.consts] : []),
       ...(inputHeaders.zod
-        ? [`export const ${pascalOperationName}Header = ${inputHeaders.zod}`]
+        ? [
+            `export const ${pascalOperationName}Header = ${inputHeaders.zod}${brand(`${pascalOperationName}Header`)}`,
+          ]
         : []),
       ...(inputBody.consts ? [inputBody.consts] : []),
       ...(inputBody.zod
@@ -1758,8 +1770,8 @@ export const ${pascalOperationName}Body = zod.array(${pascalOperationName}BodyIt
                   parsedBody.rules?.min ? `.min(${parsedBody.rules.min})` : ''
                 }${
                   parsedBody.rules?.max ? `.max(${parsedBody.rules.max})` : ''
-                }`
-              : `export const ${pascalOperationName}Body = ${inputBody.zod}`,
+                }${brand(`${pascalOperationName}Body`)}`
+              : `export const ${pascalOperationName}Body = ${inputBody.zod}${brand(`${pascalOperationName}Body`)}`,
           ]
         : []),
       ...inputResponses.flatMap((inputResponse, index) => {
@@ -1782,8 +1794,8 @@ export const ${operationResponse} = zod.array(${operationResponse}Item)${
                       parsedResponses[index].rules?.max
                         ? `.max(${parsedResponses[index].rules.max})`
                         : ''
-                    }`
-                  : `export const ${operationResponse} = ${inputResponse.zod}`,
+                    }${brand(operationResponse)}`
+                  : `export const ${operationResponse} = ${inputResponse.zod}${brand(operationResponse)}`,
               ]
             : []),
         ];