@gabrielbryk/json-schema-to-zod 2.8.0 → 2.10.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @gabrielbryk/json-schema-to-zod
 
+## 2.9.0
+
+### Minor Changes
+
+- 0ef12db: - Extract analyzer/emitter core, refactor bundle generation to avoid recursion and preserve inline defs/definitions.
+  - Add scoped naming for inline $defs, lazy cross-ref handling, and nested types emission.
+  - Expand bundle test coverage with snapshots, inline-def fixtures, and nested-type extraction.
+
+### Patch Changes
+
+- b8f6248: - Commit remaining utility, ref resolution test, and config updates.
+- 04b6c6b: Fix bundle output by emitting z.lazy for cyclical refs outside object properties, use ZodError.issues in generated conditionals, and make nested type extraction array-aware to avoid invalid indexers.
+- b8f7b29: Fix type errors in CI by replacing symbol-based allOf indexing, guarding invalid refs, and tightening string content schema parsing types.
+- 691cc5b: - Added ESLint (recommended + no-require-imports) and cleaned all lint issues across src/tests; tightened types and removed unused vars.
+  - Ensured ESM-friendly test evals and ref/anchor resolver code without require usage.
+- 4d127fe: Remove fallback to the non-existent ZodError.errors property in generated conditional schemas; rely on ZodError.issues to avoid TypeScript errors.
+- 7d257dd: - Ensure dist/esm emits real ESM with NodeNext settings and type:module, and update tests to run under ESM by providing createRequire shims.
+
 ## 2.8.0
 
 ### Minor Changes

package/dist/cjs/core/analyzeSchema.js

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.analyzeSchema = void 0;
+const parseSchema_js_1 = require("../parsers/parseSchema.js");
+const cycles_js_1 = require("../utils/cycles.js");
+const buildRefRegistry_js_1 = require("../utils/buildRefRegistry.js");
+const analyzeSchema = (schema, options = {}) => {
+    const { module, name, type, ...rest } = options;
+    if (type && (!name || module !== "esm")) {
+        throw new Error("Option `type` requires `name` to be set and `module` to be `esm`");
+    }
+    const normalized = {
+        module,
+        name,
+        type,
+        ...rest,
+        exportRefs: rest.exportRefs ?? true,
+        withMeta: rest.withMeta ?? true,
+    };
+    const refNameByPointer = new Map();
+    const usedNames = new Set();
+    if (name) {
+        usedNames.add(name);
+    }
+    const declarations = new Map();
+    const dependencies = new Map();
+    const { registry: refRegistry, rootBaseUri } = (0, buildRefRegistry_js_1.buildRefRegistry)(schema);
+    const pass1 = {
+        module,
+        name,
+        path: [],
+        seen: new Map(),
+        declarations,
+        dependencies,
+        inProgress: new Set(),
+        refNameByPointer,
+        usedNames,
+        root: schema,
+        currentSchemaName: name,
+        refRegistry,
+        rootBaseUri,
+        ...rest,
+        withMeta: normalized.withMeta,
+    };
+    (0, parseSchema_js_1.parseSchema)(schema, pass1);
+    const names = Array.from(declarations.keys());
+    const cycleRefNames = (0, cycles_js_1.detectCycles)(names, dependencies);
+    const { componentByName } = (0, cycles_js_1.computeScc)(names, dependencies);
+    return {
+        schema,
+        options: normalized,
+        refNameByPointer,
+        usedNames,
+        declarations,
+        dependencies,
+        cycleRefNames,
+        cycleComponentByName: componentByName,
+        refRegistry,
+        rootBaseUri,
+    };
+};
+exports.analyzeSchema = analyzeSchema;

package/dist/cjs/core/emitZod.js

@@ -0,0 +1,141 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.emitZod = void 0;
+const parseSchema_js_1 = require("../parsers/parseSchema.js");
+const jsdocs_js_1 = require("../utils/jsdocs.js");
+const orderDeclarations = (entries, dependencies) => {
+    const valueByName = new Map(entries);
+    const depGraph = new Map();
+    for (const [from, set] of dependencies.entries()) {
+        const onlyKnown = new Set();
+        for (const dep of set) {
+            if (valueByName.has(dep) && dep !== from) {
+                onlyKnown.add(dep);
+            }
+        }
+        if (onlyKnown.size)
+            depGraph.set(from, onlyKnown);
+    }
+    const names = Array.from(valueByName.keys());
+    for (const [name, value] of entries) {
+        const deps = depGraph.get(name) ?? new Set();
+        for (const candidate of names) {
+            if (candidate === name)
+                continue;
+            const matcher = new RegExp(`\\b${candidate}\\b`);
+            if (matcher.test(value)) {
+                deps.add(candidate);
+            }
+        }
+        if (deps.size)
+            depGraph.set(name, deps);
+    }
+    const ordered = [];
+    const perm = new Set();
+    const temp = new Set();
+    const visit = (name) => {
+        if (perm.has(name))
+            return;
+        if (temp.has(name)) {
+            temp.delete(name);
+            perm.add(name);
+            ordered.push(name);
+            return;
+        }
+        temp.add(name);
+        const deps = depGraph.get(name);
+        if (deps) {
+            for (const dep of deps) {
+                if (valueByName.has(dep)) {
+                    visit(dep);
+                }
+            }
+        }
+        temp.delete(name);
+        perm.add(name);
+        ordered.push(name);
+    };
+    for (const name of valueByName.keys()) {
+        visit(name);
+    }
+    const unique = [];
+    const seen = new Set();
+    for (const name of ordered) {
+        if (!seen.has(name)) {
+            seen.add(name);
+            unique.push(name);
+        }
+    }
+    return unique.map((name) => [name, valueByName.get(name)]);
+};
+const emitZod = (analysis) => {
+    const { schema, options, refNameByPointer, usedNames, cycleRefNames, cycleComponentByName, } = analysis;
+    const { module, name, type, noImport, exportRefs, withMeta, ...rest } = options;
+    const declarations = new Map();
+    const dependencies = new Map();
+    const parsedSchema = (0, parseSchema_js_1.parseSchema)(schema, {
+        module,
+        name,
+        path: [],
+        seen: new Map(),
+        declarations,
+        dependencies,
+        inProgress: new Set(),
+        refNameByPointer,
+        usedNames,
+        root: schema,
+        currentSchemaName: name,
+        cycleRefNames,
+        cycleComponentByName,
+        refRegistry: analysis.refRegistry,
+        rootBaseUri: analysis.rootBaseUri,
+        ...rest,
+        withMeta,
+    });
+    const declarationBlock = declarations.size
+        ? orderDeclarations(Array.from(declarations.entries()), dependencies)
+            .map(([refName, value]) => {
+            const shouldExport = exportRefs && module === "esm";
+            const decl = `${shouldExport ? "export " : ""}const ${refName} = ${value}`;
+            return decl;
+        })
+            .join("\n")
+        : "";
+    const jsdocs = rest.withJsdocs && typeof schema === "object" && schema !== null && "description" in schema
+        ? (0, jsdocs_js_1.expandJsdocs)(String(schema.description ?? ""))
+        : "";
+    const lines = [];
+    if (module === "cjs" && !noImport) {
+        lines.push(`const { z } = require("zod")`);
+    }
+    if (module === "esm" && !noImport) {
+        lines.push(`import { z } from "zod"`);
+    }
+    if (declarationBlock) {
+        lines.push(declarationBlock);
+    }
+    if (module === "cjs") {
+        const payload = name ? `{ ${JSON.stringify(name)}: ${parsedSchema} }` : parsedSchema;
+        lines.push(`${jsdocs}module.exports = ${payload}`);
+    }
+    else if (module === "esm") {
+        const exportLine = `${jsdocs}export ${name ? `const ${name} =` : `default`} ${parsedSchema}`;
+        lines.push(exportLine);
+    }
+    else if (name) {
+        lines.push(`${jsdocs}const ${name} = ${parsedSchema}`);
+    }
+    else {
+        lines.push(`${jsdocs}${parsedSchema}`);
+    }
+    let typeLine;
+    if (type && name) {
+        const typeName = typeof type === "string" ? type : `${name[0].toUpperCase()}${name.substring(1)}`;
+        typeLine = `export type ${typeName} = z.infer<typeof ${name}>`;
+    }
+    const joined = lines.filter(Boolean).join("\n\n");
+    const combined = typeLine ? `${joined}\n${typeLine}` : joined;
+    const shouldEndWithNewline = module === "esm" || module === "cjs";
+    return `${combined}${shouldEndWithNewline ? "\n" : ""}`;
+};
+exports.emitZod = emitZod;

package/dist/cjs/generators/generateBundle.js

