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

package/dist/helpers/normalizeType.js

@@ -2,155 +2,27 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const BOOLEAN_STRING_TRUE_VALUES = ['yes', 'true', '1'];
 const BOOLEAN_STRING_FALSE_VALUES = ['no', 'false', '0'];
-/**
- * Checks if a value is null or undefined.
- *
- * @param value - The value to check
- * @returns True if the value is null or undefined, false otherwise
- */
+/** Checks if a value is null or undefined. */
 const isNullOrUndefined = (value) => value === null || value === undefined;
-/**
- * Checks if a JSON Schema type is numeric (number or integer).
- *
- * @param type - The JSON Schema type to check
- * @returns True if the type is 'number' or 'integer', false otherwise
- */
+/** Checks if a JSON Schema type is numeric (number or integer). */
 const isNumericType = (type) => type === 'number' || type === 'integer';
-/**
- * Checks if a JSON Schema type is boolean.
- *
- * @param type - The JSON Schema type to check
- * @returns True if the type is 'boolean', false otherwise
- */
+/** Checks if a JSON Schema type is boolean. */
 const isBooleanType = (type) => type === 'boolean';
-/**
- * Type guard that checks if a value is a number.
- *
- * @param value - The value to check
- * @returns True if the value is a number, false otherwise
- */
+/** Type guard that checks if a value is a number. */
 const isNumberValue = (value) => typeof value === 'number';
-/**
- * Type guard that checks if a value is a boolean.
- *
- * @param value - The value to check
- * @returns True if the value is a boolean, false otherwise
- */
+/** Type guard that checks if a value is a boolean. */
 const isBooleanValue = (value) => typeof value === 'boolean';
-/**
- * Type guard that checks if a value is a string.
- *
- * @param value - The value to check
- * @returns True if the value is a string, false otherwise
- */
+/** Type guard that checks if a value is a string. */
 const isStringValue = (value) => typeof value === 'string';
-/**
- * Checks if a string is empty or contains only whitespace characters.
- *
- * @param value - The string to check
- * @returns True if the string is empty or whitespace-only, false otherwise
- */
+/** Checks if a string is empty or contains only whitespace characters. */
 const isEmptyOrWhitespaceString = (value) => value === '' || value.trim() === '';
-/**
- * Checks if a number is valid (not NaN).
- *
- * @param value - The number to check
- * @returns True if the number is valid (not NaN), false otherwise
- */
+/** Checks if a number is valid (not NaN). */
 const isValidNumber = (value) => !isNaN(value);
-/**
- * Checks if a string represents a boolean true value.
- * Recognized values (case-insensitive): 'yes', 'true', '1'.
- *
- * @param value - The string to check
- * @returns True if the string represents a boolean true value, false otherwise
- */
+/** Checks if a string represents a boolean true value. */
 const isBooleanTrueString = (value) => BOOLEAN_STRING_TRUE_VALUES.includes(value.toLowerCase());
-/**
- * Checks if a string represents a boolean false value.
- * Recognized values (case-insensitive): 'no', 'false', '0'.
- *
- * @param value - The string to check
- * @returns True if the string represents a boolean false value, false otherwise
- */
+/** Checks if a string represents a boolean false value. */
 const isBooleanFalseString = (value) => BOOLEAN_STRING_FALSE_VALUES.includes(value.toLowerCase());
