typia 9.7.1 → 10.0.0-dev.20251107

package/src/tags/ExclusiveMinimum.ts

@@ -1,41 +1,44 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Exclusive minimum value constraint tag.
- *
- * Enforces that a numeric value must be strictly greater than the specified minimum (not equal).
- * This constraint validates that the input value satisfies: input > minimum.
- *
- * Example usage:
- * ```typescript
- * type PositiveNumber = number & tags.ExclusiveMinimum<0>;    // Must be > 0
- * type LargeCount = bigint & tags.ExclusiveMinimum<999n>;     // Must be > 999
- * ```
- *
- * Note: This tag is mutually exclusive with Minimum. You cannot apply both
- * ExclusiveMinimum and Minimum constraints to the same property.
- *
- * @template Value - The exclusive minimum value constraint (number or bigint literal)
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type ExclusiveMinimum<Value extends number | bigint> = TagBase<{
-  target: Value extends bigint ? "bigint" : "number";
-  kind: "exclusiveMinimum";
-  value: Value;
-  validate: `${Cast<Value>} < $input`;
-  exclusive: ["exclusiveMinimum", "minimum"];
-  schema: Value extends bigint
-    ? {
-        exclusiveMinimum: Numeric<Value>;
-      }
-    : {
-        exclusiveMinimum: Value;
-      };
-}>;
-
-type Cast<Value extends number | bigint> = Value extends number
-  ? Value
-  : `BigInt(${Value})`;
-type Numeric<T extends bigint> = `${T}` extends `${infer N extends number}`
-  ? N
-  : never;
+import { TagBase } from "./TagBase";
+
+/**
+ * Exclusive minimum value constraint tag.
+ *
+ * Enforces that a numeric value must be strictly greater than the specified
+ * minimum (not equal). This constraint validates that the input value
+ * satisfies: input > minimum.
+ *
+ * Example usage:
+ *
+ * ```typescript
+ * type PositiveNumber = number & tags.ExclusiveMinimum<0>; // Must be > 0
+ * type LargeCount = bigint & tags.ExclusiveMinimum<999n>; // Must be > 999
+ * ```
+ *
+ * Note: This tag is mutually exclusive with Minimum. You cannot apply both
+ * ExclusiveMinimum and Minimum constraints to the same property.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template Value - The exclusive minimum value constraint (number or bigint
+ *   literal)
+ */
+export type ExclusiveMinimum<Value extends number | bigint> = TagBase<{
+  target: Value extends bigint ? "bigint" : "number";
+  kind: "exclusiveMinimum";
+  value: Value;
+  validate: `${Cast<Value>} < $input`;
+  exclusive: ["exclusiveMinimum", "minimum"];
+  schema: Value extends bigint
+    ? {
+        exclusiveMinimum: Numeric<Value>;
+      }
+    : {
+        exclusiveMinimum: Value;
+      };
+}>;
+
+type Cast<Value extends number | bigint> = Value extends number
+  ? Value
+  : `BigInt(${Value})`;
+type Numeric<T extends bigint> = `${T}` extends `${infer N extends number}`
+  ? N
+  : never;

package/src/tags/Format.ts

