@typia/interface 12.0.0-dev.20260309 → 12.0.0-dev.20260310

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/lib/http/IHttpLlmController.d.ts +5 -5
  2. package/lib/schema/IJsonParseResult.d.ts +1 -3
  3. package/lib/schema/ILlmController.d.ts +2 -5
  4. package/package.json +1 -1
  5. package/src/http/IHttpConnection.ts +200 -200
  6. package/src/http/IHttpLlmApplication.ts +72 -72
  7. package/src/http/IHttpLlmController.ts +96 -96
  8. package/src/http/IHttpLlmFunction.ts +34 -34
  9. package/src/http/IHttpMigrateApplication.ts +48 -48
  10. package/src/http/IHttpMigrateRoute.ts +165 -165
  11. package/src/http/IHttpResponse.ts +42 -42
  12. package/src/http/index.ts +7 -7
  13. package/src/index.ts +9 -9
  14. package/src/metadata/IJsDocTagInfo.ts +25 -25
  15. package/src/metadata/IMetadataComponents.ts +24 -24
  16. package/src/metadata/IMetadataSchema.ts +293 -293
  17. package/src/metadata/IMetadataSchemaCollection.ts +20 -20
  18. package/src/metadata/IMetadataSchemaUnit.ts +20 -20
  19. package/src/metadata/IMetadataTypeTag.ts +39 -39
  20. package/src/metadata/index.ts +6 -6
  21. package/src/openapi/OpenApi.ts +643 -643
  22. package/src/openapi/OpenApiV3.ts +655 -655
  23. package/src/openapi/OpenApiV3_1.ts +735 -735
  24. package/src/openapi/SwaggerV2.ts +559 -559
  25. package/src/openapi/index.ts +4 -4
  26. package/src/protobuf/ProtobufWire.ts +51 -51
  27. package/src/protobuf/index.ts +1 -1
  28. package/src/schema/IJsonParseResult.ts +134 -136
  29. package/src/schema/IJsonSchemaApplication.ts +274 -274
  30. package/src/schema/IJsonSchemaAttribute.ts +158 -158
  31. package/src/schema/IJsonSchemaCollection.ts +123 -123
  32. package/src/schema/IJsonSchemaTransformError.ts +86 -86
  33. package/src/schema/IJsonSchemaUnit.ts +120 -120
  34. package/src/schema/ILlmApplication.ts +99 -99
  35. package/src/schema/ILlmController.ts +54 -57
  36. package/src/schema/ILlmFunction.ts +145 -145
  37. package/src/schema/ILlmSchema.ts +484 -484
  38. package/src/schema/IResult.ts +84 -84
  39. package/src/schema/IValidation.ts +134 -134
  40. package/src/schema/index.ts +14 -14
  41. package/src/tags/Constant.ts +49 -49
  42. package/src/tags/ContentMediaType.ts +40 -40
  43. package/src/tags/Default.ts +50 -50
  44. package/src/tags/Example.ts +48 -48
  45. package/src/tags/Examples.ts +50 -50
  46. package/src/tags/ExclusiveMaximum.ts +46 -46
  47. package/src/tags/ExclusiveMinimum.ts +46 -46
  48. package/src/tags/Format.ts +76 -76
  49. package/src/tags/JsonSchemaPlugin.ts +45 -45
  50. package/src/tags/MaxItems.ts +39 -39
  51. package/src/tags/MaxLength.ts +37 -37
  52. package/src/tags/Maximum.ts +44 -44
  53. package/src/tags/MinItems.ts +39 -39
  54. package/src/tags/MinLength.ts +37 -37
  55. package/src/tags/Minimum.ts +44 -44
  56. package/src/tags/MultipleOf.ts +54 -54
  57. package/src/tags/Pattern.ts +59 -59
  58. package/src/tags/Sequence.ts +43 -43
  59. package/src/tags/TagBase.ts +131 -131
  60. package/src/tags/Type.ts +70 -70
  61. package/src/tags/UniqueItems.ts +44 -44
  62. package/src/tags/index.ts +21 -21
  63. package/src/typings/AssertionGuard.ts +12 -12
  64. package/src/typings/Atomic.ts +21 -21
  65. package/src/typings/CamelCase.ts +75 -75
  66. package/src/typings/ClassProperties.ts +15 -15
  67. package/src/typings/DeepPartial.ts +39 -39
  68. package/src/typings/OmitNever.ts +12 -12
  69. package/src/typings/PascalCase.ts +71 -71
  70. package/src/typings/Primitive.ts +71 -71
  71. package/src/typings/ProtobufAtomic.ts +30 -30
  72. package/src/typings/Resolved.ts +58 -58
  73. package/src/typings/SnakeCase.ts +126 -126
  74. package/src/typings/SpecialFields.ts +13 -13
  75. package/src/typings/ValidationPipe.ts +20 -20
  76. package/src/typings/index.ts +14 -14
  77. package/src/typings/internal/Equal.ts +14 -14
  78. package/src/typings/internal/IsTuple.ts +17 -17
  79. package/src/typings/internal/NativeClass.ts +31 -31
  80. package/src/typings/internal/ValueOf.ts +29 -29
  81. package/src/utils/IRandomGenerator.ts +105 -105
  82. package/src/utils/IReadableURLSearchParams.ts +25 -25
  83. package/src/utils/index.ts +2 -2
