@ai-sdk/workflow 1.0.70 → 2.0.1

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @ai-sdk/workflow
 
+## 2.0.1
+
+### Patch Changes
+
+- 4233a40: Resume transformed WorkflowAgent streams using UI message chunk indexes.
+- Updated dependencies [9a37469]
+  - ai@7.0.71
+
+## 2.0.0
+
+### Major Changes
+
+- 3238c04: Upgrade to Workflow 5 and drop Workflow 4 support. Applications must now install Workflow 5, which is currently available under the `beta` tag.
+
+### Patch Changes
+
+- d3cc3fe: Clear partial UI message parts when a WorkflowAgent model-call step is retried.
+- Updated dependencies [e6087c9]
+- Updated dependencies [9566914]
+- Updated dependencies [b181020]
+- Updated dependencies [7054073]
+- Updated dependencies [a828527]
+- Updated dependencies [d3cc3fe]
+  - @ai-sdk/provider-utils@5.0.28
+  - ai@7.0.70
+
 ## 1.0.70
 
 ### Patch Changes

package/README.md

@@ -5,7 +5,7 @@ WorkflowAgent is a class for building durable AI agents that can maintain state
 ## Installation
 
 ```bash
-npm install @ai-sdk/workflow ai
+npm install @ai-sdk/workflow ai workflow@beta
 ```
 
 ## Usage

package/dist/index.d.ts

@@ -1,7 +1,11 @@
 import { LanguageModelV4, LanguageModelV4CallOptions, SharedV4ProviderOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
 import { Context, HasRequiredKey, InferToolSetContext } from '@ai-sdk/provider-utils';
-import { ToolSet, LanguageModel, Instructions, ToolChoice, TelemetryOptions as TelemetryOptions$1, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, Experimental_SandboxSession, ModelMessage, StepResult, GenerateTextOnStepEndCallback, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
-export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
+import { ToolSet, Experimental_LanguageModelStreamPart, LanguageModel, Instructions, ToolChoice, TelemetryOptions as TelemetryOptions$1, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, Experimental_SandboxSession, ModelMessage, StepResult, GenerateTextOnStepEndCallback, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
+export { Output, ToolCallRepairFunction } from 'ai';
+
+type ModelCallStreamPart<TTools extends ToolSet = ToolSet> = Experimental_LanguageModelStreamPart<TTools> | {
+    type: 'reset-step';
+};
 
 /**
  * Shared types for AI SDK V4.
@@ -658,7 +662,7 @@ type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, TRuntimeContex
      * });
      * ```
      */
-    writable?: WritableStream<Experimental_LanguageModelStreamPart<ToolSet>>;
+    writable?: WritableStream<ModelCallStreamPart<ToolSet>>;
     /**
      * Condition for stopping the generation when there are tool results in the last step.
      * When the condition is an array, any of the conditions can be met to stop the generation.
@@ -995,12 +999,24 @@ declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet, TRuntimeContex
  * Convert a single ModelCallStreamPart to a UIMessageChunk.
  * Returns undefined for parts that don't map to UI chunks.
  */
-declare function toUIMessageChunk(part: Experimental_LanguageModelStreamPart<ToolSet>): UIMessageChunk | undefined;
+declare function toUIMessageChunk(part: ModelCallStreamPart<ToolSet>): UIMessageChunk | undefined;
 /**
  * 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.
  */
-declare function createModelCallToUIChunkTransform(): TransformStream<Experimental_LanguageModelStreamPart<ToolSet>, UIMessageChunk>;
+declare function createModelCallToUIChunkTransform({ uiStartIndex, }?: {
+    /**
+     * Number of transformed UIMessageChunks to omit from the output.
+     * Must be a non-negative safe integer.
+     */
+    uiStartIndex?: number;
+}): TransformStream<ModelCallStreamPart<ToolSet>, UIMessageChunk>;
 
 interface SendMessagesOptions<UI_MESSAGE extends UIMessage> {
     trigger: 'submit-message' | 'regenerate-message';
@@ -1014,7 +1030,8 @@ 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;
@@ -1065,9 +1082,10 @@ 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`.
      *
@@ -1209,4 +1227,4 @@ declare class WorkflowChatTransport<UI_MESSAGE extends UIMessage> implements Cha
  */
 declare function normalizeUIMessageStreamParts(source: AsyncIterable<UIMessageChunk>): AsyncGenerator<UIMessageChunk>;
 
-export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextTransform, type TelemetryOptions, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnEndCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepEndCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, normalizeUIMessageStreamParts, toUIMessageChunk };
+export { type CompatibleLanguageModel, type DownloadFunction, type GenerationSettings, type InferWorkflowAgentTools, type InferWorkflowAgentUIMessage, type ModelCallStreamPart, type OutputSpecification, type PrepareCallCallback, type PrepareCallOptions, type PrepareCallResult, type PrepareStepCallback, type PrepareStepInfo, type PrepareStepResult, type ProviderOptions, type ReconnectToStreamOptions, type SendMessagesOptions, type StreamTextTransform, type TelemetryOptions, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnEndCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepEndCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, normalizeUIMessageStreamParts, toUIMessageChunk };

package/dist/index.js

@@ -245,6 +245,7 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
   let hasTerminalError = false;
   const writer = writable == null ? void 0 : writable.getWriter();
   try {
+    await (writer == null ? void 0 : writer.write({ type: "reset-step" }));
     for await (const part of modelStream) {
       switch (part.type) {
         case "text-delta":
@@ -2119,6 +2120,8 @@ async function executeTool(toolCall, tools, messages, context, download, sandbox
 function toUIMessageChunk(part) {
   var _a;
   switch (part.type) {
+    case "reset-step":
+      return { type: "reset-step" };
     case "text-start":
       return {
         type: "text-start",
@@ -2262,20 +2265,31 @@ function toUIMessageChunk(part) {
     }
   }
 }
-function createModelCallToUIChunkTransform() {
+function createModelCallToUIChunkTransform({
+  uiStartIndex = 0
+} = {}) {
+  if (!Number.isSafeInteger(uiStartIndex) || uiStartIndex < 0) {
+    throw new RangeError("uiStartIndex must be a non-negative safe integer");
+  }
+  let uiChunkIndex = 0;
+  const enqueue = (controller, chunk) => {
+    if (uiChunkIndex++ >= uiStartIndex) {
+      controller.enqueue(chunk);
+    }
+  };
   return new TransformStream({
     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);
       }
     }
   });
@@ -2324,6 +2338,13 @@ async function* normalizeUIMessageStreamParts(source) {
   const reasoning = newPartFrameState();
   for await (const chunk of source) {
     switch (chunk.type) {
+      case "reset-step":
+        text.open.clear();
+        text.ended.clear();
+        reasoning.open.clear();
+        reasoning.ended.clear();
+        yield chunk;
+        break;
       case "finish-step":
         text.open.clear();
         text.ended.clear();
@@ -2381,6 +2402,10 @@ function createOrphanFilter() {
   }
   function shouldDrop(chunk) {
     switch (chunk.type) {
+      case "reset-step":
+        seenStartedIds.clear();
+        seenStartedToolCallIds.clear();
+        return false;
       case "text-start":
       case "reasoning-start":
         seenStartedIds.add(chunk.id);