typia 9.7.0 → 9.7.2

package/lib/schemas/json/IJsonSchemaCollection.d.ts

@@ -3,37 +3,43 @@ import type { OpenApi, OpenApiV3 } from "@samchon/openapi";
  * Collection of JSON schemas with OpenAPI specification support.
  *
  * `IJsonSchemaCollection` represents a comprehensive collection of JSON schemas
- * that can be generated from TypeScript types using the `typia.json.schemas()` function.
- * This interface supports both OpenAPI v3.0 and v3.1 specifications, with the ability
- * to automatically generate appropriate schema definitions based on the specified version.
+ * that can be generated from TypeScript types using the `typia.json.schemas()`
+ * function. This interface supports both OpenAPI v3.0 and v3.1 specifications,
+ * with the ability to automatically generate appropriate schema definitions
+ * based on the specified version.
  *
  * The collection includes:
- * - Generated JSON schemas array containing schema definitions for the specified types
+ *
+ * - Generated JSON schemas array containing schema definitions for the specified
+ *   types
  * - Reusable components that can be referenced across different schemas
- * - Version-specific formatting that adheres to either OpenAPI v3.0 or v3.1 standards
+ * - Version-specific formatting that adheres to either OpenAPI v3.0 or v3.1
+ *   standards
  *
  * Key differences between versions:
- * - OpenAPI v3.0: Uses {@link OpenApiV3.IJsonSchema} format with limited tuple support
- * - OpenAPI v3.1: Uses {@link OpenApi.IJsonSchema} format with full JSON Schema Draft 2020-12 compatibility
  *
- * @template Version The OpenAPI specification version to target ("3.0" or "3.1").
- *                   Defaults to "3.1" for enhanced JSON Schema compatibility.
- * @template Types   Array of original TypeScript types that were analyzed to generate
- *                   the JSON schemas. This provides type safety and traceability
- *                   back to the source TypeScript definitions.
+ * - OpenAPI v3.0: Uses {@link OpenApiV3.IJsonSchema} format with limited tuple
+ *   support
+ * - OpenAPI v3.1: Uses {@link OpenApi.IJsonSchema} format with full JSON Schema
+ *   Draft 2020-12 compatibility
  *
+ * @author Jeongho Nam - https://github.com/samchon
  * @example
- * ```typescript
- * // Generate schemas for OpenAPI v3.1 (default)
- * const schemas = typia.json.schemas<[User, Product]>();
- * // Type: IJsonSchemaCollection<"3.1", [User, Product]>
+ *   ```typescript
+ *   // Generate schemas for OpenAPI v3.1 (default)
+ *   const schemas = typia.json.schemas<[User, Product]>();
+ *   // Type: IJsonSchemaCollection<"3.1", [User, Product]>
  *
- * // Generate schemas for OpenAPI v3.0 (Swagger compatibility)
- * const swaggerSchemas = typia.json.schemas<[User, Product], "3.0">();
- * // Type: IJsonSchemaCollection<"3.0", [User, Product]>
- * ```
+ *   // Generate schemas for OpenAPI v3.0 (Swagger compatibility)
+ *   const swaggerSchemas = typia.json.schemas<[User, Product], "3.0">();
+ *   // Type: IJsonSchemaCollection<"3.0", [User, Product]>
+ *   ```;
  *
