@ai-sdk/workflow 2.0.0 → 2.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/workflow",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "type": "module",
   "description": "WorkflowAgent for building AI agents with AI SDK",
   "license": "Apache-2.0",
@@ -29,7 +29,7 @@
     "ajv": "^8.20.0",
     "@ai-sdk/provider": "4.0.7",
     "@ai-sdk/provider-utils": "5.0.28",
-    "ai": "7.0.70"
+    "ai": "7.0.73"
   },
   "devDependencies": {
     "@types/node": "22.19.19",

package/src/to-ui-message-chunk.ts

@@ -214,24 +214,50 @@ export function toUIMessageChunk(
 /**
  * Create a TransformStream that converts ModelCallStreamPart to UIMessageChunk.
  * Wraps toUIMessageChunk with start/start-step/finish-step lifecycle chunks.
+ *
+ * When resuming a stream, provide `uiStartIndex` and replay the source
+ * ModelCallStreamPart stream from index 0. The transform will omit the UI
+ * chunks that the client has already received. Raw model stream parts and UI
+ * message chunks do not have a one-to-one relationship, so a UI chunk index
+ * must not be used as the source stream's start index.
  */
-export function createModelCallToUIChunkTransform(): TransformStream<
-  ModelCallStreamPart<ToolSet>,
-  UIMessageChunk
-> {
+export function createModelCallToUIChunkTransform({
+  uiStartIndex = 0,
+}: {
+  /**
+   * Number of transformed UIMessageChunks to omit from the output.
+   * Must be a non-negative safe integer.
+   */
+  uiStartIndex?: number;
+} = {}): TransformStream<ModelCallStreamPart<ToolSet>, UIMessageChunk> {
+  if (!Number.isSafeInteger(uiStartIndex) || uiStartIndex < 0) {
+    throw new RangeError('uiStartIndex must be a non-negative safe integer');
+  }
+
+  let uiChunkIndex = 0;
+
+  const enqueue = (
+    controller: TransformStreamDefaultController<UIMessageChunk>,
+    chunk: UIMessageChunk,
+  ) => {
+    if (uiChunkIndex++ >= uiStartIndex) {
+      controller.enqueue(chunk);
+    }
+  };
+
   return new TransformStream<ModelCallStreamPart<ToolSet>, UIMessageChunk>({
     start: controller => {
-      controller.enqueue({ type: 'start' });
-      controller.enqueue({ type: 'start-step' });
+      enqueue(controller, { type: 'start' });
+      enqueue(controller, { type: 'start-step' });
     },
     flush: controller => {
-      controller.enqueue({ type: 'finish-step' });
-      controller.enqueue({ type: 'finish' });
+      enqueue(controller, { type: 'finish-step' });
+      enqueue(controller, { type: 'finish' });
     },
     transform: (part, controller) => {
       const uiChunk = toUIMessageChunk(part);
       if (uiChunk) {
-        controller.enqueue(uiChunk);
+        enqueue(controller, uiChunk);
       }
     },
   });

package/src/workflow-chat-transport.ts

@@ -113,7 +113,8 @@ export interface ReconnectToStreamOptions {
   abortSignal?: AbortSignal;
   /**
    * Override the `startIndex` for this reconnection.
-   * Negative values read from the end of the stream.
+   * Negative values read from the end when the server's durable stream and
+   * tail-index header use the same UIMessageChunk index space.
    * When omitted, falls back to the constructor's `initialStartIndex`.
    */
   startIndex?: number;
@@ -178,9 +179,10 @@ export interface WorkflowChatTransportOptions<UI_MESSAGE extends UIMessage> {
   /**
    * Default `startIndex` to use when reconnecting to a stream without a known
    * chunk position (i.e. the initial reconnection, not a retry).
-   * Negative values read from the end of the stream (e.g. `-10` fetches the
-   * last 10 chunks), which is useful for resuming a chat UI after a page
-   * refresh without replaying the full conversation.
+   * Negative values read from the end of a durable UIMessageChunk stream (e.g.
+   * `-10` fetches the last 10 chunks), which is useful for resuming a chat UI
+   * after a page refresh without replaying the full conversation. Raw
+   * ModelCallStreamPart streams do not support negative UI chunk indexes.
    *
    * Can be overridden per-call via `ReconnectToStreamOptions.startIndex`.
    *