@@ -1,74 +1,78 @@
-import type { TagBase } from "./TagBase";
-
-/**
- * String format constraint tag.
- *
- * Validates strings against predefined formats for common use cases.
- * This tag provides built-in validation for standard string formats without
- * needing to write custom regular expressions.
- *
- * Examples:
- *   type Email = string & Format<"email">;              // user@example.com
- *   type WebURL = string & Format<"url">;               // https://example.com
- *   type DateTime = string & Format<"date-time">;       // 2024-01-15T10:30:00Z
- *
- * Supported formats include:
- * - Network: email, url, hostname, ipv4, ipv6, uri
- * - Identifiers: uuid, byte, password
- * - Date/Time: date, time, date-time, duration
- * - Data: json-pointer, regex
- * - Internationalized: idn-email, idn-hostname, iri
- *
- * Note: This tag is mutually exclusive with the Pattern tag. You cannot use both
- * Format and Pattern on the same type.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type Format<Value extends Format.Value> = TagBase<{
-  target: "string";
-  kind: "format";
-  value: Value;
-  validate: `$importInternal("isFormat${PascalizeString<Value>}")($input)`;
-  exclusive: ["format", "pattern"];
-  schema: {
-    format: Value;
-  };
-}>;
-export namespace Format {
-  export type Value =
-    | "byte"
-    | "password"
-    | "regex"
-    | "uuid"
-    | "email"
-    | "hostname"
-    | "idn-email"
-    | "idn-hostname"
-    | "iri"
-    | "iri-reference"
-    | "ipv4"
-    | "ipv6"
-    | "uri"
-    | "uri-reference"
-    | "uri-template"
-    | "url"
-    | "date-time"
-    | "date"
-    | "time"
-    | "duration"
-    | "json-pointer"
-    | "relative-json-pointer";
-}
-
-type PascalizeString<Key extends string> = Key extends `-${infer R}`
-  ? `${PascalizeString<R>}`
-  : Key extends `${infer _F}-${infer _R}`
-    ? PascalizeSnakeString<Key>
-    : Capitalize<Key>;
-type PascalizeSnakeString<Key extends string> = Key extends `-${infer R}`
-  ? PascalizeSnakeString<R>
-  : Key extends `${infer F}${infer M}-${infer R}`
-    ? `${Uppercase<F>}${Lowercase<M>}${PascalizeSnakeString<R>}`
-    : Key extends `${infer F}${infer R}`
-      ? `${Uppercase<F>}${Lowercase<R>}`
-      : Key;
+import type { TagBase } from "./TagBase";
+
+/**
+ * String format constraint tag.
+ *
+ * Validates strings against predefined formats for common use cases. This tag
+ * provides built-in validation for standard string formats without needing to
+ * write custom regular expressions.
+ *
+ * Examples:
+ *
+ * ```ts
+ * Type Email = string & Format<"email">; // user@example.com
+ * Type WebURL = string & Format<"url">; // https://example.com
+ * Type DateTime = string & Format<"date-time">; // 2024-01-15T10:30:00Z
+ * ```
+ *
+ * Supported formats include:
+ *
+ * - Network: email, url, hostname, ipv4, ipv6, uri
+ * - Identifiers: uuid, byte, password
+ * - Date/Time: date, time, date-time, duration
+ * - Data: json-pointer, regex
+ * - Internationalized: idn-email, idn-hostname, iri
+ *
+ * Note: This tag is mutually exclusive with the Pattern tag. You cannot use
+ * both Format and Pattern on the same type.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type Format<Value extends Format.Value> = TagBase<{
+  target: "string";
+  kind: "format";
+  value: Value;
+  validate: `$importInternal("isFormat${PascalizeString<Value>}")($input)`;
+  exclusive: ["format", "pattern"];
+  schema: {
+    format: Value;
+  };
+}>;
+export namespace Format {
+  export type Value =
+    | "byte"
+    | "password"
+    | "regex"
+    | "uuid"
+    | "email"
+    | "hostname"
+    | "idn-email"
+    | "idn-hostname"
+    | "iri"
+    | "iri-reference"
+    | "ipv4"
+    | "ipv6"
+    | "uri"
+    | "uri-reference"
+    | "uri-template"
+    | "url"
+    | "date-time"
+    | "date"
+    | "time"
+    | "duration"
+    | "json-pointer"
+    | "relative-json-pointer";
+}
+
+type PascalizeString<Key extends string> = Key extends `-${infer R}`
+  ? `${PascalizeString<R>}`
+  : Key extends `${infer _F}-${infer _R}`
+    ? PascalizeSnakeString<Key>
+    : Capitalize<Key>;
+type PascalizeSnakeString<Key extends string> = Key extends `-${infer R}`
+  ? PascalizeSnakeString<R>
+  : Key extends `${infer F}${infer M}-${infer R}`
+    ? `${Uppercase<F>}${Lowercase<M>}${PascalizeSnakeString<R>}`
+    : Key extends `${infer F}${infer R}`
+      ? `${Uppercase<F>}${Lowercase<R>}`
+      : Key;

package/src/tags/JsonSchemaPlugin.ts

@@ -1,34 +1,36 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Injects custom properties into generated JSON Schema.
- *
- * The JsonSchemaPlugin tag allows you to add vendor-specific extensions or custom metadata
- * to the generated JSON Schema output. These properties are merged at the root level of
- * the schema and are commonly used for documentation, tooling hints, or API-specific metadata.
- * The custom properties only affect schema generation and do not impact runtime validation.
- *
- * @example
- * ```typescript
- * // Add OpenAPI vendor extensions
- * type UserId = string & JsonSchemaPlugin<{
- *   "x-internal-id": true,
- *   "x-deprecated": "Use UUID instead"
- * }>;
- *
- * // Add custom documentation metadata
- * type Price = number & JsonSchemaPlugin<{
- *   "x-format": "currency",
- *   "x-example": 19.99
- * }>;
- * ```
- *
- * @template Schema - Object containing custom properties to add to the JSON Schema
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type JsonSchemaPlugin<Schema extends object> = TagBase<{
-  target: "string" | "boolean" | "bigint" | "number" | "array" | "object";
-  kind: "jsonPlugin";
-  value: undefined;
-  schema: Schema;
-}>;
+import { TagBase } from "./TagBase";
+
+/**
+ * Injects custom properties into generated JSON Schema.
+ *
+ * The JsonSchemaPlugin tag allows you to add vendor-specific extensions or
+ * custom metadata to the generated JSON Schema output. These properties are
+ * merged at the root level of the schema and are commonly used for
+ * documentation, tooling hints, or API-specific metadata. The custom properties
+ * only affect schema generation and do not impact runtime validation.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @example
+ *   ```typescript
+ *   // Add OpenAPI vendor extensions
+ *   type UserId = string & JsonSchemaPlugin<{
+ *     "x-internal-id": true,
+ *     "x-deprecated": "Use UUID instead"
+ *   }>;
+ *
+ *   // Add custom documentation metadata
+ *   type Price = number & JsonSchemaPlugin<{
+ *     "x-format": "currency",
+ *     "x-example": 19.99
+ *   }>;
+ *   ```
+ *
+ * @template Schema - Object containing custom properties to add to the JSON
+ *   Schema
+ */
+export type JsonSchemaPlugin<Schema extends object> = TagBase<{
+  target: "string" | "boolean" | "bigint" | "number" | "array" | "object";
+  kind: "jsonPlugin";
+  value: undefined;
+  schema: Schema;
+}>;

