feat: set additionalProperties to false if strict

anatine · Jan 10, 2023 · 80c7012 · 80c7012
1 parent e21f365
commit 80c7012
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 4 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/zod-openapi/src/lib/zod-openapi.spec.ts b/packages/zod-openapi/src/lib/zod-openapi.spec.ts
@@ -391,6 +391,31 @@ describe('zodOpenapi', () => {
     });
   });
 
+  it('should support `strict` on an object schema', () => {
+    const zodSchema = extendApi(
+      z
+        .object({
+          aString: z.string(),
+          aNumber: z.number(),
+        })
+        .strict(),
+      {
+        description: "Super strict",
+      }
+    );
+    const apiSchema = generateSchema(zodSchema);
+    expect(apiSchema).toEqual({
+      type: 'object',
+      required: ['aString', 'aNumber'],
+      properties: {
+        aString: { type: 'string' },
+        aNumber: { type: 'number' },
+      },
+      additionalProperties: false,
+      description: "Super strict",
+    });
+  });
+
   it('Testing large mixed schema', () => {
     enum Fruits {
       Apple,

diff --git a/packages/zod-openapi/src/lib/zod-openapi.ts b/packages/zod-openapi/src/lib/zod-openapi.ts
@@ -184,9 +184,11 @@ function parseObject({
     additionalProperties = generateSchema(zodRef._def.catchall, useOutput);
   else if (zodRef._def.unknownKeys === 'passthrough')
     additionalProperties = true;
+  else if (zodRef._def.unknownKeys === 'strict')
+    additionalProperties = false;
 
   // So that `undefined` values don't end up in the schema and be weird
-  additionalProperties = additionalProperties ? { additionalProperties } : {};
+  additionalProperties = additionalProperties != null ? { additionalProperties } : {};
 
   return merge(
     {