@orpc/zod 0.18.0 → 0.20.0

package/dist/index.js

@@ -340,6 +340,22 @@ function zodCoerceInternal(schema, value, options) {
   return value;
 }
 
+// src/converter.ts
+import { JSONSchemaFormat } from "@orpc/openapi";
+
+// ../../node_modules/.pnpm/escape-string-regexp@5.0.0/node_modules/escape-string-regexp/index.js
+function escapeStringRegexp(string) {
+  if (typeof string !== "string") {
+    throw new TypeError("Expected a string");
+  }
+  return string.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&").replace(/-/g, "\\x2d");
+}
+
+// src/converter.ts
+import {
+  ZodFirstPartyTypeKind as ZodFirstPartyTypeKind2
+} from "zod";
+
 // src/schemas.ts
 import wcmatch from "wildcard-match";
 import {
@@ -475,8 +491,463 @@ var oz = {
   regexp,
   url
 };
+
+// src/converter.ts
+var NON_LOGIC_KEYWORDS = [
+  // Core Documentation Keywords
+  "$anchor",
+  "$comment",
+  "$defs",
+  "$id",
+  "title",
+  "description",
+  // Value Keywords
+  "default",
+  "deprecated",
+  "examples",
+  // Metadata Keywords
+  "$schema",
+  "definitions",
+  // Legacy, but still used
+  "readOnly",
+  "writeOnly",
+  // Display and UI Hints
+  "contentMediaType",
+  "contentEncoding",
+  "format",
+  // Custom Extensions
+  "$vocabulary",
+  "$dynamicAnchor",
+  "$dynamicRef"
+];
+var UNSUPPORTED_JSON_SCHEMA = { not: {} };
+var UNDEFINED_JSON_SCHEMA = { const: "undefined" };
+function zodToJsonSchema(schema, options) {
+  if (schema["~standard"].vendor !== "zod") {
+    console.warn(`Generate JSON schema not support ${schema["~standard"].vendor} yet`);
+    return {};
+  }
+  const schema__ = schema;
+  if (!options?.isHandledCustomJSONSchema) {
+    const customJSONSchema = getCustomJSONSchema(schema__._def, options);
+    if (customJSONSchema) {
+      const json = zodToJsonSchema(schema__, {
+        ...options,
+        isHandledCustomJSONSchema: true
+      });
+      return {
+        ...json,
+        ...customJSONSchema
+      };
+    }
+  }
+  const childOptions = { ...options, isHandledCustomJSONSchema: false };
+  const customType = getCustomZodType(schema__._def);
+  switch (customType) {
+    case "Blob": {
+      return { type: "string", contentMediaType: "*/*" };
+    }
+    case "File": {
+      const mimeType = getCustomZodFileMimeType(schema__._def) ?? "*/*";
+      return { type: "string", contentMediaType: mimeType };
+    }
+    case "Invalid Date": {
+      return { const: "Invalid Date" };
+    }
+    case "RegExp": {
+      return {
+        type: "string",
+        pattern: "^\\/(.*)\\/([a-z]*)$"
+      };
+    }
+    case "URL": {
+      return { type: "string", format: JSONSchemaFormat.URI };
+    }
+  }
+  const _expectedCustomType = customType;
+  const typeName = schema__._def.typeName;
+  switch (typeName) {
+    case ZodFirstPartyTypeKind2.ZodString: {
+      const schema_ = schema__;
+      const json = { type: "string" };
+      for (const check of schema_._def.checks) {
+        switch (check.kind) {
+          case "base64":
+            json.contentEncoding = "base64";
+            break;
+          case "cuid":
+            json.pattern = "^[0-9A-HJKMNP-TV-Z]{26}$";
+            break;
+          case "email":
+            json.format = JSONSchemaFormat.Email;
+            break;
+          case "url":
+            json.format = JSONSchemaFormat.URI;
+            break;
+          case "uuid":
+            json.format = JSONSchemaFormat.UUID;
+            break;
+          case "regex":
+            json.pattern = check.regex.source;
+            break;
+          case "min":
+            json.minLength = check.value;
+            break;
+          case "max":
+            json.maxLength = check.value;
+            break;
+          case "length":
+            json.minLength = check.value;
+            json.maxLength = check.value;
+            break;
+          case "includes":
+            json.pattern = escapeStringRegexp(check.value);
+            break;
+          case "startsWith":
+            json.pattern = `^${escapeStringRegexp(check.value)}`;
+            break;
+          case "endsWith":
+            json.pattern = `${escapeStringRegexp(check.value)}$`;
+            break;
+          case "emoji":
+            json.pattern = "^(\\p{Extended_Pictographic}|\\p{Emoji_Component})+$";
+            break;
+          case "nanoid":
+            json.pattern = "^[a-zA-Z0-9_-]{21}$";
+            break;
+          case "cuid2":
+            json.pattern = "^[0-9a-z]+$";
+            break;
+          case "ulid":
+            json.pattern = "^[0-9A-HJKMNP-TV-Z]{26}$";
+            break;
+          case "datetime":
+            json.format = JSONSchemaFormat.DateTime;
+            break;
+          case "date":
+            json.format = JSONSchemaFormat.Date;
+            break;
+          case "time":
+            json.format = JSONSchemaFormat.Time;
+            break;
+          case "duration":
+            json.format = JSONSchemaFormat.Duration;
+            break;
+          case "ip":
+            json.format = JSONSchemaFormat.IPv4;
+            break;
+          case "jwt":
+            json.pattern = "^[A-Za-z0-9-_]+\\.[A-Za-z0-9-_]+\\.[A-Za-z0-9-_]*$";
+            break;
+          case "base64url":
+            json.pattern = "^([0-9a-zA-Z-_]{4})*(([0-9a-zA-Z-_]{2}(==)?)|([0-9a-zA-Z-_]{3}(=)?))?$";
+            break;
+          default: {
+            const _expect = check.kind;
+          }
+        }
+      }
+      return json;
+    }
+    case ZodFirstPartyTypeKind2.ZodNumber: {
+      const schema_ = schema__;
+      const json = { type: "number" };
+      for (const check of schema_._def.checks) {
+        switch (check.kind) {
+          case "int":
+            json.type = "integer";
+            break;
+          case "min":
+            json.minimum = check.value;
+            break;
+          case "max":
+            json.maximum = check.value;
+            break;
+          case "multipleOf":
+            json.multipleOf = check.value;
+            break;
+          default: {
+            const _expect = check.kind;
+          }
+        }
+      }
+      return json;
+    }
+    case ZodFirstPartyTypeKind2.ZodNaN: {
+      return { const: "NaN" };
+    }
+    case ZodFirstPartyTypeKind2.ZodBigInt: {
+      const json = { type: "string", pattern: "^-?[0-9]+$" };
+      return json;
+    }
+    case ZodFirstPartyTypeKind2.ZodBoolean: {
+      return { type: "boolean" };
+    }
+    case ZodFirstPartyTypeKind2.ZodDate: {
+      const schema2 = { type: "string", format: JSONSchemaFormat.Date };
+      return schema2;
+    }
+    case ZodFirstPartyTypeKind2.ZodNull: {
+      return { type: "null" };
+    }
+    case ZodFirstPartyTypeKind2.ZodVoid:
+    case ZodFirstPartyTypeKind2.ZodUndefined: {
+      return UNDEFINED_JSON_SCHEMA;
+    }
+    case ZodFirstPartyTypeKind2.ZodLiteral: {
+      const schema_ = schema__;
+      return { const: schema_._def.value };
+    }
+    case ZodFirstPartyTypeKind2.ZodEnum: {
+      const schema_ = schema__;
+      return {
+        enum: schema_._def.values
+      };
+    }
+    case ZodFirstPartyTypeKind2.ZodNativeEnum: {
+      const schema_ = schema__;
+      return {
+        enum: Object.values(schema_._def.values)
+      };
+    }
+    case ZodFirstPartyTypeKind2.ZodArray: {
+      const schema_ = schema__;
+      const def = schema_._def;
+      const json = { type: "array" };
+      if (def.exactLength) {
+        json.maxItems = def.exactLength.value;
+        json.minItems = def.exactLength.value;
+      }
+      if (def.minLength) {
+        json.minItems = def.minLength.value;
+      }
+      if (def.maxLength) {
+        json.maxItems = def.maxLength.value;
+      }
+      return json;
+    }
+    case ZodFirstPartyTypeKind2.ZodTuple: {
+      const schema_ = schema__;
+      const prefixItems = [];
+      const json = { type: "array" };
+      for (const item of schema_._def.items) {
+        prefixItems.push(zodToJsonSchema(item, childOptions));
+      }
+      if (prefixItems?.length) {
+        json.prefixItems = prefixItems;
+      }
+      if (schema_._def.rest) {
+        const items = zodToJsonSchema(schema_._def.rest, childOptions);
+        if (items) {
+          json.items = items;
+        }
+      }
+      return json;
+    }
+    case ZodFirstPartyTypeKind2.ZodObject: {
+      const schema_ = schema__;
+      const json = { type: "object" };
+      const properties = {};
+      const required = [];
+      for (const [key, value] of Object.entries(schema_.shape)) {
+        const { schema: schema2, matches } = extractJSONSchema(
+          zodToJsonSchema(value, childOptions),
+          (schema3) => schema3 === UNDEFINED_JSON_SCHEMA
+        );
+        if (schema2) {
+          properties[key] = schema2;
+        }
+        if (matches.length === 0) {
+          required.push(key);
+        }
+      }
+      if (Object.keys(properties).length) {
+        json.properties = properties;
+      }
+      if (required.length) {
+        json.required = required;
+      }
+      const additionalProperties = zodToJsonSchema(
+        schema_._def.catchall,
+        childOptions
+      );
+      if (schema_._def.unknownKeys === "strict") {
+        json.additionalProperties = additionalProperties === UNSUPPORTED_JSON_SCHEMA ? false : additionalProperties;
+      } else {
+        if (additionalProperties && additionalProperties !== UNSUPPORTED_JSON_SCHEMA) {
+          json.additionalProperties = additionalProperties;
+        }
+      }
+      return json;
+    }
+    case ZodFirstPartyTypeKind2.ZodRecord: {
+      const schema_ = schema__;
+      const json = { type: "object" };
+      json.additionalProperties = zodToJsonSchema(
+        schema_._def.valueType,
+        childOptions
+      );
+      return json;
+    }
+    case ZodFirstPartyTypeKind2.ZodSet: {
+      const schema_ = schema__;
+      return {
+        type: "array",
+        items: zodToJsonSchema(schema_._def.valueType, childOptions)
+      };
+    }
+    case ZodFirstPartyTypeKind2.ZodMap: {
+      const schema_ = schema__;
+      return {
+        type: "array",
+        items: {
+          type: "array",
+          prefixItems: [
+            zodToJsonSchema(schema_._def.keyType, childOptions),
+            zodToJsonSchema(schema_._def.valueType, childOptions)
+          ],
+          maxItems: 2,
+          minItems: 2
+        }
+      };
+    }
+    case ZodFirstPartyTypeKind2.ZodUnion:
+    case ZodFirstPartyTypeKind2.ZodDiscriminatedUnion: {
+      const schema_ = schema__;
+      const anyOf = [];
+      for (const s of schema_._def.options) {
+        anyOf.push(zodToJsonSchema(s, childOptions));
+      }
+      return { anyOf };
+    }
+    case ZodFirstPartyTypeKind2.ZodIntersection: {
+      const schema_ = schema__;
+      const allOf = [];
+      for (const s of [schema_._def.left, schema_._def.right]) {
+        allOf.push(zodToJsonSchema(s, childOptions));
+      }
+      return { allOf };
+    }
+    case ZodFirstPartyTypeKind2.ZodLazy: {
+      const schema_ = schema__;
+      const maxLazyDepth = childOptions?.maxLazyDepth ?? 5;
+      const lazyDepth = childOptions?.lazyDepth ?? 0;
+      if (lazyDepth > maxLazyDepth) {
+        return {};
+      }
+      return zodToJsonSchema(schema_._def.getter(), {
+        ...childOptions,
+        lazyDepth: lazyDepth + 1
+      });
+    }
+    case ZodFirstPartyTypeKind2.ZodUnknown:
+    case ZodFirstPartyTypeKind2.ZodAny:
+    case void 0: {
+      return {};
+    }
+    case ZodFirstPartyTypeKind2.ZodOptional: {
+      const schema_ = schema__;
+      const inner = zodToJsonSchema(schema_._def.innerType, childOptions);
+      return {
+        anyOf: [UNDEFINED_JSON_SCHEMA, inner]
+      };
+    }
+    case ZodFirstPartyTypeKind2.ZodReadonly: {
+      const schema_ = schema__;
+      return zodToJsonSchema(schema_._def.innerType, childOptions);
+    }
+    case ZodFirstPartyTypeKind2.ZodDefault: {
+      const schema_ = schema__;
+      return zodToJsonSchema(schema_._def.innerType, childOptions);
+    }
+    case ZodFirstPartyTypeKind2.ZodEffects: {
+      const schema_ = schema__;
+      if (schema_._def.effect.type === "transform" && childOptions?.mode === "output") {
+        return {};
+      }
+      return zodToJsonSchema(schema_._def.schema, childOptions);
+    }
+    case ZodFirstPartyTypeKind2.ZodCatch: {
+      const schema_ = schema__;
+      return zodToJsonSchema(schema_._def.innerType, childOptions);
+    }
+    case ZodFirstPartyTypeKind2.ZodBranded: {
+      const schema_ = schema__;
+      return zodToJsonSchema(schema_._def.type, childOptions);
+    }
+    case ZodFirstPartyTypeKind2.ZodPipeline: {
+      const schema_ = schema__;
+      return zodToJsonSchema(
+        childOptions?.mode === "output" ? schema_._def.out : schema_._def.in,
+        childOptions
+      );
+    }
+    case ZodFirstPartyTypeKind2.ZodNullable: {
+      const schema_ = schema__;
+      const inner = zodToJsonSchema(schema_._def.innerType, childOptions);
+      return {
+        anyOf: [{ type: "null" }, inner]
+      };
+    }
+  }
+  const _expected = typeName;
+  return UNSUPPORTED_JSON_SCHEMA;
+}
+function extractJSONSchema(schema, check, matches = []) {
+  if (check(schema)) {
+    matches.push(schema);
+    return { schema: void 0, matches };
+  }
+  if (typeof schema === "boolean") {
+    return { schema, matches };
+  }
+  if (schema.anyOf && Object.keys(schema).every(
+    (k) => k === "anyOf" || NON_LOGIC_KEYWORDS.includes(k)
+  )) {
+    const anyOf = schema.anyOf.map((s) => extractJSONSchema(s, check, matches).schema).filter((v) => !!v);
+    if (anyOf.length === 1 && typeof anyOf[0] === "object") {
+      return { schema: { ...schema, anyOf: void 0, ...anyOf[0] }, matches };
+    }
+    return {
+      schema: {
+        ...schema,
+        anyOf
+      },
+      matches
+    };
+  }
+  if (schema.oneOf && Object.keys(schema).every(
+    (k) => k === "oneOf" || NON_LOGIC_KEYWORDS.includes(k)
+  )) {
+    const oneOf = schema.oneOf.map((s) => extractJSONSchema(s, check, matches).schema).filter((v) => !!v);
+    if (oneOf.length === 1 && typeof oneOf[0] === "object") {
+      return { schema: { ...schema, oneOf: void 0, ...oneOf[0] }, matches };
+    }
+    return {
+      schema: {
+        ...schema,
+        oneOf
+      },
+      matches
+    };
+  }
+  return { schema, matches };
+}
+var ZodToJsonSchemaConverter = class {
+  condition(schema) {
+    return Boolean(schema && schema["~standard"].vendor === "zod");
+  }
+  convert(schema, options) {
+    const jsonSchema = schema;
+    return zodToJsonSchema(jsonSchema, { mode: options.strategy });
+  }
+};
 export {
+  NON_LOGIC_KEYWORDS,
+  UNDEFINED_JSON_SCHEMA,
+  UNSUPPORTED_JSON_SCHEMA,
   ZodCoercer,
+  ZodToJsonSchemaConverter,
   blob,
   file,
   getCustomJSONSchema,
@@ -486,6 +957,7 @@ export {
   openapi,
   oz,
   regexp,
-  url
+  url,
+  zodToJsonSchema
 };
 //# sourceMappingURL=index.js.map

package/dist/src/converter.d.ts

@@ -0,0 +1,44 @@
+import type { Schema } from '@orpc/contract';
+import type { JSONSchema, SchemaConverter, SchemaConvertOptions } from '@orpc/openapi';
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+export declare const NON_LOGIC_KEYWORDS: ("$anchor" | "$comment" | "$defs" | "$dynamicAnchor" | "$dynamicRef" | "$id" | "$schema" | "$vocabulary" | "contentEncoding" | "contentMediaType" | "default" | "definitions" | "deprecated" | "description" | "examples" | "format" | "readOnly" | "title" | "writeOnly")[];
+export declare const UNSUPPORTED_JSON_SCHEMA: {
+    not: {};
+};
+export declare const UNDEFINED_JSON_SCHEMA: {
+    const: string;
+};
+export interface ZodToJsonSchemaOptions {
+    /**
+     * Max depth of lazy type, if it exceeds.
+     *
+     * Used `{}` when reach max depth
+     *
+     * @default 5
+     */
+    maxLazyDepth?: number;
+    /**
+     * The length used to track the depth of lazy type
+     *
+     * @internal
+     */
+    lazyDepth?: number;
+    /**
+     * The expected json schema for input or output zod schema
+     *
+     * @default input
+     */
+    mode?: 'input' | 'output';
+    /**
+     * Track if current level schema is handled custom json schema to prevent recursive
+     *
+     * @internal
+     */
+    isHandledCustomJSONSchema?: boolean;
+}
+export declare function zodToJsonSchema(schema: StandardSchemaV1, options?: ZodToJsonSchemaOptions): Exclude<JSONSchema.JSONSchema, boolean>;
+export declare class ZodToJsonSchemaConverter implements SchemaConverter {
+    condition(schema: Schema): boolean;
+    convert(schema: Schema, options: SchemaConvertOptions): JSONSchema.JSONSchema;
+}
+//# sourceMappingURL=converter.d.ts.map

package/dist/src/index.d.ts

@@ -1,3 +1,4 @@
 export * from './coercer';
+export * from './converter';
 export * from './schemas';
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@orpc/zod",
   "type": "module",
-  "version": "0.18.0",
+  "version": "0.20.0",
   "license": "MIT",
   "homepage": "https://orpc.unnoq.com",
   "repository": {
@@ -29,7 +29,7 @@
     "dist"
   ],
   "peerDependencies": {
-    "@orpc/openapi": "0.18.0"
+    "@orpc/openapi": "0.20.0"
   },
   "dependencies": {
     "json-schema-typed": "^8.0.1",