@kravc/schema 2.7.5 → 2.8.0-alpha.0

package/dist/Schema.js

@@ -0,0 +1,506 @@
+"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 validateId_1 = __importDefault(require("./helpers/validateId"));
+const normalizeRequired_1 = __importDefault(require("./helpers/normalizeRequired"));
+const normalizeProperties_1 = __importDefault(require("./helpers/normalizeProperties"));
+const getLinkedDataContext_1 = __importDefault(require("./ld/getLinkedDataContext"));
+const removeRequiredAndDefault_1 = __importDefault(require("./helpers/removeRequiredAndDefault"));
+const UNDEFINED_SCHEMA_ID = 'UNDEFINED_SCHEMA_ID';
+/**
+ * Schema class for defining and manipulating JSON schemas for object validation.
+ *
+ * This class provides a flexible API for creating, transforming, and composing JSON schemas.
+ * It supports both property-based schemas (for objects) and enum schemas (for value sets).
+ *
+ * **Use Cases:**
+ * - Define validation schemas for API request/response objects
+ * - Create reusable schema components that can be extended or composed
+ * - Generate JSON-LD linked data types for semantic web applications
+ * - Transform schemas for different use cases (e.g., create update schemas from create schemas)
+ *
+ * **Example - Basic Usage:**
+ * ```typescript
+ * const userSchema = new Schema({
+ *   firstName: { type: 'string', required: true },
+ *   lastName: { type: 'string', required: true },
+ *   email: { type: 'string', format: 'email', required: true }
+ * }, 'User');
+ * ```
+ *
+ * **Example - Schema Composition:**
+ * ```typescript
+ * const baseSchema = new Schema({ name: { required: true } }, 'Base');
+ * const extendedSchema = baseSchema.extend({ status: { enum: ['Active', 'Inactive'] } }, 'Extended');
+ * ```
+ *
+ * **Example - Linked Data Types:**
+ * ```typescript
+ * const schema = new Schema(
+ *   { id: { type: 'string' }, name: { type: 'string' } },
+ *   'Person',
+ *   'https://schema.org/'
+ * );
+ * // schema.linkedDataType will contain JSON-LD context
+ * ```
+ */
+class Schema {
+    _id;
+    _url;
+    _source;
+    _linkedDataType;
+    /**
+     * Creates a new Schema instance.
+     *
+     * **Intent:** Initialize a schema with properties, enum values, or clone from another schema.
+     * Automatically normalizes properties, infers types, and optionally creates JSON-LD linked data types.
+     *
+     * **Use Cases:**
+     * - Create a new schema from scratch with property definitions
+     * - Create an enum schema for value validation
+     * - Clone an existing schema with a new ID
+     * - Create a schema with JSON-LD context for semantic web applications
+     *
+     * @param propertiesOrSchema - Property definitions, enum schema, or existing Schema instance to clone
+     * @param id - Unique identifier for the schema (defaults to 'UNDEFINED_SCHEMA_ID' if not provided)
+     * @param url - Optional URL for generating JSON-LD linked data types (only for property schemas, not enums)
+     *
+     * **Example - Property Schema:**
+     * ```typescript
+     * const schema = new Schema({
+     *   name: { type: 'string', required: true },
+     *   age: { type: 'number', minimum: 0 }
+     * }, 'Person');
+     * ```
+     *
+     * **Example - Enum Schema:**
+     * ```typescript
+     * const sizeSchema = new Schema({ enum: ['S', 'M', 'L'], type: 'string' }, 'Size');
+     * ```
+     *
+     * **Example - Clone Schema:**
+     * ```typescript
+     * const original = new Schema({ name: { type: 'string' } }, 'Original');
+     * const cloned = new Schema(original, 'Cloned');
+     * ```
+     *
+     * **Example - With Linked Data URL:**
+     * ```typescript
+     * const schema = new Schema(
+     *   { name: { type: 'string' } },
+     *   'Person',
+     *   'https://schema.org/'
+     * );
+     * // Automatically creates linkedDataType with @id and @context
+     * ```
+     */
+    constructor(propertiesOrSchema, id, url) {
+        this._id = id || UNDEFINED_SCHEMA_ID;
+        this._url = url;
+        const isSchema = propertiesOrSchema instanceof Schema;
+        this._source = isSchema
+            ? propertiesOrSchema.source
+            : propertiesOrSchema;
+        const isLinkedDataType = !!url && !this._source.enum;
+        if (isLinkedDataType) {
+            (0, validateId_1.default)('url', url);
+            const source = this._source;
+            source.type = {
+                type: 'string',
+                default: id,
+                required: true,
+            };
+            if (source.id) {
+                source.id = {
+                    type: 'string',
+                    format: 'url',
+                    required: true,
+                };
+            }
+            const uri = (url.endsWith('/') || url.endsWith('#'))
+                ? `${url}${id}`
+                : `${url}#${id}`;
+            this._linkedDataType = {
+                '@id': uri,
+                '@context': (0, getLinkedDataContext_1.default)(source, url)
+            };
+        }
+        (0, normalizeProperties_1.default)(this._source);
+    }
+    /**
+     * Returns the unique identifier for this schema.
+     *
+     * **Intent:** Provide a way to reference and identify schemas in collections or validators.
+     *
+     * **Use Cases:**
+     * - Reference schemas in Validator instances
+     * - Track schema lineage when cloning/extending
+     * - Generate schema identifiers for JSON Schema output
+     *
+     * @returns The schema ID, or 'UNDEFINED_SCHEMA_ID' if not specified during construction
+     *
+     * **Example:**
+     * ```typescript
+     * const schema = new Schema({ name: { type: 'string' } }, 'User');
+     * console.log(schema.id); // 'User'
+     * ```
+     */
+    get id() {
+        return this._id;
+    }
+    /**
+     * Returns the URL associated with this schema for JSON-LD linked data generation.
+     *
+     * **Intent:** Provide access to the base URL used for generating semantic web identifiers.
+     *
+     * **Use Cases:**
+     * - Check if a schema has linked data support
+     * - Access the base URL for constructing related URIs
+     * - Debug linked data type generation
+     *
+     * @returns The schema URL if provided during construction, undefined otherwise
+     *
+     * **Example:**
+     * ```typescript
+     * const schema = new Schema({ name: { type: 'string' } }, 'Person', 'https://schema.org/');
+     * console.log(schema.url); // 'https://schema.org/'
+     * ```
+     */
+    get url() {
+        return this._url;
+    }
+    /**
+     * Returns a deep clone of the schema's source properties or enum definition.
+     *
+     * **Intent:** Provide immutable access to schema definitions to prevent accidental mutations.
+     *
+     * **Use Cases:**
+     * - Inspect schema structure without modifying the original
+     * - Clone schemas manually for custom transformations
+     * - Debug schema definitions
+     * - Pass schema definitions to other functions safely
+     *
+     * @returns A deep copy of the schema source (PropertiesSchema or EnumSchema)
+     *
+     * **Example:**
+     * ```typescript
+     * const schema = new Schema({ name: { type: 'string', required: true } }, 'User');
+     * const source = schema.source;
+     * // source is a clone, modifying it won't affect the original schema
+     * ```
+     */
+    get source() {
+        return (0, lodash_1.cloneDeep)(this._source);
+    }
+    /**
+     * Checks if this schema is an enum schema (defines a set of allowed values).
+     *
+     * **Intent:** Enable type-safe branching logic based on schema type.
+     *
+     * **Use Cases:**
+     * - Conditionally apply methods that only work on property schemas
+     * - Validate schema type before operations
+     * - Implement different serialization logic for enums vs objects
+     *
+     * @returns true if the schema is an enum schema, false if it's a properties schema
+     *
+     * **Example:**
+     * ```typescript
+     * const enumSchema = new Schema({ enum: ['A', 'B', 'C'] }, 'Letters');
+     * const propSchema = new Schema({ name: { type: 'string' } }, 'Person');
+     *
+     * console.log(enumSchema.isEnum); // true
+     * console.log(propSchema.isEnum); // false
+     * ```
+     */
+    get isEnum() {
+        return !!this._source.enum;
+    }
+    /**
+     * Returns a normalized JSON Schema representation of this schema.
+     *
+     * **Intent:** Convert the internal schema representation to standard JSON Schema format
+     * with normalized required arrays and proper structure for validation libraries.
+     *
+     * **Use Cases:**
+     * - Export schemas for use with JSON Schema validators (e.g., z-schema)
+     * - Generate API documentation from schemas
+     * - Serialize schemas to JSON for storage or transmission
+     * - Integrate with tools that expect standard JSON Schema format
+     *
+     * @returns A JsonSchema object (ObjectSchema for property schemas, EnumSchema for enum schemas)
+     *
+     * **Example - Property Schema:**
+     * ```typescript
+     * const schema = new Schema({
+     *   name: { type: 'string', required: true },
+     *   age: { type: 'number' }
+     * }, 'Person');
+     *
+     * const jsonSchema = schema.jsonSchema;
+     * // {
+     * //   id: 'Person',
+     * //   type: 'object',
+     * //   properties: { name: {...}, age: {...} },
+     * //   required: ['name']
+     * // }
+     * ```
+     *
+     * **Example - Enum Schema:**
+     * ```typescript
+     * const enumSchema = new Schema({ enum: ['S', 'M', 'L'], type: 'string' }, 'Size');
+     * const jsonSchema = enumSchema.jsonSchema;
+     * // { id: 'Size', enum: ['S', 'M', 'L'], type: 'string' }
+     * ```
+     */
+    get jsonSchema() {
+        if (this.isEnum) {
+            return {
+                id: this._id,
+                ...this.source
+            };
+        }
+        const jsonSchema = {
+            id: this._id,
+            type: 'object',
+            properties: this.source
+        };
+        (0, normalizeRequired_1.default)(jsonSchema);
+        return jsonSchema;
+    }
+    /**
+     * Returns the JSON-LD linked data type if a URL was provided during construction.
+     *
+     * **Intent:** Provide semantic web identifiers and context for schemas, enabling
+     * integration with Linked Data and Verifiable Credentials standards.
+     *
+     * **Use Cases:**
+     * - Generate Verifiable Credentials with proper semantic context
+     * - Create JSON-LD documents with schema.org or custom vocabularies
+     * - Enable semantic interoperability between systems
+     * - Support decentralized identity and credential systems
+     *
+     * @returns LinkedDataType object with @id and @context, or undefined if no URL was provided
+     *
+     * **Example:**
+     * ```typescript
+     * const schema = new Schema(
+     *   { name: { type: 'string' }, email: { type: 'string', format: 'email' } },
+     *   'Person',
+     *   'https://schema.org/'
+     * );
+     *
+     * const linkedData = schema.linkedDataType;
+     * // {
+     * //   '@id': 'https://schema.org/Person',
+     * //   '@context': { ... } // Generated context mapping types to schema.org
+     * // }
+     * ```
+     *
+     * **Note:** Linked data types are only generated for property schemas, not enum schemas.
+     */
+    get linkedDataType() {
+        return this._linkedDataType;
+    }
+    /**
+     * Creates a complete clone of the schema with a new identifier.
+     *
+     * **Intent:** Duplicate a schema while maintaining all properties and structure,
+     * useful for creating variations or versioning schemas.
+     *
+     * **Use Cases:**
+     * - Create schema versions (e.g., 'UserV1', 'UserV2')
+     * - Duplicate schemas for different contexts
+     * - Create base schemas that can be independently extended
+     * - Maintain schema history or branching
+     *
+     * @param id - The new unique identifier for the cloned schema
+     * @returns A new Schema instance with identical structure but different ID
+     *
+     * **Example:**
+     * ```typescript
+     * const userSchema = new Schema({ name: { type: 'string' } }, 'User');
+     * const userV2Schema = userSchema.clone('UserV2');
+     * // Both schemas have identical properties but different IDs
+     * ```
+     */
+    clone(id) {
+        return new Schema(this.source, id);
+    }
+    /**
+     * Creates a schema clone without required constraints and default values.
+     *
+     * **Intent:** Generate update/patch schemas from create schemas by removing
+     * validation constraints that make sense for creation but not for updates.
+     *
+     * **Use Cases:**
+     * - Create update schemas where all fields are optional
+     * - Generate PATCH endpoint schemas from POST endpoint schemas
+     * - Allow partial updates without requiring all original fields
+     * - Create flexible input schemas for editing operations
+     *
+     * @param id - The new unique identifier for the pure schema
+     * @returns A new Schema instance with all required flags and defaults removed
+     * @throws Error if called on an enum schema
+     *
+     * **Example:**
+     * ```typescript
+     * const createSchema = new Schema({
+     *   name: { type: 'string', required: true },
+     *   email: { type: 'string', required: true, default: 'user@example.com' }
+     * }, 'CreateUser');
+     *
+     * const updateSchema = createSchema.pure('UpdateUser');
+     * // updateSchema has no required fields and no defaults
+     * // All fields are optional for updates
+     * ```
+     */
+    pure(id) {
+        if (this.isEnum) {
+            throw new Error('The "pure" method is not supported for enum schemas.');
+        }
+        const { properties: source } = (0, removeRequiredAndDefault_1.default)({
+            type: 'object',
+            properties: this.source
+        });
+        return new Schema(source, id);
+    }
+    /**
+     * Creates a schema clone containing only the specified properties.
+     *
+     * **Intent:** Create focused schemas that expose only a subset of properties,
+     * useful for different API views or security contexts.
+     *
+     * **Use Cases:**
+     * - Create public-facing schemas that hide sensitive fields
+     * - Generate response schemas with only necessary fields
+     * - Create view-specific schemas (e.g., 'UserSummary', 'UserDetail')
+     * - Implement field-level access control in schemas
+     * - Create lightweight schemas for list views
+     *
+     * @param propertyNames - Array of property names to include in the new schema
+     * @param id - The new unique identifier for the filtered schema
+     * @returns A new Schema instance containing only the specified properties
+     * @throws Error if called on an enum schema
+     *
+     * **Example:**
+     * ```typescript
+     * const fullSchema = new Schema({
+     *   name: { type: 'string' },
+     *   email: { type: 'string' },
+     *   password: { type: 'string' },
+     *   ssn: { type: 'string' }
+     * }, 'User');
+     *
+     * const publicSchema = fullSchema.only(['name', 'email'], 'PublicUser');
+     * // publicSchema only contains name and email, hiding sensitive fields
+     * ```
+     */
+    only(propertyNames, id) {
+        if (this.isEnum) {
+            throw new Error('The "only" method is not supported for enum schemas.');
+        }
+        const source = (0, lodash_1.pick)(this.source, propertyNames);
+        return new Schema(source, id);
+    }
+    /**
+     * Creates a schema clone extended with additional properties.
+     *
+     * **Intent:** Build complex schemas incrementally by composing base schemas
+     * with additional fields, enabling schema inheritance and composition patterns.
+     *
+     * **Use Cases:**
+     * - Extend base schemas with domain-specific fields
+     * - Create schema hierarchies (e.g., BaseEntity -> User -> AdminUser)
+     * - Add computed or derived fields to existing schemas
+     * - Compose schemas from multiple sources
+     * - Build versioned schemas that add new fields
+     *
+     * @param properties - Additional properties to merge into the schema
+     * @param id - The new unique identifier for the extended schema
+     * @returns A new Schema instance with merged properties (new properties override existing ones)
+     * @throws Error if called on an enum schema
+     *
+     * **Example:**
+     * ```typescript
+     * const baseSchema = new Schema({
+     *   id: { type: 'string', required: true },
+     *   createdAt: { type: 'string', format: 'date-time', required: true }
+     * }, 'BaseEntity');
+     *
+     * const userSchema = baseSchema.extend({
+     *   name: { type: 'string', required: true },
+     *   email: { type: 'string', format: 'email', required: true }
+     * }, 'User');
+     *
+     * // userSchema contains id, createdAt, name, and email
+     * ```
+     */
+    extend(properties, id) {
+        if (this.isEnum) {
+            throw new Error('The "extend" method is not supported for enum schemas.');
+        }
+        return new Schema({ ...this.source, ...properties }, id);
+    }
+    /**
+     * Creates a new schema that wraps the current schema as a nested property.
+     *
+     * **Intent:** Transform a flat schema into a nested structure, useful for
+     * API response formatting or when data needs to be wrapped in a container object.
+     *
+     * **Use Cases:**
+     * - Wrap schemas for API responses (e.g., { data: { ...schema } })
+     * - Create nested data structures from flat schemas
+     * - Format schemas for specific API conventions
+     * - Generate wrapper schemas for pagination or metadata containers
+     * - Transform schemas for different API versions or formats
+     *
+     * @param propertyName - The name of the property that will contain the wrapped schema
+     * @param attributes - Optional attributes for the wrapper property (default: { required: true })
+     * @param id - The new unique identifier for the wrapped schema
+     * @returns A new Schema instance where the original schema is nested under the specified property
+     * @throws Error if called on an enum schema
+     *
+     * **Example:**
+     * ```typescript
+     * const userSchema = new Schema({
+     *   name: { type: 'string', required: true },
+     *   email: { type: 'string', required: true }
+     * }, 'User');
+     *
+     * const wrappedSchema = userSchema.wrap('data', { required: true }, 'UserResponse');
+     * // Resulting schema structure:
+     * // {
+     * //   data: {
+     * //     type: 'object',
+     * //     properties: { name: {...}, email: {...} },
+     * //     required: true
+     * //   }
+     * // }
+     * ```
+     *
+     * **Example - With Default Value:**
+     * ```typescript
+     * const wrappedSchema = userSchema.wrap('data', { default: '{}' }, 'OptionalUserResponse');
+     * // The 'data' property has a default value and is not required
+     * ```
+     */
+    wrap(propertyName, attributes, id) {
+        if (this.isEnum) {
+            throw new Error('The "wrap" method is not supported for enum schemas.');
+        }
+        const source = {
+            [propertyName]: {
+                type: 'object',
+                properties: this.source,
+                ...(attributes || { required: true })
+            }
+        };
+        return new Schema(source, id);
+    }
+}
+exports.default = Schema;
+//# sourceMappingURL=Schema.js.map

