typia 10.0.0-dev.20251107-4 → 10.0.1

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,155 @@
-# 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)
-  - Utilization 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 schema<T>(): IJsonSchemaUnit<T>; // 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>(
+    $defs: Record<string, ILlmSchema<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)
+  - Utilization 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/index.mjs

@@ -1,4 +1,4 @@
-import * as module from './module.mjs';
+import * as module$1 from './module.mjs';
 export { assert, assertEquals, assertGuard, assertGuardEquals, createAssert, createAssertEquals, createAssertGuard, createAssertGuardEquals, createEquals, createIs, createRandom, createValidate, createValidateEquals, equals, is, random, validate, validateEquals } from './module.mjs';
 import * as functional from './functional.mjs';
 export { functional };
@@ -22,5 +22,5 @@ export { TypeGuardError } from './TypeGuardError.mjs';
 
 
 
-export { module as default };
+export { module$1 as default };
 //# sourceMappingURL=index.mjs.map

package/lib/json.d.mts

@@ -1,8 +1,47 @@
+import { IJsonSchemaApplication } from "./schemas/json/IJsonSchemaApplication";
 import { IJsonSchemaCollection } from "./schemas/json/IJsonSchemaCollection";
 import { IJsonSchemaUnit } from "./schemas/json/IJsonSchemaUnit";
 import { IValidation } from "./IValidation";
 import { Primitive } from "./Primitive";
 import { TypeGuardError } from "./TypeGuardError";
+/**
+ * > You must configure the generic argument `Type`.
+ *
+ * JSON schema generator.
+ *
+ * Creates a JSON schema unit which contains a main JSON schema and its
+ * components. Note that, all of the named types are stored in the
+ * {@link IJsonSchemaUnit.components} property for the `$ref` referencing.
+ *
+ * Also, you can specify the OpenAPI version by configuring the second generic
+ * argument `Version`. For reference, the default version is `"3.1"`, and key
+ * different of `"3.0"` and `"3.1"` is whether supporting the tuple type or
+ * not.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template Type Target type
+ * @template Version Version of OpenAPI specification. Default is 3.1
+ * @returns JSON schema unit
+ */
+export declare function schema(): never;
+/**
+ * JSON schema generator.
+ *
+ * Creates a JSON schema unit which contains a main JSON schema and its
+ * components. Note that, all of the named types are stored in the
+ * {@link IJsonSchemaUnit.components} property for the `$ref` referencing.
+ *
+ * Also, you can specify the OpenAPI version by configuring the second generic
+ * argument `Version`. For reference, the default version is `"3.1"`, and key
+ * different of `"3.0"` and `"3.1"` is whether supporting the tuple type or
+ * not.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @template Type Target type
+ * @template Version Version of OpenAPI specification. Default is 3.1
+ * @returns JSON schema unit
+ */
+export declare function schema<Type extends unknown, Version extends "3.0" | "3.1" = "3.1">(): IJsonSchemaUnit<Version, Type>;
 /**
  * > You must configure the generic argument `Types`.
  *
@@ -42,43 +81,91 @@ export declare function schemas(): never;
  */
 export declare function schemas<Types extends unknown[], Version extends "3.0" | "3.1" = "3.1">(): IJsonSchemaCollection<Version, Types>;
 /**
- * > You must configure the generic argument `Type`.
+ * > You must configure the generic argument `Class`.
  *
- * JSON schema generator.
+ * TypeScript class to JSON function schema application.
  *
- * Creates a JSON schema unit which contains a main JSON schema and its
- * components. Note that, all of the named types are stored in the
- * {@link IJsonSchemaUnit.components} property for the `$ref` referencing.
+ * Creates a JSON function schema application from a TypeScript class or
+ * interface type containing the target functions. This is an intermediate-level
+ * function designed for professional developers who want to build custom LLM
+ * function calling schemas or need to transform class methods into structured
+ * JSON schema representations.
+ *
+ * Unlike {@link schema} which creates a schema for a single type, this function
+ * analyzes an entire class/interface and generates JSON schemas for all its
+ * methods, their parameters, and return types. The returned
+ * {@link IJsonSchemaApplication} contains:
+ *
+ * - {@link IJsonSchemaApplication.functions}: Array of function metadata with
+ *   parameter and return type schemas
+ * - {@link IJsonSchemaApplication.components}: Shared schema components for `$ref`
+ *   referencing
+ *
+ * This function serves as the underlying implementation for
+ * {@link llm.application}, and can be used when you need to:
+ *
+ * - Create your own custom LLM function calling schema format
+ * - Transform class methods into structured JSON schema format
+ * - Build API documentation or code generation tools
+ * - Develop alternative LLM integrations beyond the built-in providers
+ *
+ * For direct LLM function calling implementations, consider using
+ * {@link llm.application} instead, which provides provider-specific schemas for
+ * ChatGPT, Claude, Gemini, and other LLM providers.
  *
  * Also, you can specify the OpenAPI version by configuring the second generic
- * argument `Version`. For reference, the default version is `"3.1"`, and key
- * different of `"3.0"` and `"3.1"` is whether supporting the tuple type or
- * not.
+ * argument `Version`. For reference, the default version is `"3.1"`, and the
+ * key difference between `"3.0"` and `"3.1"` is whether supporting the tuple
+ * type or not.
  *
  * @author Jeongho Nam - https://github.com/samchon
- * @template Type Target type
+ * @template Class Target class or interface type containing the functions
  * @template Version Version of OpenAPI specification. Default is 3.1
- * @returns JSON schema unit
+ * @returns JSON function schema application
  */