- * @author Jeongho Nam - https://github.com/samchon
+ * @template Version The OpenAPI specification version to target ("3.0" or
+ *   "3.1"). Defaults to "3.1" for enhanced JSON Schema compatibility.
+ * @template Types Array of original TypeScript types that were analyzed to
+ *   generate the JSON schemas. This provides type safety and traceability back
+ *   to the source TypeScript definitions.
  */
 export type IJsonSchemaCollection<Version extends "3.0" | "3.1" = "3.1", Types = unknown[]> = Version extends "3.0" ? IJsonSchemaCollection.IV3_0<Types> : IJsonSchemaCollection.IV3_1<Types>;
 export declare namespace IJsonSchemaCollection {
@@ -41,54 +47,59 @@ export declare namespace IJsonSchemaCollection {
      * JSON Schema collection formatted for OpenAPI v3.0 specification.
      *
      * This interface represents a collection of JSON schemas that comply with
-     * OpenAPI v3.0 standards, which are compatible with Swagger tools and
-     * legacy OpenAPI implementations. OpenAPI v3.0 has some limitations
-     * compared to v3.1, particularly around tuple types and pattern properties.
+     * OpenAPI v3.0 standards, which are compatible with Swagger tools and legacy
+     * OpenAPI implementations. OpenAPI v3.0 has some limitations compared to
+     * v3.1, particularly around tuple types and pattern properties.
      *
      * Key characteristics of v3.0:
+     *
      * - Cannot express tuple types natively (falls back to array representations)
      * - Cannot express pattern properties in object schemas
      * - Uses nullable property instead of union with null type
      * - Limited JSON Schema Draft compatibility (based on Draft 4)
      *
-     * @template Types Array of original TypeScript types used to generate the schemas.
-     *                 This provides compile-time type information about what types
-     *                 were analyzed during schema generation.
+     * @template Types Array of original TypeScript types used to generate the
+     *   schemas. This provides compile-time type information about what types
+     *   were analyzed during schema generation.
      */
     interface IV3_0<Types = unknown[]> {
         /**
          * OpenAPI specification version identifier.
          *
-         * Always set to "3.0" to indicate this collection uses OpenAPI v3.0
-         * schema format and constraints.
+         * Always set to "3.0" to indicate this collection uses OpenAPI v3.0 schema
+         * format and constraints.
          */
         version: "3.0";
         /**
          * Array of generated JSON schemas.
          *
-         * Contains the actual JSON schema definitions generated from the input TypeScript types.
-         * Each schema in this array corresponds to one of the types specified in the `Types`
-         * template parameter. The schemas follow OpenAPI v3.0 format and may contain
-         * references to components defined in the {@link components} property.
+         * Contains the actual JSON schema definitions generated from the input
+         * TypeScript types. Each schema in this array corresponds to one of the
+         * types specified in the `Types` template parameter. The schemas follow
+         * OpenAPI v3.0 format and may contain references to components defined in
+         * the {@link components} property.
          *
-         * Schema references typically use the format: `{ "$ref": "#/components/schemas/TypeName" }`
+         * Schema references typically use the format: `{ "$ref":
+         * "#/components/schemas/TypeName" }`
          */
         schemas: OpenApiV3.IJsonSchema[];
         /**
          * Reusable schema components for OpenAPI v3.0.
          *
-         * Contains reusable schema definitions, security schemes, and other components
-         * that can be referenced from the main schemas. This follows the OpenAPI v3.0
-         * components structure and enables schema reuse and modularity.
+         * Contains reusable schema definitions, security schemes, and other
+         * components that can be referenced from the main schemas. This follows the
+         * OpenAPI v3.0 components structure and enables schema reuse and
+         * modularity.
          *
          * Components include:
-         * - schemas: Named type definitions that can be referenced via $ref
-         * - securitySchemes: Authentication and authorization schemes
-         * - parameters: Reusable parameter definitions
-         * - requestBodies: Reusable request body definitions
-         * - responses: Reusable response definitions
-         * - headers: Reusable header definitions
-         * - examples: Reusable example definitions
+         *
+         * - Schemas: Named type definitions that can be referenced via $ref
+         * - SecuritySchemes: Authentication and authorization schemes
+         * - Parameters: Reusable parameter definitions
+         * - RequestBodies: Reusable request body definitions
+         * - Responses: Reusable response definitions
+         * - Headers: Reusable header definitions
+         * - Examples: Reusable example definitions
          */
         components: OpenApiV3.IComponents;
         /**
@@ -100,6 +111,7 @@ export declare namespace IJsonSchemaCollection {
          * and undefined to prevent it from appearing in serialized JSON output.
          *
          * This enables:
+         *
          * - Compile-time type checking against the original types
          * - IDE intellisense and autocompletion
          * - Type-safe schema validation and usage
@@ -111,38 +123,40 @@ export declare namespace IJsonSchemaCollection {
      *
      * This interface represents a collection of JSON schemas that comply with
      * OpenAPI v3.1 standards, which provide enhanced JSON Schema compatibility
-     * and support for modern JSON Schema features. OpenAPI v3.1 is based on
-     * JSON Schema Draft 2020-12 and offers significant improvements over v3.0.
+     * and support for modern JSON Schema features. OpenAPI v3.1 is based on JSON
+     * Schema Draft 2020-12 and offers significant improvements over v3.0.
      *
      * Key advantages of v3.1:
+     *
      * - Full tuple type support with prefixItems
      * - Pattern properties support for dynamic object keys
      * - Proper null type handling via union types
      * - Enhanced JSON Schema Draft 2020-12 compatibility
      * - Better const, enum, and validation support
      *
-     * @template Types Array of original TypeScript types used to generate the schemas.
-     *                 This provides compile-time type information about what types
-     *                 were analyzed during schema generation.
+     * @template Types Array of original TypeScript types used to generate the
+     *   schemas. This provides compile-time type information about what types
+     *   were analyzed during schema generation.
      */
     interface IV3_1<Types = unknown[]> {
         /**
          * OpenAPI specification version identifier.
          *
-         * Always set to "3.1" to indicate this collection uses OpenAPI v3.1
-         * schema format with enhanced JSON Schema compatibility.
+         * Always set to "3.1" to indicate this collection uses OpenAPI v3.1 schema
+         * format with enhanced JSON Schema compatibility.
          */
         version: "3.1";
         /**
          * Reusable schema components for OpenAPI v3.1.
          *
          * Contains reusable schema definitions and other components following the
-         * OpenAPI v3.1 specification. This structure is similar to v3.0 but supports
-         * enhanced JSON Schema features and improved type definitions.
+         * OpenAPI v3.1 specification. This structure is similar to v3.0 but
+         * supports enhanced JSON Schema features and improved type definitions.
          *
          * Components include:
-         * - schemas: Named type definitions with enhanced JSON Schema support
-         * - securitySchemes: Authentication and authorization schemes
+         *
+         * - Schemas: Named type definitions with enhanced JSON Schema support
+         * - SecuritySchemes: Authentication and authorization schemes
          *
          * The emended OpenAPI v3.1 format used here removes ambiguous expressions
          * and standardizes certain patterns for better tooling compatibility.
@@ -154,6 +168,7 @@ export declare namespace IJsonSchemaCollection {
          * Contains JSON schema definitions that take advantage of OpenAPI v3.1's
          * enhanced capabilities. These schemas can express more complex TypeScript
          * types accurately, including:
+         *
          * - Tuple types using prefixItems
          * - Union types with proper null handling
          * - Complex nested object structures
@@ -168,9 +183,11 @@ export declare namespace IJsonSchemaCollection {
          *
          * This optional property stores the original TypeScript types that were
          * used to generate the JSON schemas. It provides compile-time type safety
-         * and enables better development experience without affecting runtime behavior.
+         * and enables better development experience without affecting runtime
+         * behavior.
          *
          * Benefits include:
+         *
          * - Strong typing connection to original TypeScript definitions
          * - Enhanced IDE support and autocompletion
          * - Compile-time validation of schema usage

package/lib/schemas/json/IJsonSchemaUnit.d.mts

@@ -2,55 +2,57 @@ import { OpenApi, OpenApiV3 } from "@samchon/openapi";
 /**
  * Single unit of JSON schema representation.
  *
- * `IJsonSchemaUnit` represents a self-contained JSON schema unit that encapsulates
- * a single schema definition along with its associated reusable components. This is
- * typically used when generating a JSON schema for a single TypeScript type, as
- * opposed to a collection of multiple types.
+ * `IJsonSchemaUnit` represents a self-contained JSON schema unit that
+ * encapsulates a single schema definition along with its associated reusable
+ * components. This is typically used when generating a JSON schema for a single
+ * TypeScript type, as opposed to a collection of multiple types.
  *
- * Unlike {@link IJsonSchemaCollection} which handles multiple schemas, `IJsonSchemaUnit`
- * focuses on representing a single schema with its dependencies. This makes it ideal
- * for scenarios where you need to work with individual type definitions or when
- * integrating with systems that expect single schema documents.
+ * Unlike {@link IJsonSchemaCollection} which handles multiple schemas,
+ * `IJsonSchemaUnit` focuses on representing a single schema with its
+ * dependencies. This makes it ideal for scenarios where you need to work with
+ * individual type definitions or when integrating with systems that expect
+ * single schema documents.
  *
  * The unit contains:
+ *
  * - A single JSON schema definition for the specified TypeScript type
  * - All necessary reusable components that the schema may reference
  * - Version-specific formatting for either OpenAPI v3.0 or v3.1 compatibility
  * - Optional type metadata for compile-time type safety
  *
  * Key differences from collection:
+ *
  * - Contains only one schema instead of an array of schemas
  * - More lightweight for single-type use cases
  * - Simpler structure for direct schema consumption
  * - Still maintains full component reference support
  *
- * @template Version The OpenAPI specification version to target ("3.0" or "3.1").
- *                   Defaults to "3.1" for enhanced JSON Schema Draft 2020-12 compatibility.
- *                   This determines the schema format, validation capabilities, and
- *                   available features like tuple support and null type handling.
- * @template Type    The original TypeScript type that was analyzed to generate this
- *                   JSON schema unit. This provides compile-time type safety and
- *                   enables IDEs to provide better intellisense and validation.
- *
+ * @author Jeongho Nam - https://github.com/samchon
  * @example
- * ```typescript
- * interface User {
- *   id: string;
- *   name: string;
- *   email?: string;
- * }
+ *   ```typescript
+ *   interface User {
+ *     id: string;
+ *     name: string;
+ *     email?: string;
+ *   }
  *
- * // Generate a single schema unit for OpenAPI v3.1 (default)
- * const userSchema = typia.json.schema<User>();
- * // Type: IJsonSchemaUnit<"3.1", User>
+ *   // Generate a single schema unit for OpenAPI v3.1 (default)
+ *   const userSchema = typia.json.schema<User>();
+ *   // Type: IJsonSchemaUnit<"3.1", User>
  *
- * // Generate a single schema unit for OpenAPI v3.0 (Swagger compatibility)
- * const swaggerUserSchema = typia.json.schema<User, "3.0">();
- * // Type: IJsonSchemaUnit<"3.0", User>
- * ```
+ *   // Generate a single schema unit for OpenAPI v3.0 (Swagger compatibility)
+ *   const swaggerUserSchema = typia.json.schema<User, "3.0">();
+ *   // Type: IJsonSchemaUnit<"3.0", User>
+ *   ```;
  *
+ * @template Version The OpenAPI specification version to target ("3.0" or
+ *   "3.1"). Defaults to "3.1" for enhanced JSON Schema Draft 2020-12
+ *   compatibility. This determines the schema format, validation capabilities,
+ *   and available features like tuple support and null type handling.
+ * @template Type The original TypeScript type that was analyzed to generate
+ *   this JSON schema unit. This provides compile-time type safety and enables
+ *   IDEs to provide better intellisense and validation.
  * @see {@link IJsonSchemaCollection} For handling multiple schemas at once
- * @author Jeongho Nam - https://github.com/samchon
  */
 export type IJsonSchemaUnit<Version extends "3.0" | "3.1" = "3.1", Type = unknown> = Version extends "3.0" ? IJsonSchemaUnit.IV3_0<Type> : IJsonSchemaUnit.IV3_1<Type>;
 export declare namespace IJsonSchemaUnit {
@@ -58,11 +60,12 @@ export declare namespace IJsonSchemaUnit {
      * JSON Schema unit formatted for OpenAPI v3.0 specification.
      *
      * This interface represents a single JSON schema unit that complies with
-     * OpenAPI v3.0 standards. It contains one schema definition along with
-     * any reusable components that the schema references, formatted according
-     * to OpenAPI v3.0 constraints and limitations.
+     * OpenAPI v3.0 standards. It contains one schema definition along with any
+     * reusable components that the schema references, formatted according to
+     * OpenAPI v3.0 constraints and limitations.
      *
      * OpenAPI v3.0 characteristics affecting this unit:
+     *
      * - Schema follows OpenAPI v3.0 JSON Schema subset
      * - Limited support for advanced JSON Schema features
      * - Uses nullable property for optional null values
@@ -70,32 +73,34 @@ export declare namespace IJsonSchemaUnit {
      * - Based on JSON Schema Draft 4 with OpenAPI-specific extensions
      *
      * Use cases for v3.0:
+     *
      * - Integration with legacy Swagger tooling
      * - Compatibility with older OpenAPI implementations
      * - Systems that specifically require OpenAPI v3.0 format
      * - Code generation tools that expect v3.0 schemas
      *
-     * @template Type The original TypeScript type represented by this schema unit.
-     *                Provides compile-time type information and enables type-safe
-     *                operations on the schema.
+     * @template Type The original TypeScript type represented by this schema
+     *   unit. Provides compile-time type information and enables type-safe
+     *   operations on the schema.
      */
     interface IV3_0<Type> {
         /**
          * OpenAPI specification version identifier.
          *
-         * Always set to "3.0" to indicate this schema unit uses OpenAPI v3.0
-         * format and adheres to its specific constraints and limitations.
+         * Always set to "3.0" to indicate this schema unit uses OpenAPI v3.0 format
+         * and adheres to its specific constraints and limitations.
          */
         version: "3.0";
         /**
          * The primary JSON schema definition.
          *
-         * Contains the main JSON schema that represents the TypeScript type specified
-         * in the `Type` template parameter. This schema follows OpenAPI v3.0 format
-         * and may contain references to reusable components defined in the
-         * {@link components} property.
+         * Contains the main JSON schema that represents the TypeScript type
+         * specified in the `Type` template parameter. This schema follows OpenAPI
+         * v3.0 format and may contain references to reusable components defined in
+         * the {@link components} property.
          *
          * The schema structure includes:
+         *
          * - Type definitions following OpenAPI v3.0 constraints
          * - Property definitions with v3.0-compatible validation rules
          * - References to shared components using $ref syntax
@@ -113,13 +118,14 @@ export declare namespace IJsonSchemaUnit {
          * within the schema definition.
          *
          * Component categories include:
-         * - schemas: Named type definitions for complex objects, arrays, and unions
-         * - securitySchemes: Authentication and authorization definitions
-         * - parameters: Reusable parameter specifications
-         * - requestBodies: Reusable request body definitions
-         * - responses: Reusable response specifications
-         * - headers: Reusable header definitions
-         * - examples: Reusable example values
+         *
+         * - Schemas: Named type definitions for complex objects, arrays, and unions
+         * - SecuritySchemes: Authentication and authorization definitions
+         * - Parameters: Reusable parameter specifications
+         * - RequestBodies: Reusable request body definitions
+         * - Responses: Reusable response specifications
+         * - Headers: Reusable header definitions
+         * - Examples: Reusable example values
          *
          * All components follow OpenAPI v3.0 format restrictions and capabilities.
          */
@@ -132,26 +138,28 @@ export declare namespace IJsonSchemaUnit {
          * type information without affecting the runtime JSON representation.
          *
          * Benefits of type metadata:
+         *
          * - Enables type-safe schema validation and usage
          * - Provides IDE intellisense and autocompletion
          * - Allows compile-time checking of schema operations
          * - Maintains traceability to original TypeScript definitions
          *
          * The property is intentionally marked as optional and undefined to ensure
-         * it doesn't appear in serialized JSON output while preserving type information
-         * at compile time.
+         * it doesn't appear in serialized JSON output while preserving type
+         * information at compile time.
          */
         __type?: Type | undefined;
     }
     /**
      * JSON Schema unit formatted for OpenAPI v3.1 specification.
      *
-     * This interface represents a single JSON schema unit that takes advantage
-     * of OpenAPI v3.1's enhanced capabilities and improved JSON Schema compatibility.
-     * It provides a more feature-rich and accurate representation of TypeScript
-     * types compared to the v3.0 format.
+     * This interface represents a single JSON schema unit that takes advantage of
+     * OpenAPI v3.1's enhanced capabilities and improved JSON Schema
+     * compatibility. It provides a more feature-rich and accurate representation
+     * of TypeScript types compared to the v3.0 format.
      *
      * OpenAPI v3.1 advantages for this unit:
+     *
      * - Full JSON Schema Draft 2020-12 compatibility
      * - Native tuple type support using prefixItems
      * - Proper null type handling via union types
@@ -160,21 +168,22 @@ export declare namespace IJsonSchemaUnit {
      * - Better support for complex nested structures
      *
      * Use cases for v3.1:
+     *
      * - Modern OpenAPI implementations and tooling
      * - Systems requiring accurate TypeScript type representation
      * - Applications needing advanced JSON Schema features
      * - New projects without legacy compatibility requirements
      *
-     * @template Type The original TypeScript type represented by this schema unit.
-     *                Enables compile-time type safety and provides enhanced
-     *                development experience with better IDE support.
+     * @template Type The original TypeScript type represented by this schema
+     *   unit. Enables compile-time type safety and provides enhanced development
+     *   experience with better IDE support.
      */
     interface IV3_1<Type> {
         /**
          * OpenAPI specification version identifier.
          *
-         * Always set to "3.1" to indicate this schema unit uses OpenAPI v3.1
-         * format with enhanced JSON Schema compatibility and modern features.
+         * Always set to "3.1" to indicate this schema unit uses OpenAPI v3.1 format
+         * with enhanced JSON Schema compatibility and modern features.
          */
         version: "3.1";
         /**
@@ -182,9 +191,11 @@ export declare namespace IJsonSchemaUnit {
          *
          * Contains the main JSON schema that accurately represents the TypeScript
          * type using OpenAPI v3.1's enhanced capabilities. This schema can express
-         * complex TypeScript constructs that were not possible or accurate in v3.0.
+         * complex TypeScript constructs that were not possible or accurate in
+         * v3.0.
          *
          * Enhanced schema features include:
+         *
          * - Tuple types using prefixItems for exact array structure
          * - Union types with proper null handling via oneOf
          * - Const values for literal types
@@ -192,20 +203,21 @@ export declare namespace IJsonSchemaUnit {
          * - Advanced validation constraints and metadata
          * - Recursive type definitions with proper $ref handling
          *
-         * The schema follows the emended OpenAPI v3.1 format used by typia,
-         * which removes ambiguous expressions while maintaining full compatibility.
+         * The schema follows the emended OpenAPI v3.1 format used by typia, which
+         * removes ambiguous expressions while maintaining full compatibility.
          */
         schema: OpenApi.IJsonSchema;
         /**
          * Reusable schema components for OpenAPI v3.1.
          *
-         * Contains reusable schema definitions and components that leverage
-         * OpenAPI v3.1's enhanced capabilities. These components provide better
-         * type representation and more accurate schema definitions compared to v3.0.
+         * Contains reusable schema definitions and components that leverage OpenAPI
+         * v3.1's enhanced capabilities. These components provide better type
+         * representation and more accurate schema definitions compared to v3.0.
          *
          * Enhanced component features:
-         * - schemas: More accurate type definitions with v3.1 JSON Schema features
-         * - securitySchemes: Enhanced authentication scheme definitions
+         *
+         * - Schemas: More accurate type definitions with v3.1 JSON Schema features
+         * - SecuritySchemes: Enhanced authentication scheme definitions
          * - Better support for complex nested references
          * - Improved handling of recursive and circular type dependencies
          *
@@ -218,10 +230,11 @@ export declare namespace IJsonSchemaUnit {
          *
          * This optional property preserves the original TypeScript type information
          * for compile-time type checking and enhanced development experience. It
-         * enables type-safe operations and better IDE support without affecting
-         * the runtime JSON schema representation.
+         * enables type-safe operations and better IDE support without affecting the
+         * runtime JSON schema representation.
          *
          * Enhanced type safety features:
+         *
          * - Strong typing connection to original TypeScript definitions
          * - Better IDE intellisense and error detection
          * - Compile-time validation of schema usage patterns