package/src/tags/MaxItems.ts

@@ -1,31 +1,31 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Maximum items validation tag for arrays.
- *
- * Enforces that an array contains at most the specified number of items.
- * This tag is useful for limiting array sizes, such as restricting the
- * number of uploaded files, limiting selections in a form, or capping
- * the size of collections to prevent performance issues.
- *
- * @example
- * // Allow maximum 5 file uploads
- * type FileList = File[] & MaxItems<5>;
- *
- * @example
- * // Limit tags to 10 items
- * type ProductTags = string[] & MaxItems<10>;
- *
- * @template Value - The maximum number of items allowed
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type MaxItems<Value extends number> = TagBase<{
-  target: "array";
-  kind: "maxItems";
-  value: Value;
-  validate: `$input.length <= ${Value}`;
-  exclusive: true;
-  schema: {
-    maxItems: Value;
-  };
-}>;
+import { TagBase } from "./TagBase";
+
+/**
+ * Maximum items validation tag for arrays.
+ *
+ * Enforces that an array contains at most the specified number of items. This
+ * tag is useful for limiting array sizes, such as restricting the number of
+ * uploaded files, limiting selections in a form, or capping the size of
+ * collections to prevent performance issues.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @example
+ *   // Allow maximum 5 file uploads
+ *   type FileList = File[] & MaxItems<5>;
+ *
+ * @example
+ *   // Limit tags to 10 items
+ *   type ProductTags = string[] & MaxItems<10>;
+ *
+ * @template Value - The maximum number of items allowed
+ */
+export type MaxItems<Value extends number> = TagBase<{
+  target: "array";
+  kind: "maxItems";
+  value: Value;
+  validate: `$input.length <= ${Value}`;
+  exclusive: true;
+  schema: {
+    maxItems: Value;
+  };
+}>;

