@typia/interface 12.0.0-dev.20260311 → 12.0.0-dev.20260312

package/src/http/IHttpLlmApplication.ts

@@ -1,72 +1,72 @@
-import { OpenApi } from "../openapi/OpenApi";
-import { ILlmSchema } from "../schema/ILlmSchema";
-import { IHttpLlmFunction } from "./IHttpLlmFunction";
-import { IHttpMigrateRoute } from "./IHttpMigrateRoute";
-
-/**
- * LLM function calling application from OpenAPI document.
- *
- * `IHttpLlmApplication` is a collection of {@link IHttpLlmFunction} schemas
- * converted from {@link OpenApi.IDocument} by `HttpLlm.application()`. Each
- * OpenAPI operation becomes an LLM-callable function.
- *
- * Successful conversions go to {@link functions}, failed ones to {@link errors}
- * with detailed error messages. Common failure causes:
- *
- * - Unsupported schema features (tuples, `oneOf` with incompatible types)
- * - Missing required fields in OpenAPI document
- * - Operations marked with `x-samchon-human: true`
- *
- * Configure behavior via {@link IHttpLlmApplication.IConfig}:
- *
- * - {@link IHttpLlmApplication.IConfig.maxLength}: Function name length limit
- * - {@link ILlmSchema.IConfig.strict}: OpenAI structured output mode
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface IHttpLlmApplication {
-  /** Successfully converted LLM function schemas. */
-  functions: IHttpLlmFunction[];
-
-  /** Operations that failed conversion. */
-  errors: IHttpLlmApplication.IError[];
-
-  /** Configuration used for composition. */
-  config: IHttpLlmApplication.IConfig;
-}
-export namespace IHttpLlmApplication {
-  /** Configuration for HTTP LLM application composition. */
-  export interface IConfig extends ILlmSchema.IConfig {
-    /**
-     * Maximum function name length. Truncated or UUID if exceeded.
-     *
-     * @default 64
-     */
-    maxLength: number;
-
-    /**
-     * Whether to disallow superfluous properties.
-     *
-     * @default false
-     */
-    equals: boolean;
-  }
-
-  /** Composition error for an operation. */
-  export interface IError {
-    /** HTTP method of the failed operation. */
-    method: "get" | "post" | "put" | "patch" | "delete" | "head";
-
-    /** Path of the failed operation. */
-    path: string;
-
-    /** Error messages describing the failure. */
-    messages: string[];
-
-    /** Returns source {@link OpenApi.IOperation}. */
-    operation: () => OpenApi.IOperation;
-
-    /** Returns source route. Undefined if error occurred at migration level. */
-    route: () => IHttpMigrateRoute | undefined;
-  }
-}
+import { OpenApi } from "../openapi/OpenApi";
+import { ILlmSchema } from "../schema/ILlmSchema";
+import { IHttpLlmFunction } from "./IHttpLlmFunction";
+import { IHttpMigrateRoute } from "./IHttpMigrateRoute";
+
+/**
+ * LLM function calling application from OpenAPI document.
+ *
+ * `IHttpLlmApplication` is a collection of {@link IHttpLlmFunction} schemas
+ * converted from {@link OpenApi.IDocument} by `HttpLlm.application()`. Each
+ * OpenAPI operation becomes an LLM-callable function.
+ *
+ * Successful conversions go to {@link functions}, failed ones to {@link errors}
+ * with detailed error messages. Common failure causes:
+ *
+ * - Unsupported schema features (tuples, `oneOf` with incompatible types)
+ * - Missing required fields in OpenAPI document
+ * - Operations marked with `x-samchon-human: true`
+ *
+ * Configure behavior via {@link IHttpLlmApplication.IConfig}:
+ *
+ * - {@link IHttpLlmApplication.IConfig.maxLength}: Function name length limit
+ * - {@link ILlmSchema.IConfig.strict}: OpenAI structured output mode
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface IHttpLlmApplication {
+  /** Successfully converted LLM function schemas. */
+  functions: IHttpLlmFunction[];
+
+  /** Operations that failed conversion. */
+  errors: IHttpLlmApplication.IError[];
+
+  /** Configuration used for composition. */
+  config: IHttpLlmApplication.IConfig;
+}
+export namespace IHttpLlmApplication {
+  /** Configuration for HTTP LLM application composition. */
+  export interface IConfig extends ILlmSchema.IConfig {
+    /**
+     * Maximum function name length. Truncated or UUID if exceeded.
+     *
+     * @default 64
+     */
+    maxLength: number;
+
+    /**
+     * Whether to disallow superfluous properties.
+     *
+     * @default false
+     */
+    equals: boolean;
+  }
+
+  /** Composition error for an operation. */
+  export interface IError {
+    /** HTTP method of the failed operation. */
+    method: "head" | "get" | "post" | "put" | "patch" | "delete" | "query";
+
+    /** Path of the failed operation. */
+    path: string;
+
+    /** Error messages describing the failure. */
+    messages: string[];
+
+    /** Returns source {@link OpenApi.IOperation}. */
+    operation: () => OpenApi.IOperation;
+
+    /** Returns source route. Undefined if error occurred at migration level. */
+    route: () => IHttpMigrateRoute | undefined;
+  }
+}

