fix(zui): json-schemas should be strict by default (#600)

Author: franklevasseur

zui/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpinternal/zui",
-  "version": "0.22.5",
+  "version": "0.22.6",
   "description": "A fork of Zod with additional features",
   "type": "module",
   "source": "./src/index.ts",

zui/src/transforms/transform-pipeline.test.ts

@@ -368,11 +368,11 @@ describe.concurrent('transformPipeline', () => {
     assert(srcSchema).toTransformBackToItself()
   })
   it('should map ZodObject to itself', async () => {
-    const srcSchema = z.object({ foo: z.string() })
+    const srcSchema = z.object({ foo: z.string() }).strict()
     assert(srcSchema).toTransformBackToItself()
   })
   it('should map empty ZodObject to itself', async () => {
-    const srcSchema = z.object({})
+    const srcSchema = z.object({}).strict()
     assert(srcSchema).toTransformBackToItself()
   })
   it('should map ZodUnion to itself', async () => {

zui/src/transforms/zui-to-json-schema-next/index.test.ts

@@ -71,6 +71,7 @@ describe('zuiToJsonSchemaNext', () => {
       type: 'object',
       properties: { name: { type: 'string' } },
       required: ['name'],
+      additionalProperties: false,
     })
   })
 
@@ -94,6 +95,7 @@ describe('zuiToJsonSchemaNext', () => {
         email: { type: 'string', readOnly: true },
       },
       required: ['name'],
+      additionalProperties: false,
     })
   })
 
@@ -156,6 +158,7 @@ describe('zuiToJsonSchemaNext', () => {
         },
       },
       required: ['tableIdOrName'],
+      additionalProperties: false,
     })
   })
 
@@ -179,11 +182,13 @@ describe('zuiToJsonSchemaNext', () => {
           type: 'object',
           properties: { type: { type: 'string', const: 'A' }, a: { type: 'string' } },
           required: ['type', 'a'],
+          additionalProperties: false,
         },
         {
           type: 'object',
           properties: { type: { type: 'string', const: 'B' }, b: { type: 'number' } },
           required: ['type', 'b'],
+          additionalProperties: false,
         },
       ],
     })
@@ -207,6 +212,30 @@ describe('zuiToJsonSchemaNext', () => {
     })
   })
 
+  test('should map ZodIntersection of strict schemas to IntersectionSchema removing additional properties', () => {
+    const schema = toJsonSchema(
+      z.intersection(
+        z.object({ a: z.string() }).strict(), //
+        z.object({ b: z.number() }).strict(),
+      ),
+    )
+
+    expect(schema).toEqual({
+      allOf: [
+        {
+          type: 'object',
+          properties: { a: { type: 'string' } },
+          required: ['a'],
+        },
+        {
+          type: 'object',
+          properties: { b: { type: 'number' } },
+          required: ['b'],
+        },
+      ],
+    })
+  })
+
   test('should map ZodTuple to TupleSchema', () => {
     const schema = toJsonSchema(z.tuple([z.string(), z.number()]))
     expect(schema).toEqual({

zui/src/transforms/zui-to-json-schema-next/index.ts

@@ -84,13 +84,11 @@ export function toJsonSchema(schema: z.Schema): json.ZuiJsonSchema {
         .map(([key, value]) => [key, value.mandatory()] satisfies [string, z.ZodType])
         .map(([key, value]) => [key, toJsonSchema(value)] satisfies [string, json.ZuiJsonSchema])
 
-      let additionalProperties: json.ObjectSchema['additionalProperties'] = undefined
+      let additionalProperties: json.ObjectSchema['additionalProperties'] = false
       if (def.unknownKeys instanceof z.ZodType) {
         additionalProperties = toJsonSchema(def.unknownKeys)
       } else if (def.unknownKeys === 'passthrough') {
         additionalProperties = true
-      } else if (def.unknownKeys === 'strict') {
-        additionalProperties = false
       }
 
       return {
@@ -117,9 +115,28 @@ export function toJsonSchema(schema: z.Schema): json.ZuiJsonSchema {
       } satisfies json.UnionSchema
 
     case z.ZodFirstPartyTypeKind.ZodIntersection:
+      const left = toJsonSchema(def.left)
+      const right = toJsonSchema(def.right)
+
+      /**
+       * TODO: Potential conflict between `additionalProperties` in the left and right schemas.
+       * To avoid this, we currently strip `additionalProperties` from both sides.
+       * This is a workaround and results in lost schema information.
+       * A proper fix would involve using `unevaluatedProperties`.
+       * See: https://json-schema.org/understanding-json-schema/reference/object#unevaluatedproperties
+       *
+       * – fleur
+       */
+      if ('additionalProperties' in left) {
+        delete left.additionalProperties
+      }
+      if ('additionalProperties' in right) {
+        delete right.additionalProperties
+      }
+
       return {
         description: def.description,
-        allOf: [toJsonSchema(def.left), toJsonSchema(def.right)],
+        allOf: [left, right],
         'x-zui': def['x-zui'],
       } satisfies json.IntersectionSchema