fix(zui): export json types (#629)

Co-authored-by: Francois Levasseur <[email protected]>

Author: allardy

zui/package.json

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

zui/src/index.ts

@@ -1,4 +1,5 @@
 export type { JSONSchema7 } from 'json-schema'
 
+export * as json from './transforms/common/json-schema'
 export * as transforms from './transforms'
 export * from './z'

zui/src/transforms/common/json-schema.ts

@@ -62,38 +62,32 @@ type _BooleanSchema = util.Satisfies<{ type: 'boolean' }, JSONSchema7>
 type _NullSchema = util.Satisfies<{ type: 'null' }, JSONSchema7>
 type _UndefinedSchema = util.Satisfies<{ not: true }, JSONSchema7>
 type _NeverSchema = util.Satisfies<{ not: true }, JSONSchema7>
-type _ArraySchema = util.Satisfies<
-  { type: 'array'; items: ZuiJSONSchema; minItems?: number; maxItems?: number },
-  JSONSchema7
->
-type _UnionSchema = util.Satisfies<{ anyOf: ZuiJSONSchema[] }, JSONSchema7>
-type _DiscriminatedUnionSchema = util.Satisfies<{ anyOf: ZuiJSONSchema[] }, JSONSchema7>
-type _IntersectionSchema = util.Satisfies<{ allOf: ZuiJSONSchema[] }, JSONSchema7>
+type _ArraySchema = util.Satisfies<{ type: 'array'; items: Schema; minItems?: number; maxItems?: number }, JSONSchema7>
+type _UnionSchema = util.Satisfies<{ anyOf: Schema[] }, JSONSchema7>
+type _DiscriminatedUnionSchema = util.Satisfies<{ anyOf: Schema[] }, JSONSchema7>
+type _IntersectionSchema = util.Satisfies<{ allOf: Schema[] }, JSONSchema7>
 type _SetSchema = util.Satisfies<
-  { type: 'array'; items: ZuiJSONSchema; uniqueItems: true; minItems?: number; maxItems?: number },
+  { type: 'array'; items: Schema; uniqueItems: true; minItems?: number; maxItems?: number },
   JSONSchema7
 >
 type _EnumSchema = util.Satisfies<{ type: 'string'; enum: string[] }, JSONSchema7>
 type _RefSchema = util.Satisfies<{ $ref: string }, JSONSchema7>
 type _ObjectSchema = util.Satisfies<
   {
     type: 'object'
-    properties: { [key: string]: ZuiJSONSchema }
-    additionalProperties?: ZuiJSONSchema | boolean
+    properties: { [key: string]: Schema }
+    additionalProperties?: Schema | boolean
     required?: string[]
   },
   JSONSchema7
 >
-type _TupleSchema = util.Satisfies<
-  { type: 'array'; items: ZuiJSONSchema[]; additionalItems?: ZuiJSONSchema },
-  JSONSchema7
->
-type _RecordSchema = util.Satisfies<{ type: 'object'; additionalProperties: ZuiJSONSchema }, JSONSchema7>
+type _TupleSchema = util.Satisfies<{ type: 'array'; items: Schema[]; additionalItems?: Schema }, JSONSchema7>
+type _RecordSchema = util.Satisfies<{ type: 'object'; additionalProperties: Schema }, JSONSchema7>
 type _LiteralStringSchema = util.Satisfies<{ type: 'string'; const: string }, JSONSchema7>
 type _LiteralNumberSchema = util.Satisfies<{ type: 'number'; const: number }, JSONSchema7>
 type _LiteralBooleanSchema = util.Satisfies<{ type: 'boolean'; const: boolean }, JSONSchema7>
-type _OptionalSchema = util.Satisfies<{ anyOf: [ZuiJSONSchema, UndefinedSchema] }, JSONSchema7>
-type _NullableSchema = util.Satisfies<{ anyOf: [ZuiJSONSchema, NullSchema] }, JSONSchema7>
+type _OptionalSchema = util.Satisfies<{ anyOf: [Schema, UndefinedSchema] }, JSONSchema7>
+type _NullableSchema = util.Satisfies<{ anyOf: [Schema, NullSchema] }, JSONSchema7>
 
 export type StringSchema = _StringSchema & BaseZuiJSONSchema
 export type NumberSchema = _NumberSchema & BaseZuiJSONSchema
@@ -118,10 +112,12 @@ export type LiteralNumberSchema = _LiteralNumberSchema & BaseZuiJSONSchema
 export type LiteralBooleanSchema = _LiteralBooleanSchema & BaseZuiJSONSchema
 export type OptionalSchema = _OptionalSchema & BaseZuiJSONSchema<OptionalDef>
 export type NullableSchema = _NullableSchema & BaseZuiJSONSchema<NullableDef>
-
 export type LiteralSchema = LiteralStringSchema | LiteralNumberSchema | LiteralBooleanSchema
 
-export type ZuiJSONSchema =
+/**
+ * Zui flavored JSON Schema; a subset of JSONSchema7 that includes Zui extensions
+ */
+export type Schema =
   | StringSchema
   | NumberSchema
   | BooleanSchema

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

@@ -2,7 +2,7 @@ import z from '../../z'
 import { describe, test, expect } from 'vitest'
 import { fromJSONSchema } from './index'
 import { JSONSchema7 } from 'json-schema'
-import { ZuiJSONSchema } from '../common/json-schema'
+import { Schema as ZuiJSONSchema } from '../common/json-schema'
 
 const buildSchema = (s: JSONSchema7, xZui: ZuiJSONSchema['x-zui'] = undefined): JSONSchema7 => {
   return { ...s, 'x-zui': xZui } as JSONSchema7

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

@@ -12,7 +12,7 @@ import { zodTupleToJsonTuple } from './type-processors/tuple'
  * @param schema zui schema
  * @returns ZUI flavored JSON schema
  */
-export function toJSONSchema(schema: z.Schema): json.ZuiJSONSchema {
+export function toJSONSchema(schema: z.Schema): json.Schema {
   const schemaTyped = schema as z.ZodFirstPartySchemaTypes
   const def = schemaTyped._def
 
@@ -80,7 +80,7 @@ export function toJSONSchema(schema: z.Schema): json.ZuiJSONSchema {
       const required = requiredProperties.length ? requiredProperties.map(([key]) => key) : undefined
       const properties = shape
         .map(([key, value]) => [key, value.mandatory()] satisfies [string, z.ZodType])
-        .map(([key, value]) => [key, toJSONSchema(value)] satisfies [string, json.ZuiJSONSchema])
+        .map(([key, value]) => [key, toJSONSchema(value)] satisfies [string, json.Schema])
 
       let additionalProperties: json.ObjectSchema['additionalProperties'] = false
       if (def.unknownKeys instanceof z.ZodType) {

zui/src/transforms/zui-to-json-schema/type-processors/array.ts

@@ -4,7 +4,7 @@ import * as json from '../../common/json-schema'
 
 export const zodArrayToJsonArray = (
   zodArray: z.ZodArray,
-  toSchema: (x: z.ZodTypeAny) => json.ZuiJSONSchema,
+  toSchema: (x: z.ZodTypeAny) => json.Schema,
 ): json.ArraySchema => {
   const schema: json.ArraySchema = {
     type: 'array',

zui/src/transforms/zui-to-json-schema/type-processors/set.ts

@@ -2,10 +2,7 @@ import { zuiKey } from '../../../ui/constants'
 import z from '../../../z'
 import * as json from '../../common/json-schema'
 
-export const zodSetToJsonSet = (
-  zodSet: z.ZodSet,
-  toSchema: (x: z.ZodTypeAny) => json.ZuiJSONSchema,
-): json.SetSchema => {
+export const zodSetToJsonSet = (zodSet: z.ZodSet, toSchema: (x: z.ZodTypeAny) => json.Schema): json.SetSchema => {
   const schema: json.SetSchema = {
     type: 'array',
     description: zodSet.description,

zui/src/transforms/zui-to-json-schema/type-processors/tuple.ts

@@ -4,7 +4,7 @@ import * as json from '../../common/json-schema'
 
 export const zodTupleToJsonTuple = (
   zodTuple: z.ZodTuple,
-  toSchema: (x: z.ZodTypeAny) => json.ZuiJSONSchema,
+  toSchema: (x: z.ZodTypeAny) => json.Schema,
 ): json.TupleSchema => {
   const schema: json.TupleSchema = {
     type: 'array',

zui/src/z/types/basetype/index.ts

@@ -45,7 +45,7 @@ import { CatchFn } from '../catch'
 import { toTypescriptType, TypescriptGenerationOptions } from '../../../transforms/zui-to-typescript-type'
 import { toTypescriptSchema } from '../../../transforms/zui-to-typescript-schema'
 import { toJSONSchema } from '../../../transforms/zui-to-json-schema'
-import { ZuiJSONSchema } from '../../../transforms/common/json-schema'
+import { Schema as ZuiJSONSchema } from '../../../transforms/common/json-schema'
 
 /**
  * This type is not part of the original Zod library, it's been added in Zui to: