@kravc/schema 2.8.0-alpha.6 → 2.8.0-alpha.8

package/dist/helpers/cleanupAttributes.js

@@ -5,36 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = require("lodash");
 const got_1 = __importDefault(require("./got"));
-/**
- * Removes properties from an object that are not defined in the JSON schema.
- *
- * **Intent:**
- * This function ensures that objects conform to their schema definition by removing
- * any properties that are not explicitly defined in the schema. It performs a deep
- * cleanup, recursively processing nested objects, arrays, and schema references.
- *
- * **Use Cases:**
- * - **Third-party API integrations**: When integrating with external services (e.g., Telegram)
- *   that may send additional fields you don't want to process, this function allows you
- *   to define a minimal schema and automatically strip unwanted properties.
- * - **Data sanitization**: Clean up objects received from external sources or user input
- *   before validation or processing, ensuring only expected fields are present.
- * - **Schema enforcement**: Enforce strict schema compliance by removing any properties
- *   that don't match the defined schema structure.
- * - **Pre-validation cleanup**: Remove extraneous properties before schema validation to
- *   prevent validation errors from unexpected fields.
- *
- * **Behavior:**
- * - Mutates the input object in-place (does not return a new object)
- * - Recursively processes nested objects, arrays, and schema references ($ref)
- * - Skips enum schemas (returns early without modification)
- * - Only processes object values (skips null, undefined, and primitive values)
- * - Handles array items by cleaning each object item according to the array's item schema
- *
- * @param object - The target object to clean up (mutated in-place)
- * @param jsonSchema - The JSON schema defining allowed properties
- * @param schemasMap - Optional map of schema IDs to schema definitions for resolving $ref references
- */
+/** Removes properties from an object that are not defined in the JSON schema. */
 const cleanupAttributes = (object, jsonSchema, schemasMap = {}) => {
     const { enum: enumItems } = jsonSchema;
     const isEnum = !!enumItems;

package/dist/helpers/cleanupAttributes.js.map

@@ -1 +1 @@
-{"version":3,"file":"cleanupAttributes.js","sourceRoot":"","sources":["../../src/helpers/cleanupAttributes.ts"],"names":[],"mappings":";;;;;AAAA,mCAAqC;AAErC,gDAAwB;AAYxB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,iBAAiB,GAAG,CACxB,MAAoB,EACpB,UAAsB,EACtB,aAA6B,EAAE,EAC/B,EAAE;IACF,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAI,UAAyB,CAAC;IAEvD,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,CAAC;IAE3B,IAAI,MAAM,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAI,UAA2B,CAAC;IAElD,qDAAqD;IACrD,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,KAAK,MAAM,SAAS,IAAI,MAAM,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAEpD,MAAM,mBAAmB,GAAG,IAAA,oBAAW,EAAC,QAAQ,CAAC,CAAC;QAElD,IAAI,mBAAmB,EAAE,CAAC;YACxB,yEAAyE;YACzE,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACzB,SAAS;QACX,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAI,QAAoC,CAAC;QAEpE,MAAM,WAAW,GAAG,CAAC,IAAA,oBAAW,EAAC,WAAW,CAAC,CAAC;QAE9C,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,eAAe,GAAG,IAAA,aAAG,EAAC,UAAU,EAAE,WAAW,EAAE,0BAA0B,CAAC,CAAC;YACjF,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YAErC,yFAAyF;YACzF,IAAI,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC/E,iBAAiB,CAAC,UAA0B,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;YAC7E,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAI,QAAuD,CAAC;QAE1E,MAAM,QAAQ,GAAG,IAAI,KAAK,QAAQ,CAAC;QAEnC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAI,QAAiC,CAAC;YAE/D,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YAErC,MAAM,aAAa,GAAG,UAAU;gBAC9B,OAAO,UAAU,KAAK,QAAQ;gBAC9B,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE7B,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,gBAAgB,GAAG;oBACvB,EAAE,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,SAAS,aAAa;oBAChD,UAAU;iBACX,CAAC;gBAEF,iBAAiB,CAAC,UAA0B,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;YAC9E,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,KAAK,OAAO,CAAC;QAEjC,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,EAAE,KAAK,EAAE,GAAI,QAAgC,CAAC;YAEpD,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE/C,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;gBAC1B,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,GAAI,KAAiC,CAAC;gBAErE,MAAM,EAAE,UAAU,EAAE,oBAAoB,GAAG,EAAE,EAAE,GAAI,KAA8B,CAAC;gBAElF,MAAM,eAAe,GAAG,CAAC,IAAA,oBAAW,EAAC,eAAe,CAAC,CAAC;gBAEtD,MAAM,UAAU,GAAG,eAAe;oBAChC,CAAC,CAAC,IAAA,aAAG,EAAC,UAAU,EAAE,eAAe,EAAE,0BAA0B,CAAC;oBAC9D,CAAC,CAAC;wBACA,EAAE,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,SAAS,mBAAmB;wBACtD,UAAU,EAAE,oBAAoB;qBACjC,CAAC;gBAEJ,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,YAAY,GAAG,IAAI;wBACvB,OAAO,IAAI,KAAK,QAAQ;wBACxB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAEvB,IAAI,YAAY,EAAE,CAAC;wBACjB,iBAAiB,CAAC,IAAoB,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;oBAClE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}
+{"version":3,"file":"cleanupAttributes.js","sourceRoot":"","sources":["../../src/helpers/cleanupAttributes.ts"],"names":[],"mappings":";;;;;AAAA,mCAAqC;AAGrC,gDAAwB;AAExB,iFAAiF;AACjF,MAAM,iBAAiB,GAAG,CACxB,MAAoB,EACpB,UAAsB,EACtB,aAAyC,EAAE,EAC3C,EAAE;IACF,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAI,UAAyB,CAAC;IAEvD,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,CAAC;IAE3B,IAAI,MAAM,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAAI,UAA2B,CAAC;IAElD,qDAAqD;IACrD,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,CAAC;QAC7B,OAAO;IACT,CAAC;IAED,KAAK,MAAM,SAAS,IAAI,MAAM,EAAE,CAAC;QAC/B,MAAM,QAAQ,GAAG,YAAY,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAEpD,MAAM,mBAAmB,GAAG,IAAA,oBAAW,EAAC,QAAQ,CAAC,CAAC;QAElD,IAAI,mBAAmB,EAAE,CAAC;YACxB,yEAAyE;YACzE,OAAO,MAAM,CAAC,SAAS,CAAC,CAAC;YACzB,SAAS;QACX,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,GAAI,QAAoC,CAAC;QAEpE,MAAM,WAAW,GAAG,CAAC,IAAA,oBAAW,EAAC,WAAW,CAAC,CAAC;QAE9C,IAAI,WAAW,EAAE,CAAC;YAChB,MAAM,eAAe,GAAG,IAAA,aAAG,EAAC,UAAU,EAAE,WAAW,EAAE,0BAA0B,CAAC,CAAC;YACjF,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YAErC,yFAAyF;YACzF,IAAI,UAAU,IAAI,OAAO,UAAU,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC/E,iBAAiB,CAAC,UAA0B,EAAE,eAAe,EAAE,UAAU,CAAC,CAAC;YAC7E,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAI,QAAuD,CAAC;QAE1E,MAAM,QAAQ,GAAG,IAAI,KAAK,QAAQ,CAAC;QAEnC,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,EAAE,UAAU,GAAG,EAAE,EAAE,GAAI,QAAiC,CAAC;YAE/D,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YAErC,MAAM,aAAa,GAAG,UAAU;gBAC9B,OAAO,UAAU,KAAK,QAAQ;gBAC9B,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE7B,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,gBAAgB,GAAG;oBACvB,EAAE,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,SAAS,aAAa;oBAChD,UAAU;iBACG,CAAC;gBAEhB,iBAAiB,CAAC,UAA0B,EAAE,gBAAgB,EAAE,UAAU,CAAC,CAAC;YAC9E,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,KAAK,OAAO,CAAC;QAEjC,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,EAAE,KAAK,EAAE,GAAI,QAAgC,CAAC;YAEpD,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC;YACrC,MAAM,YAAY,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAE/C,IAAI,YAAY,IAAI,KAAK,EAAE,CAAC;gBAC1B,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,GAAI,KAAiC,CAAC;gBAErE,MAAM,EAAE,UAAU,EAAE,oBAAoB,GAAG,EAAE,EAAE,GAAI,KAA8B,CAAC;gBAElF,MAAM,eAAe,GAAG,CAAC,IAAA,oBAAW,EAAC,eAAe,CAAC,CAAC;gBAEtD,MAAM,UAAU,GAAG,eAAe;oBAChC,CAAC,CAAC,IAAA,aAAG,EAAC,UAAU,EAAE,eAAe,EAAE,0BAA0B,CAAC;oBAC9D,CAAC,CAAC;wBACA,EAAE,EAAE,GAAG,YAAY,CAAC,EAAE,IAAI,SAAS,mBAAmB;wBACtD,UAAU,EAAE,oBAAoB;qBACnB,CAAC;gBAElB,KAAK,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;oBAC9B,MAAM,YAAY,GAAG,IAAI;wBACvB,OAAO,IAAI,KAAK,QAAQ;wBACxB,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;oBAEvB,IAAI,YAAY,EAAE,CAAC;wBACjB,iBAAiB,CAAC,IAAoB,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;oBAClE,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,kBAAe,iBAAiB,CAAC"}

package/dist/helpers/cleanupNulls.d.ts

@@ -1,27 +1,3 @@
-/**
- * Returns a deep copy of the object with all null properties removed.
- *
- * This is the main exported function that creates a clone of the input object
- * and removes all null properties recursively before returning it.
- *
- * @param object - The object to clean (will be cloned, original is not modified)
- * @returns A new object with all null properties removed recursively
- *
- * @example
- * ```typescript
- * const dirty = {
- *   name: 'John',
- *   age: null,
- *   address: {
- *     street: 'Main St',
- *     zip: null
- *   }
- * };
- *
- * const clean = cleanupNulls(dirty);
- * // Result: { name: 'John', address: { street: 'Main St' } }
- * // Original 'dirty' object is unchanged
- * ```
- */
+/** Returns a deep copy of the object with all null properties removed. */
 export default function (object: Record<string, unknown>): Record<string, unknown>;
 //# sourceMappingURL=cleanupNulls.d.ts.map

package/dist/helpers/cleanupNulls.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cleanupNulls.d.ts","sourceRoot":"","sources":["../../src/helpers/cleanupNulls.ts"],"names":[],"mappings":"AA0EA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,CAAC,OAAO,WAAW,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,2BAMvD"}
+{"version":3,"file":"cleanupNulls.d.ts","sourceRoot":"","sources":["../../src/helpers/cleanupNulls.ts"],"names":[],"mappings":"AAqCA,0EAA0E;AAC1E,MAAM,CAAC,OAAO,WAAW,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,2BAMvD"}

package/dist/helpers/cleanupNulls.js

@@ -3,42 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = default_1;
 const lodash_1 = require("lodash");
 const { isArray } = Array;
-/**
- * Recursively removes null properties from an object.
- *
- * **Intent:**
- * This function provides a deep cleanup of objects by removing all properties
- * that have `null` values. It's designed to sanitize objects before validation,
- * storage, or transmission by eliminating explicitly null fields.
- *
- * **Use Cases:**
- * - **Pre-validation cleanup**: Remove null values before schema validation to
- *   prevent validation errors from optional fields that were explicitly set to null.
- *   This is particularly useful when `shouldCleanupNulls` is enabled in the Validator,
- *   allowing you to clean objects before `cleanupAttributes` removes undefined properties.
- * - **Data sanitization**: Clean objects received from external sources (APIs, user input,
- *   databases) by removing null properties that may have been set during data transformation
- *   or migration processes.
- * - **API response normalization**: Prepare objects for API responses by removing null fields,
- *   reducing payload size and ensuring consistent data structures across different endpoints.
- * - **Database operations**: Clean objects before database storage or updates, removing
- *   null fields that might cause issues with database constraints or indexing.
- * - **JSON serialization optimization**: Reduce JSON payload size by removing null properties
- *   before serialization, which is especially beneficial for large objects or high-frequency
- *   API calls.
- * - **Optional field handling**: Remove explicitly null optional fields that weren't provided
- *   by the user, distinguishing between "field not provided" (undefined) and "field set to null".
- *
- * **Behavior:**
- * - Returns a deep clone of the input object (does not mutate the original)
- * - Recursively processes nested objects and arrays at all depth levels
- * - Only removes properties with `null` values (preserves `undefined`, `0`, `false`, `''`, etc.)
- * - Skips non-object values (returns early for primitives)
- * - Handles arrays by recursively processing each item
- * - Preserves object structure and non-null values exactly as they are
- *
- * @param target - The target object to clean (processed recursively, not mutated)
- */
+/** Recursively removes null properties from an object. */
 const cleanupNulls = (target) => {
     const shouldSkip = !(0, lodash_1.isObject)(target);
     if (shouldSkip) {
@@ -62,31 +27,7 @@ const cleanupNulls = (target) => {
         }
     }
 };
-/**
- * Returns a deep copy of the object with all null properties removed.
- *
- * This is the main exported function that creates a clone of the input object
- * and removes all null properties recursively before returning it.
- *
- * @param object - The object to clean (will be cloned, original is not modified)
- * @returns A new object with all null properties removed recursively
- *
- * @example
- * ```typescript
- * const dirty = {
- *   name: 'John',
- *   age: null,
- *   address: {
- *     street: 'Main St',
- *     zip: null
- *   }
- * };
- *
- * const clean = cleanupNulls(dirty);
- * // Result: { name: 'John', address: { street: 'Main St' } }
- * // Original 'dirty' object is unchanged
- * ```
- */
+/** Returns a deep copy of the object with all null properties removed. */
 function default_1(object) {
     const clone = (0, lodash_1.cloneDeep)(object);
     cleanupNulls(clone);

package/dist/helpers/cleanupNulls.js.map

@@ -1 +1 @@
-{"version":3,"file":"cleanupNulls.js","sourceRoot":"","sources":["../../src/helpers/cleanupNulls.ts"],"names":[],"mappings":";;AAmGA,4BAMC;AAzGD,mCAA6C;AAI7C,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;AAE1B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,MAAM,YAAY,GAAG,CAAC,MAAoB,EAAE,EAAE;IAC5C,MAAM,UAAU,GAAG,CAAC,IAAA,iBAAQ,EAAC,MAAM,CAAC,CAAC;IAErC,IAAI,UAAU,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAE1B,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,YAAY,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC;YAED,SAAS;QACX,CAAC;QAED,IAAI,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YACpB,YAAY,CAAC,KAAgC,CAAC,CAAC;YAE/C,SAAS;QACX,CAAC;QAED,MAAM,MAAM,GAAG,KAAK,KAAK,IAAI,CAAC;QAE9B,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,mBAAyB,MAA+B;IACtD,MAAM,KAAK,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;IAEhC,YAAY,CAAC,KAAK,CAAC,CAAC;IAEpB,OAAO,KAAK,CAAC;AACf,CAAC;AAAA,CAAC"}
+{"version":3,"file":"cleanupNulls.js","sourceRoot":"","sources":["../../src/helpers/cleanupNulls.ts"],"names":[],"mappings":";;AAsCA,4BAMC;AA5CD,mCAA6C;AAE7C,MAAM,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC;AAE1B,0DAA0D;AAC1D,MAAM,YAAY,GAAG,CAAC,MAAoB,EAAE,EAAE;IAC5C,MAAM,UAAU,GAAG,CAAC,IAAA,iBAAQ,EAAC,MAAM,CAAC,CAAC;IAErC,IAAI,UAAU,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IAED,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;QACzB,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAE1B,IAAI,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YACnB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,YAAY,CAAC,IAAI,CAAC,CAAC;YACrB,CAAC;YAED,SAAS;QACX,CAAC;QAED,IAAI,IAAA,iBAAQ,EAAC,KAAK,CAAC,EAAE,CAAC;YACpB,YAAY,CAAC,KAAgC,CAAC,CAAC;YAE/C,SAAS;QACX,CAAC;QAED,MAAM,MAAM,GAAG,KAAK,KAAK,IAAI,CAAC;QAE9B,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;AACH,CAAC,CAAC;AAEF,0EAA0E;AAC1E,mBAAyB,MAA+B;IACtD,MAAM,KAAK,GAAG,IAAA,kBAAS,EAAC,MAAM,CAAC,CAAC;IAEhC,YAAY,CAAC,KAAK,CAAC,CAAC;IAEpB,OAAO,KAAK,CAAC;AACf,CAAC;AAAA,CAAC"}

package/dist/helpers/createSchemasMap.d.ts

@@ -1,98 +1,7 @@
 import Schema from '../Schema';
-/**
- * Reads schema source from YAML file and returns a Schema instance.
- *
- * **Intent:** Load and parse a single YAML schema file, extracting the schema ID
- * from the filename and creating a Schema instance for use in validation or
- * schema composition.
- *
- * **Use Cases:**
- * - Load individual schema files during application startup
- * - Parse YAML schema definitions into Schema instances
- * - Extract schema identifiers from file paths automatically
- * - Support both enum and properties-based schemas from YAML files
- *
- * @param yamlPath - Absolute or relative path to the YAML schema file
- * @returns A Schema instance with ID extracted from the filename (without .yaml extension)
- *
- * **Example:**
- * ```typescript
- * const schema = loadSync('/path/to/schemas/User.yaml');
- * // schema.id === 'User'
- * // schema.source contains the parsed YAML content
- * ```
- *
- * **Example - Enum Schema:**
- * ```typescript
- * const statusSchema = loadSync('/path/to/schemas/Status.yaml');
- * // If Status.yaml contains: { enum: ['PENDING', 'ACTIVE'] }
- * // statusSchema.isEnum === true
- * ```
- */
+/** Reads schema source from YAML file and returns a Schema instance. */
 export declare const loadSync: (yamlPath: string) => Schema;
-/**
- * Creates a map of schemas by ID, loading from YAML files and merging with programmatic schemas.
- *
- * **Intent:** Build a centralized schema registry that combines file-based YAML schemas
- * with programmatically created Schema instances, providing a unified lookup mechanism
- * by schema ID. This enables hybrid schema management where some schemas are defined
- * in YAML files while others are created dynamically in code.
- *
- * **Use Cases:**
- * - Initialize schema registries for validators from both files and code
- * - Support schema composition where base schemas come from files and extended
- *   schemas are created programmatically
- * - Enable schema overriding where programmatic schemas can replace file-based ones
- * - Build schema maps for credential factories or API validation systems
- * - Support development workflows where schemas evolve from YAML to code
- *
- * @param servicePath - Path to directory containing YAML schema files (searched recursively)
- * @param modules - Array of Schema instances or other values (non-Schema values are filtered out)
- * @returns Record mapping schema IDs to Schema instances, with modules schemas overriding YAML schemas
- *
- * **Example - Basic Usage:**
- * ```typescript
- * const schemasMap = createSchemasMap('/path/to/examples/schemas', []);
- * // Returns: {
- * //   FavoriteItem: Schema { id: 'FavoriteItem', ... },
- * //   Profile: Schema { id: 'Profile', ... },
- * //   Status: Schema { id: 'Status', ... },
- * //   Preferences: Schema { id: 'Preferences', ... }
- * // }
- * ```
- *
- * **Example - Merging Programmatic Schemas:**
- * ```typescript
- * const customSchema = new Schema(
- *   { customField: { type: 'string' } },
- *   'CustomSchema'
- * );
- * const schemasMap = createSchemasMap('/path/to/schemas', [customSchema]);
- * // schemasMap contains both YAML schemas and CustomSchema
- * ```
- *
- * **Example - Overriding YAML Schemas:**
- * ```typescript
- * const updatedProfile = new Schema(
- *   { name: { type: 'string' }, newField: { type: 'number' } },
- *   'Profile'
- * );
- * const schemasMap = createSchemasMap('/path/to/schemas', [updatedProfile]);
- * // schemasMap.Profile is the updatedProfile instance, not the YAML version
- * ```
- *
- * **Example - Filtering Non-Schema Values:**
- * ```typescript
- * const schema = new Schema({ field: { type: 'string' } }, 'Test');
- * const schemasMap = createSchemasMap('/path/to/schemas', [
- *   schema,
- *   'not a schema',
- *   { id: 'fake' },
- *   null
- * ]);
- * // Only the Schema instance is included, other values are ignored
- * ```
- */
+/** Creates a map of schemas by ID, loading from YAML files and merging with programmatic schemas. */
 declare const createSchemasMap: (servicePath: string, modules: unknown[]) => Record<string, Schema>;
 export default createSchemasMap;
 //# sourceMappingURL=createSchemasMap.d.ts.map

package/dist/helpers/createSchemasMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createSchemasMap.d.ts","sourceRoot":"","sources":["../../src/helpers/createSchemasMap.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,WAAW,CAAC;AAM/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,eAAO,MAAM,QAAQ,GAAI,UAAU,MAAM,WAUxC,CAAC;AAuFF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,QAAA,MAAM,gBAAgB,GAAI,aAAa,MAAM,EAAE,SAAS,OAAO,EAAE,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAYxF,CAAC;AAEF,eAAe,gBAAgB,CAAC"}
+{"version":3,"file":"createSchemasMap.d.ts","sourceRoot":"","sources":["../../src/helpers/createSchemasMap.ts"],"names":[],"mappings":"AACA,OAAO,MAAM,MAAM,WAAW,CAAC;AAK/B,wEAAwE;AACxE,eAAO,MAAM,QAAQ,GAAI,UAAU,MAAM,WAUxC,CAAC;AAoBF,qGAAqG;AACrG,QAAA,MAAM,gBAAgB,GAAI,aAAa,MAAM,EAAE,SAAS,OAAO,EAAE,KAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAYxF,CAAC;AAEF,eAAe,gBAAgB,CAAC"}

package/dist/helpers/createSchemasMap.js

@@ -9,36 +9,7 @@ const Schema_1 = __importDefault(require("../Schema"));
 const js_yaml_1 = require("js-yaml");
 const lodash_1 = require("lodash");
 const fs_1 = require("fs");
-/**
- * Reads schema source from YAML file and returns a Schema instance.
- *
- * **Intent:** Load and parse a single YAML schema file, extracting the schema ID
- * from the filename and creating a Schema instance for use in validation or
- * schema composition.
- *
- * **Use Cases:**
- * - Load individual schema files during application startup
- * - Parse YAML schema definitions into Schema instances
- * - Extract schema identifiers from file paths automatically
- * - Support both enum and properties-based schemas from YAML files
- *
- * @param yamlPath - Absolute or relative path to the YAML schema file
- * @returns A Schema instance with ID extracted from the filename (without .yaml extension)
- *
- * **Example:**
- * ```typescript
- * const schema = loadSync('/path/to/schemas/User.yaml');
- * // schema.id === 'User'
- * // schema.source contains the parsed YAML content
- * ```
- *
- * **Example - Enum Schema:**
- * ```typescript
- * const statusSchema = loadSync('/path/to/schemas/Status.yaml');
- * // If Status.yaml contains: { enum: ['PENDING', 'ACTIVE'] }
- * // statusSchema.isEnum === true
- * ```
- */
+/** Reads schema source from YAML file and returns a Schema instance. */
 const loadSync = (yamlPath) => {
     const schemaId = yamlPath
         .split('/')
@@ -49,145 +20,16 @@ const loadSync = (yamlPath) => {
     return new Schema_1.default(source, schemaId);
 };
 exports.loadSync = loadSync;
-/**
- * Recursively lists all files in a directory and its subdirectories.
- *
- * **Intent:** Traverse a directory tree and collect all file paths, enabling
- * discovery of schema files nested in subdirectories without manual path specification.
- *
- * **Use Cases:**
- * - Find all schema files in a directory structure
- * - Support organized schema layouts with nested folders
- * - Enable schema discovery without hardcoding file paths
- * - Prepare file list for filtering and processing
- *
- * @param servicePath - Path to the directory to traverse
- * @returns Array of absolute file paths found in the directory tree
- *
- * **Example:**
- * ```typescript
- * const files = listFilesSync('/path/to/schemas');
- * // Returns: [
- * //   '/path/to/schemas/User.yaml',
- * //   '/path/to/schemas/nested/Profile.yaml',
- * //   '/path/to/schemas/nested/deep/Status.yaml'
- * // ]
- * ```
- *
- * **Example - Flat Directory:**
- * ```typescript
- * const files = listFilesSync('/path/to/schemas');
- * // Returns: [
- * //   '/path/to/schemas/User.yaml',
- * //   '/path/to/schemas/Profile.yaml'
- * // ]
- * ```
- */
+/** Recursively lists all files in a directory and its subdirectories. */
 const listFilesSync = (servicePath) => (0, fs_1.readdirSync)(servicePath)
     .reduce((filePaths, fileName) => (0, fs_1.statSync)(path_1.default.join(servicePath, fileName)).isDirectory() ?
     filePaths.concat(listFilesSync(path_1.default.join(servicePath, fileName))) :
     filePaths.concat(path_1.default.join(servicePath, fileName)), []);
-/**
- * Reads all YAML schema files from a directory and creates Schema instances.
- *
- * **Intent:** Bulk load schema definitions from YAML files in a directory,
- * automatically discovering and parsing all schema files for use in schema
- * registries or validators.
- *
- * **Use Cases:**
- * - Load all schemas from a schemas directory at application startup
- * - Initialize schema registries from file-based definitions
- * - Support schema-as-code workflows where schemas are stored as YAML files
- * - Enable automatic schema discovery without manual registration
- *
- * @param servicePath - Path to the directory containing YAML schema files
- * @returns Array of Schema instances, one for each YAML file found
- *
- * **Example:**
- * ```typescript
- * const schemas = readSchemasSync('/path/to/examples/schemas');
- * // Returns: [
- * //   Schema { id: 'FavoriteItem', ... },
- * //   Schema { id: 'Profile', ... },
- * //   Schema { id: 'Status', ... },
- * //   Schema { id: 'Preferences', ... }
- * // ]
- * ```
- *
- * **Example - With Nested Directories:**
- * ```typescript
- * const schemas = readSchemasSync('/path/to/schemas');
- * // Automatically finds schemas in subdirectories:
- * // - /path/to/schemas/User.yaml
- * // - /path/to/schemas/nested/Profile.yaml
- * ```
- */
+/** Reads all YAML schema files from a directory and creates Schema instances. */
 const readSchemasSync = (servicePath) => listFilesSync(servicePath)
     .filter((fileName) => fileName.endsWith('.yaml'))
     .map((schemaPath) => (0, exports.loadSync)(schemaPath));
-/**
- * Creates a map of schemas by ID, loading from YAML files and merging with programmatic schemas.
- *
- * **Intent:** Build a centralized schema registry that combines file-based YAML schemas
- * with programmatically created Schema instances, providing a unified lookup mechanism
- * by schema ID. This enables hybrid schema management where some schemas are defined
- * in YAML files while others are created dynamically in code.
- *
- * **Use Cases:**
- * - Initialize schema registries for validators from both files and code
- * - Support schema composition where base schemas come from files and extended
- *   schemas are created programmatically
- * - Enable schema overriding where programmatic schemas can replace file-based ones
- * - Build schema maps for credential factories or API validation systems
- * - Support development workflows where schemas evolve from YAML to code
- *
- * @param servicePath - Path to directory containing YAML schema files (searched recursively)
- * @param modules - Array of Schema instances or other values (non-Schema values are filtered out)
- * @returns Record mapping schema IDs to Schema instances, with modules schemas overriding YAML schemas
- *
- * **Example - Basic Usage:**
- * ```typescript
- * const schemasMap = createSchemasMap('/path/to/examples/schemas', []);
- * // Returns: {
- * //   FavoriteItem: Schema { id: 'FavoriteItem', ... },
- * //   Profile: Schema { id: 'Profile', ... },
- * //   Status: Schema { id: 'Status', ... },
- * //   Preferences: Schema { id: 'Preferences', ... }
- * // }
- * ```
- *
- * **Example - Merging Programmatic Schemas:**
- * ```typescript
- * const customSchema = new Schema(
- *   { customField: { type: 'string' } },
- *   'CustomSchema'
- * );
- * const schemasMap = createSchemasMap('/path/to/schemas', [customSchema]);
- * // schemasMap contains both YAML schemas and CustomSchema
- * ```
- *
- * **Example - Overriding YAML Schemas:**
- * ```typescript
- * const updatedProfile = new Schema(
- *   { name: { type: 'string' }, newField: { type: 'number' } },
- *   'Profile'
- * );
- * const schemasMap = createSchemasMap('/path/to/schemas', [updatedProfile]);
- * // schemasMap.Profile is the updatedProfile instance, not the YAML version
- * ```
- *
- * **Example - Filtering Non-Schema Values:**
- * ```typescript
- * const schema = new Schema({ field: { type: 'string' } }, 'Test');
- * const schemasMap = createSchemasMap('/path/to/schemas', [
- *   schema,
- *   'not a schema',
- *   { id: 'fake' },
- *   null
- * ]);
- * // Only the Schema instance is included, other values are ignored
- * ```
- */
+/** Creates a map of schemas by ID, loading from YAML files and merging with programmatic schemas. */
 const createSchemasMap = (servicePath, modules) => {
     const yamlSchemas = readSchemasSync(servicePath);
     const schemasMap = (0, lodash_1.keyBy)(yamlSchemas, 'id');

package/dist/helpers/createSchemasMap.js.map

@@ -1 +1 @@
-{"version":3,"file":"createSchemasMap.js","sourceRoot":"","sources":["../../src/helpers/createSchemasMap.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,uDAA+B;AAC/B,qCAA+B;AAC/B,mCAA+B;AAE/B,2BAAyD;AAEzD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACI,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC3C,MAAM,QAAQ,GAAG,QAAQ;SACtB,KAAK,CAAC,GAAG,CAAC;SACV,OAAO,EAAE,CAAC,CAAC,CAAC;SACZ,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAErB,MAAM,IAAI,GAAG,IAAA,iBAAY,EAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,IAAA,cAAI,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAkC,CAAC;IAEtE,OAAO,IAAI,gBAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC,CAAC;AAVW,QAAA,QAAQ,YAUnB;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,aAAa,GAAG,CAAC,WAAmB,EAAY,EAAE,CACtD,IAAA,gBAAW,EAAC,WAAW,CAAC;KACrB,MAAM,CACL,CAAC,SAAmB,EAAE,QAAgB,EAAE,EAAE,CACxC,IAAA,aAAQ,EACN,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/C,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,SAAS,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CACpD,EACH,EAAE,CAAC,CAAC;AAEV;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,eAAe,GAAG,CAAC,WAAmB,EAAE,EAAE,CAC9C,aAAa,CAAC,WAAW,CAAC;KACvB,MAAM,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACxD,GAAG,CAAC,CAAC,UAAkB,EAAE,EAAE,CAAC,IAAA,gBAAQ,EAAC,UAAU,CAAC,CAAC,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8DG;AACH,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAE,OAAkB,EAA0B,EAAE;IAC3F,MAAM,WAAW,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,IAAA,cAAK,EAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAE5C,MAAM,OAAO,GAAG,OAAO;SACpB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,YAAY,gBAAM,CAAC,CAAC;IAE9C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;IACjC,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}
+{"version":3,"file":"createSchemasMap.js","sourceRoot":"","sources":["../../src/helpers/createSchemasMap.ts"],"names":[],"mappings":";;;;;;AAAA,gDAAwB;AACxB,uDAA+B;AAC/B,qCAA+B;AAC/B,mCAA+B;AAC/B,2BAAyD;AAEzD,wEAAwE;AACjE,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAAE,EAAE;IAC3C,MAAM,QAAQ,GAAG,QAAQ;SACtB,KAAK,CAAC,GAAG,CAAC;SACV,OAAO,EAAE,CAAC,CAAC,CAAC;SACZ,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAErB,MAAM,IAAI,GAAG,IAAA,iBAAY,EAAC,QAAQ,CAAC,CAAC;IACpC,MAAM,MAAM,GAAG,IAAA,cAAI,EAAC,IAAI,CAAC,QAAQ,EAAE,CAAkC,CAAC;IAEtE,OAAO,IAAI,gBAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACtC,CAAC,CAAC;AAVW,QAAA,QAAQ,YAUnB;AAEF,yEAAyE;AACzE,MAAM,aAAa,GAAG,CAAC,WAAmB,EAAY,EAAE,CACtD,IAAA,gBAAW,EAAC,WAAW,CAAC;KACrB,MAAM,CACL,CAAC,SAAmB,EAAE,QAAgB,EAAE,EAAE,CACxC,IAAA,aAAQ,EACN,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/C,SAAS,CAAC,MAAM,CAAC,aAAa,CAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;IACnE,SAAS,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CACpD,EACH,EAAE,CAAC,CAAC;AAEV,iFAAiF;AACjF,MAAM,eAAe,GAAG,CAAC,WAAmB,EAAE,EAAE,CAC9C,aAAa,CAAC,WAAW,CAAC;KACvB,MAAM,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;KACxD,GAAG,CAAC,CAAC,UAAkB,EAAE,EAAE,CAAC,IAAA,gBAAQ,EAAC,UAAU,CAAC,CAAC,CAAC;AAEvD,qGAAqG;AACrG,MAAM,gBAAgB,GAAG,CAAC,WAAmB,EAAE,OAAkB,EAA0B,EAAE;IAC3F,MAAM,WAAW,GAAG,eAAe,CAAC,WAAW,CAAC,CAAC;IACjD,MAAM,UAAU,GAAG,IAAA,cAAK,EAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IAE5C,MAAM,OAAO,GAAG,OAAO;SACpB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,YAAY,gBAAM,CAAC,CAAC;IAE9C,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC;IACjC,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,kBAAe,gBAAgB,CAAC"}

package/dist/helpers/getReferenceIds.d.ts

@@ -1,169 +1,5 @@
 import Schema from '../Schema';
-/**
- * Recursively extracts all referenced schema IDs from a schema structure.
- *
- * **Intent:** Traverse a schema's entire structure (including nested objects and arrays)
- * to collect all schema IDs that are referenced via `$ref` properties. This enables
- * dependency resolution, schema bundling, and validation of schema completeness.
- *
- * **Use Cases:**
- * - **Dependency Resolution:** Identify all schemas that a given schema depends on,
- *   ensuring they are loaded before validation
- * - **Schema Bundling:** Collect all related schemas into a single bundle for
- *   distribution or storage
- * - **Validation Preparation:** Pre-load all referenced schemas to ensure complete
- *   validation context
- * - **Dependency Graph Building:** Understand the relationships and dependencies
- *   between schemas in a schema registry
- * - **Schema Analysis:** Analyze schema complexity by identifying all dependencies
- * - **Circular Reference Detection:** (Note: current implementation does not handle
- *   circular references and will recurse infinitely)
- *
- * **Behavior:**
- * - Returns an empty array for enum schemas (they don't reference other schemas)
- * - Recursively traverses nested object properties
- * - Handles array items that reference schemas or contain object properties
- * - Follows nested references to collect transitive dependencies
- * - Returns unique schema IDs (deduplicates if same schema is referenced multiple times)
- * - Throws an error if a referenced schema is not found in the schemasMap
- *
- * **Example - Simple Reference:**
- * ```typescript
- * const userSchema = new Schema({
- *   profile: { $ref: 'Profile' }
- * }, 'User');
- *
- * const profileSchema = new Schema({
- *   name: { type: 'string' }
- * }, 'Profile');
- *
- * const schemasMap = { 'Profile': profileSchema };
- * const referenceIds = getReferenceIds(userSchema, schemasMap);
- * // Returns: ['Profile']
- * ```
- *
- * **Example - Multiple References:**
- * ```typescript
- * const orderSchema = new Schema({
- *   customer: { $ref: 'Customer' },
- *   product: { $ref: 'Product' },
- *   shipping: { $ref: 'Address' }
- * }, 'Order');
- *
- * const schemasMap = {
- *   'Customer': customerSchema,
- *   'Product': productSchema,
- *   'Address': addressSchema
- * };
- * const referenceIds = getReferenceIds(orderSchema, schemasMap);
- * // Returns: ['Customer', 'Product', 'Address']
- * ```
- *
- * **Example - Nested References:**
- * ```typescript
- * const userSchema = new Schema({
- *   profile: { $ref: 'Profile' }
- * }, 'User');
- *
- * const profileSchema = new Schema({
- *   address: { $ref: 'Address' }
- * }, 'Profile');
- *
- * const addressSchema = new Schema({
- *   street: { type: 'string' }
- * }, 'Address');
- *
- * const schemasMap = {
- *   'Profile': profileSchema,
- *   'Address': addressSchema
- * };
- * const referenceIds = getReferenceIds(userSchema, schemasMap);
- * // Returns: ['Profile', 'Address'] (includes transitive dependencies)
- * ```
- *
- * **Example - Array with Reference Items:**
- * ```typescript
- * const orderSchema = new Schema({
- *   items: {
- *     type: 'array',
- *     items: { $ref: 'OrderItem' }
- *   }
- * }, 'Order');
- *
- * const schemasMap = { 'OrderItem': orderItemSchema };
- * const referenceIds = getReferenceIds(orderSchema, schemasMap);
- * // Returns: ['OrderItem']
- * ```
- *
- * **Example - Nested Object Properties:**
- * ```typescript
- * const userSchema = new Schema({
- *   contact: {
- *     type: 'object',
- *     properties: {
- *       address: { $ref: 'Address' }
- *     }
- *   }
- * }, 'User');
- *
- * const schemasMap = { 'Address': addressSchema };
- * const referenceIds = getReferenceIds(userSchema, schemasMap);
- * // Returns: ['Address']
- * ```
- *
- * **Example - Complex Mixed Structure:**
- * ```typescript
- * const orderSchema = new Schema({
- *   customer: { $ref: 'Customer' },
- *   items: {
- *     type: 'array',
- *     items: {
- *       type: 'object',
- *       properties: {
- *         product: { $ref: 'Product' }
- *       }
- *     }
- *   },
- *   shipping: {
- *     type: 'object',
- *     properties: {
- *       address: { $ref: 'Address' }
- *     }
- *   }
- * }, 'Order');
- *
- * const schemasMap = {
- *   'Customer': customerSchema,
- *   'Product': productSchema,
- *   'Address': addressSchema
- * };
- * const referenceIds = getReferenceIds(orderSchema, schemasMap);
- * // Returns: ['Customer', 'Product', 'Address']
- * ```
- *
- * **Example - Duplicate References:**
- * ```typescript
- * const schema = new Schema({
- *   field1: { $ref: 'SharedSchema' },
- *   field2: { $ref: 'SharedSchema' }
- * }, 'Test');
- *
- * const schemasMap = { 'SharedSchema': sharedSchema };
- * const referenceIds = getReferenceIds(schema, schemasMap);
- * // Returns: ['SharedSchema'] (deduplicated)
- * ```
- *
- * @param schema - The schema to extract references from
- * @param schemasMap - A map of schema IDs to Schema instances, used to resolve
- *   referenced schemas and traverse nested references
- * @returns An array of unique schema IDs that are referenced (directly or indirectly)
- *   by the given schema
- * @throws Error if a referenced schema is not found in the schemasMap
- *
- * **Limitations:**
- * - Does not handle circular references (will cause infinite recursion)
- * - Requires all referenced schemas to be present in schemasMap
- */
+/** Recursively extracts all referenced schema IDs from a schema structure. */
 declare const getReferenceIds: (schema: Schema, schemasMap: Record<string, Schema>) => string[];
 export default getReferenceIds;
 //# sourceMappingURL=getReferenceIds.d.ts.map

package/dist/helpers/getReferenceIds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getReferenceIds.d.ts","sourceRoot":"","sources":["../../src/helpers/getReferenceIds.ts"],"names":[],"mappings":"AAEA,OAAO,MAAM,MAAM,WAAW,CAAC;AAU/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoKG;AACH,QAAA,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,YAAY,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAAM,EA6FnF,CAAC;AAEF,eAAe,eAAe,CAAC"}
+{"version":3,"file":"getReferenceIds.d.ts","sourceRoot":"","sources":["../../src/helpers/getReferenceIds.ts"],"names":[],"mappings":"AAGA,OAAO,MAAM,MAAM,WAAW,CAAC;AAE/B,8EAA8E;AAC9E,QAAA,MAAM,eAAe,GAAI,QAAQ,MAAM,EAAE,YAAY,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAG,MAAM,EA6FnF,CAAC;AAEF,eAAe,eAAe,CAAC"}