full site update

This commit is contained in:
2025-07-24 18:46:24 +02:00
parent bfe2b90d8d
commit 37a6e0ab31
6912 changed files with 540482 additions and 361712 deletions

View File

@@ -33,6 +33,7 @@ export const defaultOptions = {
emailStrategy: "format:email",
base64Strategy: "contentEncoding:base64",
nameStrategy: "ref",
openAiAnyTypeName: "OpenAiAnyType"
};
export const getDefaultOptions = (options) => (typeof options === "string"
? {

View File

@@ -6,6 +6,7 @@ export const getRefs = (options) => {
: _options.basePath;
return {
..._options,
flags: { hasReferencedOpenAiAnyType: false },
currentPath: currentPath,
propertyPath: undefined,
seen: new Map(Object.entries(_options.definitions).map(([name, def]) => [

View File

@@ -0,0 +1,8 @@
export const getRelativePath = (pathA, pathB) => {
let i = 0;
for (; i < pathA.length && i < pathB.length; i++) {
if (pathA[i] !== pathB[i])
break;
}
return [(pathA.length - i).toString(), ...pathB.slice(i)].join("/");
};

View File

@@ -1,6 +1,7 @@
export * from "./Options.js";
export * from "./Refs.js";
export * from "./errorMessages.js";
export * from "./getRelativePath.js";
export * from "./parseDef.js";
export * from "./parseTypes.js";
export * from "./parsers/any.js";

View File

@@ -1,5 +1,7 @@
import { ignoreOverride } from "./Options.js";
import { selectParser } from "./selectParser.js";
import { getRelativePath } from "./getRelativePath.js";
import { parseAnyDef } from "./parsers/any.js";
export function parseDef(def, refs, forceResolution = false) {
const seenItem = refs.seen.get(def);
if (refs.override) {
@@ -43,20 +45,12 @@ const get$ref = (item, refs) => {
if (item.path.length < refs.currentPath.length &&
item.path.every((value, index) => refs.currentPath[index] === value)) {
console.warn(`Recursive reference detected at ${refs.currentPath.join("/")}! Defaulting to any`);
return {};
return parseAnyDef(refs);
}
return refs.$refStrategy === "seen" ? {} : undefined;
return refs.$refStrategy === "seen" ? parseAnyDef(refs) : undefined;
}
}
};
const getRelativePath = (pathA, pathB) => {
let i = 0;
for (; i < pathA.length && i < pathB.length; i++) {
if (pathA[i] !== pathB[i])
break;
}
return [(pathA.length - i).toString(), ...pathB.slice(i)].join("/");
};
const addMeta = (def, refs, jsonSchema) => {
if (def.description) {
jsonSchema.description = def.description;

View File

@@ -1,3 +1,17 @@
export function parseAnyDef() {
return {};
import { getRelativePath } from "../getRelativePath.js";
export function parseAnyDef(refs) {
if (refs.target !== "openAi") {
return {};
}
const anyDefinitionPath = [
...refs.basePath,
refs.definitionPath,
refs.openAiAnyTypeName,
];
refs.flags.hasReferencedOpenAiAnyType = true;
return {
$ref: refs.$refStrategy === "relative"
? getRelativePath(anyDefinitionPath, refs.currentPath)
: anyDefinitionPath.join("/"),
};
}

View File

@@ -1,6 +1,7 @@
import { parseDef } from "../parseDef.js";
import { parseAnyDef } from "./any.js";
export function parseEffectsDef(_def, refs) {
return refs.effectStrategy === "input"
? parseDef(_def.schema._def, refs)
: {};
: parseAnyDef(refs);
}

View File

@@ -1,5 +1,6 @@
import { parseDef } from "../parseDef.js";
import { parseRecordDef } from "./record.js";
import { parseAnyDef } from "./any.js";
export function parseMapDef(def, refs) {
if (refs.mapStrategy === "record") {
return parseRecordDef(def, refs);
@@ -7,11 +8,11 @@ export function parseMapDef(def, refs) {
const keys = parseDef(def.keyType._def, {
...refs,
currentPath: [...refs.currentPath, "items", "items", "0"],
}) || {};
}) || parseAnyDef(refs);
const values = parseDef(def.valueType._def, {
...refs,
currentPath: [...refs.currentPath, "items", "items", "1"],
}) || {};
}) || parseAnyDef(refs);
return {
type: "array",
maxItems: 125,

View File

@@ -1,5 +1,11 @@
export function parseNeverDef() {
return {
not: {},
};
import { parseAnyDef } from "./any.js";
export function parseNeverDef(refs) {
return refs.target === "openAi"
? undefined
: {
not: parseAnyDef({
...refs,
currentPath: [...refs.currentPath, "not"],
}),
};
}

View File

@@ -1,4 +1,3 @@
import { ZodOptional } from "zod";
import { parseDef } from "../parseDef.js";
export function parseObjectDef(def, refs) {
const forceOptionalIntoNullable = refs.target === "openAi";
@@ -15,7 +14,7 @@ export function parseObjectDef(def, refs) {
}
let propOptional = safeIsOptional(propDef);
if (propOptional && forceOptionalIntoNullable) {
if (propDef instanceof ZodOptional) {
if (propDef._def.typeName === "ZodOptional") {
propDef = propDef._def.innerType;
}
if (!propDef.isNullable()) {

View File

@@ -1,4 +1,5 @@
import { parseDef } from "../parseDef.js";
import { parseAnyDef } from "./any.js";
export const parseOptionalDef = (def, refs) => {
if (refs.currentPath.toString() === refs.propertyPath?.toString()) {
return parseDef(def.innerType._def, refs);
@@ -11,10 +12,10 @@ export const parseOptionalDef = (def, refs) => {
? {
anyOf: [
{
not: {},
not: parseAnyDef(refs),
},
innerSchema,
],
}
: {};
: parseAnyDef(refs);
};

View File

@@ -2,6 +2,7 @@ import { ZodFirstPartyTypeKind, } from "zod";
import { parseDef } from "../parseDef.js";
import { parseStringDef } from "./string.js";
import { parseBrandedDef } from "./branded.js";
import { parseAnyDef } from "./any.js";
export function parseRecordDef(def, refs) {
if (refs.target === "openAi") {
console.warn("Warning: OpenAI may not support records in schemas! Try an array of key-value pairs instead.");
@@ -16,7 +17,7 @@ export function parseRecordDef(def, refs) {
[key]: parseDef(def.valueType._def, {
...refs,
currentPath: [...refs.currentPath, "properties", key],
}) ?? {},
}) ?? parseAnyDef(refs),
}), {}),
additionalProperties: refs.rejectedAdditionalProperties,
};

View File

@@ -1,5 +1,6 @@
export function parseUndefinedDef() {
import { parseAnyDef } from "./any.js";
export function parseUndefinedDef(refs) {
return {
not: {},
not: parseAnyDef(refs),
};
}

View File

@@ -1,3 +1,4 @@
export function parseUnknownDef() {
return {};
import { parseAnyDef } from "./any.js";
export function parseUnknownDef(refs) {
return parseAnyDef(refs);
}

View File

@@ -44,7 +44,7 @@ export const selectParser = (def, typeName, refs) => {
case ZodFirstPartyTypeKind.ZodDate:
return parseDateDef(def, refs);
case ZodFirstPartyTypeKind.ZodUndefined:
return parseUndefinedDef();
return parseUndefinedDef(refs);
case ZodFirstPartyTypeKind.ZodNull:
return parseNullDef(refs);
case ZodFirstPartyTypeKind.ZodArray:
@@ -78,13 +78,13 @@ export const selectParser = (def, typeName, refs) => {
return parsePromiseDef(def, refs);
case ZodFirstPartyTypeKind.ZodNaN:
case ZodFirstPartyTypeKind.ZodNever:
return parseNeverDef();
return parseNeverDef(refs);
case ZodFirstPartyTypeKind.ZodEffects:
return parseEffectsDef(def, refs);
case ZodFirstPartyTypeKind.ZodAny:
return parseAnyDef();
return parseAnyDef(refs);
case ZodFirstPartyTypeKind.ZodUnknown:
return parseUnknownDef();
return parseUnknownDef(refs);
case ZodFirstPartyTypeKind.ZodDefault:
return parseDefaultDef(def, refs);
case ZodFirstPartyTypeKind.ZodBranded:

View File

@@ -1,14 +1,15 @@
import { parseDef } from "./parseDef.js";
import { getRefs } from "./Refs.js";
import { parseAnyDef } from "./parsers/any.js";
const zodToJsonSchema = (schema, options) => {
const refs = getRefs(options);
const definitions = typeof options === "object" && options.definitions
let definitions = typeof options === "object" && options.definitions
? Object.entries(options.definitions).reduce((acc, [name, schema]) => ({
...acc,
[name]: parseDef(schema._def, {
...refs,
currentPath: [...refs.basePath, refs.definitionPath, name],
}, true) ?? {},
}, true) ?? parseAnyDef(refs),
}), {})
: undefined;
const name = typeof options === "string"
@@ -21,7 +22,7 @@ const zodToJsonSchema = (schema, options) => {
: {
...refs,
currentPath: [...refs.basePath, refs.definitionPath, name],
}, false) ?? {};
}, false) ?? parseAnyDef(refs);
const title = typeof options === "object" &&
options.name !== undefined &&
options.nameStrategy === "title"
@@ -30,6 +31,26 @@ const zodToJsonSchema = (schema, options) => {
if (title !== undefined) {
main.title = title;
}
if (refs.flags.hasReferencedOpenAiAnyType) {
if (!definitions) {
definitions = {};
}
if (!definitions[refs.openAiAnyTypeName]) {
definitions[refs.openAiAnyTypeName] = {
// Skipping "object" as no properties can be defined and additionalProperties must be "false"
type: ["string", "number", "integer", "boolean", "array", "null"],
items: {
$ref: refs.$refStrategy === "relative"
? "1"
: [
...refs.basePath,
refs.definitionPath,
refs.openAiAnyTypeName,
].join("/"),
},
};
}
}
const combined = name === undefined
? definitions
? {