-/**
- * Normalizes a value to match a specified JSON Schema type.
- *
- * ## Intent
- *
- * This function is designed to coerce values into their expected types based on JSON Schema
- * type definitions. It's particularly useful when processing data from external sources (like
- * form inputs, query parameters, or API responses) where values may arrive as strings but
- * need to be converted to their proper types according to a schema definition.
- *
- * The function performs type coercion where appropriate, but preserves the original value
- * when conversion is not possible or when the value is already of the correct type. This
- * makes it safe to use in data normalization pipelines without losing information.
- *
- * ## Use Cases
- *
- * 1. **Schema-based data normalization**: When processing objects against JSON Schema
- *    definitions, ensuring property values match their declared types.
- *
- * 2. **Form data processing**: Converting string values from HTML forms (which are always
- *    strings) to their expected types (numbers, booleans) based on schema definitions.
- *
- * 3. **API response normalization**: Normalizing API responses where types may be ambiguous
- *    or incorrectly serialized (e.g., numbers as strings, booleans as strings).
- *
- * 4. **Configuration parsing**: Parsing configuration values from environment variables or
- *    config files where everything is initially a string but needs type coercion.
- *
- * ## Behavior by Type
- *
- * - **number/integer**: Attempts to convert strings and booleans to numbers. Preserves
- *   original value if conversion fails or value is already a number.
- *
- * - **boolean**: Converts numbers (0 → false, non-zero → true) and recognized string
- *   values ('yes', 'true', '1' → true; 'no', 'false', '0' → false). Preserves original
- *   value for unrecognized strings or non-convertible types.
- *
- * - **string/object/array**: Returns the value as-is (no conversion performed).
- *
- * - **null/undefined**: Always preserved regardless of target type.
- *
- * ## Examples
- *
- * ### Number Conversion
- * ```typescript
- * normalizeType('number', '123')      // → 123
- * normalizeType('number', '45.67')    // → 45.67
- * normalizeType('number', '0')        // → 0
- * normalizeType('number', true)       // → 1
- * normalizeType('number', 'abc')      // → 'abc' (conversion failed, original preserved)
- * ```
- *
- * ### Boolean Conversion
- * ```typescript
- * normalizeType('boolean', 0)         // → false
- * normalizeType('boolean', 1)         // → true
- * normalizeType('boolean', 'yes')     // → true
- * normalizeType('boolean', 'true')    // → true
- * normalizeType('boolean', '1')       // → true
- * normalizeType('boolean', 'no')      // → false
- * normalizeType('boolean', 'false')   // → false
- * normalizeType('boolean', 'maybe')   // → 'maybe' (unrecognized, original preserved)
- * ```
- *
- * ### Type Preservation
- * ```typescript
- * normalizeType('string', 'hello')    // → 'hello'
- * normalizeType('string', 123)        // → 123 (no conversion for string type)
- * normalizeType('object', { a: 1 })   // → { a: 1 }
- * normalizeType('array', [1, 2, 3])   // → [1, 2, 3]
- * normalizeType('number', null)       // → null (null always preserved)
- * ```
- *
- * @param type - The target JSON Schema type ('number', 'integer', 'boolean', 'string', 'object', 'array')
- * @param value - The value to normalize (can be any type)
- * @returns The normalized value, or the original value if normalization is not applicable
- */
+/** Normalizes a value to match a specified JSON Schema type. */
 const normalizeType = (type, value) => {
     // Preserve null and undefined values regardless of target type
     if (isNullOrUndefined(value)) {

package/dist/helpers/normalizeType.js.map

@@ -1 +1 @@
-{"version":3,"file":"normalizeType.js","sourceRoot":"","sources":["../../src/helpers/normalizeType.ts"],"names":[],"mappings":";;AAEA,MAAM,0BAA0B,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,2BAA2B,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;AAEzD;;;;;GAKG;AACH,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA6B,EAAE,CACtE,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAExC;;;;;GAKG;AACH,MAAM,aAAa,GAAG,CAAC,IAAe,EAAW,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS,CAAC;AAE5F;;;;;GAKG;AACH,MAAM,aAAa,GAAG,CAAC,IAAe,EAAW,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC;AAEvE;;;;;GAKG;AACH,MAAM,aAAa,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;AAErF;;;;;GAKG;AACH,MAAM,cAAc,GAAG,CAAC,KAAc,EAAoB,EAAE,CAAC,OAAO,KAAK,KAAK,SAAS,CAAC;AAExF;;;;;GAKG;AACH,MAAM,aAAa,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;AAErF;;;;;GAKG;AACH,MAAM,yBAAyB,GAAG,CAAC,KAAa,EAAW,EAAE,CAC3D,KAAK,KAAK,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AAEtC;;;;;GAKG;AACH,MAAM,aAAa,GAAG,CAAC,KAAa,EAAW,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAW,EAAE,CACrD,0BAA0B,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAE3D;;;;;;GAMG;AACH,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAW,EAAE,CACtD,2BAA2B,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4EG;AACH,MAAM,aAAa,GAAG,CAAC,IAAe,EAAE,KAAc,EAAuC,EAAE;IAC7F,+DAA+D;IAC/D,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kCAAkC;IAClC,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,oCAAoC;QACpC,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mDAAmD;QACnD,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvB,CAAC;QAED,iCAAiC;QACjC,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,qDAAqD;YACrD,IAAI,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAChC,+CAA+C;YAC/C,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QAED,wEAAwE;QACxE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACtB,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,qCAAqC;QACrC,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,8CAA8C;QAC9C,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QAED,mCAAmC;QACnC,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,0EAA0E;QAC1E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0EAA0E;IAC1E,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,kBAAe,aAAa,CAAC"}
+{"version":3,"file":"normalizeType.js","sourceRoot":"","sources":["../../src/helpers/normalizeType.ts"],"names":[],"mappings":";;AAEA,MAAM,0BAA0B,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;AACxD,MAAM,2BAA2B,GAAG,CAAC,IAAI,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;AAEzD,8CAA8C;AAC9C,MAAM,iBAAiB,GAAG,CAAC,KAAc,EAA6B,EAAE,CACtE,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,CAAC;AAExC,mEAAmE;AACnE,MAAM,aAAa,GAAG,CAAC,IAAe,EAAW,EAAE,CAAC,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,SAAS,CAAC;AAE5F,+CAA+C;AAC/C,MAAM,aAAa,GAAG,CAAC,IAAe,EAAW,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC;AAEvE,qDAAqD;AACrD,MAAM,aAAa,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;AAErF,sDAAsD;AACtD,MAAM,cAAc,GAAG,CAAC,KAAc,EAAoB,EAAE,CAAC,OAAO,KAAK,KAAK,SAAS,CAAC;AAExF,qDAAqD;AACrD,MAAM,aAAa,GAAG,CAAC,KAAc,EAAmB,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;AAErF,0EAA0E;AAC1E,MAAM,yBAAyB,GAAG,CAAC,KAAa,EAAW,EAAE,CAC3D,KAAK,KAAK,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;AAEtC,6CAA6C;AAC7C,MAAM,aAAa,GAAG,CAAC,KAAa,EAAW,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAEhE,0DAA0D;AAC1D,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAW,EAAE,CACrD,0BAA0B,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAE3D,2DAA2D;AAC3D,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAW,EAAE,CACtD,2BAA2B,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,CAAC;AAE5D,gEAAgE;AAChE,MAAM,aAAa,GAAG,CAAC,IAAe,EAAE,KAAc,EAAuC,EAAE;IAC7F,+DAA+D;IAC/D,IAAI,iBAAiB,CAAC,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,kCAAkC;IAClC,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,oCAAoC;QACpC,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,mDAAmD;QACnD,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvB,CAAC;QAED,iCAAiC;QACjC,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,qDAAqD;YACrD,IAAI,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;gBACrC,OAAO,KAAK,CAAC;YACf,CAAC;YAED,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAChC,+CAA+C;YAC/C,IAAI,aAAa,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7B,OAAO,SAAS,CAAC;YACnB,CAAC;QACH,CAAC;QAED,wEAAwE;QACxE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACtB,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,qCAAqC;QACrC,IAAI,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,8CAA8C;QAC9C,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,OAAO,OAAO,CAAC,KAAK,CAAC,CAAC;QACxB,CAAC;QAED,mCAAmC;QACnC,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACzB,IAAI,mBAAmB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,oBAAoB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAChC,OAAO,KAAK,CAAC;YACf,CAAC;QACH,CAAC;QAED,0EAA0E;QAC1E,OAAO,KAAK,CAAC;IACf,CAAC;IAED,0EAA0E;IAC1E,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,kBAAe,aAAa,CAAC"}

package/dist/helpers/nullifyEmptyValues.d.ts

@@ -1,139 +1,5 @@
 import { type SchemaErrorDetail } from 'z-schema';
-import type { TargetObject } from './JsonSchema';
-/**
- * Converts empty string values to null for specific format validation errors.
- *
- * **Intent:**
- * This function provides a post-validation normalization strategy that attempts to
- * resolve format validation errors by converting empty strings to null. This is
- * particularly useful when dealing with optional fields where an empty string
- * represents "no value provided" rather than an invalid format. By converting
- * empty strings to null, the validation may pass if the schema allows null values
- * for optional fields.
- *
- * **Use Cases:**
- * - **Optional field normalization**: When optional string fields receive empty
- *   strings from user input or API responses, converting them to null allows
- *   validation to succeed if the schema permits null values for optional fields.
- *   This is especially common with form inputs that submit empty strings instead
- *   of omitting fields entirely.
- * - **Format error recovery**: After schema validation fails with format errors
- *   (pattern mismatch, enum mismatch, invalid format), this function attempts to
- *   resolve errors by nullifying empty strings. This enables graceful handling
- *   of optional fields that failed format validation due to empty values.
- * - **API integration**: When integrating with external APIs or services that
- *   send empty strings for optional fields, this function normalizes the data
- *   to use null instead, which is often more semantically correct for optional
- *   fields in JSON schemas.
- * - **Data transformation pipeline**: As part of a validation and normalization
- *   pipeline, this function can be used to clean and normalize data before
- *   further processing or storage, ensuring consistent representation of
- *   "missing" values.
- * - **User input handling**: When processing user-submitted forms or data where
- *   empty string inputs should be treated as "not provided" rather than invalid,
- *   this function converts them to null for proper schema validation.
- *
- * **Behavior:**
- * - Returns a deep clone of the input object (does not mutate the original)
- * - Only processes format-related errors (PATTERN, ENUM_MISMATCH, INVALID_FORMAT)
- * - Skips required attributes (marked with `x-required: true`)
- * - Only converts empty strings (`''`) to null, preserving other values
- * - Supports nested paths and array indices
- * - Returns both the modified object and remaining validation errors that
- *   couldn't be resolved
- *
- * **Examples:**
- *
- * ```typescript
- * // Example 1: Basic usage with pattern error
- * const object = { email: '' };
- * const error = {
- *   code: 'PATTERN',
- *   path: '#/email',
- *   // ... other error properties
- * };
- * const [result, remainingErrors] = nullifyEmptyValues(object, [error]);
- * // result: { email: null }
- * // remainingErrors: []
- * ```
- *
- * ```typescript
- * // Example 2: Required fields are not nullified
- * const object = { requiredField: '', optionalField: '' };
- * const requiredError = {
- *   code: 'PATTERN',
- *   path: '#/requiredField',
- *   // schema has x-required: true
- * };
- * const optionalError = {
- *   code: 'PATTERN',
- *   path: '#/optionalField',
- *   // schema has no x-required or x-required: false
- * };
- * const [result, remainingErrors] = nullifyEmptyValues(
- *   object,
- *   [requiredError, optionalError]
- * );
- * // result: { requiredField: '', optionalField: null }
- * // remainingErrors: [requiredError] // required field error remains
- * ```
- *
- * ```typescript
- * // Example 3: Nested paths and arrays
- * const object = {
- *   user: {
- *     profile: {
- *       bio: '',
- *       tags: ['', 'tag1', '']
- *     }
- *   }
- * };
- * const errors = [
- *   { code: 'PATTERN', path: '#/user/profile/bio' },
- *   { code: 'INVALID_FORMAT', path: '#/user/profile/tags/0' },
- *   { code: 'ENUM_MISMATCH', path: '#/user/profile/tags/2' }
- * ];
- * const [result, remainingErrors] = nullifyEmptyValues(object, errors);
- * // result: {
- * //   user: {
- * //     profile: {
- * //       bio: null,
- * //       tags: [null, 'tag1', null]
- * //     }
- * //   }
- * // }
- * // remainingErrors: []
- * ```
- *
- * ```typescript
- * // Example 4: Non-format errors are not processed
- * const object = { field: '' };
- * const formatError = { code: 'PATTERN', path: '#/field' };
- * const typeError = { code: 'INVALID_TYPE', path: '#/field' };
- * const [result, remainingErrors] = nullifyEmptyValues(
- *   object,
- *   [formatError, typeError]
- * );
- * // result: { field: null }
- * // remainingErrors: [typeError] // type error remains
- * ```
- *
- * ```typescript
- * // Example 5: Non-empty values are preserved
- * const object = { field: 'invalid-value' };
- * const error = { code: 'PATTERN', path: '#/field' };
- * const [result, remainingErrors] = nullifyEmptyValues(object, [error]);
- * // result: { field: 'invalid-value' } // unchanged
- * // remainingErrors: [error] // error remains
- * ```
- *
- * @param object - The target object to process (will be deep cloned, not mutated)
- * @param validationErrors - Array of schema validation errors from z-schema
- * @returns A tuple containing:
- *   - `[0]`: Deep clone of the object with empty strings converted to null where applicable
- *   - `[1]`: Array of validation errors that couldn't be resolved (required fields,
- *            non-format errors, or errors for non-empty values)
- */
+/** Converts empty string values to null for specific format validation errors. */
 declare const nullifyEmptyValues: (object: TargetObject, validationErrors: SchemaErrorDetail[]) => [TargetObject, SchemaErrorDetail[]];
 export default nullifyEmptyValues;
 //# sourceMappingURL=nullifyEmptyValues.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"nullifyEmptyValues.d.ts","sourceRoot":"","sources":["../../src/helpers/nullifyEmptyValues.ts"],"names":[],"mappings":"AACA,OAAO,EAA4B,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE5E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAiBjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqIG;AACH,QAAA,MAAM,kBAAkB,GACtB,QAAQ,YAAY,EACpB,kBAAkB,iBAAiB,EAAE,KACpC,CAAC,YAAY,EAAE,iBAAiB,EAAE,CA+CpC,CAAC;AAEF,eAAe,kBAAkB,CAAC"}
+{"version":3,"file":"nullifyEmptyValues.d.ts","sourceRoot":"","sources":["../../src/helpers/nullifyEmptyValues.ts"],"names":[],"mappings":"AACA,OAAgB,EAAE,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAe3D,kFAAkF;AAClF,QAAA,MAAM,kBAAkB,GACtB,QAAQ,YAAY,EACpB,kBAAkB,iBAAiB,EAAE,KACpC,CAAC,YAAY,EAAE,iBAAiB,EAAE,CAiDpC,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/helpers/nullifyEmptyValues.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const lodash_1 = require("lodash");
-const z_schema_1 = require("z-schema");
+const z_schema_1 = __importDefault(require("z-schema"));
 /**
  * Format error codes that indicate validation failures due to format mismatches.
  * These errors can potentially be resolved by converting empty strings to null.
@@ -11,151 +14,16 @@ const FORMAT_ERROR_CODES = [
     'ENUM_MISMATCH',
     'INVALID_FORMAT'
 ];
-/**
- * Values that are considered "empty" and can be safely converted to null.
- */
+/** Values that are considered "empty" and can be safely converted to null. */
 const EMPTY_VALUES = [''];
-/**
- * Converts empty string values to null for specific format validation errors.
- *
- * **Intent:**
- * This function provides a post-validation normalization strategy that attempts to
- * resolve format validation errors by converting empty strings to null. This is
- * particularly useful when dealing with optional fields where an empty string
- * represents "no value provided" rather than an invalid format. By converting
- * empty strings to null, the validation may pass if the schema allows null values
- * for optional fields.
- *
- * **Use Cases:**
- * - **Optional field normalization**: When optional string fields receive empty
- *   strings from user input or API responses, converting them to null allows
- *   validation to succeed if the schema permits null values for optional fields.
- *   This is especially common with form inputs that submit empty strings instead
- *   of omitting fields entirely.
- * - **Format error recovery**: After schema validation fails with format errors
- *   (pattern mismatch, enum mismatch, invalid format), this function attempts to
- *   resolve errors by nullifying empty strings. This enables graceful handling
- *   of optional fields that failed format validation due to empty values.
- * - **API integration**: When integrating with external APIs or services that
- *   send empty strings for optional fields, this function normalizes the data
- *   to use null instead, which is often more semantically correct for optional
- *   fields in JSON schemas.
- * - **Data transformation pipeline**: As part of a validation and normalization
- *   pipeline, this function can be used to clean and normalize data before
- *   further processing or storage, ensuring consistent representation of
- *   "missing" values.
- * - **User input handling**: When processing user-submitted forms or data where
- *   empty string inputs should be treated as "not provided" rather than invalid,
- *   this function converts them to null for proper schema validation.
- *
- * **Behavior:**
- * - Returns a deep clone of the input object (does not mutate the original)
- * - Only processes format-related errors (PATTERN, ENUM_MISMATCH, INVALID_FORMAT)
- * - Skips required attributes (marked with `x-required: true`)
- * - Only converts empty strings (`''`) to null, preserving other values
- * - Supports nested paths and array indices
- * - Returns both the modified object and remaining validation errors that
- *   couldn't be resolved
- *
- * **Examples:**
- *
- * ```typescript
- * // Example 1: Basic usage with pattern error
- * const object = { email: '' };
- * const error = {
- *   code: 'PATTERN',
- *   path: '#/email',
- *   // ... other error properties
- * };
- * const [result, remainingErrors] = nullifyEmptyValues(object, [error]);
- * // result: { email: null }
- * // remainingErrors: []
- * ```
- *
- * ```typescript
- * // Example 2: Required fields are not nullified
- * const object = { requiredField: '', optionalField: '' };
- * const requiredError = {
- *   code: 'PATTERN',
- *   path: '#/requiredField',
- *   // schema has x-required: true
- * };
- * const optionalError = {
- *   code: 'PATTERN',
- *   path: '#/optionalField',
- *   // schema has no x-required or x-required: false
- * };
- * const [result, remainingErrors] = nullifyEmptyValues(
- *   object,
- *   [requiredError, optionalError]
- * );
- * // result: { requiredField: '', optionalField: null }
- * // remainingErrors: [requiredError] // required field error remains
- * ```
- *
- * ```typescript
- * // Example 3: Nested paths and arrays
- * const object = {
- *   user: {
- *     profile: {
- *       bio: '',
- *       tags: ['', 'tag1', '']
- *     }
- *   }
- * };
- * const errors = [
- *   { code: 'PATTERN', path: '#/user/profile/bio' },
- *   { code: 'INVALID_FORMAT', path: '#/user/profile/tags/0' },
- *   { code: 'ENUM_MISMATCH', path: '#/user/profile/tags/2' }
- * ];
- * const [result, remainingErrors] = nullifyEmptyValues(object, errors);
- * // result: {
- * //   user: {
- * //     profile: {
- * //       bio: null,
- * //       tags: [null, 'tag1', null]
- * //     }
- * //   }
- * // }
- * // remainingErrors: []
- * ```
- *
- * ```typescript
- * // Example 4: Non-format errors are not processed
- * const object = { field: '' };
- * const formatError = { code: 'PATTERN', path: '#/field' };
- * const typeError = { code: 'INVALID_TYPE', path: '#/field' };
- * const [result, remainingErrors] = nullifyEmptyValues(
- *   object,
- *   [formatError, typeError]
- * );
- * // result: { field: null }
- * // remainingErrors: [typeError] // type error remains
- * ```
- *
- * ```typescript
- * // Example 5: Non-empty values are preserved
- * const object = { field: 'invalid-value' };
- * const error = { code: 'PATTERN', path: '#/field' };
- * const [result, remainingErrors] = nullifyEmptyValues(object, [error]);
- * // result: { field: 'invalid-value' } // unchanged
- * // remainingErrors: [error] // error remains
- * ```
- *
- * @param object - The target object to process (will be deep cloned, not mutated)
- * @param validationErrors - Array of schema validation errors from z-schema
- * @returns A tuple containing:
- *   - `[0]`: Deep clone of the object with empty strings converted to null where applicable
- *   - `[1]`: Array of validation errors that couldn't be resolved (required fields,
- *            non-format errors, or errors for non-empty values)
- */
+/** Converts empty string values to null for specific format validation errors. */
 const nullifyEmptyValues = (object, validationErrors) => {
     // Create a deep clone to avoid mutating the original object
     const result = JSON.parse(JSON.stringify(object));
     const remainingErrors = [];
     for (const error of validationErrors) {
         const { code, path: pathString } = error;
-        const schema = (0, lodash_1.get)(error, z_schema_1.schemaSymbol);
+        const schema = (0, lodash_1.get)(error, z_schema_1.default.schemaSymbol);
         const isAttributeRequired = schema?.['x-required'] === true;
         const isFormatError = FORMAT_ERROR_CODES.includes(code);
         const shouldSkipRequiredAttribute = isAttributeRequired;
@@ -171,10 +39,12 @@ const nullifyEmptyValues = (object, validationErrors) => {
             continue;
         }
         // Parse the JSON path (e.g., '#/user/profile/field' -> ['user', 'profile', 'field'])
-        const path = pathString.replace(/^#\//, '').split('/').filter(Boolean);
-        // Get the actual value from the error's JSON context
-        const json = (0, lodash_1.get)(error, z_schema_1.jsonSymbol);
-        const value = (0, lodash_1.get)(json, path);
+        const path = typeof pathString === 'string'
+            ? pathString.replace(/^#\//, '').split('/').filter(Boolean)
+            : pathString;
+        // Get the actual value from the error's JSON context, or fall back to the object
+        const json = (0, lodash_1.get)(error, z_schema_1.default.jsonSymbol);
+        const value = (0, lodash_1.get)(json ?? result, path);
         const isEmptyValue = EMPTY_VALUES.includes(value);
         const shouldSkipNonEmptyValue = !isEmptyValue;
         // Only nullify if the value is actually empty

package/dist/helpers/nullifyEmptyValues.js.map

@@ -1 +1 @@
-{"version":3,"file":"nullifyEmptyValues.js","sourceRoot":"","sources":["../../src/helpers/nullifyEmptyValues.ts"],"names":[],"mappings":";;AAAA,mCAAkC;AAClC,uCAA4E;AAI5E;;;GAGG;AACH,MAAM,kBAAkB,GAAG;IACzB,SAAS;IACT,eAAe;IACf,gBAAgB;CACR,CAAC;AAEX;;GAEG;AACH,MAAM,YAAY,GAAG,CAAC,EAAE,CAAU,CAAC;AAEnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqIG;AACH,MAAM,kBAAkB,GAAG,CACzB,MAAoB,EACpB,gBAAqC,EACA,EAAE;IACvC,4DAA4D;IAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAiB,CAAC;IAClE,MAAM,eAAe,GAAwB,EAAE,CAAC;IAEhD,KAAK,MAAM,KAAK,IAAI,gBAAgB,EAAE,CAAC;QACrC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QACzC,MAAM,MAAM,GAAG,IAAA,YAAG,EAAC,KAAK,EAAE,uBAAY,CAAwC,CAAC;QAC/E,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;QAC5D,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAyC,CAAC,CAAC;QAE7F,MAAM,2BAA2B,GAAG,mBAAmB,CAAC;QACxD,MAAM,wBAAwB,GAAG,CAAC,aAAa,CAAC;QAEhD,0DAA0D;QAC1D,IAAI,2BAA2B,EAAE,CAAC;YAChC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,qCAAqC;QACrC,IAAI,wBAAwB,EAAE,CAAC;YAC7B,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,qFAAqF;QACrF,MAAM,IAAI,GAAG,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAEvE,qDAAqD;QACrD,MAAM,IAAI,GAAG,IAAA,YAAG,EAAC,KAAK,EAAE,qBAAU,CAAiB,CAAC;QACpD,MAAM,KAAK,GAAG,IAAA,YAAG,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAE9B,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAoC,CAAC,CAAC;QACjF,MAAM,uBAAuB,GAAG,CAAC,YAAY,CAAC;QAE9C,8CAA8C;QAC9C,IAAI,uBAAuB,EAAE,CAAC;YAC5B,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,6CAA6C;QAC7C,IAAA,YAAG,EAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}
+{"version":3,"file":"nullifyEmptyValues.js","sourceRoot":"","sources":["../../src/helpers/nullifyEmptyValues.ts"],"names":[],"mappings":";;;;;AAAA,mCAAkC;AAClC,wDAA2D;AAE3D;;;GAGG;AACH,MAAM,kBAAkB,GAAG;IACzB,SAAS;IACT,eAAe;IACf,gBAAgB;CACR,CAAC;AAEX,8EAA8E;AAC9E,MAAM,YAAY,GAAG,CAAC,EAAE,CAAU,CAAC;AAEnC,kFAAkF;AAClF,MAAM,kBAAkB,GAAG,CACzB,MAAoB,EACpB,gBAAqC,EACA,EAAE;IACvC,4DAA4D;IAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAiB,CAAC;IAClE,MAAM,eAAe,GAAwB,EAAE,CAAC;IAEhD,KAAK,MAAM,KAAK,IAAI,gBAAgB,EAAE,CAAC;QACrC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QACzC,MAAM,MAAM,GAAG,IAAA,YAAG,EAAC,KAAK,EAAE,kBAAO,CAAC,YAAY,CAAwC,CAAC;QACvF,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAC,YAAY,CAAC,KAAK,IAAI,CAAC;QAC5D,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAyC,CAAC,CAAC;QAE7F,MAAM,2BAA2B,GAAG,mBAAmB,CAAC;QACxD,MAAM,wBAAwB,GAAG,CAAC,aAAa,CAAC;QAEhD,0DAA0D;QAC1D,IAAI,2BAA2B,EAAE,CAAC;YAChC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,qCAAqC;QACrC,IAAI,wBAAwB,EAAE,CAAC;YAC7B,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,qFAAqF;QACrF,MAAM,IAAI,GAAG,OAAO,UAAU,KAAK,QAAQ;YACzC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;YAC3D,CAAC,CAAC,UAAU,CAAC;QAEf,iFAAiF;QACjF,MAAM,IAAI,GAAG,IAAA,YAAG,EAAC,KAAK,EAAE,kBAAO,CAAC,UAAU,CAA6B,CAAC;QACxE,MAAM,KAAK,GAAG,IAAA,YAAG,EAAC,IAAI,IAAI,MAAM,EAAE,IAAI,CAAC,CAAC;QAExC,MAAM,YAAY,GAAG,YAAY,CAAC,QAAQ,CAAC,KAAoC,CAAC,CAAC;QACjF,MAAM,uBAAuB,GAAG,CAAC,YAAY,CAAC;QAE9C,8CAA8C;QAC9C,IAAI,uBAAuB,EAAE,CAAC;YAC5B,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,SAAS;QACX,CAAC;QAED,6CAA6C;QAC7C,IAAA,YAAG,EAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;AACnC,CAAC,CAAC;AAEF,kBAAe,kBAAkB,CAAC"}

package/dist/helpers/removeRequiredAndDefault.d.ts

@@ -1,106 +1,6 @@
-import type { EnumSchema, PropertySchema } from './JsonSchema';
-/**
- * Recursively removes `required` and `default` attributes from a JSON schema.
- *
- * **Intent:**
- * This function is designed to transform JSON schemas by stripping out validation
- * constraints (`required`) and default values (`default`) from all properties,
- * including nested objects and array items. This is useful for creating "pure"
- * or "update-friendly" versions of schemas where all fields become optional and
- * no defaults are applied.
- *
- * **Use Cases:**
- * 1. **Update Schemas**: Create schemas for partial updates where all fields are optional
- * 2. **Schema Transformation**: Prepare schemas for contexts where required/default
- *    constraints are not needed (e.g., credential generation, API transformations)
- * 3. **Schema Normalization**: Remove validation metadata before further processing
- *
- * **Behavior:**
- * - Mutates the input schema in-place by deleting `required` and `default` properties
- * - Recursively processes nested object properties
- * - Recursively processes array items (including nested objects within arrays)
- * - Preserves all other schema properties (type, description, pattern, etc.)
- * - Returns an object containing only the `properties` field
- *
- * **Examples:**
- *
- * ```typescript
- * // Example 1: Simple object schema
- * const schema = {
- *   type: 'object',
- *   properties: {
- *     name: { type: 'string', required: true, default: 'John' },
- *     age: { type: 'number', required: false, default: 0 }
- *   }
- * };
- *
- * const result = removeRequiredAndDefault(schema);
- * // result.properties.name: { type: 'string' } (required and default removed)
- * // result.properties.age: { type: 'number' } (required and default removed)
- * ```
- *
- * ```typescript
- * // Example 2: Nested objects
- * const schema = {
- *   type: 'object',
- *   properties: {
- *     user: {
- *       type: 'object',
- *       required: true,
- *       default: {},
- *       properties: {
- *         name: { type: 'string', required: true, default: 'John' },
- *         address: {
- *           type: 'object',
- *           properties: {
- *             street: { type: 'string', required: true, default: '' }
- *           }
- *         }
- *       }
- *     }
- *   }
- * };
- *
- * const result = removeRequiredAndDefault(schema);
- * // All required and default attributes are removed at all nesting levels
- * ```
- *
- * ```typescript
- * // Example 3: Arrays with object items
- * const schema = {
- *   type: 'object',
- *   properties: {
- *     users: {
- *       type: 'array',
- *       required: true,
- *       default: [],
- *       items: {
- *         type: 'object',
- *         properties: {
- *           name: { type: 'string', required: true, default: 'John' }
- *         }
- *       }
- *     }
- *   }
- * };
- *
- * const result = removeRequiredAndDefault(schema);
- * // Removes required/default from array property and nested object properties
- * ```
- *
- * **Limitations:**
- * - Only processes schemas with a `properties` field (ObjectPropertySchema)
- * - EnumSchema is accepted as a parameter but not processed (will return empty properties)
- * - The function mutates the input schema object
- * - Array items that are primitives (string, number, etc.) are processed but
- *   their return values are discarded (this is intentional)
- *
- * @param jsonSchema - The JSON schema to process (must have a `properties` field)
- * @returns An object containing only the `properties` field with all `required`
- *          and `default` attributes removed recursively
- */
+/** Recursively removes `required` and `default` attributes from a JSON schema. */
 declare const removeRequiredAndDefault: (jsonSchema: PropertySchema | EnumSchema) => {
-    properties: import("./JsonSchema").PropertiesSchema;
+    properties: PropertiesSchema;
 };
 export default removeRequiredAndDefault;
 //# sourceMappingURL=removeRequiredAndDefault.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"removeRequiredAndDefault.d.ts","sourceRoot":"","sources":["../../src/helpers/removeRequiredAndDefault.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EAGf,MAAM,cAAc,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmGG;AACH,QAAA,MAAM,wBAAwB,GAAI,YAAY,cAAc,GAAG,UAAU;;CAyCxE,CAAC;AAEF,eAAe,wBAAwB,CAAC"}
+{"version":3,"file":"removeRequiredAndDefault.d.ts","sourceRoot":"","sources":["../../src/helpers/removeRequiredAndDefault.ts"],"names":[],"mappings":"AACA,kFAAkF;AAClF,QAAA,MAAM,wBAAwB,GAAI,YAAY,cAAc,GAAG,UAAU;;CAyCxE,CAAC;AAEF,eAAe,wBAAwB,CAAC"}