@@ -1,165 +1,165 @@
1
- import { OpenApi } from "../openapi/OpenApi";
2
-
3
- /**
4
- * HTTP route converted from OpenAPI operation.
5
- *
6
- * `IHttpMigrateRoute` represents a single API endpoint with all
7
- * request/response schemas resolved and ready for code generation. Contains
8
- * {@link parameters} for URL path variables, {@link query} for query strings,
9
- * {@link headers}, {@link body} for request payload, and
10
- * {@link success}/{@link exceptions} for responses.
11
- *
12
- * @author Jeongho Nam - https://github.com/samchon
13
- */
14
- export interface IHttpMigrateRoute {
15
- /** HTTP method. Operations with other methods are ignored. */
16
- method: "head" | "get" | "post" | "put" | "patch" | "delete";
17
-
18
- /** Original path from OpenAPI document. */
19
- path: string;
20
-
21
- /** Emended path with `:param` format, always starts with `/`. */
22
- emendedPath: string;
23
-
24
- /**
25
- * Accessor path for generated RPC function.
26
- *
27
- * Namespaces from static path segments, function name from method +
28
- * parameters. `delete` becomes `erase` to avoid reserved keyword.
29
- */
30
- accessor: string[];
31
-
32
- /** Path parameters only. */
33
- parameters: IHttpMigrateRoute.IParameter[];
34
-
35
- /** Combined headers as single object. Null if none. */
36
- headers: IHttpMigrateRoute.IHeaders | null;
37
-
38
- /** Combined query parameters as single object. Null if none. */
39
- query: IHttpMigrateRoute.IQuery | null;
40
-
41
- /** Request body metadata. Null if none. */
42
- body: IHttpMigrateRoute.IBody | null;
43
-
44
- /** Success response (200/201). Null if void return. */
45
- success: IHttpMigrateRoute.ISuccess | null;
46
-
47
- /** Exception responses keyed by status code. */
48
- exceptions: Record<string, IHttpMigrateRoute.IException>;
49
-
50
- /** Returns description comment for the RPC function. */
51
- comment: () => string;
52
-
53
- /** Returns source {@link OpenApi.IOperation}. */
54
- operation: () => OpenApi.IOperation;
55
- }
56
- export namespace IHttpMigrateRoute {
57
- /** Path parameter metadata. */
58
- export interface IParameter {
59
- /** Parameter name in path template. */
60
- name: string;
61
-
62
- /** Parameter variable key. */
63
- key: string;
64
-
65
- /** Parameter type schema. */
66
- schema: OpenApi.IJsonSchema;
67
-
68
- /** Returns source parameter definition. */
69
- parameter: () => OpenApi.IOperation.IParameter;
70
- }
71
-
72
- /** Headers metadata. */
73
- export interface IHeaders {
74
- /** Combined headers parameter name. */
75
- name: string;
76
-
77
- /** Headers variable key. */
78
- key: string;
79
-
80
- /** Combined headers schema. */
81
- schema: OpenApi.IJsonSchema;
82
-
83
- /** Returns title. */
84
- title: () => string | undefined;
85
-
86
- /** Returns description. */
87
- description: () => string | undefined;
88
-
89
- /** Returns example value. */
90
- example: () => any | undefined;
91
-
92
- /** Returns named examples. */
93
- examples: () => Record<string, any> | undefined;
94
- }
95
-
96
- /** Query parameters metadata. */
97
- export interface IQuery {
98
- /** Combined query parameter name. */
99
- name: string;
100
-
101
- /** Query variable key. */
102
- key: string;
103
-
104
- /** Combined query schema. */
105
- schema: OpenApi.IJsonSchema;
106
-
107
- /** Returns title. */
108
- title: () => string | undefined;
109
-
110
- /** Returns description. */
111
- description: () => string | undefined;
112
-
113
- /** Returns example value. */
114
- example: () => any | undefined;
115
-
116
- /** Returns named examples. */
117
- examples: () => Record<string, any> | undefined;
118
- }
119
-
120
- /** Request body metadata. */
121
- export interface IBody {
122
- /** Body parameter name. */
123
- name: string;
124
-
125
- /** Body variable key. */
126
- key: string;
127
-
128
- /** Content media type. */
129
- type:
130
- | "text/plain"
131
- | "application/json"
132
- | "application/x-www-form-urlencoded"
133
- | "multipart/form-data";
134
-
135
- /** Body type schema. */
136
- schema: OpenApi.IJsonSchema;
137
-
138
- /** Returns description. */
139
- description: () => string | undefined;
140
-
141
- /** Returns source media type definition. */
142
- media: () => OpenApi.IOperation.IMediaType;
143
-
144
- /** Nestia encryption flag. */
145
- "x-nestia-encrypted"?: boolean;
146
- }
147
-
148
- /** Success response metadata. */
149
- export interface ISuccess extends IBody {
150
- /** HTTP status code. */
151
- status: string;
152
- }
153
-
154
- /** Exception response metadata. */
155
- export interface IException {
156
- /** Exception type schema. */
157
- schema: OpenApi.IJsonSchema;
158
-
159
- /** Returns source response definition. */
160
- response: () => OpenApi.IOperation.IResponse;
161
-
162
- /** Returns source media type definition. */
163
- media: () => OpenApi.IOperation.IMediaType;
164
- }
165
- }
1
+ import { OpenApi } from "../openapi/OpenApi";
2
+
3
+ /**
4
+ * HTTP route converted from OpenAPI operation.
5
+ *
6
+ * `IHttpMigrateRoute` represents a single API endpoint with all
7
+ * request/response schemas resolved and ready for code generation. Contains
8
+ * {@link parameters} for URL path variables, {@link query} for query strings,
9
+ * {@link headers}, {@link body} for request payload, and
10
+ * {@link success}/{@link exceptions} for responses.
11
+ *
12
+ * @author Jeongho Nam - https://github.com/samchon
13
+ */
14
+ export interface IHttpMigrateRoute {
15
+ /** HTTP method. Operations with other methods are ignored. */
16
+ method: "head" | "get" | "post" | "put" | "patch" | "delete";
17
+
18
+ /** Original path from OpenAPI document. */
19
+ path: string;
20
+
21
+ /** Emended path with `:param` format, always starts with `/`. */
22
+ emendedPath: string;
23
+
24
+ /**
25
+ * Accessor path for generated RPC function.
26
+ *
27
+ * Namespaces from static path segments, function name from method +
28
+ * parameters. `delete` becomes `erase` to avoid reserved keyword.
29
+ */
30
+ accessor: string[];
31
+
32
+ /** Path parameters only. */
33
+ parameters: IHttpMigrateRoute.IParameter[];
34
+
35
+ /** Combined headers as single object. Null if none. */
36
+ headers: IHttpMigrateRoute.IHeaders | null;
37
+
38
+ /** Combined query parameters as single object. Null if none. */
39
+ query: IHttpMigrateRoute.IQuery | null;
40
+
41
+ /** Request body metadata. Null if none. */
42
+ body: IHttpMigrateRoute.IBody | null;
43
+
44
+ /** Success response (200/201). Null if void return. */
45
+ success: IHttpMigrateRoute.ISuccess | null;
46
+
47
+ /** Exception responses keyed by status code. */
48
+ exceptions: Record<string, IHttpMigrateRoute.IException>;
49
+
50
+ /** Returns description comment for the RPC function. */
51
+ comment: () => string;
52
+
53
+ /** Returns source {@link OpenApi.IOperation}. */
54
+ operation: () => OpenApi.IOperation;
55
+ }
56
+ export namespace IHttpMigrateRoute {
57
+ /** Path parameter metadata. */
58
+ export interface IParameter {
59
+ /** Parameter name in path template. */
60
+ name: string;
61
+
62
+ /** Parameter variable key. */
63
+ key: string;
64
+
65
+ /** Parameter type schema. */
66
+ schema: OpenApi.IJsonSchema;
67
+
68
+ /** Returns source parameter definition. */
69
+ parameter: () => OpenApi.IOperation.IParameter;
70
+ }
71
+
72
+ /** Headers metadata. */
73
+ export interface IHeaders {
74
+ /** Combined headers parameter name. */
75
+ name: string;
76
+
77
+ /** Headers variable key. */
78
+ key: string;
79
+
80
+ /** Combined headers schema. */
81
+ schema: OpenApi.IJsonSchema;
82
+
83
+ /** Returns title. */
84
+ title: () => string | undefined;
85
+
86
+ /** Returns description. */
87
+ description: () => string | undefined;
88
+
89
+ /** Returns example value. */
90
+ example: () => any | undefined;
91
+
92
+ /** Returns named examples. */
93
+ examples: () => Record<string, any> | undefined;
94
+ }
95
+
96
+ /** Query parameters metadata. */
97
+ export interface IQuery {
98
+ /** Combined query parameter name. */
99
+ name: string;
100
+
101
+ /** Query variable key. */
102
+ key: string;
103
+
104
+ /** Combined query schema. */
105
+ schema: OpenApi.IJsonSchema;
106
+
107
+ /** Returns title. */
108
+ title: () => string | undefined;
109
+
110
+ /** Returns description. */
111
+ description: () => string | undefined;
112
+
113
+ /** Returns example value. */
114
+ example: () => any | undefined;
115
+
116
+ /** Returns named examples. */
117
+ examples: () => Record<string, any> | undefined;
118
+ }
119
+
120
+ /** Request body metadata. */
121
+ export interface IBody {
122
+ /** Body parameter name. */
123
+ name: string;
124
+
125
+ /** Body variable key. */
126
+ key: string;
127
+
128
+ /** Content media type. */
129
+ type:
130
+ | "text/plain"
131
+ | "application/json"
132
+ | "application/x-www-form-urlencoded"
133
+ | "multipart/form-data";
134
+
135
+ /** Body type schema. */
136
+ schema: OpenApi.IJsonSchema;
137
+
138
+ /** Returns description. */
139
+ description: () => string | undefined;
140
+
141
+ /** Returns source media type definition. */
142
+ media: () => OpenApi.IOperation.IMediaType;
143
+
144
+ /** Nestia encryption flag. */
145
+ "x-nestia-encrypted"?: boolean;
146
+ }
147
+
148
+ /** Success response metadata. */
149
+ export interface ISuccess extends IBody {
150
+ /** HTTP status code. */
151
+ status: string;
152
+ }
153
+
154
+ /** Exception response metadata. */
155
+ export interface IException {
156
+ /** Exception type schema. */
157
+ schema: OpenApi.IJsonSchema;
158
+
159
+ /** Returns source response definition. */
160
+ response: () => OpenApi.IOperation.IResponse;
161
+
162
+ /** Returns source media type definition. */
163
+ media: () => OpenApi.IOperation.IMediaType;
164
+ }
165
+ }
@@ -1,42 +1,42 @@
1
- /**
2
- * HTTP response structure returned from server communication.
3
- *
4
- * `IHttpResponse` represents the complete HTTP response received from a remote
5
- * server, containing the status code, response headers, and body. This
6
- * interface is used by `@nestia/fetcher` to return structured response data
7
- * from API calls.
8
- *
9
- * The {@link status} property contains the HTTP status code (e.g., 200, 404),
10
- * {@link headers} contains all response headers (some may have multiple values),
11
- * and {@link body} contains the parsed response body (typically JSON-decoded).
12
- *
13
- * @author Jeongho Nam - https://github.com/samchon
14
- */
15
- export interface IHttpResponse {
16
- /**
17
- * HTTP status code of the response.
18
- *
19
- * Standard HTTP status codes indicating the result of the request. Common
20
- * values: 200 (OK), 201 (Created), 400 (Bad Request), 401 (Unauthorized), 404
21
- * (Not Found), 500 (Internal Server Error).
22
- */
23
- status: number;
24
-
25
- /**
26
- * Response headers from the server.
27
- *
28
- * Contains all HTTP headers returned by the server. Header values can be
29
- * either a single string or an array of strings for headers that appear
30
- * multiple times (e.g., `Set-Cookie`).
31
- */
32
- headers: Record<string, string | string[]>;
33
-
34
- /**
35
- * Parsed body content of the response.
36
- *
37
- * The response body after parsing. For JSON responses, this is the decoded
38
- * JavaScript object. The actual type depends on the endpoint and response
39
- * content-type.
40
- */
41
- body: unknown;
42
- }
1
+ /**
2
+ * HTTP response structure returned from server communication.
3
+ *
4
+ * `IHttpResponse` represents the complete HTTP response received from a remote
5
+ * server, containing the status code, response headers, and body. This
6
+ * interface is used by `@nestia/fetcher` to return structured response data
7
+ * from API calls.
8
+ *
9
+ * The {@link status} property contains the HTTP status code (e.g., 200, 404),
10
+ * {@link headers} contains all response headers (some may have multiple values),
11
+ * and {@link body} contains the parsed response body (typically JSON-decoded).
12
+ *
13
+ * @author Jeongho Nam - https://github.com/samchon
14
+ */
15
+ export interface IHttpResponse {
16
+ /**
17
+ * HTTP status code of the response.
18
+ *
19
+ * Standard HTTP status codes indicating the result of the request. Common
20
+ * values: 200 (OK), 201 (Created), 400 (Bad Request), 401 (Unauthorized), 404
21
+ * (Not Found), 500 (Internal Server Error).
22
+ */
23
+ status: number;
24
+
25
+ /**
26
+ * Response headers from the server.
27
+ *
28
+ * Contains all HTTP headers returned by the server. Header values can be
29
+ * either a single string or an array of strings for headers that appear
30
+ * multiple times (e.g., `Set-Cookie`).
31
+ */
32
+ headers: Record<string, string | string[]>;
33
+
34
+ /**
35
+ * Parsed body content of the response.
36
+ *
37
+ * The response body after parsing. For JSON responses, this is the decoded
38
+ * JavaScript object. The actual type depends on the endpoint and response
39
+ * content-type.
40
+ */
41
+ body: unknown;
42
+ }
package/src/http/index.ts CHANGED
@@ -1,7 +1,7 @@
1
- export * from "./IHttpConnection";
2
- export * from "./IHttpLlmController";
3
- export * from "./IHttpLlmApplication";
4
- export * from "./IHttpLlmFunction";
5
- export * from "./IHttpMigrateApplication";
6
- export * from "./IHttpMigrateRoute";
7
- export * from "./IHttpResponse";
1
+ export * from "./IHttpConnection";
2
+ export * from "./IHttpLlmController";
3
+ export * from "./IHttpLlmApplication";
4
+ export * from "./IHttpLlmFunction";
5
+ export * from "./IHttpMigrateApplication";
6
+ export * from "./IHttpMigrateRoute";
7
+ export * from "./IHttpResponse";
package/src/index.ts CHANGED
@@ -1,9 +1,9 @@
1
- export * from "./http/index";
2
- export * from "./schema/index";
3
- export * from "./openapi/index";
4
- export * from "./typings/index";
5
- export * from "./utils/index";
6
- export * from "./metadata/index";
7
- export * from "./protobuf/index";
8
-
9
- export * as tags from "./tags/index";
1
+ export * from "./http/index";
2
+ export * from "./schema/index";
3
+ export * from "./openapi/index";
4
+ export * from "./typings/index";
5
+ export * from "./utils/index";
6
+ export * from "./metadata/index";
7
+ export * from "./protobuf/index";
8
+
9
+ export * as tags from "./tags/index";
@@ -1,25 +1,25 @@
1
- /**
2
- * JSDoc tag information extracted from TypeScript source.
3
- *
4
- * Represents a single JSDoc tag like `@param`, `@returns`, `@deprecated`, etc.
5
- * Used throughout typia's metadata system to preserve documentation.
6
- *
7
- * @author Jeongho Nam - https://github.com/samchon
8
- */
9
- export interface IJsDocTagInfo {
10
- /** Tag name without `@` prefix (e.g., `"param"`, `"returns"`). */
11
- name: string;
12
-
13
- /** Tag text content, if any. */
14
- text?: IJsDocTagInfo.IText[];
15
- }
16
- export namespace IJsDocTagInfo {
17
- /** Text segment within a JSDoc tag. */
18
- export interface IText {
19
- /** Text content. */
20
- text: string;
21
-
22
- /** Text kind (e.g., `"text"`, `"parameterName"`). */
23
- kind: string;
24
- }
25
- }
1
+ /**
2
+ * JSDoc tag information extracted from TypeScript source.
3
+ *
4
+ * Represents a single JSDoc tag like `@param`, `@returns`, `@deprecated`, etc.
5
+ * Used throughout typia's metadata system to preserve documentation.
6
+ *
7
+ * @author Jeongho Nam - https://github.com/samchon
8
+ */
9
+ export interface IJsDocTagInfo {
10
+ /** Tag name without `@` prefix (e.g., `"param"`, `"returns"`). */
11
+ name: string;
12
+
13
+ /** Tag text content, if any. */
14
+ text?: IJsDocTagInfo.IText[];
15
+ }
16
+ export namespace IJsDocTagInfo {
17
+ /** Text segment within a JSDoc tag. */
18
+ export interface IText {
19
+ /** Text content. */
20
+ text: string;
21
+
22
+ /** Text kind (e.g., `"text"`, `"parameterName"`). */
23
+ kind: string;
24
+ }
25
+ }
@@ -1,24 +1,24 @@
1
- import { IMetadataSchema } from "./IMetadataSchema";
2
-
3
- /**
4
- * Shared type definitions for metadata schemas.
5
- *
6
- * `IMetadataComponents` stores reusable type definitions that can be referenced
7
- * from {@link IMetadataSchema} via {@link IMetadataSchema.IReference}. This
8
- * enables deduplication of complex types across multiple schemas.
9
- *
10
- * @author Jeongho Nam - https://github.com/samchon
11
- */
12
- export interface IMetadataComponents {
13
- /** Object type definitions. */
14
- objects: IMetadataSchema.IObjectType[];
15
-
16
- /** Type alias definitions. */
17
- aliases: IMetadataSchema.IAliasType[];
18
-
19
- /** Array type definitions. */
20
- arrays: IMetadataSchema.IArrayType[];
21
-
22
- /** Tuple type definitions. */
23
- tuples: IMetadataSchema.ITupleType[];
24
- }
1
+ import { IMetadataSchema } from "./IMetadataSchema";
2
+
3
+ /**
4
+ * Shared type definitions for metadata schemas.
5
+ *
6
+ * `IMetadataComponents` stores reusable type definitions that can be referenced
7
+ * from {@link IMetadataSchema} via {@link IMetadataSchema.IReference}. This
8
+ * enables deduplication of complex types across multiple schemas.
9
+ *
10
+ * @author Jeongho Nam - https://github.com/samchon
11
+ */
12
+ export interface IMetadataComponents {
13
+ /** Object type definitions. */
14
+ objects: IMetadataSchema.IObjectType[];
15
+
16
+ /** Type alias definitions. */
17
+ aliases: IMetadataSchema.IAliasType[];
18
+
19
+ /** Array type definitions. */
20
+ arrays: IMetadataSchema.IArrayType[];
21
+
22
+ /** Tuple type definitions. */
23
+ tuples: IMetadataSchema.ITupleType[];
24
+ }