ai-resumable-stream 1.2.1 → 1.3.0

package/README.md

@@ -309,6 +309,7 @@ await subscriber.quit();
 async function createResumableUIMessageStream(options: CreateResumableUIMessageStream): Promise<{
   startStream: (
     stream: ReadableStream<UIMessageChunk>,
+    options?: { onFlush?: () => void | Promise<void> },
   ) => Promise<AsyncIterableStream<UIMessageChunk>>;
   resumeStream: () => Promise<AsyncIterableStream<UIMessageChunk> | null>;
   stopStream: () => Promise<void>;
@@ -330,11 +331,14 @@ type CreateResumableUIMessageStream = {
 ```typescript
 async function startStream(
   stream: ReadableStream<UIMessageChunk>,
+  options?: { onFlush?: () => void | Promise<void> },
 ): Promise<AsyncIterableStream<UIMessageChunk>>;
 ```
 
 Starts a new resumable stream. A single drain loop reads from the source and sends chunks to both the client and Redis simultaneously. If the client disconnects, chunks continue flowing to Redis for resumability.
 
+The optional `onFlush` callback is invoked after the stream finishes draining to Redis and cleanup is complete, regardless of how the stream ended (complete, error, or abort). Use it for cleanup tasks like removing the active stream ID from the database. Errors thrown by `onFlush` are silently caught.
+
 #### `resumeStream`
 
 ```typescript

package/dist/index.d.mts

@@ -40,7 +40,9 @@ type CreateResumableUIMessageStream = {
  * eagerly and enqueues directly to the output stream.
  */
 declare function createResumableUIMessageStream(options: CreateResumableUIMessageStream): Promise<{
-  startStream: (stream: ReadableStream<UIMessageChunk>) => Promise<AsyncIterableStream<UIMessageChunk>>;
+  startStream: (stream: ReadableStream<UIMessageChunk>, options?: {
+    onFlush?: () => void | Promise<void>;
+  }) => Promise<AsyncIterableStream<UIMessageChunk>>;
   resumeStream: () => Promise<AsyncIterableStream<UIMessageChunk> | null>;
   stopStream: () => Promise<void>;
 }>;

package/dist/index.mjs

@@ -6,7 +6,7 @@ import { createResumableStreamContext } from "resumable-stream";
 /**
 * Converts an SSE stream to a UI message stream.
 */
-function convertSSEToUIMessageStream(stream, onComplete) {
+function convertSSEToUIMessageStream(stream, onFlush) {
 	return parseJsonEventStream({
 		stream: stream.pipeThrough(new TextEncoderStream()),
 		schema: uiMessageChunkSchema
@@ -15,7 +15,7 @@ function convertSSEToUIMessageStream(stream, onComplete) {
 			if (result.success) controller.enqueue(result.value);
 		},
 		flush() {
-			onComplete?.();
+			onFlush?.();
 		}
 	}));
 }
@@ -69,7 +69,8 @@ async function createResumableUIMessageStream(options) {
 	* 3. Sends SSE to Redis stream → resumable-stream → Redis
 	* 4. Propagates errors to both streams
 	*/
-	async function startStream(stream) {
+	async function startStream(stream, options) {
+		const { onFlush } = options ?? {};
 		/**
 		* Track client disconnect to avoid unbounded memory growth
 		*/
@@ -139,6 +140,9 @@ async function createResumableUIMessageStream(options) {
 				try {
 					await unsubscribe();
 				} catch {}
+				try {
+					await onFlush?.();
+				} catch {}
 			}
 		})();
 		return createAsyncIterableStream(clientStream);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai-resumable-stream",
-  "version": "1.2.1",
+  "version": "1.3.0",
   "description": "AI SDK: resume and stop UI message streams",
   "keywords": [
     "ai",