typia 9.7.2 → 10.0.0-dev.20251107

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.
- *
- * @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;
-  };
-}>;
+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,25 +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,39 +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.
- *
- * @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;
+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.
- *
- * @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;
-  };
-}>;
+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,25 +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;
+  };
+}>;

package/src/tags/Minimum.ts

@@ -1,39 +1,39 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Minimum value constraint tag.
- *
- * Enforces that a numeric value must be greater than or equal to the specified
- * minimum. This constraint validates that the input value satisfies: input >=
- * minimum.
- *
- * Example usage:
- *
- * ```typescript
- * type Age = number & tags.Minimum<0>; // Age must be 0 or greater
- * type Balance = bigint & tags.Minimum<0n>; // BigInt balance must be non-negative
- * ```
- *
- * Note: This tag is mutually exclusive with ExclusiveMinimum. You cannot apply
- * both Minimum and ExclusiveMinimum constraints to the same property.
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @template Value - The minimum value constraint (number or bigint literal)
- */
-export type Minimum<Value extends number | bigint> = TagBase<{
-  target: Value extends bigint ? "bigint" : "number";
-  kind: "minimum";
-  value: Value;
-  validate: `${Cast<Value>} <= $input`;
-  exclusive: ["minimum", "exclusiveMinimum"];
-  schema: Value extends bigint
-    ? { minimum: Numeric<Value> }
-    : { minimum: 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";
+
+/**
+ * Minimum value constraint tag.
+ *
+ * Enforces that a numeric value must be greater than or equal to the specified
+ * minimum. This constraint validates that the input value satisfies: input >=
+ * minimum.
+ *
+ * Example usage:
+ *
+ * ```typescript
+ * type Age = number & tags.Minimum<0>; // Age must be 0 or greater
+ * type Balance = bigint & tags.Minimum<0n>; // BigInt balance must be non-negative
+ * ```
+ *
+ * Note: This tag is mutually exclusive with ExclusiveMinimum. You cannot apply
+ * both Minimum and ExclusiveMinimum constraints to the same property.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template Value - The minimum value constraint (number or bigint literal)
+ */
+export type Minimum<Value extends number | bigint> = TagBase<{
+  target: Value extends bigint ? "bigint" : "number";
+  kind: "minimum";
+  value: Value;
+  validate: `${Cast<Value>} <= $input`;
+  exclusive: ["minimum", "exclusiveMinimum"];
+  schema: Value extends bigint
+    ? { minimum: Numeric<Value> }
+    : { minimum: 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/MultipleOf.ts

@@ -1,42 +1,42 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Multiple of constraint tag.
- *
- * Enforces that a numeric value must be an exact multiple of the specified
- * divisor. This constraint validates that the input value satisfies: input %
- * divisor === 0.
- *
- * Example usage:
- *
- * ```typescript
- * type EvenNumber = number & tags.MultipleOf<2>; // Must be even (2, 4, 6, ...)
- * type DollarAmount = number & tags.MultipleOf<0.01>; // Must be in cents
- * ```
- *
- * Common use cases include validating even/odd numbers, currency amounts, time
- * intervals, or any value that must align to specific increments.
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @template Value - The divisor value that input must be a multiple of (number
- *   or bigint literal)
- */
-export type MultipleOf<Value extends number | bigint> = TagBase<{
-  target: Value extends bigint ? "bigint" : "number";
-  kind: "multipleOf";
-  value: Value;
-  validate: `$input % ${Cast<Value>} === ${Value extends bigint
-    ? Cast<0n>
-    : 0}`;
-  exclusive: true;
-  schema: Value extends bigint
-    ? { multipleOf: Numeric<Value> }
-    : { multipleOf: 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";
+
+/**
+ * Multiple of constraint tag.
+ *
+ * Enforces that a numeric value must be an exact multiple of the specified
+ * divisor. This constraint validates that the input value satisfies: input %
+ * divisor === 0.
+ *
+ * Example usage:
+ *
+ * ```typescript
+ * type EvenNumber = number & tags.MultipleOf<2>; // Must be even (2, 4, 6, ...)
+ * type DollarAmount = number & tags.MultipleOf<0.01>; // Must be in cents
+ * ```
+ *
+ * Common use cases include validating even/odd numbers, currency amounts, time
+ * intervals, or any value that must align to specific increments.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template Value - The divisor value that input must be a multiple of (number
+ *   or bigint literal)
+ */
+export type MultipleOf<Value extends number | bigint> = TagBase<{
+  target: Value extends bigint ? "bigint" : "number";
+  kind: "multipleOf";
+  value: Value;
+  validate: `$input % ${Cast<Value>} === ${Value extends bigint
+    ? Cast<0n>
+    : 0}`;
+  exclusive: true;
+  schema: Value extends bigint
+    ? { multipleOf: Numeric<Value> }
+    : { multipleOf: 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/Pattern.ts

@@ -1,49 +1,49 @@
-import { TagBase } from "./TagBase";
-
-/**
- * String pattern (regular expression) constraint tag.
- *
- * Validates that a string matches a specified regular expression pattern. Use
- * this tag to enforce custom string formats through regex validation.
- *
- * Examples:
- *
- * ```ts
- * type PhoneNumber = string & Pattern<"^\d{3}-\d{3}-\d{4}$">; // 123-456-7890
- * type HexColor = string & Pattern<"^#[0-9A-Fa-f]{6}$">; // #FF5733
- * ```
- *
- * Note: This tag is mutually exclusive with the Format tag. You cannot use both
- * Pattern and Format on the same type.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export type Pattern<Value extends string> = TagBase<{
-  target: "string";
-  kind: "pattern";
-  value: Value;
-  validate: `RegExp("${Serialize<Value>}").test($input)`;
-  exclusive: ["format", "pattern"];
-  schema: {
-    pattern: Value;
-  };
-}>;
-
-/// reference: https://github.com/type-challenges/type-challenges/issues/22394#issuecomment-1397158205
-type Serialize<T extends string, Output extends string = ""> = string extends T
-  ? never
-  : T extends ""
-    ? Output
-    : T extends `${infer P}${infer R}`
-      ? Serialize<R, `${Output}${P extends keyof Escaper ? Escaper[P] : P}`>
-      : never;
-
-type Escaper = {
-  '"': '\\"';
-  "\\": "\\\\";
-  "\b": "\\b";
-  "\f": "\\f";
-  "\n": "\\n";
-  "\r": "\\r";
-  "\t": "\\t";
-};
+import { TagBase } from "./TagBase";
+
+/**
+ * String pattern (regular expression) constraint tag.
+ *
+ * Validates that a string matches a specified regular expression pattern. Use
+ * this tag to enforce custom string formats through regex validation.
+ *
+ * Examples:
+ *
+ * ```ts
+ * type PhoneNumber = string & Pattern<"^\d{3}-\d{3}-\d{4}$">; // 123-456-7890
+ * type HexColor = string & Pattern<"^#[0-9A-Fa-f]{6}$">; // #FF5733
+ * ```
+ *
+ * Note: This tag is mutually exclusive with the Format tag. You cannot use both
+ * Pattern and Format on the same type.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export type Pattern<Value extends string> = TagBase<{
+  target: "string";
+  kind: "pattern";
+  value: Value;
+  validate: `RegExp("${Serialize<Value>}").test($input)`;
+  exclusive: ["format", "pattern"];
+  schema: {
+    pattern: Value;
+  };
+}>;
+
+/// reference: https://github.com/type-challenges/type-challenges/issues/22394#issuecomment-1397158205
+type Serialize<T extends string, Output extends string = ""> = string extends T
+  ? never
+  : T extends ""
+    ? Output
+    : T extends `${infer P}${infer R}`
+      ? Serialize<R, `${Output}${P extends keyof Escaper ? Escaper[P] : P}`>
+      : never;
+
+type Escaper = {
+  '"': '\\"';
+  "\\": "\\\\";
+  "\b": "\\b";
+  "\f": "\\f";
+  "\n": "\\n";
+  "\r": "\\r";
+  "\t": "\\t";
+};

package/src/tags/Sequence.ts

@@ -1,37 +1,37 @@
-import { TagBase } from "./TagBase";
-
-/**
- * Assigns unique field numbers for Protocol Buffer serialization.
- *
- * In Protocol Buffer encoding, each field in a message must have a unique
- * numeric identifier. The Sequence tag assigns these field numbers to
- * TypeScript properties, enabling proper Protocol Buffer serialization and
- * deserialization. Field numbers 1-15 require only one byte to encode, making
- * them ideal for frequently used fields. Numbers 19000-19999 are reserved by
- * the Protocol Buffer specification and should not be used.
- *
- * @author Jeongho Nam - https://github.com/samchon
- * @example
- *   ```typescript
- *   interface User {
- *     id: string & Sequence<1>;        // Most frequent field uses 1
- *     email: string & Sequence<2>;     // Common fields use low numbers
- *     createdAt: number & Sequence<3>;
- *     metadata?: object & Sequence<10>; // Optional fields work too
- *   }
- *
- *   // Generate Protocol Buffer message
- *   const message = typia.protobuf.message<User>();
- *   ```
- *
- * @template N - Field number (positive integer from 1 to 536,870,911, excluding
- *   19000-19999)
- */
-export type Sequence<N extends number> = TagBase<{
-  target: "boolean" | "bigint" | "number" | "string" | "array" | "object";
-  kind: "sequence";
-  value: N;
-  schema: {
-    "x-protobuf-sequence": N;
-  };
-}>;
+import { TagBase } from "./TagBase";
+
+/**
+ * Assigns unique field numbers for Protocol Buffer serialization.
+ *
+ * In Protocol Buffer encoding, each field in a message must have a unique
+ * numeric identifier. The Sequence tag assigns these field numbers to
+ * TypeScript properties, enabling proper Protocol Buffer serialization and
+ * deserialization. Field numbers 1-15 require only one byte to encode, making
+ * them ideal for frequently used fields. Numbers 19000-19999 are reserved by
+ * the Protocol Buffer specification and should not be used.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @example
+ *   ```typescript
+ *   interface User {
+ *     id: string & Sequence<1>;        // Most frequent field uses 1
+ *     email: string & Sequence<2>;     // Common fields use low numbers
+ *     createdAt: number & Sequence<3>;
+ *     metadata?: object & Sequence<10>; // Optional fields work too
+ *   }
+ *
+ *   // Generate Protocol Buffer message
+ *   const message = typia.protobuf.message<User>();
+ *   ```
+ *
+ * @template N - Field number (positive integer from 1 to 536,870,911, excluding
+ *   19000-19999)
+ */
+export type Sequence<N extends number> = TagBase<{
+  target: "boolean" | "bigint" | "number" | "string" | "array" | "object";
+  kind: "sequence";
+  value: N;
+  schema: {
+    "x-protobuf-sequence": N;
+  };
+}>;