-export declare function schema(): never;
+export declare function application(): never;
 /**
- * JSON schema generator.
+ * TypeScript class to JSON function schema application.
  *
- * Creates a JSON schema unit which contains a main JSON schema and its
- * components. Note that, all of the named types are stored in the
- * {@link IJsonSchemaUnit.components} property for the `$ref` referencing.
+ * Creates a JSON function schema application from a TypeScript class or
+ * interface type containing the target functions. This is an intermediate-level
+ * function designed for professional developers who want to build custom LLM
+ * function calling schemas or need to transform class methods into structured
+ * JSON schema representations.
+ *
+ * Unlike {@link schema} which creates a schema for a single type, this function
+ * analyzes an entire class/interface and generates JSON schemas for all its
+ * methods, their parameters, and return types. The returned
+ * {@link IJsonSchemaApplication} contains:
+ *
+ * - {@link IJsonSchemaApplication.functions}: Array of function metadata with
+ *   parameter and return type schemas
+ * - {@link IJsonSchemaApplication.components}: Shared schema components for `$ref`
+ *   referencing
+ *
+ * This function serves as the underlying implementation for
+ * {@link llm.application}, and can be used when you need to:
+ *
+ * - Create your own custom LLM function calling schema format
+ * - Transform class methods into structured JSON schema format
+ * - Build API documentation or code generation tools
+ * - Develop alternative LLM integrations beyond the built-in providers
+ *
+ * For direct LLM function calling implementations, consider using
+ * {@link llm.application} instead, which provides provider-specific schemas for
+ * ChatGPT, Claude, Gemini, and other LLM providers.
  *
  * Also, you can specify the OpenAPI version by configuring the second generic
- * argument `Version`. For reference, the default version is `"3.1"`, and key
- * different of `"3.0"` and `"3.1"` is whether supporting the tuple type or
- * not.
+ * argument `Version`. For reference, the default version is `"3.1"`, and the
+ * key difference between `"3.0"` and `"3.1"` is whether supporting the tuple
+ * type or not.
  *
  * @author Jeongho Nam - https://github.com/samchon
- * @template Type Target type
+ * @template Class Target class or interface type containing the functions
  * @template Version Version of OpenAPI specification. Default is 3.1
- * @returns JSON schema unit
+ * @returns JSON function schema application
  */
-export declare function schema<Type extends unknown, Version extends "3.0" | "3.1" = "3.1">(): IJsonSchemaUnit<Version, Type>;
+export declare function application<Class extends object, Version extends "3.0" | "3.1" = "3.1">(): IJsonSchemaApplication<Version, Class>;
 /**
  * > You must configure the generic argument `T`.
  *