@copilotkitnext/runtime 0.0.0-0.0.0-max-changeset-10101010101010-20260109191632

package/dist/runtime-BEcxV64L.d.ts

@@ -0,0 +1,97 @@
+import { MaybePromise, NonEmptyRecord } from '@copilotkitnext/shared';
+import { AbstractAgent, RunAgentInput, BaseEvent } from '@ag-ui/client';
+import { Observable } from 'rxjs';
+
+/**
+ * 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);
+}
+
+export { AgentRunner as A, CopilotRuntime as C, VERSION as V, type AgentRunnerRunRequest as a, type AgentRunnerConnectRequest as b, type AgentRunnerIsRunningRequest as c, type AgentRunnerStopRequest as d, type CopilotRuntimeOptions as e };

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import { config as baseConfig } from "@copilotkitnext/eslint-config/base";
+
+export default [...baseConfig];

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@copilotkitnext/runtime",
+  "version": "0.0.0-0.0.0-max-changeset-10101010101010-20260109191632",
+  "description": "Server-side runtime package for CopilotKit2",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "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": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@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",
+    "@copilotkitnext/eslint-config": "0.0.0-0.0.0-max-changeset-10101010101010-20260109191632",
+    "@copilotkitnext/shared": "0.0.0-0.0.0-max-changeset-10101010101010-20260109191632",
+    "@copilotkitnext/typescript-config": "0.0.0-0.0.0-max-changeset-10101010101010-20260109191632"
+  },
+  "dependencies": {
+    "cors": "^2.8.5",
+    "express": "^4.21.2",
+    "hono": "^4.6.13",
+    "rxjs": "7.8.1"
+  },
+  "peerDependencies": {
+    "@ag-ui/client": "0.0.42",
+    "@ag-ui/core": "0.0.42",
+    "@ag-ui/encoder": "0.0.42",
+    "openai": "^5.9.0",
+    "@copilotkitnext/shared": "0.0.0-0.0.0-max-changeset-10101010101010-20260109191632"
+  },
+  "peerDependenciesMeta": {},
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "lint": "eslint . --max-warnings 0",
+    "check-types": "tsc --noEmit",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
+}

package/vitest.config.mjs

@@ -0,0 +1,15 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    environment: "node",
+    globals: true,
+    include: ["src/**/__tests__/**/*.{test,spec}.ts"],
+    coverage: {
+      reporter: ["text", "lcov", "html"],
+      include: ["src/**/*.ts"],
+      exclude: ["src/**/*.d.ts", "src/**/index.ts"],
+    },
+    setupFiles: [],
+  },
+});