| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605 |
- import { extractDefs, finalize, initializeContext, process, } from "./to-json-schema.js";
- import { getEnumValues } from "./util.js";
- const formatMap = {
- guid: "uuid",
- url: "uri",
- datetime: "date-time",
- json_string: "json-string",
- regex: "", // do not set
- };
- // ==================== SIMPLE TYPE PROCESSORS ====================
- export const stringProcessor = (schema, ctx, _json, _params) => {
- const json = _json;
- json.type = "string";
- const { minimum, maximum, format, patterns, contentEncoding } = schema._zod
- .bag;
- if (typeof minimum === "number")
- json.minLength = minimum;
- if (typeof maximum === "number")
- json.maxLength = maximum;
- // custom pattern overrides format
- if (format) {
- json.format = formatMap[format] ?? format;
- if (json.format === "")
- delete json.format; // empty format is not valid
- // JSON Schema format: "time" requires a full time with offset or Z
- // z.iso.time() does not include timezone information, so format: "time" should never be used
- if (format === "time") {
- delete json.format;
- }
- }
- if (contentEncoding)
- json.contentEncoding = contentEncoding;
- if (patterns && patterns.size > 0) {
- const regexes = [...patterns];
- if (regexes.length === 1)
- json.pattern = regexes[0].source;
- else if (regexes.length > 1) {
- json.allOf = [
- ...regexes.map((regex) => ({
- ...(ctx.target === "draft-07" || ctx.target === "draft-04" || ctx.target === "openapi-3.0"
- ? { type: "string" }
- : {}),
- pattern: regex.source,
- })),
- ];
- }
- }
- };
- export const numberProcessor = (schema, ctx, _json, _params) => {
- const json = _json;
- const { minimum, maximum, format, multipleOf, exclusiveMaximum, exclusiveMinimum } = schema._zod.bag;
- if (typeof format === "string" && format.includes("int"))
- json.type = "integer";
- else
- json.type = "number";
- if (typeof exclusiveMinimum === "number") {
- if (ctx.target === "draft-04" || ctx.target === "openapi-3.0") {
- json.minimum = exclusiveMinimum;
- json.exclusiveMinimum = true;
- }
- else {
- json.exclusiveMinimum = exclusiveMinimum;
- }
- }
- if (typeof minimum === "number") {
- json.minimum = minimum;
- if (typeof exclusiveMinimum === "number" && ctx.target !== "draft-04") {
- if (exclusiveMinimum >= minimum)
- delete json.minimum;
- else
- delete json.exclusiveMinimum;
- }
- }
- if (typeof exclusiveMaximum === "number") {
- if (ctx.target === "draft-04" || ctx.target === "openapi-3.0") {
- json.maximum = exclusiveMaximum;
- json.exclusiveMaximum = true;
- }
- else {
- json.exclusiveMaximum = exclusiveMaximum;
- }
- }
- if (typeof maximum === "number") {
- json.maximum = maximum;
- if (typeof exclusiveMaximum === "number" && ctx.target !== "draft-04") {
- if (exclusiveMaximum <= maximum)
- delete json.maximum;
- else
- delete json.exclusiveMaximum;
- }
- }
- if (typeof multipleOf === "number")
- json.multipleOf = multipleOf;
- };
- export const booleanProcessor = (_schema, _ctx, json, _params) => {
- json.type = "boolean";
- };
- export const bigintProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("BigInt cannot be represented in JSON Schema");
- }
- };
- export const symbolProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Symbols cannot be represented in JSON Schema");
- }
- };
- export const nullProcessor = (_schema, ctx, json, _params) => {
- if (ctx.target === "openapi-3.0") {
- json.type = "string";
- json.nullable = true;
- json.enum = [null];
- }
- else {
- json.type = "null";
- }
- };
- export const undefinedProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Undefined cannot be represented in JSON Schema");
- }
- };
- export const voidProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Void cannot be represented in JSON Schema");
- }
- };
- export const neverProcessor = (_schema, _ctx, json, _params) => {
- json.not = {};
- };
- export const anyProcessor = (_schema, _ctx, _json, _params) => {
- // empty schema accepts anything
- };
- export const unknownProcessor = (_schema, _ctx, _json, _params) => {
- // empty schema accepts anything
- };
- export const dateProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Date cannot be represented in JSON Schema");
- }
- };
- export const enumProcessor = (schema, _ctx, json, _params) => {
- const def = schema._zod.def;
- const values = getEnumValues(def.entries);
- // Number enums can have both string and number values
- if (values.every((v) => typeof v === "number"))
- json.type = "number";
- if (values.every((v) => typeof v === "string"))
- json.type = "string";
- json.enum = values;
- };
- export const literalProcessor = (schema, ctx, json, _params) => {
- const def = schema._zod.def;
- const vals = [];
- for (const val of def.values) {
- if (val === undefined) {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Literal `undefined` cannot be represented in JSON Schema");
- }
- else {
- // do not add to vals
- }
- }
- else if (typeof val === "bigint") {
- if (ctx.unrepresentable === "throw") {
- throw new Error("BigInt literals cannot be represented in JSON Schema");
- }
- else {
- vals.push(Number(val));
- }
- }
- else {
- vals.push(val);
- }
- }
- if (vals.length === 0) {
- // do nothing (an undefined literal was stripped)
- }
- else if (vals.length === 1) {
- const val = vals[0];
- json.type = val === null ? "null" : typeof val;
- if (ctx.target === "draft-04" || ctx.target === "openapi-3.0") {
- json.enum = [val];
- }
- else {
- json.const = val;
- }
- }
- else {
- if (vals.every((v) => typeof v === "number"))
- json.type = "number";
- if (vals.every((v) => typeof v === "string"))
- json.type = "string";
- if (vals.every((v) => typeof v === "boolean"))
- json.type = "boolean";
- if (vals.every((v) => v === null))
- json.type = "null";
- json.enum = vals;
- }
- };
- export const nanProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("NaN cannot be represented in JSON Schema");
- }
- };
- export const templateLiteralProcessor = (schema, _ctx, json, _params) => {
- const _json = json;
- const pattern = schema._zod.pattern;
- if (!pattern)
- throw new Error("Pattern not found in template literal");
- _json.type = "string";
- _json.pattern = pattern.source;
- };
- export const fileProcessor = (schema, _ctx, json, _params) => {
- const _json = json;
- const file = {
- type: "string",
- format: "binary",
- contentEncoding: "binary",
- };
- const { minimum, maximum, mime } = schema._zod.bag;
- if (minimum !== undefined)
- file.minLength = minimum;
- if (maximum !== undefined)
- file.maxLength = maximum;
- if (mime) {
- if (mime.length === 1) {
- file.contentMediaType = mime[0];
- Object.assign(_json, file);
- }
- else {
- Object.assign(_json, file); // shared props at root
- _json.anyOf = mime.map((m) => ({ contentMediaType: m })); // only contentMediaType differs
- }
- }
- else {
- Object.assign(_json, file);
- }
- };
- export const successProcessor = (_schema, _ctx, json, _params) => {
- json.type = "boolean";
- };
- export const customProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Custom types cannot be represented in JSON Schema");
- }
- };
- export const functionProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Function types cannot be represented in JSON Schema");
- }
- };
- export const transformProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Transforms cannot be represented in JSON Schema");
- }
- };
- export const mapProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Map cannot be represented in JSON Schema");
- }
- };
- export const setProcessor = (_schema, ctx, _json, _params) => {
- if (ctx.unrepresentable === "throw") {
- throw new Error("Set cannot be represented in JSON Schema");
- }
- };
- // ==================== COMPOSITE TYPE PROCESSORS ====================
- export const arrayProcessor = (schema, ctx, _json, params) => {
- const json = _json;
- const def = schema._zod.def;
- const { minimum, maximum } = schema._zod.bag;
- if (typeof minimum === "number")
- json.minItems = minimum;
- if (typeof maximum === "number")
- json.maxItems = maximum;
- json.type = "array";
- json.items = process(def.element, ctx, { ...params, path: [...params.path, "items"] });
- };
- export const objectProcessor = (schema, ctx, _json, params) => {
- const json = _json;
- const def = schema._zod.def;
- json.type = "object";
- json.properties = {};
- const shape = def.shape;
- for (const key in shape) {
- json.properties[key] = process(shape[key], ctx, {
- ...params,
- path: [...params.path, "properties", key],
- });
- }
- // required keys
- const allKeys = new Set(Object.keys(shape));
- const requiredKeys = new Set([...allKeys].filter((key) => {
- const v = def.shape[key]._zod;
- if (ctx.io === "input") {
- return v.optin === undefined;
- }
- else {
- return v.optout === undefined;
- }
- }));
- if (requiredKeys.size > 0) {
- json.required = Array.from(requiredKeys);
- }
- // catchall
- if (def.catchall?._zod.def.type === "never") {
- // strict
- json.additionalProperties = false;
- }
- else if (!def.catchall) {
- // regular
- if (ctx.io === "output")
- json.additionalProperties = false;
- }
- else if (def.catchall) {
- json.additionalProperties = process(def.catchall, ctx, {
- ...params,
- path: [...params.path, "additionalProperties"],
- });
- }
- };
- export const unionProcessor = (schema, ctx, json, params) => {
- const def = schema._zod.def;
- // Exclusive unions (inclusive === false) use oneOf (exactly one match) instead of anyOf (one or more matches)
- // This includes both z.xor() and discriminated unions
- const isExclusive = def.inclusive === false;
- const options = def.options.map((x, i) => process(x, ctx, {
- ...params,
- path: [...params.path, isExclusive ? "oneOf" : "anyOf", i],
- }));
- if (isExclusive) {
- json.oneOf = options;
- }
- else {
- json.anyOf = options;
- }
- };
- export const intersectionProcessor = (schema, ctx, json, params) => {
- const def = schema._zod.def;
- const a = process(def.left, ctx, {
- ...params,
- path: [...params.path, "allOf", 0],
- });
- const b = process(def.right, ctx, {
- ...params,
- path: [...params.path, "allOf", 1],
- });
- const isSimpleIntersection = (val) => "allOf" in val && Object.keys(val).length === 1;
- const allOf = [
- ...(isSimpleIntersection(a) ? a.allOf : [a]),
- ...(isSimpleIntersection(b) ? b.allOf : [b]),
- ];
- json.allOf = allOf;
- };
- export const tupleProcessor = (schema, ctx, _json, params) => {
- const json = _json;
- const def = schema._zod.def;
- json.type = "array";
- const prefixPath = ctx.target === "draft-2020-12" ? "prefixItems" : "items";
- const restPath = ctx.target === "draft-2020-12" ? "items" : ctx.target === "openapi-3.0" ? "items" : "additionalItems";
- const prefixItems = def.items.map((x, i) => process(x, ctx, {
- ...params,
- path: [...params.path, prefixPath, i],
- }));
- const rest = def.rest
- ? process(def.rest, ctx, {
- ...params,
- path: [...params.path, restPath, ...(ctx.target === "openapi-3.0" ? [def.items.length] : [])],
- })
- : null;
- if (ctx.target === "draft-2020-12") {
- json.prefixItems = prefixItems;
- if (rest) {
- json.items = rest;
- }
- }
- else if (ctx.target === "openapi-3.0") {
- json.items = {
- anyOf: prefixItems,
- };
- if (rest) {
- json.items.anyOf.push(rest);
- }
- json.minItems = prefixItems.length;
- if (!rest) {
- json.maxItems = prefixItems.length;
- }
- }
- else {
- json.items = prefixItems;
- if (rest) {
- json.additionalItems = rest;
- }
- }
- // length
- const { minimum, maximum } = schema._zod.bag;
- if (typeof minimum === "number")
- json.minItems = minimum;
- if (typeof maximum === "number")
- json.maxItems = maximum;
- };
- export const recordProcessor = (schema, ctx, _json, params) => {
- const json = _json;
- const def = schema._zod.def;
- json.type = "object";
- // For looseRecord with regex patterns, use patternProperties
- // This correctly represents "only validate keys matching the pattern" semantics
- // and composes well with allOf (intersections)
- const keyType = def.keyType;
- const keyBag = keyType._zod.bag;
- const patterns = keyBag?.patterns;
- if (def.mode === "loose" && patterns && patterns.size > 0) {
- // Use patternProperties for looseRecord with regex patterns
- const valueSchema = process(def.valueType, ctx, {
- ...params,
- path: [...params.path, "patternProperties", "*"],
- });
- json.patternProperties = {};
- for (const pattern of patterns) {
- json.patternProperties[pattern.source] = valueSchema;
- }
- }
- else {
- // Default behavior: use propertyNames + additionalProperties
- if (ctx.target === "draft-07" || ctx.target === "draft-2020-12") {
- json.propertyNames = process(def.keyType, ctx, {
- ...params,
- path: [...params.path, "propertyNames"],
- });
- }
- json.additionalProperties = process(def.valueType, ctx, {
- ...params,
- path: [...params.path, "additionalProperties"],
- });
- }
- // Add required for keys with discrete values (enum, literal, etc.)
- const keyValues = keyType._zod.values;
- if (keyValues) {
- const validKeyValues = [...keyValues].filter((v) => typeof v === "string" || typeof v === "number");
- if (validKeyValues.length > 0) {
- json.required = validKeyValues;
- }
- }
- };
- export const nullableProcessor = (schema, ctx, json, params) => {
- const def = schema._zod.def;
- const inner = process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- if (ctx.target === "openapi-3.0") {
- seen.ref = def.innerType;
- json.nullable = true;
- }
- else {
- json.anyOf = [inner, { type: "null" }];
- }
- };
- export const nonoptionalProcessor = (schema, ctx, _json, params) => {
- const def = schema._zod.def;
- process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = def.innerType;
- };
- export const defaultProcessor = (schema, ctx, json, params) => {
- const def = schema._zod.def;
- process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = def.innerType;
- json.default = JSON.parse(JSON.stringify(def.defaultValue));
- };
- export const prefaultProcessor = (schema, ctx, json, params) => {
- const def = schema._zod.def;
- process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = def.innerType;
- if (ctx.io === "input")
- json._prefault = JSON.parse(JSON.stringify(def.defaultValue));
- };
- export const catchProcessor = (schema, ctx, json, params) => {
- const def = schema._zod.def;
- process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = def.innerType;
- let catchValue;
- try {
- catchValue = def.catchValue(undefined);
- }
- catch {
- throw new Error("Dynamic catch values are not supported in JSON Schema");
- }
- json.default = catchValue;
- };
- export const pipeProcessor = (schema, ctx, _json, params) => {
- const def = schema._zod.def;
- const innerType = ctx.io === "input" ? (def.in._zod.def.type === "transform" ? def.out : def.in) : def.out;
- process(innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = innerType;
- };
- export const readonlyProcessor = (schema, ctx, json, params) => {
- const def = schema._zod.def;
- process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = def.innerType;
- json.readOnly = true;
- };
- export const promiseProcessor = (schema, ctx, _json, params) => {
- const def = schema._zod.def;
- process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = def.innerType;
- };
- export const optionalProcessor = (schema, ctx, _json, params) => {
- const def = schema._zod.def;
- process(def.innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = def.innerType;
- };
- export const lazyProcessor = (schema, ctx, _json, params) => {
- const innerType = schema._zod.innerType;
- process(innerType, ctx, params);
- const seen = ctx.seen.get(schema);
- seen.ref = innerType;
- };
- // ==================== ALL PROCESSORS ====================
- export const allProcessors = {
- string: stringProcessor,
- number: numberProcessor,
- boolean: booleanProcessor,
- bigint: bigintProcessor,
- symbol: symbolProcessor,
- null: nullProcessor,
- undefined: undefinedProcessor,
- void: voidProcessor,
- never: neverProcessor,
- any: anyProcessor,
- unknown: unknownProcessor,
- date: dateProcessor,
- enum: enumProcessor,
- literal: literalProcessor,
- nan: nanProcessor,
- template_literal: templateLiteralProcessor,
- file: fileProcessor,
- success: successProcessor,
- custom: customProcessor,
- function: functionProcessor,
- transform: transformProcessor,
- map: mapProcessor,
- set: setProcessor,
- array: arrayProcessor,
- object: objectProcessor,
- union: unionProcessor,
- intersection: intersectionProcessor,
- tuple: tupleProcessor,
- record: recordProcessor,
- nullable: nullableProcessor,
- nonoptional: nonoptionalProcessor,
- default: defaultProcessor,
- prefault: prefaultProcessor,
- catch: catchProcessor,
- pipe: pipeProcessor,
- readonly: readonlyProcessor,
- promise: promiseProcessor,
- optional: optionalProcessor,
- lazy: lazyProcessor,
- };
- export function toJSONSchema(input, params) {
- if ("_idmap" in input) {
- // Registry case
- const registry = input;
- const ctx = initializeContext({ ...params, processors: allProcessors });
- const defs = {};
- // First pass: process all schemas to build the seen map
- for (const entry of registry._idmap.entries()) {
- const [_, schema] = entry;
- process(schema, ctx);
- }
- const schemas = {};
- const external = {
- registry,
- uri: params?.uri,
- defs,
- };
- // Update the context with external configuration
- ctx.external = external;
- // Second pass: emit each schema
- for (const entry of registry._idmap.entries()) {
- const [key, schema] = entry;
- extractDefs(ctx, schema);
- schemas[key] = finalize(ctx, schema);
- }
- if (Object.keys(defs).length > 0) {
- const defsSegment = ctx.target === "draft-2020-12" ? "$defs" : "definitions";
- schemas.__shared = {
- [defsSegment]: defs,
- };
- }
- return { schemas };
- }
- // Single schema case
- const ctx = initializeContext({ ...params, processors: allProcessors });
- process(input, ctx);
- extractDefs(ctx, input);
- return finalize(ctx, input);
- }
|