package/src/tags/MaxLength.ts

@@ -1,24 +1,25 @@
-import { TagBase } from "./TagBase";
-
-/**
- * String maximum length constraint tag.
- *
- * Validates that a string's length is less than or equal to the specified value.
- * This tag enforces an upper limit on the number of characters in a string.
- *
- * Examples:
- *   type ShortComment = string & MaxLength<200>;  // Comment limited to 200 characters
- *   type ZipCode = string & MaxLength<10>;        // Zip code with max 10 characters
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type MaxLength<Value extends number> = TagBase<{
-  target: "string";
-  kind: "maxLength";
-  value: Value;
-  validate: `$input.length <= ${Value}`;
-  exclusive: true;
-  schema: {
-    maxLength: Value;
-  };
-}>;
+import { TagBase } from "./TagBase";
+
+/**
+ * String maximum length constraint tag.
+ *
+ * Validates that a string's length is less than or equal to the specified
+ * value. This tag enforces an upper limit on the number of characters in a
+ * string.
+ *
+ * Examples: type ShortComment = string & MaxLength<200>; // Comment limited to
+ * 200 characters type ZipCode = string & MaxLength<10>; // Zip code with max 10
+ * characters
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type MaxLength<Value extends number> = TagBase<{
+  target: "string";
+  kind: "maxLength";
+  value: Value;
+  validate: `$input.length <= ${Value}`;
+  exclusive: true;
+  schema: {
+    maxLength: Value;
+  };
+}>;

package/src/tags/Maximum.ts

@@ -1,37 +1,39 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Maximum value constraint tag.
- *
- * Enforces that a numeric value must be less than or equal to the specified maximum.
- * This constraint validates that the input value satisfies: input <= maximum.
- *
- * Example usage:
- * ```typescript
- * type Percentage = number & tags.Maximum<100>;     // Must be <= 100
- * type SmallInt = bigint & tags.Maximum<255n>;      // BigInt must be <= 255
- * ```
- *
- * Note: This tag is mutually exclusive with ExclusiveMaximum. You cannot apply both
- * Maximum and ExclusiveMaximum constraints to the same property.
- *
- * @template Value - The maximum value constraint (number or bigint literal)
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type Maximum<Value extends number | bigint> = TagBase<{
-  target: Value extends bigint ? "bigint" : "number";
-  kind: "maximum";
-  value: Value;
-  validate: `$input <= ${Cast<Value>}`;
-  exclusive: ["maximum", "exclusiveMaximum"];
-  schema: Value extends bigint
-    ? { maximum: Numeric<Value> }
-    : { maximum: Value };
-}>;
-
-type Cast<Value extends number | bigint> = Value extends number
-  ? Value
-  : `BigInt(${Value})`;
-type Numeric<T extends bigint> = `${T}` extends `${infer N extends number}`
-  ? N
-  : never;
+import { TagBase } from "./TagBase";
+
+/**
+ * Maximum value constraint tag.
+ *
+ * Enforces that a numeric value must be less than or equal to the specified
+ * maximum. This constraint validates that the input value satisfies: input <=
+ * maximum.
+ *
+ * Example usage:
+ *
+ * ```typescript
+ * type Percentage = number & tags.Maximum<100>; // Must be <= 100
+ * type SmallInt = bigint & tags.Maximum<255n>; // BigInt must be <= 255
+ * ```
+ *
+ * Note: This tag is mutually exclusive with ExclusiveMaximum. You cannot apply
+ * both Maximum and ExclusiveMaximum constraints to the same property.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template Value - The maximum value constraint (number or bigint literal)
+ */
+export type Maximum<Value extends number | bigint> = TagBase<{
+  target: Value extends bigint ? "bigint" : "number";
+  kind: "maximum";
+  value: Value;
+  validate: `$input <= ${Cast<Value>}`;
+  exclusive: ["maximum", "exclusiveMaximum"];
+  schema: Value extends bigint
+    ? { maximum: Numeric<Value> }
+    : { maximum: Value };
+}>;
+
+type Cast<Value extends number | bigint> = Value extends number
+  ? Value
+  : `BigInt(${Value})`;
+type Numeric<T extends bigint> = `${T}` extends `${infer N extends number}`
+  ? N
+  : never;