package/src/http/IHttpLlmFunction.ts

@@ -1,34 +1,34 @@
-import { OpenApi } from "../openapi/OpenApi";
-import { ILlmFunction } from "../schema/ILlmFunction";
-import { IHttpMigrateRoute } from "./IHttpMigrateRoute";
-
-/**
- * LLM function calling schema from OpenAPI operation.
- *
- * Extends {@link ILlmFunction} with HTTP-specific properties. Generated from
- * {@link OpenApi.IOperation} as part of {@link IHttpLlmApplication}.
- *
- * - {@link method}, {@link path}: HTTP endpoint info
- * - {@link operation}: Source OpenAPI operation
- * - {@link route}: Source migration route
- *
- * Inherits {@link parse} and {@link validate} from {@link ILlmFunction}.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface IHttpLlmFunction extends ILlmFunction {
-  /** HTTP method of the endpoint. */
-  method: "get" | "post" | "patch" | "put" | "delete";
-
-  /** Path of the endpoint. */
-  path: string;
-
-  /** Category tags from {@link OpenApi.IOperation.tags}. */
-  tags?: string[];
-
-  /** Returns the source {@link OpenApi.IOperation}. */
-  operation: () => OpenApi.IOperation;
-
-  /** Returns the source {@link IHttpMigrateRoute}. */
-  route: () => IHttpMigrateRoute;
-}
+import { OpenApi } from "../openapi/OpenApi";
+import { ILlmFunction } from "../schema/ILlmFunction";
+import { IHttpMigrateRoute } from "./IHttpMigrateRoute";
+
+/**
+ * LLM function calling schema from OpenAPI operation.
+ *
+ * Extends {@link ILlmFunction} with HTTP-specific properties. Generated from
+ * {@link OpenApi.IOperation} as part of {@link IHttpLlmApplication}.
+ *
+ * - {@link method}, {@link path}: HTTP endpoint info
+ * - {@link operation}: Source OpenAPI operation
+ * - {@link route}: Source migration route
+ *
+ * Inherits {@link parse} and {@link validate} from {@link ILlmFunction}.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface IHttpLlmFunction extends ILlmFunction {
+  /** HTTP method of the endpoint. */
+  method: "head" | "get" | "post" | "put" | "patch" | "delete" | "query";
+
+  /** Path of the endpoint. */
+  path: string;
+
+  /** Category tags from {@link OpenApi.IOperation.tags}. */
+  tags?: string[];
+
+  /** Returns the source {@link OpenApi.IOperation}. */
+  operation: () => OpenApi.IOperation;
+
+  /** Returns the source {@link IHttpMigrateRoute}. */
+  route: () => IHttpMigrateRoute;
+}

package/src/http/IHttpMigrateApplication.ts

