typia 9.3.1 → 9.5.0-dev.20250710

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2022 Jeongho Nam
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2022 Jeongho Nam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,153 +1,153 @@
-# Typia
-![Typia Logo](https://typia.io/logo.png)
-
-[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/typia/blob/master/LICENSE)
-[![NPM Version](https://img.shields.io/npm/v/typia.svg)](https://www.npmjs.com/package/typia)
-[![NPM Downloads](https://img.shields.io/npm/dm/typia.svg)](https://www.npmjs.com/package/typia)
-[![Build Status](https://github.com/samchon/typia/workflows/build/badge.svg)](https://github.com/samchon/typia/actions?query=workflow%3Abuild)
-[![Guide Documents](https://img.shields.io/badge/Guide-Documents-forestgreen)](https://typia.io/docs/)
-[![Gurubase](https://img.shields.io/badge/Gurubase-Document%20Chatbot-006BFF)](https://gurubase.io/g/typia)
-[![Discord Badge](https://img.shields.io/badge/discord-samchon-d91965?style=flat&labelColor=5866f2&logo=discord&logoColor=white&link=https://discord.gg/E94XhzrUCZ)](https://discord.gg/E94XhzrUCZ)
-
-```typescript
-// RUNTIME VALIDATORS
-export function is<T>(input: unknown): input is T; // returns boolean
-export function assert<T>(input: unknown): T; // throws TypeGuardError
-export function assertGuard<T>(input: unknown): asserts input is T;
-export function validate<T>(input: unknown): IValidation<T>; // detailed
-
-// JSON FUNCTIONS
-export namespace json {
-  export function application<T>(): IJsonApplication; // JSON schema
-  export function assertParse<T>(input: string): T; // type safe parser
-  export function assertStringify<T>(input: T): string; // safe and faster
-}
-
-// AI FUNCTION CALLING SCHEMA
-export namespace llm {
-  // collection of function calling schemas
-  export function application<Class, Model>(): ILlmApplication<Class>;
-  export function controller<Class, Model>(
-    name: string,
-    execute: Class,
-  ): ILlmController<Model>; // +executor
-  // structured output
-  export function parameters<P, Model>(): ILlmSchema.IParameters<Model>; 
-  export function schema<T, Model>(): ILlmSchema<Model>; // type schema
-}
-
-// PROTOCOL BUFFER
-export namespace protobuf {
-  export function message<T>(): string; // Protocol Buffer message
-  export function assertDecode<T>(buffer: Uint8Array): T; // safe decoder
-  export function assertEncode<T>(input: T): Uint8Array; // safe encoder
-}
-
-// RANDOM GENERATOR
-export function random<T>(g?: Partial<IRandomGenerator>): T;
-```
-
-`typia` is a transformer library supporting below features:
-
-  - Super-fast Runtime Validators
-  - Enhanced JSON schema and serde functions
-  - LLM function calling schema and structured output
-  - Protocol Buffer encoder and decoder
-  - Random data generator
-
-> [!NOTE]
->
-> - **Only one line** required, with pure TypeScript type
-> - Runtime validator is **20,000x faster** than `class-validator`
-> - JSON serialization is **200x faster** than `class-transformer`
-
-
-
-
-## Transformation
-If you call `typia` function, it would be compiled like below.
-
-This is the key concept of `typia`, transforming TypeScript type to a runtime function. The `typia.is<T>()` function is transformed to a dedicated type checker by analyzing the target type `T` in the compilation level.
-
-This feature enables developers to ensure type safety in their applications, leveraging TypeScript's static typing while also providing runtime validation. Instead of defining additional schemas, you can simply utilize the pure TypeScript type itself.
-
-```typescript
-//----
-// examples/checkString.ts
-//----
-import typia, { tags } from "typia";
-export const checkString = typia.createIs<string>();
-
-//----
-// examples/checkUUID.js
-//----
-import typia from "typia";
-export const checkString = (() => {
-  return (input) => "string" === typeof input;
-})();
-```
-
-
-
-## Sponsors
-Thanks for your support.
-
-Your donation encourages `typia` development.
-
-Also, `typia` is re-distributing half of donations to core contributors of `typia`.
-
-  - [`nonara/ts-patch`](https://github.com/nonara/ts-patch)
-  - [`ryoppippi/unplugin-typia`](https://github.com/ryoppippi/unplugin-typia)
-
-[![Sponsors](https://opencollective.com/typia/badge.svg?avatarHeight=75&width=600)](https://opencollective.com/typia)
-
-
-
-
-## Playground
-You can experience how typia works by [playground website](https://typia.io/playground):
-
-  - 💻 https://typia.io/playground
-
-
-
-
-## Guide Documents
-Check out the document in the [website](https://typia.io/docs/):
-
-### 🏠 Home
-  - [Introduction](https://typia.io/docs/)
-  - [Setup](https://typia.io/docs/setup/)
-  - [Pure TypeScript](https://typia.io/docs/pure/)
-  
-### 📖 Features
-  - Runtime Validators
-    - [`assert()` function](https://typia.io/docs/validators/assert/)
-    - [`is()` function](https://typia.io/docs/validators/is/)
-    - [`validate()` function](https://typia.io/docs/validators/validate/)
-    - [Functional Module](https://typia.io/docs/validators/functional)
-    - [Special Tags](https://typia.io/docs/validators/tags/)
-  - Enhanced JSON
-    - [JSON Schema](https://typia.io/docs/json/schema/)
-    - [`stringify()` functions](https://typia.io/docs/json/stringify/)
-    - [`parse()` functions](https://typia.io/docs/json/parse/)
-  - LLM Function Calling
-    - [`application()` function](https://typia.io/docs/llm/application/)
-    - [`parameters()` function](https://typia.io/docs/llm/parameters/)
-    - [`schema()` function](https://typia.io/docs/llm/schema/)
-    - [AI Chatbot Development](https://typia.io/docs/llm/chat/)
-    - [Documentation Strategy](https://typia.io/docs/llm/strategy/)
-  - Protocol Buffer
-    - [Message Schema](https://typia.io/docs/protobuf/message)
-    - [`decode()` functions](https://typia.io/docs/protobuf/decode/)
-    - [`encode()` functions](https://typia.io/docs/protobuf/encode/)
-  - [Random Generator](https://typia.io/docs/random/)
-  - [Miscellaneous](https://typia.io/docs/misc/)
-
-### 🔗 Appendix
-  - [API Documents](https://typia.io/api)
-  - Utillization Cases
-    - [NestJS](https://typia.io/docs/utilization/nestjs/)
-    - [tRPC](https://typia.io/docs/utilization/trpc/)
-  - [⇲ Benchmark Result](https://github.com/samchon/typia/tree/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz)
-  - [⇲ `dev.to` Articles](https://dev.to/samchon/series/22474)
+# Typia
+![Typia Logo](https://typia.io/logo.png)
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/samchon/typia/blob/master/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/typia.svg)](https://www.npmjs.com/package/typia)
+[![NPM Downloads](https://img.shields.io/npm/dm/typia.svg)](https://www.npmjs.com/package/typia)
+[![Build Status](https://github.com/samchon/typia/workflows/build/badge.svg)](https://github.com/samchon/typia/actions?query=workflow%3Abuild)
+[![Guide Documents](https://img.shields.io/badge/Guide-Documents-forestgreen)](https://typia.io/docs/)
+[![Gurubase](https://img.shields.io/badge/Gurubase-Document%20Chatbot-006BFF)](https://gurubase.io/g/typia)
+[![Discord Badge](https://img.shields.io/badge/discord-samchon-d91965?style=flat&labelColor=5866f2&logo=discord&logoColor=white&link=https://discord.gg/E94XhzrUCZ)](https://discord.gg/E94XhzrUCZ)
+
+```typescript
+// RUNTIME VALIDATORS
+export function is<T>(input: unknown): input is T; // returns boolean
+export function assert<T>(input: unknown): T; // throws TypeGuardError
+export function assertGuard<T>(input: unknown): asserts input is T;
+export function validate<T>(input: unknown): IValidation<T>; // detailed
+
+// JSON FUNCTIONS
+export namespace json {
+  export function application<T>(): IJsonApplication; // JSON schema
+  export function assertParse<T>(input: string): T; // type safe parser
+  export function assertStringify<T>(input: T): string; // safe and faster
+}
+
+// AI FUNCTION CALLING SCHEMA
+export namespace llm {
+  // collection of function calling schemas
+  export function application<Class, Model>(): ILlmApplication<Class>;
+  export function controller<Class, Model>(
+    name: string,
+    execute: Class,
+  ): ILlmController<Model>; // +executor
+  // structured output
+  export function parameters<P, Model>(): ILlmSchema.IParameters<Model>; 
+  export function schema<T, Model>(): ILlmSchema<Model>; // type schema
+}
+
+// PROTOCOL BUFFER
+export namespace protobuf {
+  export function message<T>(): string; // Protocol Buffer message
+  export function assertDecode<T>(buffer: Uint8Array): T; // safe decoder
+  export function assertEncode<T>(input: T): Uint8Array; // safe encoder
+}
+
+// RANDOM GENERATOR
+export function random<T>(g?: Partial<IRandomGenerator>): T;
+```
+
+`typia` is a transformer library supporting below features:
+
+  - Super-fast Runtime Validators
+  - Enhanced JSON schema and serde functions
+  - LLM function calling schema and structured output
+  - Protocol Buffer encoder and decoder
+  - Random data generator
+
+> [!NOTE]
+>
+> - **Only one line** required, with pure TypeScript type
+> - Runtime validator is **20,000x faster** than `class-validator`
+> - JSON serialization is **200x faster** than `class-transformer`
+
+
+
+
+## Transformation
+If you call `typia` function, it would be compiled like below.
+
+This is the key concept of `typia`, transforming TypeScript type to a runtime function. The `typia.is<T>()` function is transformed to a dedicated type checker by analyzing the target type `T` in the compilation level.
+
+This feature enables developers to ensure type safety in their applications, leveraging TypeScript's static typing while also providing runtime validation. Instead of defining additional schemas, you can simply utilize the pure TypeScript type itself.
+
+```typescript
+//----
+// examples/checkString.ts
+//----
+import typia, { tags } from "typia";
+export const checkString = typia.createIs<string>();
+
+//----
+// examples/checkString.js
+//----
+import typia from "typia";
+export const checkString = (() => {
+  return (input) => "string" === typeof input;
+})();
+```
+
+
+
+## Sponsors
+Thanks for your support.
+
+Your donation encourages `typia` development.
+
+Also, `typia` is re-distributing half of donations to core contributors of `typia`.
+
+  - [`nonara/ts-patch`](https://github.com/nonara/ts-patch)
+  - [`ryoppippi/unplugin-typia`](https://github.com/ryoppippi/unplugin-typia)
+
+[![Sponsors](https://opencollective.com/typia/badge.svg?avatarHeight=75&width=600)](https://opencollective.com/typia)
+
+
+
+
+## Playground
+You can experience how typia works by [playground website](https://typia.io/playground):
+
+  - 💻 https://typia.io/playground
+
+
+
+
+## Guide Documents
+Check out the document in the [website](https://typia.io/docs/):
+
+### 🏠 Home
+  - [Introduction](https://typia.io/docs/)
+  - [Setup](https://typia.io/docs/setup/)
+  - [Pure TypeScript](https://typia.io/docs/pure/)
+  
+### 📖 Features
+  - Runtime Validators
+    - [`assert()` function](https://typia.io/docs/validators/assert/)
+    - [`is()` function](https://typia.io/docs/validators/is/)
+    - [`validate()` function](https://typia.io/docs/validators/validate/)
+    - [Functional Module](https://typia.io/docs/validators/functional)
+    - [Special Tags](https://typia.io/docs/validators/tags/)
+  - Enhanced JSON
+    - [JSON Schema](https://typia.io/docs/json/schema/)
+    - [`stringify()` functions](https://typia.io/docs/json/stringify/)
+    - [`parse()` functions](https://typia.io/docs/json/parse/)
+  - LLM Function Calling
+    - [`application()` function](https://typia.io/docs/llm/application/)
+    - [`parameters()` function](https://typia.io/docs/llm/parameters/)
+    - [`schema()` function](https://typia.io/docs/llm/schema/)
+    - [AI Chatbot Development](https://typia.io/docs/llm/chat/)
+    - [Documentation Strategy](https://typia.io/docs/llm/strategy/)
+  - Protocol Buffer
+    - [Message Schema](https://typia.io/docs/protobuf/message)
+    - [`decode()` functions](https://typia.io/docs/protobuf/decode/)
+    - [`encode()` functions](https://typia.io/docs/protobuf/encode/)
+  - [Random Generator](https://typia.io/docs/random/)
+  - [Miscellaneous](https://typia.io/docs/misc/)
+
+### 🔗 Appendix
+  - [API Documents](https://typia.io/api)
+  - Utillization Cases
+    - [NestJS](https://typia.io/docs/utilization/nestjs/)
+    - [tRPC](https://typia.io/docs/utilization/trpc/)
+  - [⇲ Benchmark Result](https://github.com/samchon/typia/tree/master/benchmark/results/11th%20Gen%20Intel(R)%20Core(TM)%20i5-1135G7%20%40%202.40GHz)
+  - [⇲ `dev.to` Articles](https://dev.to/samchon/series/22474)

package/lib/AssertionGuard.d.mts

@@ -1 +1,39 @@
+/**
+ * Type definition for assertion guard functions in `typia`.
+ *
+ * An assertion guard is a function that asserts an input value's type at runtime
+ * and performs a TypeScript type assertion if validation passes. Unlike regular
+ * assertion functions that return the validated value, assertion guards return
+ * nothing but automatically cast the input parameter to the expected type `T`.
+ *
+ * This type is used by `typia.createAssertGuard<T>()` and `typia.createAssertGuardEquals<T>()`
+ * to generate reusable assertion guard functions.
+ *
+ * @template T - The expected type to validate and assert against
+ * @param input - The value to validate (type unknown)
+ * @throws {TypeGuardError} When the input value doesn't match the expected type T
+ * @returns void - Returns nothing, but asserts that input is type T
+ *
+ * @example
+ * ```typescript
+ * interface IMember {
+ *   name: string;
+ *   age: number;
+ * }
+ *
+ * // Create reusable assertion guard
+ * const assertMember: AssertionGuard<IMember> = typia.createAssertGuard<IMember>();
+ *
+ * // Usage - input will be automatically cast to IMember if validation passes
+ * const unknownData: unknown = { name: "John", age: 25 };
+ *
+ * assertMember(unknownData);
+ * // After this line, unknownData is automatically treated as IMember type
+ * console.log(unknownData.name); // TypeScript knows this is safe
+ * ```
+ *
+ * @see {@link https://github.com/samchon/typia#assertguard-functions} Typia assertion guards documentation
+ * @see {@link TypeGuardError} Error thrown when assertion fails
+ * @author Jeongho Nam - https://github.com/samchon
+ */
 export type AssertionGuard<T> = (input: unknown) => asserts input is T;

package/lib/AssertionGuard.d.ts

@@ -1 +1,39 @@
+/**
+ * Type definition for assertion guard functions in `typia`.
+ *
+ * An assertion guard is a function that asserts an input value's type at runtime
+ * and performs a TypeScript type assertion if validation passes. Unlike regular
+ * assertion functions that return the validated value, assertion guards return
+ * nothing but automatically cast the input parameter to the expected type `T`.
+ *
+ * This type is used by `typia.createAssertGuard<T>()` and `typia.createAssertGuardEquals<T>()`
+ * to generate reusable assertion guard functions.
+ *
+ * @template T - The expected type to validate and assert against
+ * @param input - The value to validate (type unknown)
+ * @throws {TypeGuardError} When the input value doesn't match the expected type T
+ * @returns void - Returns nothing, but asserts that input is type T
+ *
+ * @example
+ * ```typescript
+ * interface IMember {
+ *   name: string;
+ *   age: number;
+ * }
+ *
+ * // Create reusable assertion guard
+ * const assertMember: AssertionGuard<IMember> = typia.createAssertGuard<IMember>();
+ *
+ * // Usage - input will be automatically cast to IMember if validation passes
+ * const unknownData: unknown = { name: "John", age: 25 };
+ *
+ * assertMember(unknownData);
+ * // After this line, unknownData is automatically treated as IMember type
+ * console.log(unknownData.name); // TypeScript knows this is safe
+ * ```
+ *
+ * @see {@link https://github.com/samchon/typia#assertguard-functions} Typia assertion guards documentation
+ * @see {@link TypeGuardError} Error thrown when assertion fails
+ * @author Jeongho Nam - https://github.com/samchon
+ */
 export type AssertionGuard<T> = (input: unknown) => asserts input is T;

package/lib/TypeGuardError.d.mts

@@ -1,17 +1,138 @@
+/**
+ * Custom error class thrown when runtime assertion fails in `typia.assert<T>()` function.
+ *
+ * This error is thrown by the `typia.assert<T>()` function when the input value
+ * doesn't match the expected type.
+ *
+ * The error provides detailed information about the first assertion failure encountered,
+ * including the access path where the error occurred, the expected type, and the actual value.
+ *
+ * @template T - The expected type (generic for type safety)
+ * @author Jeongho Nam - https://github.com/samchon
+ * @example
+ * ```typescript
+ * interface IMember {
+ *   name: string;
+ *   age: number & ExclusiveMinimum<19>;
+ * }
+ *
+ * try {
+ *   typia.assert<IMember>({ name: "John", age: 18 });
+ * } catch (error) {
+ *   if (error instanceof TypeGuardError) {
+ *     console.log(error.method);   // "typia.assert"
+ *     console.log(error.path);     // "input.age"
+ *     console.log(error.expected); // "number & ExclusiveMinimum<19>"
+ *     console.log(error.value);    // 18
+ *   }
+ * }
+ * ```
+ */
 export declare class TypeGuardError<T = any> extends Error {
+    /**
+     * The name of the typia method that threw this error.
+     *
+     * @example "typia.assert"
+     */
     readonly method: string;
+    /**
+     * The access path to the property where the assertion error occurred.
+     *
+     * Uses dot notation to indicate the path for nested object properties.
+     * May be `undefined` if the error occurred at the root level.
+     *
+     * @example
+     * - `"input.age"` - Error in the age property of the object
+     * - `"input.profile.email"` - Error in the email property of a nested object
+     * - `"input[0].name"` - Error in the name property of the first array element
+     * - `undefined` - Error occurred at the root level
+     */
     readonly path: string | undefined;
+    /**
+     * String representation of the expected type at the error location.
+     *
+     * Represents TypeScript types as strings, including detailed type information
+     * for complex types.
+     *
+     * @example
+     * - `"string"` - Expected string type
+     * - `"number & ExclusiveMinimum<19>"` - Expected number greater than 19
+     * - `"undefined"` - Expected undefined (when superfluous property found in assertion)
+     * - `"{ name: string; age: number }"` - Expected object type
+     */
     readonly expected: string;
-    readonly value: any;
-    protected readonly fake_expected_typed_value_?: T | undefined;
+    /**
+     * The actual value that failed assertion.
+     *
+     * Stores the actual value at the error path as-is.
+     * Useful for debugging by comparing the expected type with the actual value.
+     *
+     * @example
+     * - `18` - Numeric value
+     * - `"invalid"` - String value
+     * - `{ name: "John", age: 18, sex: 1 }` - Object value
+     */
+    readonly value: unknown;
+    /**
+     * Creates a new TypeGuardError instance.
+     *
+     * @param props - Object containing the properties needed to create the error
+     *
+     * @example
+     * ```typescript
+     * const error = new TypeGuardError({
+     *   method: "typia.assert",
+     *   path: "input.age",
+     *   expected: "number & ExclusiveMinimum<19>",
+     *   value: 18
+     * });
+     * ```
+     */
     constructor(props: TypeGuardError.IProps);
 }
 export declare namespace TypeGuardError {
+    /**
+     * Interface for properties passed to the TypeGuardError constructor.
+     *
+     * @example
+     * ```typescript
+     * const props: TypeGuardError.IProps = {
+     *   method: "typia.assertEquals",
+     *   path: "input.sex",
+     *   expected: "undefined",
+     *   value: 1,
+     *   message: "Custom error message" // optional
+     * };
+     * ```
+     */
     interface IProps {
+        /**
+         * The name of the typia method that threw the error.
+         *
+         * @example "typia.assert", "typia.assertEquals"
+         */
         method: string;
+        /**
+         * The access path to the property where the assertion error occurred (optional).
+         *
+         * @example "input.age", "input.profile.email"
+         */
         path?: undefined | string;
+        /**
+         * String representation of the expected type at the error location.
+         *
+         * @example "string", "number & ExclusiveMinimum<19>"
+         */
         expected: string;
-        value: any;
+        /**
+         * The actual value that failed assertion.
+         */
+        value: unknown;
+        /**
+         * Custom error message (optional).
+         *
+         * If not provided, a default format message will be automatically generated.
+         */
         message?: undefined | string;
     }
 }