fix: Support uniqueItems in Zod

kubb-labs · Jan 22, 2025 · ce201f0 · ce201f0
1 parent c291bbf
commit ce201f0
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 5 deletions.
diff --git a/.changeset/silver-colts-admire.md b/.changeset/silver-colts-admire.md
@@ -0,0 +1,5 @@
+---
+"@kubb/plugin-zod": patch
+---
+
+Support uniqueItems in Zod
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -4,6 +4,9 @@ title: Changelog
 
 # Changelog
 
+## 3.5.4
+- [`plugin-zod`](/plugins/plugin-zod): Support uniqueItems in Zod
+
 ## 3.5.3
 - [`plugin-client`](/plugins/plugin-client): allow exporting custom client fetch function and use generated fetch when `pluginClient` is available
 - [`plugin-react-query`](/plugins/plugin-react-query/): allow exporting custom client fetch function and use generated fetch when `pluginClient` is available

diff --git a/examples/advanced/petStore.yaml b/examples/advanced/petStore.yaml
@@ -207,6 +207,7 @@ paths:
             application/json:
               schema:
                 type: array
+                uniqueItems: true
                 minItems: 1
                 maxItems: 3
                 items:

diff --git a/examples/advanced/src/gen/docs.html b/examples/advanced/src/gen/docs.html
diff --git a/examples/advanced/src/gen/zod/petController/findPetsByStatusSchema.ts b/examples/advanced/src/gen/zod/petController/findPetsByStatusSchema.ts
@@ -20,7 +20,8 @@ export type FindPetsByStatusPathParamsSchema = FindPetsByStatusPathParams
 export const findPetsByStatus200Schema = z
   .array(z.lazy(() => petSchema))
   .min(1)
-  .max(3) as unknown as ToZod<FindPetsByStatus200>
+  .max(3)
+  .refine((items) => new Set(items).size === items.length, { message: 'Array entries must be unique' }) as unknown as ToZod<FindPetsByStatus200>
 
 export type FindPetsByStatus200Schema = FindPetsByStatus200
 

diff --git a/packages/plugin-oas/src/SchemaGenerator.ts b/packages/plugin-oas/src/SchemaGenerator.ts
@@ -857,6 +857,7 @@ export class SchemaGenerator<
       const min = schema.minimum ?? schema.minLength ?? schema.minItems ?? undefined
       const max = schema.maximum ?? schema.maxLength ?? schema.maxItems ?? undefined
       const items = this.parse({ schema: 'items' in schema ? (schema.items as SchemaObject) : [], name, parentName })
+      const unique = !!schema.uniqueItems
 
       return [
         {
@@ -865,6 +866,7 @@ export class SchemaGenerator<
             items,
             min,
             max,
+            unique,
           },
         },
         ...baseItems.filter((item) => item.keyword !== schemaKeywords.min && item.keyword !== schemaKeywords.max),

diff --git a/packages/plugin-oas/src/SchemaMapper.ts b/packages/plugin-oas/src/SchemaMapper.ts
@@ -25,7 +25,7 @@ export type SchemaKeywordMapper = {
   tuple: { keyword: 'tuple'; args: { items: Schema[]; min?: number; max?: number } }
   array: {
     keyword: 'array'
-    args: { items: Schema[]; min?: number; max?: number }
+    args: { items: Schema[]; min?: number; max?: number; unique?: boolean }
   }
   enum: {
     keyword: 'enum'

diff --git a/packages/plugin-oas/src/__snapshots__/SchemaGenerator.test.ts.snap b/packages/plugin-oas/src/__snapshots__/SchemaGenerator.test.ts.snap
@@ -339,6 +339,7 @@ exports[`SchemaGenerator core > 'Pets' 1`] = `
       ],
       "max": undefined,
       "min": undefined,
+      "unique": false,
     },
     "keyword": "array",
   },

diff --git a/packages/plugin-zod/src/parser.ts b/packages/plugin-zod/src/parser.ts
@@ -35,8 +35,13 @@ const zodKeywordMapper = {
   nullable: () => '.nullable()',
   null: () => 'z.null()',
   nullish: () => '.nullish()',
-  array: (items: string[] = [], min?: number, max?: number) => {
-    return [`z.array(${items?.join('')})`, min !== undefined ? `.min(${min})` : undefined, max !== undefined ? `.max(${max})` : undefined]
+  array: (items: string[] = [], min?: number, max?: number, unique?: boolean) => {
+    return [
+      `z.array(${items?.join('')})`,
+      min !== undefined ? `.min(${min})` : undefined,
+      max !== undefined ? `.max(${max})` : undefined,
+      unique ? `.refine(items => new Set(items).size === items.length, { message: "Array entries must be unique" })` : undefined,
+    ]
       .filter(Boolean)
       .join('')
   },
@@ -226,6 +231,7 @@ export function parse({ parent, current, siblings }: SchemaTree, options: Parser
         .filter(Boolean),
       current.args.min,
       current.args.max,
+      current.args.unique,
     )
   }