@@ -1,48 +1,48 @@
-import { OpenApi } from "../openapi/OpenApi";
-import { IHttpMigrateRoute } from "./IHttpMigrateRoute";
-
-/**
- * Migrated application from OpenAPI document.
- *
- * `IHttpMigrateApplication` converts OpenAPI operations into callable HTTP
- * routes via `HttpMigration.application()`. Unlike {@link IHttpLlmApplication}
- * which targets LLM function calling, this focuses on SDK/client code
- * generation with full HTTP semantics.
- *
- * Each {@link IHttpMigrateRoute} represents a single API endpoint with:
- *
- * - Resolved path parameters (`:id` format)
- * - Combined query/header schemas as objects
- * - Request/response body with content type
- * - Accessor path for RPC-style function naming
- *
- * Failed operations go to {@link errors} with detailed messages.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface IHttpMigrateApplication {
-  /** Successfully migrated routes. */
-  routes: IHttpMigrateRoute[];
-
-  /** Operations that failed migration. */
-  errors: IHttpMigrateApplication.IError[];
-
-  /** Returns source OpenAPI document. */
-  document: () => OpenApi.IDocument;
-}
-export namespace IHttpMigrateApplication {
-  /** Migration error for an operation. */
-  export interface IError {
-    /** Returns source operation. */
-    operation: () => OpenApi.IOperation;
-
-    /** HTTP method. */
-    method: "head" | "get" | "post" | "put" | "patch" | "delete";
-
-    /** Operation path. */
-    path: string;
-
-    /** Error messages. */
-    messages: string[];
-  }
-}
+import { OpenApi } from "../openapi/OpenApi";
+import { IHttpMigrateRoute } from "./IHttpMigrateRoute";
+
+/**
+ * Migrated application from OpenAPI document.
+ *
+ * `IHttpMigrateApplication` converts OpenAPI operations into callable HTTP
+ * routes via `HttpMigration.application()`. Unlike {@link IHttpLlmApplication}
+ * which targets LLM function calling, this focuses on SDK/client code
+ * generation with full HTTP semantics.
+ *
+ * Each {@link IHttpMigrateRoute} represents a single API endpoint with:
+ *
+ * - Resolved path parameters (`:id` format)
+ * - Combined query/header schemas as objects
+ * - Request/response body with content type
+ * - Accessor path for RPC-style function naming
+ *
+ * Failed operations go to {@link errors} with detailed messages.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface IHttpMigrateApplication {
+  /** Successfully migrated routes. */
+  routes: IHttpMigrateRoute[];
+
+  /** Operations that failed migration. */
+  errors: IHttpMigrateApplication.IError[];
+
+  /** Returns source OpenAPI document. */
+  document: () => OpenApi.IDocument;
+}
+export namespace IHttpMigrateApplication {
+  /** Migration error for an operation. */
+  export interface IError {
+    /** Returns source operation. */
+    operation: () => OpenApi.IOperation;
+
+    /** HTTP method. */
+    method: "head" | "get" | "post" | "put" | "patch" | "delete" | "query";
+
+    /** Operation path. */
+    path: string;
+
+    /** Error messages. */
+    messages: string[];
+  }
+}

package/src/http/IHttpMigrateRoute.ts