@@ -1,61 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateSchemaBundle = void 0;
-const jsonSchemaToZod_js_1 = require("../jsonSchemaToZod.js");
+const analyzeSchema_js_1 = require("../core/analyzeSchema.js");
+const emitZod_js_1 = require("../core/emitZod.js");
 const generateSchemaBundle = (schema, options = {}) => {
     const module = options.module ?? "esm";
-    const rootName = options.splitDefs?.rootName ?? options.name ?? "RootSchema";
-    const rootTypeName = typeof options.type === "string"
-        ? options.type
-        : options.splitDefs?.rootTypeName ?? (typeof options.type === "boolean" && options.type ? rootName : undefined);
     if (!schema || typeof schema !== "object") {
         throw new Error("generateSchemaBundle requires an object schema");
     }
-    const defs = schema.$defs || schema.definitions || {};
+    const defs = schema.$defs || {};
+    const definitions = schema.definitions || {};
     const defNames = Object.keys(defs);
-    const defInfoMap = buildDefInfoMap(defNames, defs, options);
-    const cycles = detectCycles(defInfoMap);
-    for (const defName of cycles) {
-        const info = defInfoMap.get(defName);
-        if (info)
-            info.hasCycle = true;
-    }
+    const { rootName, rootTypeName, defInfoMap } = buildBundleContext(defNames, defs, options);
     const files = [];
-    // Generate individual $def files
-    for (const defName of defNames) {
-        const info = defInfoMap.get(defName);
-        const usedRefs = new Set();
-        const defSchemaWithDefs = {
-            ...defs[defName],
-            $defs: defs,
-        };
-        const zodSchema = (0, jsonSchemaToZod_js_1.jsonSchemaToZod)(defSchemaWithDefs, {
+    const targets = planBundleTargets(schema, defs, definitions, defNames, options, rootName, rootTypeName);
+    for (const target of targets) {
+        const usedRefs = target.usedRefs;
+        const analysis = (0, analyzeSchema_js_1.analyzeSchema)(target.schemaWithDefs, {
             ...options,
             module,
-            name: info.schemaName,
-            type: info.typeName,
-            parserOverride: createRefHandler(defName, defInfoMap, usedRefs, defs, options),
+            name: target.schemaName,
+            type: target.typeName,
+            parserOverride: createRefHandler(target.defName, defInfoMap, usedRefs, {
+                ...(target.schemaWithDefs.$defs || {}),
+                ...(target.schemaWithDefs.definitions || {}),
+            }, options),
         });
+        const zodSchema = (0, emitZod_js_1.emitZod)(analysis);
         const finalSchema = buildSchemaFile(zodSchema, usedRefs, defInfoMap, module);
-        const fileName = options.splitDefs?.fileName?.(defName, { isRoot: false }) ?? `${defName}.schema.ts`;
-        files.push({ fileName, contents: finalSchema });
-    }
-    // Generate root schema if requested
-    if (options.splitDefs?.includeRoot ?? true) {
-        const usedRefs = new Set();
-        const workflowSchemaWithDefs = {
-            ...schema,
-        };
-        const workflowZodSchema = (0, jsonSchemaToZod_js_1.jsonSchemaToZod)(workflowSchemaWithDefs, {
-            ...options,
-            module,
-            name: rootName,
-            type: rootTypeName,
-            parserOverride: createRefHandler(null, defInfoMap, usedRefs, defs, options),
-        });
-        const finalWorkflow = buildSchemaFile(workflowZodSchema, usedRefs, defInfoMap, module);
-        const rootFile = options.splitDefs?.fileName?.("root", { isRoot: true }) ?? "workflow.schema.ts";
-        files.push({ fileName: rootFile, contents: finalWorkflow });
+        files.push({ fileName: target.fileName, contents: finalSchema });
     }
     // Nested types extraction (optional)
     const nestedTypesEnabled = options.nestedTypes?.enable;
@@ -95,13 +68,32 @@ const buildDefInfoMap = (defNames, defs, options) => {
     }
     return map;
 };
+const buildBundleContext = (defNames, defs, options) => {
+    const defInfoMap = buildDefInfoMap(defNames, defs, options);
+    const cycles = detectCycles(defInfoMap);
+    for (const defName of cycles) {
+        const info = defInfoMap.get(defName);
+        if (info)
+            info.hasCycle = true;
+    }
+    const rootName = options.splitDefs?.rootName ?? options.name ?? "RootSchema";
+    const rootTypeName = typeof options.type === "string"
+        ? options.type
+        : options.splitDefs?.rootTypeName ?? (typeof options.type === "boolean" && options.type ? rootName : undefined);
+    return { defInfoMap, rootName, rootTypeName };
+};
 const createRefHandler = (currentDefName, defInfoMap, usedRefs, allDefs, options) => {
+    const useLazyCrossRefs = options.refResolution?.lazyCrossRefs ?? true;
     return (schema, refs) => {
         if (typeof schema["$ref"] === "string") {
             const refPath = schema["$ref"];
             const match = refPath.match(/^#\/(?:\$defs|definitions)\/(.+)$/);
             if (match) {
                 const refName = match[1];
+                // Only intercept top-level def refs (no nested path like a/$defs/x)
+                if (refName.includes("/")) {
+                    return undefined;
+                }
                 const refInfo = defInfoMap.get(refName);
                 if (refInfo) {
                     // Track imports when referencing other defs
@@ -118,22 +110,22 @@ const createRefHandler = (currentDefName, defInfoMap, usedRefs, allDefs, options
                     });
                     if (resolved)
                         return resolved;
+                    if (isCycle && useLazyCrossRefs) {
+                        return `z.lazy(() => ${refInfo.schemaName})`;
+                    }
                     return refInfo.schemaName;
                 }
+                // If the ref points to a local/inline $def (not part of top-level defs),
+                // let the default parser resolve it normally.
+                if (allDefs && Object.prototype.hasOwnProperty.call(allDefs, refName)) {
+                    return undefined;
+                }
             }
             const unknown = options.refResolution?.onUnknownRef?.({ ref: refPath, currentDef: currentDefName });
             if (unknown)
                 return unknown;
             return options.useUnknown ? "z.unknown()" : "z.any()";
         }
-        // Inline $defs within a schema
-        if (schema["$defs"] && typeof schema["$defs"] === "object") {
-            return (0, jsonSchemaToZod_js_1.jsonSchemaToZod)(schema, {
-                ...options,
-                module: options.module ?? "esm",
-                parserOverride: createRefHandler(currentDefName, defInfoMap, usedRefs, allDefs, options),
-            });
-        }
         return undefined;
     };
 };
@@ -151,6 +143,52 @@ const buildSchemaFile = (zodCode, usedRefs, defInfoMap, module) => {
         return zodCode;
     return zodCode.replace('import { z } from "zod"', `import { z } from "zod"\n${imports.join("\n")}`);
 };
+const planBundleTargets = (rootSchema, defs, definitions, defNames, options, rootName, rootTypeName) => {
+    const targets = [];
+    for (const defName of defNames) {
+        const defSchema = defs[defName];
+        const defSchemaWithDefs = {
+            ...defSchema,
+            $defs: { ...defs, ...defSchema?.$defs },
+            definitions: {
+                ...defSchema.definitions,
+                ...definitions,
+            },
+        };
+        const pascalName = toPascalCase(defName);
+        const schemaName = options.splitDefs?.schemaName?.(defName, { isRoot: false }) ?? `${pascalName}Schema`;
+        const typeName = options.splitDefs?.typeName?.(defName, { isRoot: false }) ?? pascalName;
+        const fileName = options.splitDefs?.fileName?.(defName, { isRoot: false }) ?? `${defName}.schema.ts`;
+        targets.push({
+            defName,
+            schemaWithDefs: defSchemaWithDefs,
+            schemaName,
+            typeName,
+            fileName,
+            usedRefs: new Set(),
+            isRoot: false,
+        });
+    }
+    if (options.splitDefs?.includeRoot ?? true) {
+        const rootFile = options.splitDefs?.fileName?.("root", { isRoot: true }) ?? "workflow.schema.ts";
+        targets.push({
+            defName: null,
+            schemaWithDefs: {
+                ...rootSchema,
+                definitions: {
+                    ...rootSchema.definitions,
+                    ...definitions,
+                },
+            },
+            schemaName: rootName,
+            typeName: rootTypeName,
+            fileName: rootFile,
+            usedRefs: new Set(),
+            isRoot: true,
+        });
+    }
+    return targets;
+};
 const findRefDependencies = (schema, validDefNames) => {
     const deps = new Set();
     function traverse(obj) {
@@ -239,7 +277,7 @@ const findNestedTypesInSchema = (schema, parentTypeName, defNames, currentPath =
     if (schema === null || typeof schema !== "object")
         return nestedTypes;
     const record = schema;
-    if (record.title && typeof record.title === "string" && record.type === "object") {
+    if (record.title && typeof record.title === "string") {
         const title = record.title;
         if (title !== parentTypeName && !defNames.map((d) => toPascalCase(d)).includes(title)) {
             nestedTypes.push({
@@ -250,6 +288,12 @@ const findNestedTypesInSchema = (schema, parentTypeName, defNames, currentPath =
             });
         }
     }
+    // inline $defs
+    if (record.$defs && typeof record.$defs === "object") {
+        for (const [, defSchema] of Object.entries(record.$defs)) {
+            nestedTypes.push(...findNestedTypesInSchema(defSchema, parentTypeName, defNames, currentPath));
+        }
+    }
     if (record.properties && typeof record.properties === "object") {
         for (const [propName, propSchema] of Object.entries(record.properties)) {
             nestedTypes.push(...findNestedTypesInSchema(propSchema, parentTypeName, defNames, [...currentPath, propName]));
@@ -261,10 +305,10 @@ const findNestedTypesInSchema = (schema, parentTypeName, defNames, currentPath =
         }
     }
     if (record.items) {
-        nestedTypes.push(...findNestedTypesInSchema(record.items, parentTypeName, defNames, currentPath));
+        nestedTypes.push(...findNestedTypesInSchema(record.items, parentTypeName, defNames, [...currentPath, "items"]));
     }
     if (record.additionalProperties && typeof record.additionalProperties === "object") {
-        nestedTypes.push(...findNestedTypesInSchema(record.additionalProperties, parentTypeName, defNames, currentPath));
+        nestedTypes.push(...findNestedTypesInSchema(record.additionalProperties, parentTypeName, defNames, [...currentPath, "additionalProperties"]));
     }
     return nestedTypes;
 };
@@ -285,23 +329,33 @@ const generateNestedTypesFile = (nestedTypes) => {
         }
         byParent.get(info.parentType).push(info);
     }
-    const imports = new Set();
+    const imports = new Map(); // file -> type name
     for (const info of nestedTypes) {
-        imports.add(info.file);
+        if (!imports.has(info.file)) {
+            imports.set(info.file, info.parentType);
+        }
     }
-    for (const file of [...imports].sort()) {
-        const typeName = file === "workflow" ? "Workflow" : toPascalCase(file);
+    for (const [file, typeName] of [...imports.entries()].sort()) {
         lines.push(`import type { ${typeName} } from './${file}.schema.js';`);
     }
     lines.push("");
+    const buildAccessExpr = (parentType, propertyPath) => {
+        let accessExpr = parentType;
+        for (const prop of propertyPath) {
+            const accessor = prop === "items"
+                ? "[number]"
+                : typeof prop === "number"
+                    ? `[${prop}]`
+                    : `[${JSON.stringify(prop)}]`;
+            accessExpr = `NonNullable<${accessExpr}${accessor}>`;
+        }
+        return accessExpr;
+    };
     for (const [parentType, types] of [...byParent.entries()].sort()) {
         lines.push(`// From ${parentType}`);
         for (const info of types.sort((a, b) => a.typeName.localeCompare(b.typeName))) {
             if (info.propertyPath.length > 0) {
-                let accessExpr = parentType;
-                for (const prop of info.propertyPath) {
-                    accessExpr = `NonNullable<${accessExpr}['${prop}']>`;
-                }
+                const accessExpr = buildAccessExpr(parentType, info.propertyPath);
                 lines.push(`export type ${info.typeName} = ${accessExpr};`);
             }
         }

package/dist/cjs/index.js

@@ -15,6 +15,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Types.js"), exports);
+__exportStar(require("./core/analyzeSchema.js"), exports);
+__exportStar(require("./core/emitZod.js"), exports);
 __exportStar(require("./generators/generateBundle.js"), exports);
 __exportStar(require("./jsonSchemaToZod.js"), exports);
 __exportStar(require("./parsers/parseAllOf.js"), exports);
@@ -36,10 +38,12 @@ __exportStar(require("./parsers/parseSchema.js"), exports);
 __exportStar(require("./parsers/parseSimpleDiscriminatedOneOf.js"), exports);
 __exportStar(require("./parsers/parseString.js"), exports);
 __exportStar(require("./utils/anyOrUnknown.js"), exports);
+__exportStar(require("./utils/buildRefRegistry.js"), exports);
 __exportStar(require("./utils/cycles.js"), exports);
 __exportStar(require("./utils/half.js"), exports);
 __exportStar(require("./utils/jsdocs.js"), exports);
 __exportStar(require("./utils/omit.js"), exports);
+__exportStar(require("./utils/resolveUri.js"), exports);
 __exportStar(require("./utils/withMessage.js"), exports);
 __exportStar(require("./zodToJsonSchema.js"), exports);
 const jsonSchemaToZod_js_1 = require("./jsonSchemaToZod.js");