@copilotkitnext/runtime 0.0.3 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/index.js +1 -1
  2. package/dist/index.js.map +1 -1
  3. package/dist/index.mjs +1 -1
  4. package/dist/index.mjs.map +1 -1
  5. package/package.json +4 -4
  6. package/.turbo/turbo-build.log +0 -23
  7. package/.turbo/turbo-check-types.log +0 -4
  8. package/.turbo/turbo-lint.log +0 -56
  9. package/.turbo/turbo-test$colon$coverage.log +0 -149
  10. package/.turbo/turbo-test.log +0 -108
  11. package/src/__tests__/get-runtime-info.test.ts +0 -117
  12. package/src/__tests__/handle-run.test.ts +0 -69
  13. package/src/__tests__/handle-transcribe.test.ts +0 -289
  14. package/src/__tests__/in-process-agent-runner-messages.test.ts +0 -599
  15. package/src/__tests__/in-process-agent-runner.test.ts +0 -726
  16. package/src/__tests__/middleware.test.ts +0 -432
  17. package/src/__tests__/routing.test.ts +0 -257
  18. package/src/endpoint.ts +0 -150
  19. package/src/handler.ts +0 -3
  20. package/src/handlers/get-runtime-info.ts +0 -50
  21. package/src/handlers/handle-connect.ts +0 -144
  22. package/src/handlers/handle-run.ts +0 -156
  23. package/src/handlers/handle-transcribe.ts +0 -126
  24. package/src/index.ts +0 -8
  25. package/src/middleware.ts +0 -232
  26. package/src/runner/__tests__/enterprise-runner.test.ts +0 -992
  27. package/src/runner/__tests__/event-compaction.test.ts +0 -253
  28. package/src/runner/__tests__/in-memory-runner.test.ts +0 -483
  29. package/src/runner/__tests__/sqlite-runner.test.ts +0 -975
  30. package/src/runner/agent-runner.ts +0 -27
  31. package/src/runner/enterprise.ts +0 -653
  32. package/src/runner/event-compaction.ts +0 -250
  33. package/src/runner/in-memory.ts +0 -328
  34. package/src/runner/index.ts +0 -0
  35. package/src/runner/sqlite.ts +0 -481
  36. package/src/runtime.ts +0 -53
  37. package/src/transcription-service/transcription-service-openai.ts +0 -29
  38. package/src/transcription-service/transcription-service.ts +0 -11
  39. package/tsconfig.json +0 -13
  40. package/tsup.config.ts +0 -11