package/src/tags/MinItems.ts

@@ -1,31 +1,31 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Minimum items validation tag for arrays.
- *
- * Enforces that an array contains at least the specified number of items.
- * This tag is useful for ensuring arrays have a minimum length requirement,
- * such as requiring at least one item in a list or a minimum number of
- * selections in a multi-choice field.
- *
- * @example
- * // Require at least 1 item in the array
- * type Tags = string[] & MinItems<1>;
- *
- * @example
- * // Require at least 3 selections
- * type MultipleChoice = number[] & MinItems<3>;
- *
- * @template Value - The minimum number of items required
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type MinItems<Value extends number> = TagBase<{
-  target: "array";
-  kind: "minItems";
-  value: Value;
-  validate: `${Value} <= $input.length`;
-  exclusive: true;
-  schema: {
-    minItems: Value;
-  };
-}>;
+import { TagBase } from "./TagBase";
+
+/**
+ * Minimum items validation tag for arrays.
+ *
+ * Enforces that an array contains at least the specified number of items. This
+ * tag is useful for ensuring arrays have a minimum length requirement, such as
+ * requiring at least one item in a list or a minimum number of selections in a
+ * multi-choice field.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @example
+ *   // Require at least 1 item in the array
+ *   type Tags = string[] & MinItems<1>;
+ *
+ * @example
+ *   // Require at least 3 selections
+ *   type MultipleChoice = number[] & MinItems<3>;
+ *
+ * @template Value - The minimum number of items required
+ */
+export type MinItems<Value extends number> = TagBase<{
+  target: "array";
+  kind: "minItems";
+  value: Value;
+  validate: `${Value} <= $input.length`;
+  exclusive: true;
+  schema: {
+    minItems: Value;
+  };
+}>;

package/src/tags/MinLength.ts

@@ -1,24 +1,25 @@
-import { TagBase } from "./TagBase";
-
-/**
- * String minimum length constraint tag.
- *
- * Validates that a string's length is greater than or equal to the specified value.
- * This tag ensures that string values meet a minimum character count requirement.
- *
- * Examples:
- *   type Username = string & MinLength<3>;     // Username must be at least 3 characters
- *   type Password = string & MinLength<8>;     // Password must be at least 8 characters
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type MinLength<Value extends number> = TagBase<{
-  target: "string";
-  kind: "minLength";
-  value: Value;
-  validate: `${Value} <= $input.length`;
-  exclusive: true;
-  schema: {
-    minLength: Value;
-  };
-}>;
+import { TagBase } from "./TagBase";
+
+/**
+ * String minimum length constraint tag.
+ *
+ * Validates that a string's length is greater than or equal to the specified
+ * value. This tag ensures that string values meet a minimum character count
+ * requirement.
+ *
+ * Examples: type Username = string & MinLength<3>; // Username must be at least
+ * 3 characters type Password = string & MinLength<8>; // Password must be at
+ * least 8 characters
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type MinLength<Value extends number> = TagBase<{
+  target: "string";
+  kind: "minLength";
+  value: Value;
+  validate: `${Value} <= $input.length`;
+  exclusive: true;
+  schema: {
+    minLength: Value;
+  };
+}>;