typia 7.5.1 → 7.6.0-dev.20241229

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,148 +1,149 @@
-# 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-Ask%20Typia%20Guru-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
-}
-
-// LLM FUNCTION CALLING SCHEMA
-export namespace llm {
-  // application schema from a class or interface type
-  export function application<App, Model>(): ILlmApplication<Model>;
-  // structured output
-  export function parameters<P, Moodel>(): 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)
-
-[![Sponsers](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/)
-  - 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/)
-    - [Prisma](https://typia.io/docs/utilization/prisma/)
-    - [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-Ask%20Typia%20Guru-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
+}
+
+// LLM FUNCTION CALLING SCHEMA
+export namespace llm {
+  // application schema from a class or interface type
+  export function application<App, Model>(): ILlmApplication<Model>;
+  // structured output
+  export function parameters<P, Moodel>(): 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)
+
+[![Sponsers](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/)
+    - [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/)
+    - [Prisma](https://typia.io/docs/utilization/prisma/)
+    - [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/tags/Type.d.ts

@@ -13,5 +13,6 @@ export type Type<Value extends "int32" | "uint32" | "int64" | "uint64" | "float"
     exclusive: true;
     schema: {
         type: Value extends "int32" | "uint32" | "int64" | "uint64" ? "integer" : "number";
+        format: Value;
     };
 }>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typia",
-  "version": "7.5.1",
+  "version": "7.6.0-dev.20241229",
   "description": "Superfast runtime validators with only one line",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -41,7 +41,7 @@
   },
   "homepage": "https://typia.io",
   "dependencies": {
-    "@samchon/openapi": "^2.3.0",
+    "@samchon/openapi": "^2.4.0-dev.20241229",
     "commander": "^10.0.0",
     "comment-json": "^4.2.3",
     "inquirer": "^8.2.5",
@@ -49,8 +49,7 @@
     "randexp": "^0.5.3"
   },
   "peerDependencies": {
-    "typescript": ">=4.8.0 <5.8.0",
-    "@samchon/openapi": ">=2.3.0 <3.0.0"
+    "typescript": ">=4.8.0 <5.8.0"
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^26.0.1",

package/src/IRandomGenerator.ts

@@ -1,49 +1,49 @@
-import { OpenApi } from "@samchon/openapi";
-
-export interface IRandomGenerator {
-  // REGULAR
-  boolean(): boolean | undefined;
-  number(schema: OpenApi.IJsonSchema.INumber): number;
-  integer(schema: OpenApi.IJsonSchema.IInteger): number;
-  bigint(schema: OpenApi.IJsonSchema.IInteger): bigint;
-  string(schema: OpenApi.IJsonSchema.IString): string;
-  array<T>(
-    schema: Omit<OpenApi.IJsonSchema.IArray, "items"> & {
-      element: (index: number, count: number) => T;
-    },
-  ): T[];
-  pattern(regex: RegExp): string;
-
-  //----
-  // FORMAT
-  //----
-  // SPECIAL CHARACTERS
-  byte(): string;
-  password(): string;
-  regex(): string;
-  uuid(): string;
-
-  // ADDRESSES
-  email(): string;
-  hostname(): string;
-  idnEmail(): string;
-  idnHostname(): string;
-  iri(): string;
-  iriReference(): string;
-  ipv4(): string;
-  ipv6(): string;
-  uri(): string;
-  uriReference(): string;
-  uriTemplate(): string;
-  url(): string;
-
-  // TIMESTAMPS
-  datetime(props?: { minimum?: number; maximum?: number }): string;
-  date(props?: { minimum?: number; maximum?: number }): string;
-  time(): string;
-  duration(): string;
-
-  // POINTERS
-  jsonPointer(): string;
-  relativeJsonPointer(): string;
-}
+import { OpenApi } from "@samchon/openapi";
+
+export interface IRandomGenerator {
+  // REGULAR
+  boolean(): boolean | undefined;
+  number(schema: OpenApi.IJsonSchema.INumber): number;
+  integer(schema: OpenApi.IJsonSchema.IInteger): number;
+  bigint(schema: OpenApi.IJsonSchema.IInteger): bigint;
+  string(schema: OpenApi.IJsonSchema.IString): string;
+  array<T>(
+    schema: Omit<OpenApi.IJsonSchema.IArray, "items"> & {
+      element: (index: number, count: number) => T;
+    },
+  ): T[];
+  pattern(regex: RegExp): string;
+
+  //----
+  // FORMAT
+  //----
+  // SPECIAL CHARACTERS
+  byte(): string;
+  password(): string;
+  regex(): string;
+  uuid(): string;
+
+  // ADDRESSES
+  email(): string;
+  hostname(): string;
+  idnEmail(): string;
+  idnHostname(): string;
+  iri(): string;
+  iriReference(): string;
+  ipv4(): string;
+  ipv6(): string;
+  uri(): string;
+  uriReference(): string;
+  uriTemplate(): string;
+  url(): string;
+
+  // TIMESTAMPS
+  datetime(props?: { minimum?: number; maximum?: number }): string;
+  date(props?: { minimum?: number; maximum?: number }): string;
+  time(): string;
+  duration(): string;
+
+  // POINTERS
+  jsonPointer(): string;
+  relativeJsonPointer(): string;
+}

package/src/IReadableURLSearchParams.ts

@@ -1,9 +1,9 @@
-/**
- * Interface for a readable URLSearchParams object.
- *
- * This interface is a subset of the {@link URLSearchParams} interface,
- * designed especially for the [Hono.JS](https://hono.dev/) libray.
- *
- * @author https://github.com/miyaji255
- */
-export type IReadableURLSearchParams = Pick<URLSearchParams, "get" | "getAll">;
+/**
+ * Interface for a readable URLSearchParams object.
+ *
+ * This interface is a subset of the {@link URLSearchParams} interface,
+ * designed especially for the [Hono.JS](https://hono.dev/) libray.
+ *
+ * @author https://github.com/miyaji255
+ */
+export type IReadableURLSearchParams = Pick<URLSearchParams, "get" | "getAll">;

package/src/IValidation.ts

@@ -1,21 +1,21 @@
-export type IValidation<T = unknown> =
-  | IValidation.ISuccess<T>
-  | IValidation.IFailure;
-export namespace IValidation {
-  export interface ISuccess<T = unknown> {
-    success: true;
-    data: T;
-  }
-
-  export interface IFailure {
-    success: false;
-    errors: IError[];
-    data: unknown;
-  }
-
-  export interface IError {
-    path: string;
-    expected: string;
-    value: any;
-  }
-}
+export type IValidation<T = unknown> =
+  | IValidation.ISuccess<T>
+  | IValidation.IFailure;
+export namespace IValidation {
+  export interface ISuccess<T = unknown> {
+    success: true;
+    data: T;
+  }
+
+  export interface IFailure {
+    success: false;
+    errors: IError[];
+    data: unknown;
+  }
+
+  export interface IError {
+    path: string;
+    expected: string;
+    value: any;
+  }
+}