@copilotkitnext/runtime 0.0.1

package/.cursor/rules/runtime.always.mdc

@@ -0,0 +1,9 @@
+---
+description: Conventions for the runtime package.
+globs: "*"
+alwaysApply: true
+---
+
+- Node-targeted code compiled from `src/` to `dist/` using TypeScript.
+- Vitest tests reside in `src/__tests__/` and use Node environment.
+- Exported APIs live under `src/index.ts`.

package/.turbo/turbo-build.log

@@ -0,0 +1,22 @@
+
+> @copilotkitnext/runtime@0.0.0 build /Users/mme/Code/CopilotKit2/packages/runtime
+> tsup
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+CLI Using tsup config: /Users/mme/Code/CopilotKit2/packages/runtime/tsup.config.ts
+CLI Target: es2022
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+ESM dist/index.mjs     55.89 KB
+ESM dist/index.mjs.map 117.76 KB
+ESM ⚡️ Build success in 17ms
+CJS dist/index.js     58.40 KB
+CJS dist/index.js.map 118.05 KB
+CJS ⚡️ Build success in 17ms
+DTS Build start
+DTS ⚡️ Build success in 6164ms
+DTS dist/index.d.ts  7.96 KB
+DTS dist/index.d.mts 7.96 KB

package/.turbo/turbo-check-types.log

@@ -0,0 +1,4 @@
+
+> @copilotkit/runtime@0.0.0 check-types /Users/mme/Code/CopilotKit2/packages/runtime
+> tsc --noEmit
+

package/.turbo/turbo-lint.log

@@ -0,0 +1,56 @@
+
+> @copilotkit/runtime@0.0.0 lint /Users/mme/Code/CopilotKit2/packages/runtime
+> eslint . --max-warnings 0
+
+
+/Users/mme/Code/CopilotKit2/packages/runtime/src/__tests__/in-process-agent-runner-messages.test.ts
+  35:17  warning  'input' is defined but never used                                                                                                                              @typescript-eslint/no-unused-vars
+  46:5   warning  Include a description after the "@ts-expect-error" directive to explain why the @ts-expect-error is necessary. The description must be 3 characters or longer  @typescript-eslint/ban-ts-comment
+
+/Users/mme/Code/CopilotKit2/packages/runtime/src/runner/__tests__/event-compaction.test.ts
+   21:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   41:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   45:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   47:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   66:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   68:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   72:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   74:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   90:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  117:29  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  137:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  157:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  161:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  163:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  182:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  184:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  188:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  190:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  206:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  221:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  244:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  249:31  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+
+/Users/mme/Code/CopilotKit2/packages/runtime/src/runner/event-compaction.ts
+  129:19  warning  'messageId' is assigned a value but never used   @typescript-eslint/no-unused-vars
+  140:21  warning  'toolCallId' is assigned a value but never used  @typescript-eslint/no-unused-vars
+
+/Users/mme/Code/CopilotKit2/packages/runtime/src/runner/in-memory.ts
+    8:10  warning  'EMPTY' is defined but never used  @typescript-eslint/no-unused-vars
+   99:31  warning  'args' is defined but never used   @typescript-eslint/no-unused-vars
+  121:16  warning  'error' is defined but never used  @typescript-eslint/no-unused-vars
+
+/Users/mme/Code/CopilotKit2/packages/runtime/src/runner/sqlite.ts
+    8:10  warning  'EMPTY' is defined but never used         @typescript-eslint/no-unused-vars
+   60:15  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   68:41  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+   71:24  warning  A `require()` style import is forbidden   @typescript-eslint/no-require-imports
+   73:14  warning  'e' is defined but never used             @typescript-eslint/no-unused-vars
+  164:50  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
+  232:31  warning  'args' is defined but never used          @typescript-eslint/no-unused-vars
+  254:16  warning  'error' is defined but never used         @typescript-eslint/no-unused-vars
+
+✖ 37 problems (0 errors, 37 warnings)
+
+ESLint found too many warnings (maximum: 0).
+ ELIFECYCLE  Command failed with exit code 1.

package/.turbo/turbo-test$colon$coverage.log