@@ -1,165 +1,165 @@
-import { OpenApi } from "../openapi/OpenApi";
-
-/**
- * HTTP route converted from OpenAPI operation.
- *
- * `IHttpMigrateRoute` represents a single API endpoint with all
- * request/response schemas resolved and ready for code generation. Contains
- * {@link parameters} for URL path variables, {@link query} for query strings,
- * {@link headers}, {@link body} for request payload, and
- * {@link success}/{@link exceptions} for responses.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface IHttpMigrateRoute {
-  /** HTTP method. Operations with other methods are ignored. */
-  method: "head" | "get" | "post" | "put" | "patch" | "delete";
-
-  /** Original path from OpenAPI document. */
-  path: string;
-
-  /** Emended path with `:param` format, always starts with `/`. */
-  emendedPath: string;
-
-  /**
-   * Accessor path for generated RPC function.
-   *
-   * Namespaces from static path segments, function name from method +
-   * parameters. `delete` becomes `erase` to avoid reserved keyword.
-   */
-  accessor: string[];
-
-  /** Path parameters only. */
-  parameters: IHttpMigrateRoute.IParameter[];
-
-  /** Combined headers as single object. Null if none. */
-  headers: IHttpMigrateRoute.IHeaders | null;
-
-  /** Combined query parameters as single object. Null if none. */
-  query: IHttpMigrateRoute.IQuery | null;
-
-  /** Request body metadata. Null if none. */
-  body: IHttpMigrateRoute.IBody | null;
-
-  /** Success response (200/201). Null if void return. */
-  success: IHttpMigrateRoute.ISuccess | null;
-
-  /** Exception responses keyed by status code. */
-  exceptions: Record<string, IHttpMigrateRoute.IException>;
-
-  /** Returns description comment for the RPC function. */
-  comment: () => string;
-
-  /** Returns source {@link OpenApi.IOperation}. */
-  operation: () => OpenApi.IOperation;
-}
-export namespace IHttpMigrateRoute {
-  /** Path parameter metadata. */
-  export interface IParameter {
-    /** Parameter name in path template. */
-    name: string;
-
-    /** Parameter variable key. */
-    key: string;
-
-    /** Parameter type schema. */
-    schema: OpenApi.IJsonSchema;
-
-    /** Returns source parameter definition. */
-    parameter: () => OpenApi.IOperation.IParameter;
-  }
-
-  /** Headers metadata. */
-  export interface IHeaders {
-    /** Combined headers parameter name. */
-    name: string;
-
-    /** Headers variable key. */
-    key: string;
-
-    /** Combined headers schema. */
-    schema: OpenApi.IJsonSchema;
-
-    /** Returns title. */
-    title: () => string | undefined;
-
-    /** Returns description. */
-    description: () => string | undefined;
-
-    /** Returns example value. */
-    example: () => any | undefined;
-
-    /** Returns named examples. */
-    examples: () => Record<string, any> | undefined;
-  }
-
-  /** Query parameters metadata. */
-  export interface IQuery {
-    /** Combined query parameter name. */
-    name: string;
-
-    /** Query variable key. */
-    key: string;
-
-    /** Combined query schema. */
-    schema: OpenApi.IJsonSchema;
-
-    /** Returns title. */
-    title: () => string | undefined;
-
-    /** Returns description. */
-    description: () => string | undefined;
-
-    /** Returns example value. */
-    example: () => any | undefined;
-
-    /** Returns named examples. */
-    examples: () => Record<string, any> | undefined;
-  }
-
-  /** Request body metadata. */
-  export interface IBody {
-    /** Body parameter name. */
-    name: string;
-
-    /** Body variable key. */
-    key: string;
-
-    /** Content media type. */
-    type:
-      | "text/plain"
-      | "application/json"
-      | "application/x-www-form-urlencoded"
-      | "multipart/form-data";
-
-    /** Body type schema. */
-    schema: OpenApi.IJsonSchema;
-
-    /** Returns description. */
-    description: () => string | undefined;
-
-    /** Returns source media type definition. */
-    media: () => OpenApi.IOperation.IMediaType;
-
-    /** Nestia encryption flag. */
-    "x-nestia-encrypted"?: boolean;
-  }
-
-  /** Success response metadata. */
-  export interface ISuccess extends IBody {
-    /** HTTP status code. */
-    status: string;
-  }
-
-  /** Exception response metadata. */
-  export interface IException {
-    /** Exception type schema. */
-    schema: OpenApi.IJsonSchema;
-
-    /** Returns source response definition. */
-    response: () => OpenApi.IOperation.IResponse;
-
-    /** Returns source media type definition. */
-    media: () => OpenApi.IOperation.IMediaType;
-  }
-}
+import { OpenApi } from "../openapi/OpenApi";
+
+/**
+ * HTTP route converted from OpenAPI operation.
+ *
+ * `IHttpMigrateRoute` represents a single API endpoint with all
+ * request/response schemas resolved and ready for code generation. Contains
+ * {@link parameters} for URL path variables, {@link query} for query strings,
+ * {@link headers}, {@link body} for request payload, and
+ * {@link success}/{@link exceptions} for responses.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface IHttpMigrateRoute {
+  /** HTTP method. */
+  method: "head" | "get" | "post" | "put" | "patch" | "delete" | "query";
+
+  /** Original path from OpenAPI document. */
+  path: string;
+
+  /** Emended path with `:param` format, always starts with `/`. */
+  emendedPath: string;
+
+  /**
+   * Accessor path for generated RPC function.
+   *
+   * Namespaces from static path segments, function name from method +
+   * parameters. `delete` becomes `erase` to avoid reserved keyword.
+   */
+  accessor: string[];
+
+  /** Path parameters only. */
+  parameters: IHttpMigrateRoute.IParameter[];
+
+  /** Combined headers as single object. Null if none. */
+  headers: IHttpMigrateRoute.IHeaders | null;
+
+  /** Combined query parameters as single object. Null if none. */
+  query: IHttpMigrateRoute.IQuery | null;
+
+  /** Request body metadata. Null if none. */
+  body: IHttpMigrateRoute.IBody | null;
+
+  /** Success response (200/201). Null if void return. */
+  success: IHttpMigrateRoute.ISuccess | null;
+
+  /** Exception responses keyed by status code. */
+  exceptions: Record<string, IHttpMigrateRoute.IException>;
+
+  /** Returns description comment for the RPC function. */
+  comment: () => string;
+
+  /** Returns source {@link OpenApi.IOperation}. */
+  operation: () => OpenApi.IOperation;
+}
+export namespace IHttpMigrateRoute {
+  /** Path parameter metadata. */
+  export interface IParameter {
+    /** Parameter name in path template. */
+    name: string;
+
+    /** Parameter variable key. */
+    key: string;
+
+    /** Parameter type schema. */
+    schema: OpenApi.IJsonSchema;
+
+    /** Returns source parameter definition. */
+    parameter: () => OpenApi.IOperation.IParameter;
+  }
+
+  /** Headers metadata. */
+  export interface IHeaders {
+    /** Combined headers parameter name. */
+    name: string;
+
+    /** Headers variable key. */
+    key: string;
+
+    /** Combined headers schema. */
+    schema: OpenApi.IJsonSchema;
+
+    /** Returns title. */
+    title: () => string | undefined;
+
+    /** Returns description. */
+    description: () => string | undefined;
+
+    /** Returns example value. */
+    example: () => any | undefined;
+
+    /** Returns named examples. */
+    examples: () => Record<string, any> | undefined;
+  }
+
+  /** Query parameters metadata. */
+  export interface IQuery {
+    /** Combined query parameter name. */
+    name: string;
+
+    /** Query variable key. */
+    key: string;
+
+    /** Combined query schema. */
+    schema: OpenApi.IJsonSchema;
+
+    /** Returns title. */
+    title: () => string | undefined;
+
+    /** Returns description. */
+    description: () => string | undefined;
+
+    /** Returns example value. */
+    example: () => any | undefined;
+
+    /** Returns named examples. */
+    examples: () => Record<string, any> | undefined;
+  }
+
+  /** Request body metadata. */
+  export interface IBody {
+    /** Body parameter name. */
+    name: string;
+
+    /** Body variable key. */
+    key: string;
+
+    /** Content media type. */
+    type:
+      | "text/plain"
+      | "application/json"
+      | "application/x-www-form-urlencoded"
+      | "multipart/form-data";
+
+    /** Body type schema. */
+    schema: OpenApi.IJsonSchema;
+
+    /** Returns description. */
+    description: () => string | undefined;
+
+    /** Returns source media type definition. */
+    media: () => OpenApi.IOperation.IMediaType;
+
+    /** Nestia encryption flag. */
+    "x-nestia-encrypted"?: boolean;
+  }
+
+  /** Success response metadata. */
+  export interface ISuccess extends IBody {
+    /** HTTP status code. */
+    status: string;
+  }
+
+  /** Exception response metadata. */
+  export interface IException {
+    /** Exception type schema. */
+    schema: OpenApi.IJsonSchema;
+
+    /** Returns source response definition. */
+    response: () => OpenApi.IOperation.IResponse;
+
+    /** Returns source media type definition. */
+    media: () => OpenApi.IOperation.IMediaType;
+  }
+}