fix(zui): x-zui properties on optional not handled by zui-from-json-schema-legacy transformer (#639)

Co-authored-by: François Levasseur <francois_levasseur@hotmail.com>
Co-authored-by: Xavier Hamel <xavier.hamel@botpress.com>

Author: xavierhamel

zui/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpinternal/zui",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "A fork of Zod with additional features",
   "type": "module",
   "source": "./src/index.ts",
@@ -55,4 +55,4 @@
     "pnpm": "8.6.2"
   },
   "packageManager": "pnpm@8.6.2"
-}
+}

zui/src/transforms/zui-from-json-schema-legacy/index.ts

@@ -46,7 +46,7 @@ const jsonSchemaToZod = (schema: any): ZodTypeAny => {
 
 const applyZuiPropsRecursively = (zodField: ZodTypeAny, jsonSchemaField: any) => {
   if (jsonSchemaField[zuiKey] && zodField._def) {
-    zodField._def[zuiKey] = jsonSchemaField[zuiKey]
+    zodField.naked()._def[zuiKey] = jsonSchemaField[zuiKey]
   }
 
   if (zodField._def?.typeName === 'ZodObject' && jsonSchemaField.type === 'object' && jsonSchemaField.properties) {

zui/src/transforms/zui-from-json-schema-legacy/json-schema-to-zui.test.ts

@@ -97,6 +97,27 @@ describe('jsonSchemaToZui', () => {
     expect(jsonSchema).toEqual(converted)
   })
 
+  test('should map extensions (x-zui) to zod schema for ZodOptional', () => {
+    const jSchema = {
+      type: 'object',
+      properties: {
+        optional: {
+          type: 'string',
+          'x-zui': {
+            secret: true,
+          },
+        },
+      },
+    } as JSONSchema7
+    const zSchema = fromJSONSchemaLegacy(jSchema)
+    const expected = z.object({
+      optional: z.optional(z.string().secret()),
+    })
+    expect(zSchema.isEqual(expected)).toBe(true)
+    const field = (zSchema as z.ZodObject)._def.shape().optional as z.ZodOptional<z.ZodString>
+    expect(field._def.innerType._def['x-zui']?.secret, 'Expected secret to be true').toBe(true)
+  })
+
   test('convert object with nested', () => {
     const zuiSchema = fromJSONSchemaLegacy({
       type: 'object',
@@ -136,8 +157,8 @@ describe('jsonSchemaToZui', () => {
     traverseZodDefinitions(zuiSchema._def, (type, def, path) => {
       if (path.join('.') === 'address.city.bestFoods') {
         expect(['ZodArray', 'ZodOptional']).toContain(type)
-        if (type === 'ZodOptional') {
-          expect(def[zuiKey]?.title).toBe('Best foods')
+        if (def.typeName === 'ZodOptional') {
+          expect(def.innerType._def[zuiKey]?.title).toBe('Best foods')
         }
       }
       if (path.join('.') === 'address.city.bestFoods.0.type') {