@@ -0,0 +1,149 @@
+
+
+> @copilotkit/runtime@0.0.0 test:coverage /Users/mme/Code/CopilotKit2/packages/runtime
+> jest --coverage
+
+Determining test suites to run...
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+
+ RUNS  src/__tests__/endpoint.test.ts
+
+File            | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
+----------------|---------|----------|---------|---------|-------------------
+All files       |   43.47 |    52.17 |   15.38 |   43.47 |                   
+ src            |   46.42 |    57.14 |   22.22 |   46.42 |                   
+  endpoint.ts   |   38.63 |    36.36 |   14.28 |   38.63 | 10-40,85-131      
+  handler.ts    |     100 |      100 |     100 |     100 |                   
+  logger.ts     |     100 |       75 |     100 |     100 | 12-16             
+  runtime.ts    |      50 |      100 |       0 |      50 | 44-46             
+ src/handlers   |   30.76 |        0 |       0 |   30.76 |                   
+  get-agents.ts |    12.5 |        0 |       0 |    12.5 | 10-34             
+  get-info.ts   |   66.66 |      100 |       0 |   66.66 | 10                
+  handle-run.ts |      50 |      100 |       0 |      50 | 14                
+----------------|---------|----------|---------|---------|-------------------
+Test Suites: 1 passed, 1 total
+Tests:       20 passed, 20 total
+Snapshots:   0 total
+Time:        0.556 s, estimated 1 s
+Ran all test suites.

package/.turbo/turbo-test.log

