@typia/interface 12.0.0-dev.20260307-2 → 12.0.0-dev.20260310

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: "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;
+  }
+}

package/src/http/IHttpLlmController.ts

@@ -1,96 +1,96 @@
-import { IHttpConnection } from "./IHttpConnection";
-import { IHttpLlmApplication } from "./IHttpLlmApplication";
-import { IHttpLlmFunction } from "./IHttpLlmFunction";
-import { IHttpResponse } from "./IHttpResponse";
-
-/**
- * Controller of HTTP LLM function calling.
- *
- * `IHttpLlmController` is a controller for registering OpenAPI operations as
- * LLM function calling tools. It contains {@link IHttpLlmApplication} with
- * {@link IHttpLlmFunction function calling schemas}, {@link name identifier},
- * and {@link connection} to the API server.
- *
- * You can create this controller with {@link HttpLlm.controller} function,
- * and register it to MCP server with {@link registerMcpControllers}:
- *
- * ```typescript
- * import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
- * import { HttpLlm } from "@typia/utils";
- * import { registerMcpControllers } from "@typia/mcp";
- *
- * const server = new McpServer({ name: "my-server", version: "1.0.0" });
- * registerMcpControllers({
- *   server,
- *   controllers: [
- *     HttpLlm.controller({
- *       name: "shopping",
- *       document: await fetch(
- *         "https://shopping-be.wrtn.io/editor/swagger.json",
- *       ).then((r) => r.json()),
- *       connection: {
- *         host: "https://shopping-be.wrtn.io",
- *         headers: {
- *           Authorization: "Bearer ********",
- *         },
- *       },
- *     }),
- *   ],
- * });
- * ```
- *
- * For TypeScript class-based controller, use {@link ILlmController} instead.
- *
- * @author Jeongho Nam - https://github.com/samchon
- */
-export interface IHttpLlmController {
-  /** Protocol discriminator. */
-  protocol: "http";
-
-  /** Identifier name of the controller. */
-  name: string;
-
-  /** Application schema of function calling. */
-  application: IHttpLlmApplication;
-
-  /**
-   * Connection to the server.
-   *
-   * Connection to the API server including the URL and headers.
-   */
-  connection: IHttpConnection;
-
-  /**
-   * Executor of the API function.
-   *
-   * Default executor is {@link HttpLlm.execute} function, and you can override
-   * it with your own function.
-   *
-   * @param props Properties of the API function call
-   * @returns HTTP response of the API function call
-   */
-  execute?:
-    | undefined
-    | ((props: {
-        /** Connection to the server. */
-        connection: IHttpConnection;
-
-        /** Application schema. */
-        application: IHttpLlmApplication;
-
-        /** Function schema. */
-        function: IHttpLlmFunction;
-
-        /**
-         * Arguments of the function calling.
-         *
-         * It is an object of key-value pairs of the API function's parameters.
-         * The property keys are composed by below rules:
-         *
-         * - Parameter names
-         * - Query parameter as an object type if exists
-         * - Body parameter if exists
-         */
-        arguments: object;
-      }) => Promise<IHttpResponse>);
-}
+import { IHttpConnection } from "./IHttpConnection";
+import { IHttpLlmApplication } from "./IHttpLlmApplication";
+import { IHttpLlmFunction } from "./IHttpLlmFunction";
+import { IHttpResponse } from "./IHttpResponse";
+
+/**
+ * Controller of HTTP LLM function calling.
+ *
+ * `IHttpLlmController` is a controller for registering OpenAPI operations as
+ * LLM function calling tools. It contains {@link IHttpLlmApplication} with
+ * {@link IHttpLlmFunction function calling schemas}, {@link name identifier}, and
+ * {@link connection} to the API server.
+ *
+ * You can create this controller with {@link HttpLlm.controller} function, and
+ * register it to MCP server with {@link registerMcpControllers}:
+ *
+ * ```typescript
+ * import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+ * import { registerMcpControllers } from "@typia/mcp";
+ * import { HttpLlm } from "@typia/utils";
+ *
+ * const server = new McpServer({ name: "my-server", version: "1.0.0" });
+ * registerMcpControllers({
+ *   server,
+ *   controllers: [
+ *     HttpLlm.controller({
+ *       name: "shopping",
+ *       document: await fetch(
+ *         "https://shopping-be.wrtn.io/editor/swagger.json",
+ *       ).then((r) => r.json()),
+ *       connection: {
+ *         host: "https://shopping-be.wrtn.io",
+ *         headers: {
+ *           Authorization: "Bearer ********",
+ *         },
+ *       },
+ *     }),
+ *   ],
+ * });
+ * ```
+ *
+ * For TypeScript class-based controller, use {@link ILlmController} instead.
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ */
+export interface IHttpLlmController {
+  /** Protocol discriminator. */
+  protocol: "http";
+
+  /** Identifier name of the controller. */
+  name: string;
+
+  /** Application schema of function calling. */
+  application: IHttpLlmApplication;
+
+  /**
+   * Connection to the server.
+   *
+   * Connection to the API server including the URL and headers.
+   */
+  connection: IHttpConnection;
+
+  /**
+   * Executor of the API function.
+   *
+   * Default executor is {@link HttpLlm.execute} function, and you can override
+   * it with your own function.
+   *
+   * @param props Properties of the API function call
+   * @returns HTTP response of the API function call
+   */
+  execute?:
+    | undefined
+    | ((props: {
+        /** Connection to the server. */
+        connection: IHttpConnection;
+
+        /** Application schema. */
+        application: IHttpLlmApplication;
+
+        /** Function schema. */
+        function: IHttpLlmFunction;
+
+        /**
+         * Arguments of the function calling.
+         *
+         * It is an object of key-value pairs of the API function's parameters.
+         * The property keys are composed by below rules:
+         *
+         * - Parameter names
+         * - Query parameter as an object type if exists
+         * - Body parameter if exists
+         */
+        arguments: object;
+      }) => Promise<IHttpResponse>);
+}

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: "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;
+}

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";
+
+    /** Operation path. */
+    path: string;
+
+    /** Error messages. */
+    messages: string[];
+  }
+}