package/dist/Schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Schema.js","sourceRoot":"","sources":["../src/Schema.ts"],"names":[],"mappings":";;;;;AAAA,mCAAyC;AAEzC,sEAA8C;AAC9C,oFAA4D;AAC5D,wFAAgE;AAChE,qFAA6D;AAC7D,kGAA0E;AAS1E,MAAM,mBAAmB,GAAG,qBAAqB,CAAC;AA0ClD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,MAAM,MAAM;IACF,GAAG,CAAS;IACZ,IAAI,CAAU;IACd,OAAO,CAAgC;IACvC,eAAe,CAAkB;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;IACH,YAAY,kBAA0D,EAAE,EAAW,EAAE,GAAY;QAC/F,IAAI,CAAC,GAAG,GAAG,EAAE,IAAI,mBAAmB,CAAC;QAErC,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAEhB,MAAM,QAAQ,GAAG,kBAAkB,YAAY,MAAM,CAAC;QAEtD,IAAI,CAAC,OAAO,GAAG,QAAQ;YACrB,CAAC,CAAC,kBAAkB,CAAC,MAAM;YAC3B,CAAC,CAAC,kBAAkB,CAAC;QAEvB,MAAM,gBAAgB,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QAErD,IAAI,gBAAgB,EAAE,CAAC;YACrB,IAAA,oBAAU,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YAEvB,MAAM,MAAM,GAAG,IAAI,CAAC,OAA2B,CAAC;YAEhD,MAAM,CAAC,IAAI,GAAG;gBACZ,IAAI,EAAE,QAAQ;gBACd,OAAO,EAAE,EAAE;gBACX,QAAQ,EAAE,IAAI;aACf,CAAC;YAEF,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,CAAC,EAAE,GAAG;oBACV,IAAI,EAAE,QAAQ;oBACd,MAAM,EAAE,KAAK;oBACb,QAAQ,EAAE,IAAI;iBACf,CAAC;YACJ,CAAC;YAED,MAAM,GAAG,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;gBAClD,CAAC,CAAC,GAAG,GAAG,GAAG,EAAE,EAAE;gBACf,CAAC,CAAC,GAAG,GAAG,IAAI,EAAE,EAAE,CAAC;YAEnB,IAAI,CAAC,eAAe,GAAG;gBACrB,KAAK,EAAE,GAAG;gBACV,UAAU,EAAE,IAAA,8BAAoB,EAAC,MAAM,EAAE,GAAG,CAAC;aAC9C,CAAC;QACJ,CAAC;QAED,IAAA,6BAAmB,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,EAAE;QACJ,OAAO,IAAI,CAAC,GAAG,CAAC;IAClB,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,GAAG;QACL,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,MAAM;QACR,OAAO,IAAA,kBAAS,EAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,MAAM;QACR,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,UAAU;QACZ,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO;gBACL,EAAE,EAAE,IAAI,CAAC,GAAG;gBACZ,GAAG,IAAI,CAAC,MAAM;aACD,CAAC;QAClB,CAAC;QAED,MAAM,UAAU,GAAG;YACjB,EAAE,EAAE,IAAI,CAAC,GAAG;YACZ,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI,CAAC,MAAM;SACR,CAAC;QAElB,IAAA,2BAAiB,EAAC,UAAU,CAAC,CAAC;QAE9B,OAAO,UAAU,CAAC;IACpB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,EAAU;QACd,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACrC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAI,CAAC,EAAU;QACb,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,GAAG,IAAA,kCAAwB,EAAC;YACtD,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI,CAAC,MAA0B;SAC5C,CAAC,CAAC;QAEH,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CAAC,aAAuB,EAAE,EAAU;QACtC,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,MAAM,GAAG,IAAA,aAAI,EAAC,IAAI,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QAChD,OAAO,IAAI,MAAM,CAAC,MAA0B,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,UAA4B,EAAE,EAAU;QAC7C,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,OAAO,IAAI,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,UAAU,EAAE,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CAAC,YAAoB,EAAE,UAAqD,EAAE,EAAU;QAC1F,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;QAC1E,CAAC;QAED,MAAM,MAAM,GAAG;YACb,CAAC,YAAY,CAAC,EAAE;gBACd,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,IAAI,CAAC,MAAM;gBACvB,GAAG,CAAC,UAAU,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;aACtC;SACkB,CAAC;QAEtB,OAAO,IAAI,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;CACF;AAED,kBAAe,MAAM,CAAC"}

