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

package/src/helpers/__tests__/normalizeProperties.test.ts

@@ -1,5 +1,7 @@
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../../types.d.ts" />
+
 import normalizeProperties from '../normalizeProperties';
-import type { EnumSchema, PropertiesSchema } from '../JsonSchema';
 
 describe('normalizeProperties(schema)', () => {
   describe('enum schema', () => {

package/src/helpers/__tests__/normalizeRequired.test.ts

@@ -1,13 +1,8 @@
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../../types.d.ts" />
+
 import { get } from 'lodash';
 import normalizeRequired from '../normalizeRequired';
-import type {
-  EnumSchema,
-  ObjectSchema,
-  ObjectPropertySchema,
-  ArrayPropertySchema,
-  ReferencePropertySchema,
-  PropertySchema,
-} from '../JsonSchema';
 
 describe('normalizeRequired(schema)', () => {
   describe('basic functionality', () => {
@@ -572,7 +567,7 @@ describe('normalizeRequired(schema)', () => {
       expect(schema.required).toEqual(['refField', 'normalField']);
       expect(schema.properties.refField.required).toBeUndefined(); // Removed after normalization
       expect(schema.properties.refField['x-required']).toBe(true); // x-required flag set
-      
+
       // Normal field should be processed
       expect(schema.properties.normalField['x-required']).toBe(true);
       expect(schema.properties.normalField.required).toBeUndefined();

package/src/helpers/__tests__/nullifyEmptyValues.test.ts

@@ -1,6 +1,5 @@
 import nullifyEmptyValues from '../nullifyEmptyValues';
-import { schemaSymbol, jsonSymbol } from 'z-schema';
-import type { SchemaErrorDetail } from 'z-schema';
+import ZSchema, { type SchemaErrorDetail } from 'z-schema';
 
 describe('nullifyEmptyValues(object, validationErrors)', () => {
   // eslint-disable-next-line jsdoc/require-jsdoc
@@ -19,9 +18,9 @@ describe('nullifyEmptyValues(object, validationErrors)', () => {
       inner: [],
     } as SchemaErrorDetail;
 
-    // Attach symbols to the error object
-    (error as SchemaErrorDetail)[schemaSymbol] = schema;
-    (error as SchemaErrorDetail)[jsonSymbol] = json;
+    // Attach symbols to the error object (z-schema v9: symbols are on ZSchema class)
+    (error as SchemaErrorDetail)[ZSchema.schemaSymbol] = schema;
+    (error as SchemaErrorDetail)[ZSchema.jsonSymbol] = json;
 
     return error;
   };
@@ -355,6 +354,38 @@ describe('nullifyEmptyValues(object, validationErrors)', () => {
       expect(remainingErrors).toHaveLength(0);
     });
 
+    it('should handle path as array (z-schema reportPathAsArray format)', () => {
+      const object = { field: '', items: ['', 'value'] };
+      const error1 = {
+        code: 'PATTERN',
+        path: ['field'],
+        message: 'Error at field',
+        params: [],
+        inner: [],
+      } as SchemaErrorDetail;
+      (error1 as SchemaErrorDetail)[ZSchema.schemaSymbol] = {};
+      (error1 as SchemaErrorDetail)[ZSchema.jsonSymbol] = object;
+
+      const error2 = {
+        code: 'ENUM_MISMATCH',
+        path: ['items', 0],
+        message: 'Error at items/0',
+        params: [],
+        inner: [],
+      } as SchemaErrorDetail;
+      (error2 as SchemaErrorDetail)[ZSchema.schemaSymbol] = {};
+      (error2 as SchemaErrorDetail)[ZSchema.jsonSymbol] = object;
+
+      const validationErrors = [error1, error2];
+
+      const [result, remainingErrors] = nullifyEmptyValues(object, validationErrors);
+
+      expect(result.field).toBeNull();
+      expect(result.items[0]).toBeNull();
+      expect(result.items[1]).toBe('value');
+      expect(remainingErrors).toHaveLength(0);
+    });
+
     it('should preserve other object properties', () => {
       const object = {
         emptyField: '',
@@ -527,7 +558,7 @@ describe('nullifyEmptyValues(object, validationErrors)', () => {
       } as SchemaErrorDetail;
 
       // Don't attach schemaSymbol
-      (error as SchemaErrorDetail)[jsonSymbol] = object;
+      (error as SchemaErrorDetail)[ZSchema.jsonSymbol] = object;
       const validationErrors = [error];
 
       const [result, remainingErrors] = nullifyEmptyValues(object, validationErrors);
@@ -548,15 +579,15 @@ describe('nullifyEmptyValues(object, validationErrors)', () => {
         inner: [],
       } as SchemaErrorDetail;
 
-      // Don't attach jsonSymbol
-      (error as SchemaErrorDetail)[schemaSymbol] = {};
+      // Don't attach jsonSymbol - falls back to object for value lookup
+      (error as SchemaErrorDetail)[ZSchema.schemaSymbol] = {};
       const validationErrors = [error];
 
-      const [, remainingErrors] = nullifyEmptyValues(object, validationErrors);
+      const [result, remainingErrors] = nullifyEmptyValues(object, validationErrors);
 
-      // Missing json symbol means value is undefined, should not nullify
-      expect(remainingErrors).toHaveLength(1);
-      expect(remainingErrors[0]).toBe(error);
+      // When json is missing, falls back to object; empty string is nullified
+      expect(result.field).toBeNull();
+      expect(remainingErrors).toHaveLength(0);
     });
 
     it('should handle all format error codes together', () => {

package/src/helpers/__tests__/removeRequiredAndDefault.test.ts

@@ -1,15 +1,8 @@
+// eslint-disable-next-line @typescript-eslint/triple-slash-reference
+/// <reference path="../../types.d.ts" />
+
 import { get } from 'lodash';
 import removeRequiredAndDefault from '../removeRequiredAndDefault';
-import type {
-  ObjectPropertySchema,
-  ArrayPropertySchema,
-  StringPropertySchema,
-  NumberPropertySchema,
-  IntegerPropertySchema,
-  BooleanPropertySchema,
-  EnumSchema,
-  ReferencePropertySchema,
-} from '../JsonSchema';
 
 describe('removeRequiredAndDefault(jsonSchema)', () => {
   describe('basic property removal', () => {

package/src/helpers/cleanupAttributes.ts

@@ -1,51 +1,13 @@
 import { isUndefined } from 'lodash';
+import { type JsonSchema } from 'z-schema';
 
 import got from './got';
-import type {
-  JsonSchema,
-  EnumSchema,
-  TargetObject,
-  ObjectSchema,
-  JsonSchemasMap,
-  ArrayPropertySchema,
-  ObjectPropertySchema,
-  ReferencePropertySchema
-} from './JsonSchema';
-
-/**
- * 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: TargetObject,
   jsonSchema: JsonSchema,
-  schemasMap: JsonSchemasMap = {}
+  schemasMap: Record<string, JsonSchema> = {}
 ) => {
   const { enum: enumItems } = (jsonSchema as EnumSchema);
 
@@ -105,7 +67,7 @@ const cleanupAttributes = (
         const nestedJsonSchema = {
           id: `${objectSchema.id}.${fieldName}.properties`,
           properties
-        };
+        } as JsonSchema;
 
         cleanupAttributes(fieldValue as TargetObject, nestedJsonSchema, schemasMap);
       }
@@ -132,7 +94,7 @@ const cleanupAttributes = (
           : {
             id: `${objectSchema.id}.${fieldName}.items.properties`,
             properties: itemObjectProperties
-          };
+          } as JsonSchema;
 
         for (const item of fieldValue) {
           const isObjectItem = item &&

package/src/helpers/cleanupNulls.ts

@@ -1,45 +1,8 @@
 import { isObject, cloneDeep } from 'lodash';
 
-import { type TargetObject } from './JsonSchema';
-
 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: TargetObject) => {
   const shouldSkip = !isObject(target);
 
@@ -72,31 +35,7 @@ const cleanupNulls = (target: TargetObject) => {
   }
 };
 
-/**
- * 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>) {
   const clone = cloneDeep(object);
 

package/src/helpers/createSchemasMap.ts

@@ -2,39 +2,9 @@ import path from 'path';
 import Schema from '../Schema';
 import { load } from 'js-yaml';
 import { keyBy } from 'lodash';
-import type { EnumSchema, PropertiesSchema } from './JsonSchema';
 import { readFileSync, readdirSync, statSync } from '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. */
 export const loadSync = (yamlPath: string) => {
   const schemaId = yamlPath
     .split('/')
@@ -47,40 +17,7 @@ export const loadSync = (yamlPath: string) => {
   return new Schema(source, schemaId);
 };
 
-/**
- * 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: string): string[] =>
   readdirSync(servicePath)
     .reduce(
@@ -92,109 +29,13 @@ const listFilesSync = (servicePath: string): string[] =>
         )
     , []);
 
-/**
- * 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: string) =>
   listFilesSync(servicePath)
     .filter((fileName: string) => fileName.endsWith('.yaml'))
     .map((schemaPath: string) => 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: string, modules: unknown[]): Record<string, Schema> => {
   const yamlSchemas = readSchemasSync(servicePath);
   const schemasMap = keyBy(yamlSchemas, 'id');

package/src/helpers/getReferenceIds.ts

@@ -1,180 +1,9 @@
 import { isUndefined, uniq } from 'lodash';
 
-import Schema from '../Schema';
 import got from './got';
-import {
-  EnumSchema,
-  ObjectSchema,
-  ArrayPropertySchema,
-  ObjectPropertySchema,
-  ReferencePropertySchema,
-} from './JsonSchema';
+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. */
 const getReferenceIds = (schema: Schema, schemasMap: Record<string, Schema>): string[] => {
   /** Returns schema from the map by ID */
   const getSchema = (id: string) => got(schemasMap, id, 'Schema "$PATH" not found');