@inkeep/agents-run-api 0.0.0-dev-20250910232631

package/dist/utils/stream-helpers.d.ts

@@ -0,0 +1,186 @@
+import type { OperationEvent } from './agent-operations';
+export interface StreamHelper {
+    writeRole(role?: string): Promise<void>;
+    writeContent(content: string): Promise<void>;
+    streamData(data: any): Promise<void>;
+    streamText(text: string, delayMs?: number): Promise<void>;
+    writeError(errorMessage: string): Promise<void>;
+    complete(): Promise<void>;
+    writeData(type: string, data: any): Promise<void>;
+    writeOperation(operation: OperationEvent): Promise<void>;
+}
+export interface HonoSSEStream {
+    writeSSE(message: {
+        data: string;
+        event?: string;
+        id?: string;
+    }): Promise<void>;
+    sleep(ms: number): Promise<unknown>;
+}
+export interface ChatCompletionChunk {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: Array<{
+        index: number;
+        delta: {
+            role?: string;
+            content?: string;
+        };
+        finish_reason: string | null;
+    }>;
+}
+export declare class SSEStreamHelper implements StreamHelper {
+    private stream;
+    private requestId;
+    private timestamp;
+    private isTextStreaming;
+    private queuedOperations;
+    constructor(stream: HonoSSEStream, requestId: string, timestamp: number);
+    /**
+     * Write the initial role message
+     */
+    writeRole(role?: string): Promise<void>;
+    /**
+     * Write content chunk
+     */
+    writeContent(content: string): Promise<void>;
+    /**
+     * Stream text word by word with optional delay
+     */
+    streamText(text: string, delayMs?: number): Promise<void>;
+    streamData(data: any): Promise<void>;
+    /**
+     * Write error message
+     */
+    writeError(errorMessage: string): Promise<void>;
+    /**
+     * Write the final completion message
+     */
+    writeCompletion(finishReason?: string): Promise<void>;
+    /**
+     * Write the final [DONE] message
+     */
+    writeDone(): Promise<void>;
+    /**
+     * Complete the stream with finish reason and done message
+     */
+    complete(finishReason?: string): Promise<void>;
+    writeData(type: string, data: any): Promise<void>;
+    writeOperation(operation: OperationEvent): Promise<void>;
+    /**
+     * Flush all queued operations in order after text streaming completes
+     */
+    private flushQueuedOperations;
+}
+/**
+ * Factory function to create SSE stream helper
+ */
+export declare function createSSEStreamHelper(stream: HonoSSEStream, requestId: string, timestamp: number): SSEStreamHelper;
+export interface VercelUIWriter {
+    write(chunk: any): void;
+    merge(stream: any): void;
+    onError?: (error: Error) => void;
+}
+export declare class VercelDataStreamHelper implements StreamHelper {
+    private writer;
+    private textId;
+    private jsonBuffer;
+    private sentItems;
+    private completedItems;
+    private sessionId?;
+    private static readonly MAX_BUFFER_SIZE;
+    private isCompleted;
+    private isTextStreaming;
+    private queuedOperations;
+    private lastTextEndTimestamp;
+    private readonly TEXT_GAP_THRESHOLD;
+    private connectionDropTimer?;
+    private readonly MAX_LIFETIME_MS;
+    constructor(writer: VercelUIWriter);
+    setSessionId(sessionId: string): void;
+    writeRole(_?: string): Promise<void>;
+    writeContent(content: string): Promise<void>;
+    streamText(text: string, delayMs?: number): Promise<void>;
+    writeData(type: string, data: any): Promise<void>;
+    writeError(errorMessage: string): Promise<void>;
+    streamData(data: any): Promise<void>;
+    mergeStream(stream: any): Promise<void>;
+    writeCompletion(_finishReason?: string): Promise<void>;
+    writeDone(): Promise<void>;
+    /**
+     * Complete the stream and clean up all memory
+     * This is the primary cleanup point to prevent memory leaks between requests
+     */
+    complete(): Promise<void>;
+    /**
+     * Clean up all memory allocations
+     * Should be called when the stream helper is no longer needed
+     */
+    cleanup(): void;
+    /**
+     * JSON-aware buffer truncation that preserves complete JSON structures
+     */
+    private truncateJsonBufferSafely;
+    /**
+     * Reindex sent items after buffer truncation
+     */
+    private reindexSentItems;
+    /**
+     * Force cleanup on connection drop or timeout
+     */
+    private forceCleanup;
+    /**
+     * Check if the stream has been completed and cleaned up
+     */
+    isStreamCompleted(): boolean;
+    /**
+     * Get current memory usage stats (for debugging/monitoring)
+     */
+    getMemoryStats(): {
+        bufferSize: number;
+        sentItemsCount: number;
+        completedItemsCount: number;
+        isCompleted: boolean;
+    };
+    writeOperation(operation: OperationEvent): Promise<void>;
+    /**
+     * Flush all queued operations in order after text streaming completes
+     */
+    private flushQueuedOperations;
+}
+export declare function createVercelStreamHelper(writer: VercelUIWriter): VercelDataStreamHelper;
+/**
+ * MCP Stream Helper that captures content instead of streaming
+ * Used for MCP tool responses which require a single response message
+ */
+export declare class MCPStreamHelper implements StreamHelper {
+    private capturedText;
+    private capturedData;
+    private capturedOperations;
+    private hasError;
+    private errorMessage;
+    private sessionId?;
+    setSessionId(sessionId: string): void;
+    writeRole(_role?: string): Promise<void>;
+    writeContent(content: string): Promise<void>;
+    streamText(text: string, _delayMs?: number): Promise<void>;
+    streamData(data: any): Promise<void>;
+    writeData(_type: string, data: any): Promise<void>;
+    writeError(errorMessage: string): Promise<void>;
+    complete(): Promise<void>;
+    writeOperation(operation: OperationEvent): Promise<void>;
+    /**
+     * Get the captured response for MCP tool result
+     */
+    getCapturedResponse(): {
+        text: string;
+        data: any[];
+        operations: OperationEvent[];
+        hasError: boolean;
+        errorMessage: string;
+    };
+}
+export declare function createMCPStreamHelper(): MCPStreamHelper;
+//# sourceMappingURL=stream-helpers.d.ts.map