package/dist/ValidationError.d.ts

@@ -0,0 +1,70 @@
+import type { SchemaErrorDetail } from 'z-schema';
+import { TargetObject } from './helpers/JsonSchema';
+/**
+ * Normalized validation error thrown when object validation fails against a schema.
+ *
+ * This error is thrown by the Validator when an object does not conform to its schema.
+ * It extends the standard Error class and provides structured access to validation
+ * failure details, including the schema ID, the invalid object, and normalized error
+ * information for each validation failure.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   validator.validate(userData, 'UserSchema');
+ * } catch (error) {
+ *   if (error instanceof ValidationError) {
+ *     const errorDetails = error.toJSON();
+ *     console.error(errorDetails.schemaId); // 'UserSchema'
+ *     console.error(errorDetails.validationErrors); // Array of validation failures
+ *   }
+ * }
+ * ```
+ */
+declare class ValidationError extends Error {
+    private _object;
+    private _schemaId;
+    private _validationErrors;
+    /**
+     * Creates a validation error instance.
+     *
+     * @param schemaId - The identifier of the schema that failed validation
+     * @param invalidObject - The object that failed validation (may be partially processed)
+     * @param validationErrors - Array of validation error details from z-schema, which will be
+     *                          normalized to extract only path, code, params, and message
+     */
+    constructor(schemaId: string, invalidObject: TargetObject, validationErrors: SchemaErrorDetail[]);
+    /**
+     * Returns a JSON serializable representation of the validation error.
+     *
+     * This method is useful for:
+     * - API error responses (can be directly serialized and sent to clients)
+     * - Logging validation failures in a structured format
+     * - Error reporting and debugging
+     *
+     * @returns An object containing:
+     *   - `code`: The error class name ('ValidationError')
+     *   - `object`: The invalid object that failed validation
+     *   - `message`: The error message (e.g., '"SchemaId" validation failed')
+     *   - `schemaId`: The identifier of the schema that failed validation
+     *   - `validationErrors`: Array of normalized validation errors, each containing:
+     *     - `path`: JSON path to the invalid field (e.g., '#/user/email')
+     *     - `code`: Error code from z-schema (e.g., 'INVALID_TYPE', 'REQUIRED')
+     *     - `params`: Array of error-specific parameters
+     *     - `message`: Human-readable error message
+     */
+    toJSON(): {
+        code: string;
+        object: TargetObject;
+        message: string;
+        schemaId: string;
+        validationErrors: {
+            path: string;
+            code: string;
+            params: string[];
+            message: string;
+        }[];
+    };
+}
+export default ValidationError;
+//# sourceMappingURL=ValidationError.d.ts.map

