@copilotkitnext/runtime 0.0.20 → 0.0.21

package/dist/index.d.mts

@@ -1,112 +1,21 @@
-import { MaybePromise, NonEmptyRecord } from '@copilotkitnext/shared';
-export { finalizeRunEvents } from '@copilotkitnext/shared';
-import { AbstractAgent, RunAgentInput, BaseEvent } from '@ag-ui/client';
-import { Observable } from 'rxjs';
+import { C as CopilotRuntime, A as AgentRunner, a as AgentRunnerRunRequest, b as AgentRunnerConnectRequest, c as AgentRunnerIsRunningRequest, d as AgentRunnerStopRequest } from './runtime-BEcxV64L.mjs';
+export { e as CopilotRuntimeOptions, V as VERSION } from './runtime-BEcxV64L.mjs';
 import * as hono_hono_base from 'hono/hono-base';
 import * as hono_utils_http_status from 'hono/utils/http-status';
-
-/**
- * Middleware support for CopilotKit Runtime.
- *
- * A middleware hook can be provided as either:
- *   1. A **callback function** executed in-process.
- *   2. A **webhook URL** (http/https).  The runtime will `POST` a JSON payload
- *      to the URL and, for *before* hooks, accept an optional modified
- *      `Request` object in the response body.
- *
- * Two lifecycle hooks are available:
- *   • `BEFORE_REQUEST` – runs *before* the request handler.
- *   • `AFTER_REQUEST`  – runs *after* the handler returns a `Response`.
- */
-
-interface BeforeRequestMiddlewareParameters {
-    runtime: CopilotRuntime;
-    request: Request;
-    path: string;
-}
-interface AfterRequestMiddlewareParameters {
-    runtime: CopilotRuntime;
-    response: Response;
-    path: string;
-}
-type BeforeRequestMiddlewareFn = (params: BeforeRequestMiddlewareParameters) => MaybePromise<Request | void>;
-type AfterRequestMiddlewareFn = (params: AfterRequestMiddlewareParameters) => MaybePromise<void>;
-/**
- * A middleware value can be either a callback function or a webhook URL.
- */
-type BeforeRequestMiddleware = BeforeRequestMiddlewareFn;
-type AfterRequestMiddleware = AfterRequestMiddlewareFn;
-
-interface TranscribeFileOptions {
-    audioFile: File;
-    /** MIME type of the audio file */
-    mimeType?: string;
-    /** Size of the audio file in bytes */
-    size?: number;
-}
-declare abstract class TranscriptionService {
-    abstract transcribeFile(options: TranscribeFileOptions): Promise<string>;
-}
-
-interface AgentRunnerRunRequest {
-    threadId: string;
-    agent: AbstractAgent;
-    input: RunAgentInput;
-}
-interface AgentRunnerConnectRequest {
-    threadId: string;
-}
-interface AgentRunnerIsRunningRequest {
-    threadId: string;
-}
-interface AgentRunnerStopRequest {
-    threadId: string;
-}
-declare abstract class AgentRunner {
-    abstract run(request: AgentRunnerRunRequest): Observable<BaseEvent>;
-    abstract connect(request: AgentRunnerConnectRequest): Observable<BaseEvent>;
-    abstract isRunning(request: AgentRunnerIsRunningRequest): Promise<boolean>;
-    abstract stop(request: AgentRunnerStopRequest): Promise<boolean | undefined>;
-}
-
-declare const VERSION: string;
-/**
- * Options used to construct a `CopilotRuntime` instance.
- */
-interface CopilotRuntimeOptions {
-    /** Map of available agents (loaded lazily is fine). */
-    agents: MaybePromise<NonEmptyRecord<Record<string, AbstractAgent>>>;
-    /** The runner to use for running agents. */
-    runner?: AgentRunner;
-    /** Optional transcription service for audio processing. */
-    transcriptionService?: TranscriptionService;
-    /** Optional *before* middleware – callback function or webhook URL. */
-    beforeRequestMiddleware?: BeforeRequestMiddleware;
-    /** Optional *after* middleware – callback function or webhook URL. */
-    afterRequestMiddleware?: AfterRequestMiddleware;
-}
-/**
- * Central runtime object passed to all request handlers.
- */
-declare class CopilotRuntime {
-    agents: CopilotRuntimeOptions["agents"];
-    transcriptionService: CopilotRuntimeOptions["transcriptionService"];
-    beforeRequestMiddleware: CopilotRuntimeOptions["beforeRequestMiddleware"];
-    afterRequestMiddleware: CopilotRuntimeOptions["afterRequestMiddleware"];
-    runner: AgentRunner;
-    constructor({ agents, transcriptionService, beforeRequestMiddleware, afterRequestMiddleware, runner, }: CopilotRuntimeOptions);
-}
+import { Observable } from 'rxjs';
+import { BaseEvent } from '@ag-ui/client';
+export { finalizeRunEvents } from '@copilotkitnext/shared';
 
 interface CopilotEndpointParams {
     runtime: CopilotRuntime;
     basePath: string;
 }