package/dist/utils/stream-helpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stream-helpers.d.ts","sourceRoot":"","sources":["../../src/utils/stream-helpers.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAGzD,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7C,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACrC,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1D,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,cAAc,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1D;AAGD,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,EAAE,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChF,KAAK,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,KAAK,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,EAAE;YACL,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,OAAO,CAAC,EAAE,MAAM,CAAC;SAClB,CAAC;QACF,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;KAC9B,CAAC,CAAC;CACJ;AAED,qBAAa,eAAgB,YAAW,YAAY;IAMhD,OAAO,CAAC,MAAM;IACd,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,SAAS;IANnB,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,gBAAgB,CAAwB;gBAGtC,MAAM,EAAE,aAAa,EACrB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM;IAG3B;;OAEG;IACG,SAAS,CAAC,IAAI,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBlD;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBlD;;OAEG;IACG,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBtD,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAI1C;;OAEG;IACG,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIrD;;OAEG;IACG,eAAe,CAAC,YAAY,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAiB3D;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAMhC;;OAEG;IACG,QAAQ,CAAC,YAAY,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ9C,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAmBjD,cAAc,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAqB9D;;OAEG;YACW,qBAAqB;CAYpC;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,aAAa,EACrB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,eAAe,CAEjB;AAGD,MAAM,WAAW,cAAc;IAC7B,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,IAAI,CAAC;IACxB,KAAK,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED,qBAAa,sBAAuB,YAAW,YAAY;IAuB7C,OAAO,CAAC,MAAM;IAtB1B,OAAO,CAAC,MAAM,CAAuB;IACrC,OAAO,CAAC,UAAU,CAAM;IACxB,OAAO,CAAC,SAAS,CAA6B;IAC9C,OAAO,CAAC,cAAc,CAAqB;IAC3C,OAAO,CAAC,SAAS,CAAC,CAAS;IAG3B,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAmB;IAC1D,OAAO,CAAC,WAAW,CAAS;IAG5B,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,gBAAgB,CAAwB;IAGhD,OAAO,CAAC,oBAAoB,CAAa;IACzC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAQ;IAG3C,OAAO,CAAC,mBAAmB,CAAC,CAAiB;IAC7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAW;gBAEvB,MAAM,EAAE,cAAc;IAO1C,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAK/B,SAAS,CAAC,CAAC,SAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAIzC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuD5C,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,SAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAmEtD,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BjD,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY/C,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpC,WAAW,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IASvC,eAAe,CAAC,aAAa,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAItD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAIhC;;;OAGG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAa/B;;;OAGG;IACI,OAAO,IAAI,IAAI;IAetB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA2DhC;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAMxB;;OAEG;IACH,OAAO,CAAC,YAAY;IAsBpB;;OAEG;IACI,iBAAiB,IAAI,OAAO;IAInC;;OAEG;IACI,cAAc;;;;;;IASf,cAAc,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAqC9D;;OAEG;YACW,qBAAqB;CAgBpC;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,cAAc,0BAE9D;AAED;;;GAGG;AACH,qBAAa,eAAgB,YAAW,YAAY;IAClD,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,kBAAkB,CAAwB;IAClD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,YAAY,CAAM;IAC1B,OAAO,CAAC,SAAS,CAAC,CAAS;IAE3B,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAI/B,SAAS,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI5C,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK1D,UAAU,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;IAIlD,UAAU,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/C,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAIzB,cAAc,CAAC,SAAS,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI9D;;OAEG;IACH,mBAAmB,IAAI;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,GAAG,EAAE,CAAC;QACZ,UAAU,EAAE,cAAc,EAAE,CAAC;QAC7B,QAAQ,EAAE,OAAO,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;KACtB;CASF;AAED,wBAAgB,qBAAqB,IAAI,eAAe,CAEvD"}