package/dist/ValidationError.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationError.d.ts","sourceRoot":"","sources":["../src/ValidationError.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,cAAM,eAAgB,SAAQ,KAAK;IACjC,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,iBAAiB,CAKrB;IAEJ;;;;;;;OAOG;gBACS,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,YAAY,EAAE,gBAAgB,EAAE,iBAAiB,EAAE;IAgBhG;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM;;;;;;kBAjDE,MAAM;kBACN,MAAM;oBACJ,MAAM,EAAE;qBACP,MAAM;;;CAuDlB;AAED,eAAe,eAAe,CAAC"}

package/dist/ValidationError.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Normalized validation error thrown when object validation fails against a schema.
+ *
+ * This error is thrown by the Validator when an object does not conform to its schema.
+ * It extends the standard Error class and provides structured access to validation
+ * failure details, including the schema ID, the invalid object, and normalized error
+ * information for each validation failure.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   validator.validate(userData, 'UserSchema');
+ * } catch (error) {
+ *   if (error instanceof ValidationError) {
+ *     const errorDetails = error.toJSON();
+ *     console.error(errorDetails.schemaId); // 'UserSchema'
+ *     console.error(errorDetails.validationErrors); // Array of validation failures
+ *   }
+ * }
+ * ```
+ */
+class ValidationError extends Error {
+    _object;
+    _schemaId;
+    _validationErrors;
+    /**
+     * Creates a validation error instance.
+     *
+     * @param schemaId - The identifier of the schema that failed validation
+     * @param invalidObject - The object that failed validation (may be partially processed)
+     * @param validationErrors - Array of validation error details from z-schema, which will be
+     *                          normalized to extract only path, code, params, and message
+     */
+    constructor(schemaId, invalidObject, validationErrors) {
+        super(`"${schemaId}" validation failed`);
+        this._object = invalidObject;
+        this._schemaId = schemaId;
+        this._validationErrors = validationErrors
+            .map(error => ({
+            path: error.path,
+            code: error.code,
+            params: error.params,
+            message: error.message,
+        }));
+    }
+    /**
+     * Returns a JSON serializable representation of the validation error.
+     *
+     * This method is useful for:
+     * - API error responses (can be directly serialized and sent to clients)
+     * - Logging validation failures in a structured format
+     * - Error reporting and debugging
+     *
+     * @returns An object containing:
+     *   - `code`: The error class name ('ValidationError')
+     *   - `object`: The invalid object that failed validation
+     *   - `message`: The error message (e.g., '"SchemaId" validation failed')
+     *   - `schemaId`: The identifier of the schema that failed validation
+     *   - `validationErrors`: Array of normalized validation errors, each containing:
+     *     - `path`: JSON path to the invalid field (e.g., '#/user/email')
+     *     - `code`: Error code from z-schema (e.g., 'INVALID_TYPE', 'REQUIRED')
+     *     - `params`: Array of error-specific parameters
+     *     - `message`: Human-readable error message
+     */
+    toJSON() {
+        return {
+            code: this.constructor.name,
+            object: this._object,
+            message: this.message,
+            schemaId: this._schemaId,
+            validationErrors: this._validationErrors
+        };
+    }
+}
+exports.default = ValidationError;
+//# sourceMappingURL=ValidationError.js.map

package/dist/ValidationError.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ValidationError.js","sourceRoot":"","sources":["../src/ValidationError.ts"],"names":[],"mappings":";;AAIA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,eAAgB,SAAQ,KAAK;IACzB,OAAO,CAAe;IACtB,SAAS,CAAS;IAClB,iBAAiB,CAKrB;IAEJ;;;;;;;OAOG;IACH,YAAY,QAAgB,EAAE,aAA2B,EAAE,gBAAqC;QAC9F,KAAK,CAAC,IAAI,QAAQ,qBAAqB,CAAC,CAAC;QAEzC,IAAI,CAAC,OAAO,GAAG,aAAa,CAAC;QAE7B,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;QAE1B,IAAI,CAAC,iBAAiB,GAAG,gBAAgB;aACtC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YACb,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,OAAO,EAAE,KAAK,CAAC,OAAO;SACvB,CAAC,CAAC,CAAC;IACR,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI;YAC3B,MAAM,EAAE,IAAI,CAAC,OAAO;YACpB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,SAAS;YACxB,gBAAgB,EAAE,IAAI,CAAC,iBAAiB;SACzC,CAAC;IACJ,CAAC;CACF;AAED,kBAAe,eAAe,CAAC"}