-type CopilotEndpointContext = {
+type CopilotEndpointContext$1 = {
     Variables: {
         modifiedRequest?: Request;
     };
 };
-declare function createCopilotEndpoint({ runtime, basePath }: CopilotEndpointParams): hono_hono_base.HonoBase<CopilotEndpointContext, {
+declare function createCopilotEndpoint({ runtime, basePath }: CopilotEndpointParams): hono_hono_base.HonoBase<CopilotEndpointContext$1, {
     [x: `${string}/*`]: {};
 } & {
     [x: `${string}/agent/:agentId/run`]: {
@@ -169,6 +78,31 @@ declare function createCopilotEndpoint({ runtime, basePath }: CopilotEndpointPar
     };
 }, string>;
 
+interface CopilotSingleEndpointParams {
+    runtime: CopilotRuntime;
+    /**
+     * Absolute path at which to mount the single-route endpoint (e.g. "/api/copilotkit").
+     */
+    basePath: string;
+}
+type CopilotEndpointContext = {
+    Variables: {
+        modifiedRequest?: Request;
+    };
+};
+declare function createCopilotEndpointSingleRoute({ runtime, basePath }: CopilotSingleEndpointParams): hono_hono_base.HonoBase<CopilotEndpointContext, {
+    [x: `${string}/*`]: {};
+} & {
+    [x: string]: {
+        $post: {
+            input: {};
+            output: {};
+            outputFormat: string;
+            status: hono_utils_http_status.StatusCode;
+        };
+    };
+}, string>;
+
 declare class InMemoryAgentRunner extends AgentRunner {
     run(request: AgentRunnerRunRequest): Observable<BaseEvent>;
     connect(request: AgentRunnerConnectRequest): Observable<BaseEvent>;
@@ -176,4 +110,4 @@ declare class InMemoryAgentRunner extends AgentRunner {
     stop(request: AgentRunnerStopRequest): Promise<boolean | undefined>;
 }
 
-export { AgentRunner, type AgentRunnerConnectRequest, type AgentRunnerIsRunningRequest, type AgentRunnerRunRequest, type AgentRunnerStopRequest, CopilotRuntime, type CopilotRuntimeOptions, InMemoryAgentRunner, VERSION, createCopilotEndpoint };
+export { AgentRunner, AgentRunnerConnectRequest, AgentRunnerIsRunningRequest, AgentRunnerRunRequest, AgentRunnerStopRequest, CopilotRuntime, InMemoryAgentRunner, createCopilotEndpoint, createCopilotEndpointSingleRoute };

package/dist/index.d.ts

@@ -1,112 +1,21 @@
-import { MaybePromise, NonEmptyRecord } from '@copilotkitnext/shared';
-export { finalizeRunEvents } from '@copilotkitnext/shared';
-import { AbstractAgent, RunAgentInput, BaseEvent } from '@ag-ui/client';
-import { Observable } from 'rxjs';
+import { C as CopilotRuntime, A as AgentRunner, a as AgentRunnerRunRequest, b as AgentRunnerConnectRequest, c as AgentRunnerIsRunningRequest, d as AgentRunnerStopRequest } from './runtime-BEcxV64L.js';
+export { e as CopilotRuntimeOptions, V as VERSION } from './runtime-BEcxV64L.js';
 import * as hono_hono_base from 'hono/hono-base';
 import * as hono_utils_http_status from 'hono/utils/http-status';
-
-/**
- * Middleware support for CopilotKit Runtime.
- *
- * A middleware hook can be provided as either:
- *   1. A **callback function** executed in-process.
- *   2. A **webhook URL** (http/https).  The runtime will `POST` a JSON payload
- *      to the URL and, for *before* hooks, accept an optional modified
- *      `Request` object in the response body.
- *
- * Two lifecycle hooks are available:
- *   • `BEFORE_REQUEST` – runs *before* the request handler.
- *   • `AFTER_REQUEST`  – runs *after* the handler returns a `Response`.
- */
-
-interface BeforeRequestMiddlewareParameters {
-    runtime: CopilotRuntime;
-    request: Request;
-    path: string;
-}
-interface AfterRequestMiddlewareParameters {
-    runtime: CopilotRuntime;
-    response: Response;
-    path: string;
-}
-type BeforeRequestMiddlewareFn = (params: BeforeRequestMiddlewareParameters) => MaybePromise<Request | void>;
-type AfterRequestMiddlewareFn = (params: AfterRequestMiddlewareParameters) => MaybePromise<void>;
-/**
- * A middleware value can be either a callback function or a webhook URL.
- */
-type BeforeRequestMiddleware = BeforeRequestMiddlewareFn;
-type AfterRequestMiddleware = AfterRequestMiddlewareFn;
-
-interface TranscribeFileOptions {
-    audioFile: File;
-    /** MIME type of the audio file */
-    mimeType?: string;
-    /** Size of the audio file in bytes */
-    size?: number;
-}
-declare abstract class TranscriptionService {
-    abstract transcribeFile(options: TranscribeFileOptions): Promise<string>;
-}
-
-interface AgentRunnerRunRequest {
-    threadId: string;
-    agent: AbstractAgent;
-    input: RunAgentInput;
-}
-interface AgentRunnerConnectRequest {
-    threadId: string;
-}
-interface AgentRunnerIsRunningRequest {
-    threadId: string;
-}
-interface AgentRunnerStopRequest {
-    threadId: string;
-}
-declare abstract class AgentRunner {
-    abstract run(request: AgentRunnerRunRequest): Observable<BaseEvent>;
-    abstract connect(request: AgentRunnerConnectRequest): Observable<BaseEvent>;
-    abstract isRunning(request: AgentRunnerIsRunningRequest): Promise<boolean>;
-    abstract stop(request: AgentRunnerStopRequest): Promise<boolean | undefined>;
-}
-
-declare const VERSION: string;
-/**
- * Options used to construct a `CopilotRuntime` instance.
- */
-interface CopilotRuntimeOptions {
-    /** Map of available agents (loaded lazily is fine). */
-    agents: MaybePromise<NonEmptyRecord<Record<string, AbstractAgent>>>;
-    /** The runner to use for running agents. */
-    runner?: AgentRunner;
-    /** Optional transcription service for audio processing. */
-    transcriptionService?: TranscriptionService;
-    /** Optional *before* middleware – callback function or webhook URL. */
-    beforeRequestMiddleware?: BeforeRequestMiddleware;
-    /** Optional *after* middleware – callback function or webhook URL. */
-    afterRequestMiddleware?: AfterRequestMiddleware;
-}
-/**
- * Central runtime object passed to all request handlers.
- */
-declare class CopilotRuntime {
-    agents: CopilotRuntimeOptions["agents"];
-    transcriptionService: CopilotRuntimeOptions["transcriptionService"];
-    beforeRequestMiddleware: CopilotRuntimeOptions["beforeRequestMiddleware"];
-    afterRequestMiddleware: CopilotRuntimeOptions["afterRequestMiddleware"];
-    runner: AgentRunner;
-    constructor({ agents, transcriptionService, beforeRequestMiddleware, afterRequestMiddleware, runner, }: CopilotRuntimeOptions);
-}
+import { Observable } from 'rxjs';
+import { BaseEvent } from '@ag-ui/client';
+export { finalizeRunEvents } from '@copilotkitnext/shared';
 
 interface CopilotEndpointParams {
     runtime: CopilotRuntime;
     basePath: string;
 }
-type CopilotEndpointContext = {
+type CopilotEndpointContext$1 = {
     Variables: {
         modifiedRequest?: Request;
     };
 };
-declare function createCopilotEndpoint({ runtime, basePath }: CopilotEndpointParams): hono_hono_base.HonoBase<CopilotEndpointContext, {
+declare function createCopilotEndpoint({ runtime, basePath }: CopilotEndpointParams): hono_hono_base.HonoBase<CopilotEndpointContext$1, {
     [x: `${string}/*`]: {};
 } & {
     [x: `${string}/agent/:agentId/run`]: {
@@ -169,6 +78,31 @@ declare function createCopilotEndpoint({ runtime, basePath }: CopilotEndpointPar
     };
 }, string>;
 
+interface CopilotSingleEndpointParams {
+    runtime: CopilotRuntime;
+    /**
+     * Absolute path at which to mount the single-route endpoint (e.g. "/api/copilotkit").
+     */
+    basePath: string;
+}
+type CopilotEndpointContext = {
+    Variables: {
+        modifiedRequest?: Request;
+    };
+};
+declare function createCopilotEndpointSingleRoute({ runtime, basePath }: CopilotSingleEndpointParams): hono_hono_base.HonoBase<CopilotEndpointContext, {
+    [x: `${string}/*`]: {};
+} & {
+    [x: string]: {
+        $post: {
+            input: {};
+            output: {};
+            outputFormat: string;
+            status: hono_utils_http_status.StatusCode;
+        };
+    };
+}, string>;
+
 declare class InMemoryAgentRunner extends AgentRunner {
     run(request: AgentRunnerRunRequest): Observable<BaseEvent>;
     connect(request: AgentRunnerConnectRequest): Observable<BaseEvent>;
@@ -176,4 +110,4 @@ declare class InMemoryAgentRunner extends AgentRunner {
     stop(request: AgentRunnerStopRequest): Promise<boolean | undefined>;
 }
 
-export { AgentRunner, type AgentRunnerConnectRequest, type AgentRunnerIsRunningRequest, type AgentRunnerRunRequest, type AgentRunnerStopRequest, CopilotRuntime, type CopilotRuntimeOptions, InMemoryAgentRunner, VERSION, createCopilotEndpoint };
+export { AgentRunner, AgentRunnerConnectRequest, AgentRunnerIsRunningRequest, AgentRunnerRunRequest, AgentRunnerStopRequest, CopilotRuntime, InMemoryAgentRunner, createCopilotEndpoint, createCopilotEndpointSingleRoute };

package/dist/index.js

@@ -25,14 +25,15 @@ __export(index_exports, {
   InMemoryAgentRunner: () => InMemoryAgentRunner,
   VERSION: () => VERSION,
   createCopilotEndpoint: () => createCopilotEndpoint,
-  finalizeRunEvents: () => import_shared4.finalizeRunEvents
+  createCopilotEndpointSingleRoute: () => createCopilotEndpointSingleRoute,
+  finalizeRunEvents: () => import_shared5.finalizeRunEvents
 });
 module.exports = __toCommonJS(index_exports);
 
 // package.json
 var package_default = {
   name: "@copilotkitnext/runtime",
-  version: "0.0.20",
+  version: "0.0.21",
   description: "Server-side runtime package for CopilotKit2",
   main: "dist/index.js",
   types: "dist/index.d.ts",
@@ -41,6 +42,11 @@ var package_default = {
       types: "./dist/index.d.ts",
       import: "./dist/index.mjs",
       require: "./dist/index.js"
+    },
+    "./express": {
+      types: "./dist/express.d.ts",
+      import: "./dist/express.mjs",
+      require: "./dist/express.js"
     }
   },
   publishConfig: {
@@ -60,18 +66,23 @@ var package_default = {
   devDependencies: {
     "@copilotkitnext/eslint-config": "workspace:*",
     "@copilotkitnext/typescript-config": "workspace:*",
+    "@types/cors": "^2.8.17",
+    "@types/express": "^4.17.21",
     "@types/node": "^22.15.3",
     eslint: "^9.30.0",
     openai: "^5.9.0",
+    supertest: "^7.1.1",
     tsup: "^8.5.0",
     typescript: "5.8.2",
     vitest: "^3.0.5"
   },
   dependencies: {
-    "@ag-ui/client": "0.0.40-alpha.6",
-    "@ag-ui/core": "0.0.40-alpha.6",
-    "@ag-ui/encoder": "0.0.40-alpha.6",
+    "@ag-ui/client": "0.0.40-alpha.11",
+    "@ag-ui/core": "0.0.40-alpha.11",
+    "@ag-ui/encoder": "0.0.40-alpha.11",
     "@copilotkitnext/shared": "workspace:*",
+    cors: "^2.8.5",
+    express: "^4.21.2",
     hono: "^4.6.13",
     rxjs: "7.8.1"
   },
@@ -348,7 +359,7 @@ var CopilotRuntime = class {
   }
 };
 
-// src/endpoint.ts
+// src/endpoints/hono.ts
 var import_hono = require("hono");
 var import_cors = require("hono/cors");
 
@@ -637,7 +648,7 @@ async function handleTranscribe({
   }
 }
 
-// src/endpoint.ts
+// src/endpoints/hono.ts
 var import_shared3 = require("@copilotkitnext/shared");
 
 // src/middleware.ts
@@ -856,7 +867,7 @@ async function handleStopAgent({
   }
 }
 
-// src/endpoint.ts
+// src/endpoints/hono.ts
 function createCopilotEndpoint({ runtime, basePath }) {
   const app = new import_hono.Hono();
   return app.basePath(basePath).use(
@@ -965,8 +976,210 @@ function createCopilotEndpoint({ runtime, basePath }) {
   });
 }
 
-// src/runner/index.ts
+// src/endpoints/hono-single.ts
+var import_hono2 = require("hono");
+var import_cors2 = require("hono/cors");
 var import_shared4 = require("@copilotkitnext/shared");
+
+// src/endpoints/single-route-helpers.ts
+var METHOD_NAMES = [
+  "agent/run",
+  "agent/connect",
+  "agent/stop",
+  "info",
+  "transcribe"
+];
+async function parseMethodCall(request) {
+  const contentType = request.headers.get("content-type") || "";
+  if (!contentType.includes("application/json")) {
+    throw createResponseError("Single-route endpoint expects JSON payloads", 415);
+  }
+  let jsonEnvelope;
+  try {
+    jsonEnvelope = await request.clone().json();
+  } catch (error) {
+    throw createResponseError("Invalid JSON payload", 400);
+  }
+  const method = validateMethod(jsonEnvelope.method);
+  return {
+    method,
+    params: jsonEnvelope.params,
+    body: jsonEnvelope.body
+  };
+}
+function expectString(params, key) {
+  const value = params?.[key];
+  if (typeof value === "string" && value.trim().length > 0) {
+    return value;
+  }
+  throw createResponseError(`Missing or invalid parameter '${key}'`, 400);
+}
+function createJsonRequest(base, body) {
+  if (body === void 0 || body === null) {
+    throw createResponseError("Missing request body for JSON handler", 400);
+  }
+  const headers = new Headers(base.headers);
+  headers.set("content-type", "application/json");
+  headers.delete("content-length");
+  const serializedBody = serializeJsonBody(body);
+  return new Request(base.url, {
+    method: "POST",
+    headers,
+    body: serializedBody,
+    signal: base.signal
+  });
+}
+function createResponseError(message, status) {
+  return new Response(
+    JSON.stringify({
+      error: "invalid_request",
+      message
+    }),
+    {
+      status,
+      headers: {
+        "Content-Type": "application/json"
+      }
+    }
+  );
+}
+function validateMethod(method) {
+  if (!method) {
+    throw createResponseError("Missing method field", 400);
+  }
+  if (METHOD_NAMES.includes(method)) {
+    return method;
+  }
+  throw createResponseError(`Unsupported method '${method}'`, 400);
+}
+function serializeJsonBody(body) {
+  if (typeof body === "string") {
+    return body;
+  }
+  if (body instanceof Blob || body instanceof ArrayBuffer || body instanceof Uint8Array) {
+    return body;
+  }
+  if (body instanceof FormData || body instanceof URLSearchParams) {
+    return body;
+  }
+  return JSON.stringify(body);
+}
+
+// src/endpoints/hono-single.ts
+function createCopilotEndpointSingleRoute({ runtime, basePath }) {
+  const app = new import_hono2.Hono();
+  const routePath = normalizePath(basePath);
+  return app.basePath(routePath).use(
+    "*",
+    (0, import_cors2.cors)({
+      origin: "*",
+      allowMethods: ["GET", "HEAD", "PUT", "POST", "DELETE", "PATCH", "OPTIONS"],
+      allowHeaders: ["*"]
+    })
+  ).use("*", async (c, next) => {
+    const request = c.req.raw;
+    const path = c.req.path;
+    try {
+      const maybeModifiedRequest = await callBeforeRequestMiddleware({
+        runtime,
+        request,
+        path
+      });
+      if (maybeModifiedRequest) {
+        c.set("modifiedRequest", maybeModifiedRequest);
+      }
+    } catch (error) {
+      import_shared4.logger.error({ err: error, url: request.url, path }, "Error running before request middleware");
+      if (error instanceof Response) {
+        return error;
+      }
+      throw error;
+    }
+    await next();
+  }).use("*", async (c, next) => {
+    await next();
+    const response = c.res;
+    const path = c.req.path;
+    callAfterRequestMiddleware({
+      runtime,
+      response,
+      path
+    }).catch((error) => {
+      import_shared4.logger.error({ err: error, url: c.req.url, path }, "Error running after request middleware");
+    });
+  }).post("/", async (c) => {
+    const request = c.get("modifiedRequest") || c.req.raw;
+    let methodCall;
+    try {
+      methodCall = await parseMethodCall(request);
+    } catch (error) {
+      if (error instanceof Response) {
+        import_shared4.logger.warn({ url: request.url }, "Invalid single-route payload");
+        return error;
+      }
+      import_shared4.logger.warn({ err: error, url: request.url }, "Invalid single-route payload");
+      return c.json(
+        {
+          error: "invalid_request",
+          message: error instanceof Error ? error.message : "Invalid request payload"
+        },
+        400
+      );
+    }
+    try {
+      switch (methodCall.method) {
+        case "agent/run": {
+          const agentId = expectString(methodCall.params, "agentId");
+          const handlerRequest = createJsonRequest(request, methodCall.body);
+          return await handleRunAgent({ runtime, request: handlerRequest, agentId });
+        }
+        case "agent/connect": {
+          const agentId = expectString(methodCall.params, "agentId");
+          const handlerRequest = createJsonRequest(request, methodCall.body);
+          return await handleConnectAgent({ runtime, request: handlerRequest, agentId });
+        }
+        case "agent/stop": {
+          const agentId = expectString(methodCall.params, "agentId");
+          const threadId = expectString(methodCall.params, "threadId");
+          return await handleStopAgent({ runtime, request, agentId, threadId });
+        }
+        case "info": {
+          return await handleGetRuntimeInfo({ runtime, request });
+        }
+        case "transcribe": {
+          return await handleTranscribe({ runtime, request });
+        }
+        default: {
+          const exhaustiveCheck = methodCall.method;
+          return exhaustiveCheck;
+        }
+      }
+    } catch (error) {
+      if (error instanceof Response) {
+        return error;
+      }
+      import_shared4.logger.error({ err: error, url: request.url, method: methodCall.method }, "Error running single-route handler");
+      throw error;
+    }
+  }).notFound((c) => {
+    return c.json({ error: "Not found" }, 404);
+  });
+}
+function normalizePath(path) {
+  if (!path) {
+    throw new Error("basePath must be provided for single-route endpoint");
+  }
+  if (!path.startsWith("/")) {
+    return `/${path}`;
+  }
+  if (path.length > 1 && path.endsWith("/")) {
+    return path.slice(0, -1);
+  }
+  return path;
+}
+
+// src/runner/index.ts
+var import_shared5 = require("@copilotkitnext/shared");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AgentRunner,
@@ -974,6 +1187,7 @@ var import_shared4 = require("@copilotkitnext/shared");
   InMemoryAgentRunner,
   VERSION,
   createCopilotEndpoint,
+  createCopilotEndpointSingleRoute,
   finalizeRunEvents
 });
 //# sourceMappingURL=index.js.map