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

package/dist/CredentialFactory.js.map

@@ -1 +1 @@
-{"version":3,"file":"CredentialFactory.js","sourceRoot":"","sources":["../src/CredentialFactory.ts"],"names":[],"mappings":";;;;;AAAA,6DAAgD;AAEhD,4DAAoC;AACpC,sEAA8C;AAE9C,sDAAuD;AAEvD,MAAM,EAAE,0BAA0B,EAAE,GAAG,+BAAS,CAAC;AAEjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG;AACH,MAAM,iBAAiB;IACb,IAAI,CAAS;IACb,MAAM,CAAW;IACjB,QAAQ,CAAiC;IACzC,UAAU,CAAY;IAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,YAAY,GAAW,EAAE,OAAiB;QACxC,IAAA,oBAAU,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAEvB,IAAI,CAAC,MAAM,GAAG,OAAO;aAClB,GAAG,CAAC,MAAM,CAAC,EAAE;YACZ,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;gBACf,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,OAAO,IAAI,gBAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAI,mBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE7C,KAAK,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACjD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,cAAe,CAAC;QACtC,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,IAAI,cAAc;QAChB,MAAM,CAAE,cAAc,CAAE,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;QAE1D,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,IAAI,OAAO;QACT,OAAO;YACL,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE;YAC3C,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAwGG;IACH,gBAAgB,CAAC,EAAU,EAAE,MAAc,EAAE,UAAwB,EAAE;QACrE,IAAA,oBAAU,EAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACrB,IAAA,oBAAU,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE7B,MAAM,IAAI,GAAG;YACX,sBAAsB;YACtB,IAAI,CAAC,cAAc;SACpB,CAAC;QAEF,MAAM,CAAE,QAAQ,CAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACjC,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAEzE,OAAO;YACL,UAAU,EAAE;gBACV,0BAA0B;gBAC1B,IAAI,CAAC,OAAO;aACb;YACD,EAAE;YACF,IAAI;YACJ,MAAM;YACN,iBAAiB;SAClB,CAAC;IACJ,CAAC;CACF;AAED,kBAAe,iBAAiB,CAAC"}
+{"version":3,"file":"CredentialFactory.js","sourceRoot":"","sources":["../src/CredentialFactory.ts"],"names":[],"mappings":";;;;;AAAA,6DAAgD;AAEhD,4DAAoC;AACpC,sEAA8C;AAC9C,sDAAuD;AAEvD,MAAM,EAAE,0BAA0B,EAAE,GAAG,+BAAS,CAAC;AAEjD,mGAAmG;AACnG,MAAM,iBAAiB;IACb,IAAI,CAAS;IACb,MAAM,CAAW;IACjB,QAAQ,CAAiC;IACzC,UAAU,CAAY;IAE9B,gDAAgD;IAChD,YAAY,GAAW,EAAE,OAAiB;QACxC,IAAA,oBAAU,EAAC,KAAK,EAAE,GAAG,CAAC,CAAC;QAEvB,IAAI,CAAC,MAAM,GAAG,OAAO;aAClB,GAAG,CAAC,MAAM,CAAC,EAAE;YACZ,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;gBACf,OAAO,MAAM,CAAC;YAChB,CAAC;YAED,OAAO,IAAI,gBAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEL,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC;QAChB,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,UAAU,GAAG,IAAI,mBAAS,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE7C,KAAK,MAAM,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YACjD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,cAAe,CAAC;QACtC,CAAC;IACH,CAAC;IAED,uEAAuE;IACvE,IAAI,cAAc;QAChB,MAAM,CAAE,cAAc,CAAE,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC;QAE1D,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,6DAA6D;IAC7D,IAAI,OAAO;QACT,OAAO;YACL,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE;YAC3C,GAAG,IAAI,CAAC,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,iEAAiE;IACjE,gBAAgB,CAAC,EAAU,EAAE,MAAc,EAAE,UAAwB,EAAE;QACrE,IAAA,oBAAU,EAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACrB,IAAA,oBAAU,EAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE7B,MAAM,IAAI,GAAG;YACX,sBAAsB;YACtB,IAAI,CAAC,cAAc;SACpB,CAAC;QAEF,MAAM,CAAE,QAAQ,CAAE,GAAG,IAAI,CAAC,MAAM,CAAC;QACjC,MAAM,iBAAiB,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAEzE,OAAO;YACL,UAAU,EAAE;gBACV,0BAA0B;gBAC1B,IAAI,CAAC,OAAO;aACb;YACD,EAAE;YACF,IAAI;YACJ,MAAM;YACN,iBAAiB;SAClB,CAAC;IACJ,CAAC;CACF;AAED,kBAAe,iBAAiB,CAAC"}

package/dist/Schema.d.ts

@@ -1,446 +1,41 @@
+import type { JsonSchema } from 'z-schema';
 import type { LinkedDataContext } from './ld/getLinkedDataContext';
-import type { JsonSchema, EnumSchema, PropertiesSchema } from './helpers/JsonSchema';
-/**
- * JSON-LD linked data type structure for semantic web integration.
- *
- * **Intent:** Provide a standardized format for representing schemas in the
- * semantic web, enabling integration with Linked Data and Verifiable Credentials.
- *
- * **Use Cases:**
- * - Generate Verifiable Credentials with proper semantic context
- * - Create JSON-LD documents compatible with schema.org and other vocabularies
- * - Enable semantic interoperability between different systems
- * - Support decentralized identity and credential systems
- *
- * **Structure:**
- * - `@id`: The unique identifier (URI) for the schema type
- * - `@context`: The JSON-LD context mapping properties to semantic types
- *
- * **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': {
- * //     '@vocab': 'https://schema.org/',
- * //     'name': 'https://schema.org/name',
- * //     'email': 'https://schema.org/email'
- * //   }
- * // }
- * ```
- */
+/** JSON-LD linked data type structure for semantic web integration. */
 export type LinkedDataType = {
     '@id': string;
     '@context': LinkedDataContext;
 };
 export type SchemaSource = EnumSchema | PropertiesSchema;
 export type PropertiesSchemaSource = PropertiesSchema;