@@ -0,0 +1,107 @@
+
+> @copilotkitnext/runtime@0.0.0 test /Users/mme/Code/CopilotKit2/packages/runtime
+> vitest run
+
+
+ RUN  v3.2.4 /Users/mme/Code/CopilotKit2/packages/runtime
+
+ ✓ src/__tests__/handle-transcribe.test.ts (12 tests) 36ms
+stderr | src/__tests__/handle-run.test.ts > handleRunAgent > should return 500 when runtime.agents throws an error
+Error running agent: Error: Database connection failed
+    at /Users/mme/Code/CopilotKit2/packages/runtime/src/__tests__/handle-run.test.ts:46:30
+    at file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:155:11
+    at file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:752:26
+    at file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1897:20
+    at new Promise (<anonymous>)
+    at runWithTimeout (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1863:10)
+    at runTest (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1574:12)
+    at processTicksAndRejections (node:internal/process/task_queues:95:5)
+    at runSuite (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1729:8)
+    at runSuite (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1729:8)
+Error stack: Error: Database connection failed
+    at /Users/mme/Code/CopilotKit2/packages/runtime/src/__tests__/handle-run.test.ts:46:30
+    at file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:155:11
+    at file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:752:26
+    at file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1897:20
+    at new Promise (<anonymous>)
+    at runWithTimeout (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1863:10)
+    at runTest (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1574:12)
+    at processTicksAndRejections (node:internal/process/task_queues:95:5)
+    at runSuite (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1729:8)
+    at runSuite (file:///Users/mme/Code/CopilotKit2/node_modules/.pnpm/@vitest+runner@3.2.4/node_modules/@vitest/runner/dist/chunk-hooks.js:1729:8)
+Error details: {
+  name: 'Error',
+  message: 'Database connection failed',
+  cause: undefined
+}
+
+ ✓ src/runner/__tests__/in-memory-runner.test.ts (7 tests) 8ms
+ ✓ src/__tests__/in-process-agent-runner-messages.test.ts (7 tests) 8ms
+ ✓ src/__tests__/handle-run.test.ts (2 tests) 16ms
+ ✓ src/__tests__/routing.test.ts (21 tests) 39ms
+ ✓ src/runner/__tests__/sqlite-runner.test.ts (19 tests) 201ms
+ ✓ src/__tests__/in-process-agent-runner.test.ts (18 tests) 749ms
+ ✓ src/runner/__tests__/event-compaction.test.ts (12 tests) 28ms
+ ✓ src/__tests__/get-runtime-info.test.ts (4 tests) 8ms
+stderr | src/__tests__/middleware.test.ts > CopilotEndpoint middleware > handles webhook middleware timeout
+{
+  err: Response {
+    status: 502,
+    statusText: '',
+    headers: Headers {},
+    body: null,
+    bodyUsed: false,
+    ok: false,
+    redirected: false,
+    type: 'default',
+    url: ''
+  },
+  url: 'https://example.com/info',
+  path: '/info'
+} Error running before request middleware
+
+stderr | src/__tests__/middleware.test.ts > CopilotEndpoint middleware > handles webhook middleware error responses
+{
+  err: Response {
+    status: 400,
+    statusText: '',
+    headers: Headers { 'content-type': 'text/plain;charset=UTF-8' },
+    body: ReadableStream { locked: false, state: 'readable', supportsBYOB: true },
+    bodyUsed: false,
+    ok: false,
+    redirected: false,
+    type: 'default',
+    url: ''
+  },
+  url: 'https://example.com/info',
+  path: '/info'
+} Error running before request middleware
+
+stderr | src/__tests__/middleware.test.ts > CopilotEndpoint middleware > handles webhook middleware server error
+{
+  err: Response {
+    status: 502,
+    statusText: '',
+    headers: Headers {},
+    body: null,
+    bodyUsed: false,
+    ok: false,
+    redirected: false,
+    type: 'default',
+    url: ''
+  },
+  url: 'https://example.com/info',
+  path: '/info'
+} Error running before request middleware
+
+ ✓ src/__tests__/middleware.test.ts (11 tests) 2378ms
+   ✓ CopilotEndpoint middleware > handles webhook middleware timeout  2003ms
+ ✓ src/runner/__tests__/enterprise-runner.test.ts (20 tests) 3206ms
+   ✓ EnterpriseAgentRunner > should prevent concurrent runs on same thread  630ms
+   ✓ EnterpriseAgentRunner > should track running state correctly  303ms
+
+ Test Files  11 passed (11)
+      Tests  133 passed (133)
+   Start at  10:38:14
+   Duration  4.92s (transform 1.12s, setup 0ms, collect 6.01s, tests 6.68s, environment 1ms, prepare 2.04s)
+

package/LICENSE

@@ -0,0 +1,11 @@
+Note: This license does not apply to the whole project. Individual packages may contain their own licenses.
+
+MIT License
+
+Copyright 2025 Tawkit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README-RUNNERS.md

@@ -0,0 +1,78 @@
+# Agent Runners
+
+CopilotKit Runtime provides two agent runners for different use cases:
+
+## InMemoryAgentRunner (Default)
+
+The default runner that stores all data in memory. Perfect for development and applications that don't need persistence.
+
+```typescript
+import { CopilotRuntime, InMemoryAgentRunner } from "@copilotkitnext/runtime";
+
+// Default - uses InMemoryAgentRunner automatically
+const runtime = new CopilotRuntime({
+  agents: myAgents,
+});
+
+// Or explicitly
+const runtime = new CopilotRuntime({
+  agents: myAgents,
+  runner: new InMemoryAgentRunner(),
+});
+```
+
+**Features:**
+
+- No external dependencies
+- Fast performance
+- Data is lost when process restarts
+- Perfect for development and stateless applications
+
+## SqliteAgentRunner
+
+Provides persistent storage using SQLite. Ideal for applications that need to preserve conversation history across restarts.
+
+```typescript
+import { CopilotRuntime, SqliteAgentRunner } from "@copilotkitnext/runtime";
+
+const runtime = new CopilotRuntime({
+  agents: myAgents,
+  runner: new SqliteAgentRunner("./data/copilot.db"),
+});
+
+// Or use in-memory SQLite (data persists during runtime only)
+const runtime = new CopilotRuntime({
+  agents: myAgents,
+  runner: new SqliteAgentRunner(":memory:"),
+});
+```
+
+**Features:**
+
+- Persistent storage across restarts
+- Maintains conversation history
+- Parent-child run relationships
+- Event compaction for historic runs
+
+**Requirements:**
+
+- Requires `better-sqlite3` to be installed:
+  ```bash
+  npm install better-sqlite3
+  ```
+
+## Choosing the Right Runner
+
+- **Use InMemoryAgentRunner when:**
+  - Building prototypes or demos
+  - Running in serverless environments
+  - You don't need conversation history
+  - You want zero external dependencies
+
+- **Use SqliteAgentRunner when:**
+  - You need persistent conversation history
+  - Building production applications
+  - You want to analyze historic conversations
+  - Running on a traditional server
+
+Both runners implement the same `AgentRunner` interface, so you can switch between them without changing your application code.