@@ -1,481 +0,0 @@
1
- import {
2
- AgentRunner,
3
- AgentRunnerConnectRequest,
4
- AgentRunnerIsRunningRequest,
5
- AgentRunnerRunRequest,
6
- type AgentRunnerStopRequest,
7
- } from "./agent-runner";
8
- import { Observable, ReplaySubject } from "rxjs";
9
- import {
10
- BaseEvent,
11
- RunAgentInput,
12
- Message,
13
- EventType,
14
- TextMessageStartEvent,
15
- TextMessageContentEvent,
16
- TextMessageEndEvent,
17
- ToolCallStartEvent,
18
- ToolCallArgsEvent,
19
- ToolCallEndEvent,
20
- ToolCallResultEvent,
21
- } from "@ag-ui/client";
22
- import { compactEvents } from "./event-compaction";
23
- import Database from "better-sqlite3";
24
-
25
- const SCHEMA_VERSION = 1;
26
-
27
- interface AgentRunRecord {
28
- id: number;
29
- thread_id: string;
30
- run_id: string;
31
- parent_run_id: string | null;
32
- events: BaseEvent[];
33
- input: RunAgentInput;
34
- created_at: number;
35
- version: number;
36
- }
37
-
38
- export interface SqliteAgentRunnerOptions {
39
- dbPath?: string;
40
- }
41
-
42
- // Active connections for streaming events
43
- // This is the only in-memory state we need - just for active streaming
44
- const ACTIVE_CONNECTIONS = new Map<string, ReplaySubject<BaseEvent>>();
45
-
46
- export class SqliteAgentRunner extends AgentRunner {
47
- private db: any;
48
-
49
- constructor(options: SqliteAgentRunnerOptions = {}) {
50
- super();
51
- const dbPath = options.dbPath ?? ":memory:";
52
-
53
- if (!Database) {
54
- throw new Error(
55
- 'better-sqlite3 is required for SqliteAgentRunner but was not found.\n' +
56
- 'Please install it in your project:\n' +
57
- ' npm install better-sqlite3\n' +
58
- ' or\n' +
59
- ' pnpm add better-sqlite3\n' +
60
- ' or\n' +
61
- ' yarn add better-sqlite3\n\n' +
62
- 'If you don\'t need persistence, use InMemoryAgentRunner instead.'
63
- );
64
- }
65
-
66
- this.db = new Database(dbPath);
67
- this.initializeSchema();
68
- }
69
-
70
- private convertMessageToEvents(message: Message): BaseEvent[] {
71
- const events: BaseEvent[] = [];
72
-
73
- if (
74
- (message.role === "assistant" ||
75
- message.role === "user" ||
76
- message.role === "developer" ||
77
- message.role === "system") &&
78
- message.content
79
- ) {
80
- const textStartEvent: TextMessageStartEvent = {
81
- type: EventType.TEXT_MESSAGE_START,
82
- messageId: message.id,
83
- role: message.role,
84
- };
85
- events.push(textStartEvent);
86
-
87
- const textContentEvent: TextMessageContentEvent = {
88
- type: EventType.TEXT_MESSAGE_CONTENT,
89
- messageId: message.id,
90
- delta: message.content,
91
- };
92
- events.push(textContentEvent);
93
-
94
- const textEndEvent: TextMessageEndEvent = {
95
- type: EventType.TEXT_MESSAGE_END,
96
- messageId: message.id,
97
- };
98
- events.push(textEndEvent);
99
- }
100
-
101
- if (message.role === "assistant" && message.toolCalls) {
102
- for (const toolCall of message.toolCalls) {
103
- const toolStartEvent: ToolCallStartEvent = {
104
- type: EventType.TOOL_CALL_START,
105
- toolCallId: toolCall.id,
106
- toolCallName: toolCall.function.name,
107
- parentMessageId: message.id,
108
- };
109
- events.push(toolStartEvent);
110
-
111
- const toolArgsEvent: ToolCallArgsEvent = {
112
- type: EventType.TOOL_CALL_ARGS,
113
- toolCallId: toolCall.id,
114
- delta: toolCall.function.arguments,
115
- };
116
- events.push(toolArgsEvent);
117
-
118
- const toolEndEvent: ToolCallEndEvent = {
119
- type: EventType.TOOL_CALL_END,
120
- toolCallId: toolCall.id,
121
- };
122
- events.push(toolEndEvent);
123
- }
124
- }
125
-
126
- if (message.role === "tool" && message.toolCallId) {
127
- const toolResultEvent: ToolCallResultEvent = {
128
- type: EventType.TOOL_CALL_RESULT,
129
- messageId: message.id,
130
- toolCallId: message.toolCallId,
131
- content: message.content,
132
- role: "tool",
133
- };
134
- events.push(toolResultEvent);
135
- }
136
-
137
- return events;
138
- }
139
-
140
- private initializeSchema(): void {
141
- // Create the agent_runs table
142
- this.db.exec(`
143
- CREATE TABLE IF NOT EXISTS agent_runs (
144
- id INTEGER PRIMARY KEY AUTOINCREMENT,
145
- thread_id TEXT NOT NULL,
146
- run_id TEXT NOT NULL UNIQUE,
147
- parent_run_id TEXT,
148
- events TEXT NOT NULL,
149
- input TEXT NOT NULL,
150
- created_at INTEGER NOT NULL,
151
- version INTEGER NOT NULL
152
- )
153
- `);
154
-
155
- // Create run_state table to track active runs
156
- this.db.exec(`
157
- CREATE TABLE IF NOT EXISTS run_state (
158
- thread_id TEXT PRIMARY KEY,
159
- is_running INTEGER DEFAULT 0,
160
- current_run_id TEXT,
161
- updated_at INTEGER NOT NULL
162
- )
163
- `);
164
-
165
- // Create indexes for efficient queries
166
- this.db.exec(`
167
- CREATE INDEX IF NOT EXISTS idx_thread_id ON agent_runs(thread_id);
168
- CREATE INDEX IF NOT EXISTS idx_parent_run_id ON agent_runs(parent_run_id);
169
- `);
170
-
171
- // Create schema version table
172
- this.db.exec(`
173
- CREATE TABLE IF NOT EXISTS schema_version (
174
- version INTEGER PRIMARY KEY,
175
- applied_at INTEGER NOT NULL
176
- )
177
- `);
178
-
179
- // Check and set schema version
180
- const currentVersion = this.db
181
- .prepare("SELECT version FROM schema_version ORDER BY version DESC LIMIT 1")
182
- .get() as { version: number } | undefined;
183
-
184
- if (!currentVersion || currentVersion.version < SCHEMA_VERSION) {
185
- this.db
186
- .prepare("INSERT OR REPLACE INTO schema_version (version, applied_at) VALUES (?, ?)")
187
- .run(SCHEMA_VERSION, Date.now());
188
- }
189
- }
190
-
191
- private storeRun(
192
- threadId: string,
193
- runId: string,
194
- events: BaseEvent[],
195
- input: RunAgentInput,
196
- parentRunId?: string | null
197
- ): void {
198
- // Compact ONLY the events from this run
199
- const compactedEvents = compactEvents(events);
200
-
201
- const stmt = this.db.prepare(`
202
- INSERT INTO agent_runs (thread_id, run_id, parent_run_id, events, input, created_at, version)
203
- VALUES (?, ?, ?, ?, ?, ?, ?)
204
- `);
205
-
206
- stmt.run(
207
- threadId,
208
- runId,
209
- parentRunId ?? null,
210
- JSON.stringify(compactedEvents), // Store only this run's compacted events
211
- JSON.stringify(input),
212
- Date.now(),
213
- SCHEMA_VERSION
214
- );
215
- }
216
-
217
- private getHistoricRuns(threadId: string): AgentRunRecord[] {
218
- const stmt = this.db.prepare(`
219
- WITH RECURSIVE run_chain AS (
220
- -- Base case: find the root runs (those without parent)
221
- SELECT * FROM agent_runs
222
- WHERE thread_id = ? AND parent_run_id IS NULL
223
-
224
- UNION ALL
225
-
226
- -- Recursive case: find children of current level
227
- SELECT ar.* FROM agent_runs ar
228
- INNER JOIN run_chain rc ON ar.parent_run_id = rc.run_id
229
- WHERE ar.thread_id = ?
230
- )
231
- SELECT * FROM run_chain
232
- ORDER BY created_at ASC
233
- `);
234
-
235
- const rows = stmt.all(threadId, threadId) as any[];
236
-
237
- return rows.map(row => ({
238
- id: row.id,
239
- thread_id: row.thread_id,
240
- run_id: row.run_id,
241
- parent_run_id: row.parent_run_id,
242
- events: JSON.parse(row.events),
243
- input: JSON.parse(row.input),
244
- created_at: row.created_at,
245
- version: row.version
246
- }));
247
- }
248
-
249
- private getLatestRunId(threadId: string): string | null {
250
- const stmt = this.db.prepare(`
251
- SELECT run_id FROM agent_runs
252
- WHERE thread_id = ?
253
- ORDER BY created_at DESC
254
- LIMIT 1
255
- `);
256
-
257
- const result = stmt.get(threadId) as { run_id: string } | undefined;
258
- return result?.run_id ?? null;
259
- }
260
-
261
- private setRunState(threadId: string, isRunning: boolean, runId?: string): void {
262
- const stmt = this.db.prepare(`
263
- INSERT OR REPLACE INTO run_state (thread_id, is_running, current_run_id, updated_at)
264
- VALUES (?, ?, ?, ?)
265
- `);
266
- stmt.run(threadId, isRunning ? 1 : 0, runId ?? null, Date.now());
267
- }
268
-
269
- private getRunState(threadId: string): { isRunning: boolean; currentRunId: string | null } {
270
- const stmt = this.db.prepare(`
271
- SELECT is_running, current_run_id FROM run_state WHERE thread_id = ?
272
- `);
273
- const result = stmt.get(threadId) as { is_running: number; current_run_id: string | null } | undefined;
274
-
275
- return {
276
- isRunning: result?.is_running === 1,
277
- currentRunId: result?.current_run_id ?? null
278
- };
279
- }
280
-
281
- run(request: AgentRunnerRunRequest): Observable<BaseEvent> {
282
- // Check if thread is already running in database
283
- const runState = this.getRunState(request.threadId);
284
- if (runState.isRunning) {
285
- throw new Error("Thread already running");
286
- }
287
-
288
- // Mark thread as running in database
289
- this.setRunState(request.threadId, true, request.input.runId);
290
-
291
- // Track seen message IDs and current run events in memory for this run
292
- const seenMessageIds = new Set<string>();
293
- const currentRunEvents: BaseEvent[] = [];
294
-
295
- // Get all previously seen message IDs from historic runs
296
- const historicRuns = this.getHistoricRuns(request.threadId);
297
- const historicMessageIds = new Set<string>();
298
- for (const run of historicRuns) {
299
- for (const event of run.events) {
300
- if ('messageId' in event && typeof event.messageId === 'string') {
301
- historicMessageIds.add(event.messageId);
302
- }
303
- }
304
- }
305
-
306
- // Get or create subject for this thread's connections
307
- const nextSubject = new ReplaySubject<BaseEvent>(Infinity);
308
- const prevSubject = ACTIVE_CONNECTIONS.get(request.threadId);
309
-
310
- // Update the active connection for this thread
311
- ACTIVE_CONNECTIONS.set(request.threadId, nextSubject);
312
-
313
- // Create a subject for run() return value
314
- const runSubject = new ReplaySubject<BaseEvent>(Infinity);
315
-
316
- // Helper function to run the agent and handle errors
317
- const runAgent = async () => {
318
- // Get parent run ID for chaining
319
- const parentRunId = this.getLatestRunId(request.threadId);
320
-
321
- try {
322
- await request.agent.runAgent(request.input, {
323
- onEvent: ({ event }) => {
324
- runSubject.next(event); // For run() return - only agent events
325
- nextSubject.next(event); // For connect() / store - all events
326
- currentRunEvents.push(event); // Accumulate for database storage
327
- },
328
- onNewMessage: ({ message }) => {
329
- // Called for each new message
330
- if (!seenMessageIds.has(message.id)) {
331
- seenMessageIds.add(message.id);
332
- }
333
- },
334
- onRunStartedEvent: () => {
335
- // Process input messages
336
- if (request.input.messages) {
337
- for (const message of request.input.messages) {
338
- if (!seenMessageIds.has(message.id)) {
339
- seenMessageIds.add(message.id);
340
- const events = this.convertMessageToEvents(message);
341
-
342
- // Check if this message is NEW (not in historic runs)
343
- const isNewMessage = !historicMessageIds.has(message.id);
344
-
345
- for (const event of events) {
346
- // Always emit to stream for context
347
- nextSubject.next(event);
348
-
349
- // Store if this is a NEW message for this run
350
- if (isNewMessage) {
351
- currentRunEvents.push(event);
352
- }
353
- }
354
- }
355
- }
356
- }
357
- },
358
- });
359
-
360
- // Store the run in database
361
- this.storeRun(
362
- request.threadId,
363
- request.input.runId,
364
- currentRunEvents,
365
- request.input,
366
- parentRunId
367
- );
368
-
369
- // Mark run as complete in database
370
- this.setRunState(request.threadId, false);
371
-
372
- // Complete the subjects
373
- runSubject.complete();
374
- nextSubject.complete();
375
- } catch {
376
- // Store the run even if it failed (partial events)
377
- if (currentRunEvents.length > 0) {
378
- this.storeRun(
379
- request.threadId,
380
- request.input.runId,
381
- currentRunEvents,
382
- request.input,
383
- parentRunId
384
- );
385
- }
386
-
387
- // Mark run as complete in database
388
- this.setRunState(request.threadId, false);
389
-
390
- // Don't emit error to the subject, just complete it
391
- // This allows subscribers to get events emitted before the error
392
- runSubject.complete();
393
- nextSubject.complete();
394
- }
395
- };
396
-
397
- // Bridge previous events if they exist
398
- if (prevSubject) {
399
- prevSubject.subscribe({
400
- next: (e) => nextSubject.next(e),
401
- error: (err) => nextSubject.error(err),
402
- complete: () => {
403
- // Don't complete nextSubject here - it needs to stay open for new events
404
- },
405
- });
406
- }
407
-
408
- // Start the agent execution immediately (not lazily)
409
- runAgent();
410
-
411
- // Return the run subject (only agent events, no injected messages)
412
- return runSubject.asObservable();
413
- }
414
-
415
- connect(request: AgentRunnerConnectRequest): Observable<BaseEvent> {
416
- const connectionSubject = new ReplaySubject<BaseEvent>(Infinity);
417
-
418
- // Load historic runs from database
419
- const historicRuns = this.getHistoricRuns(request.threadId);
420
-
421
- // Collect all historic events from database
422
- const allHistoricEvents: BaseEvent[] = [];
423
- for (const run of historicRuns) {
424
- allHistoricEvents.push(...run.events);
425
- }
426
-
427
- // Compact all events together before emitting
428
- const compactedEvents = compactEvents(allHistoricEvents);
429
-
430
- // Emit compacted events and track message IDs
431
- const emittedMessageIds = new Set<string>();
432
- for (const event of compactedEvents) {
433
- connectionSubject.next(event);
434
- if ('messageId' in event && typeof event.messageId === 'string') {
435
- emittedMessageIds.add(event.messageId);
436
- }
437
- }
438
-
439
- // Bridge active run to connection if exists
440
- const activeSubject = ACTIVE_CONNECTIONS.get(request.threadId);
441
- const runState = this.getRunState(request.threadId);
442
-
443
- if (activeSubject && runState.isRunning) {
444
- activeSubject.subscribe({
445
- next: (event) => {
446
- // Skip message events that we've already emitted from historic
447
- if ('messageId' in event && typeof event.messageId === 'string' && emittedMessageIds.has(event.messageId)) {
448
- return;
449
- }
450
- connectionSubject.next(event);
451
- },
452
- complete: () => connectionSubject.complete(),
453
- error: (err) => connectionSubject.error(err)
454
- });
455
- } else {
456
- // No active run, complete after historic events
457
- connectionSubject.complete();
458
- }
459
-
460
- return connectionSubject.asObservable();
461
- }
462
-
463
- isRunning(request: AgentRunnerIsRunningRequest): Promise<boolean> {
464
- const runState = this.getRunState(request.threadId);
465
- return Promise.resolve(runState.isRunning);
466
- }
467
-
468
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
469
- stop(_request: AgentRunnerStopRequest): Promise<boolean | undefined> {
470
- throw new Error("Method not implemented.");
471
- }
472
-
473
- /**
474
- * Close the database connection (for cleanup)
475
- */
476
- close(): void {
477
- if (this.db) {
478
- this.db.close();
479
- }
480
- }
481
- }
package/src/runtime.ts DELETED
@@ -1,53 +0,0 @@
1
- import { MaybePromise, NonEmptyRecord } from "@copilotkitnext/shared";
2
- import { AbstractAgent } from "@ag-ui/client";
3
- import pkg from "../package.json";
4
- import type {
5
- BeforeRequestMiddleware,
6
- AfterRequestMiddleware,
7
- } from "./middleware";
8
- import { TranscriptionService } from "./transcription-service/transcription-service";
9
- import { AgentRunner } from "./runner/agent-runner";
10
- import { InMemoryAgentRunner } from "./runner/in-memory";
11
-
12
- export const VERSION = pkg.version;
13
-
14
- /**
15
- * Options used to construct a `CopilotRuntime` instance.
16
- */
17
- export interface CopilotRuntimeOptions {
18
- /** Map of available agents (loaded lazily is fine). */
19
- agents: MaybePromise<NonEmptyRecord<Record<string, AbstractAgent>>>;
20
- /** The runner to use for running agents. */
21
- runner?: AgentRunner;
22
- /** Optional transcription service for audio processing. */
23
- transcriptionService?: TranscriptionService;
24
- /** Optional *before* middleware – callback function or webhook URL. */
25
- beforeRequestMiddleware?: BeforeRequestMiddleware;
26
- /** Optional *after* middleware – callback function or webhook URL. */
27
- afterRequestMiddleware?: AfterRequestMiddleware;
28
- }
29
-
30
- /**
31
- * Central runtime object passed to all request handlers.
32
- */
33
- export class CopilotRuntime {
34
- public agents: CopilotRuntimeOptions["agents"];
35
- public transcriptionService: CopilotRuntimeOptions["transcriptionService"];
36
- public beforeRequestMiddleware: CopilotRuntimeOptions["beforeRequestMiddleware"];
37
- public afterRequestMiddleware: CopilotRuntimeOptions["afterRequestMiddleware"];
38
- public runner: AgentRunner;
39
-
40
- constructor({
41
- agents,
42
- transcriptionService,
43
- beforeRequestMiddleware,
44
- afterRequestMiddleware,
45
- runner,
46
- }: CopilotRuntimeOptions) {
47
- this.agents = agents;
48
- this.transcriptionService = transcriptionService;
49
- this.beforeRequestMiddleware = beforeRequestMiddleware;
50
- this.afterRequestMiddleware = afterRequestMiddleware;
51
- this.runner = runner ?? new InMemoryAgentRunner();
52
- }
53
- }
@@ -1,29 +0,0 @@
1
- import {
2
- TranscribeFileOptions,
3
- TranscriptionService,
4
- } from "./transcription-service";
5
- import OpenAI from "openai";
6
-
7
- export interface TranscribeAdapterOpenAIConfig {
8
- openai: OpenAI;
9
- model?: string;
10
- }
11
-
12
- export class TranscriptionServiceOpenAI extends TranscriptionService {
13
- private openai: OpenAI;
14
- private model: string;
15
-
16
- constructor(config: TranscribeAdapterOpenAIConfig) {
17
- super();
18
- this.openai = config.openai ?? new OpenAI();
19
- this.model = config.model ?? "whisper-1";
20
- }
21
-
22
- async transcribeFile(options: TranscribeFileOptions): Promise<string> {
23
- const response = await this.openai.audio.transcriptions.create({
24
- file: options.audioFile,
25
- model: this.model,
26
- });
27
- return response.text;
28
- }
29
- }
@@ -1,11 +0,0 @@
1
- export interface TranscribeFileOptions {
2
- audioFile: File;
3
- /** MIME type of the audio file */
4
- mimeType?: string;
5
- /** Size of the audio file in bytes */
6
- size?: number;
7
- }
8
-
9
- export abstract class TranscriptionService {
10
- abstract transcribeFile(options: TranscribeFileOptions): Promise<string>;
11
- }
package/tsconfig.json DELETED
@@ -1,13 +0,0 @@
1
- {
2
- "extends": "@copilotkitnext/typescript-config/base.json",
3
- "compilerOptions": {
4
- "outDir": "dist",
5
- "rootDir": "src",
6
- "declaration": true,
7
- "declarationMap": true,
8
- "sourceMap": true,
9
- "types": ["vitest/globals"]
10
- },
11
- "include": ["src/**/*"],
12
- "exclude": ["dist", "node_modules", "src/**/__tests__/**", "src/**/*.test.ts"]
13
- }
package/tsup.config.ts DELETED
@@ -1,11 +0,0 @@
1
- import { defineConfig } from 'tsup';
2
-
3
- export default defineConfig({
4
- entry: ['src/index.ts'],
5
- format: ['cjs', 'esm'],
6
- dts: true,
7
- sourcemap: true,
8
- clean: true,
9
- target: 'es2022',
10
- outDir: 'dist',
11
- });