-/**
- * 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
- * ```
- */
+/** Schema class for defining and manipulating JSON schemas for object validation. */
 declare class Schema {
     private _id;
     private _url?;
     private _source;
     private _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
-     * ```
-     */
+    /** Creates a new Schema instance. */
     constructor(propertiesOrSchema: Schema | SchemaSource, id?: string, url?: string);
-    /**
-     * 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'
-     * ```
-     */
+    /** Returns the unique identifier for this schema. */
     get id(): string;
-    /**
-     * 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/'
-     * ```
-     */
+    /** Returns the URL associated with this schema for JSON-LD linked data generation. */
     get url(): string | undefined;
-    /**
-     * 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
-     * ```
-     */
+    /** Returns a deep clone of the schema's source properties or enum definition. */
     get source(): EnumSchema | PropertiesSchema;
-    /**
-     * 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
-     * ```
-     */
+    /** Checks if this schema is an enum schema (defines a set of allowed values). */
     get isEnum(): boolean;
-    /**
-     * 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' }
-     * ```
-     */
+    /** Returns a normalized JSON Schema representation of this schema. */
     get jsonSchema(): 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.
-     */
+    /** Returns the JSON-LD linked data type if a URL was provided during construction. */
     get linkedDataType(): LinkedDataType | undefined;
-    /**
-     * 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
-     * ```
-     */
+    /** Creates a complete clone of the schema with a new identifier. */
     clone(id?: string): Schema;
-    /**
-     * 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
-     * ```
-     */
+    /** Creates a schema clone without required constraints and default values. */
     pure(id?: string): Schema;
-    /**
-     * 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
-     * ```
-     */
+    /** Creates a schema clone containing only the specified properties. */
     only(propertyNames: string[], id?: string): Schema;
-    /**
-     * 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
-     * ```
-     */
+    /** Creates a schema clone extended with additional properties. */
     extend(properties: PropertiesSchema, id?: string): Schema;
-    /**
-     * 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
-     * ```
-     */
+    /** Creates a new schema that wraps the current schema as a nested property. */
     wrap(propertyName: string, attributes: {
         default?: string;
         required?: boolean;

package/dist/Schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,gBAAgB,EAEjB,MAAM,sBAAsB,CAAC;AAI9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,iBAAiB,CAAC;CAC/B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAEzD,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,cAAM,MAAM;IACV,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,OAAO,CAAgC;IAC/C,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4CG;gBACS,kBAAkB,EAAE,MAAM,GAAG,YAAY,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IA6ChF;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,EAAE,WAEL;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,GAAG,uBAEN;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,MAAM,kCAET;IAED;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,IAAI,MAAM,YAET;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoCG;IACH,IAAI,UAAU,IAAI,UAAU,CAiB3B;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,cAAc,+BAEjB;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM;IAIjB;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM;IAahB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,MAAM;IASzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,UAAU,EAAE,gBAAgB,EAAE,EAAE,CAAC,EAAE,MAAM;IAQhD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;KAAE,EAAE,EAAE,CAAC,EAAE,MAAM;CAe9F;AAED,eAAe,MAAM,CAAC"}
+{"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../src/Schema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAQ3C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAInE,uEAAuE;AACvE,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,iBAAiB,CAAC;CAC/B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAEzD,MAAM,MAAM,sBAAsB,GAAG,gBAAgB,CAAC;AAEtD,qFAAqF;AACrF,cAAM,MAAM;IACV,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,IAAI,CAAC,CAAS;IACtB,OAAO,CAAC,OAAO,CAAgC;IAC/C,OAAO,CAAC,eAAe,CAAC,CAAiB;IAEzC,qCAAqC;gBACzB,kBAAkB,EAAE,MAAM,GAAG,YAAY,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IA6ChF,qDAAqD;IACrD,IAAI,EAAE,WAEL;IAED,sFAAsF;IACtF,IAAI,GAAG,uBAEN;IAED,iFAAiF;IACjF,IAAI,MAAM,kCAET;IAED,iFAAiF;IACjF,IAAI,MAAM,YAET;IAED,sEAAsE;IACtE,IAAI,UAAU,IAAI,UAAU,CAiB3B;IAED,sFAAsF;IACtF,IAAI,cAAc,+BAEjB;IAED,oEAAoE;IACpE,KAAK,CAAC,EAAE,CAAC,EAAE,MAAM;IAIjB,8EAA8E;IAC9E,IAAI,CAAC,EAAE,CAAC,EAAE,MAAM;IAahB,uEAAuE;IACvE,IAAI,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,MAAM;IASzC,kEAAkE;IAClE,MAAM,CAAC,UAAU,EAAE,gBAAgB,EAAE,EAAE,CAAC,EAAE,MAAM;IAQhD,+EAA+E;IAC/E,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,UAAU,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;KAAE,EAAE,EAAE,CAAC,EAAE,MAAM;CAe9F;AAED,eAAe,MAAM,CAAC"}