@ai-sdk/workflow 1.0.70 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @ai-sdk/workflow
 
+## 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,12 @@ 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.
  */
-declare function createModelCallToUIChunkTransform(): TransformStream<Experimental_LanguageModelStreamPart<ToolSet>, UIMessageChunk>;
+declare function createModelCallToUIChunkTransform(): TransformStream<ModelCallStreamPart<ToolSet>, UIMessageChunk>;
 
 interface SendMessagesOptions<UI_MESSAGE extends UIMessage> {
     trigger: 'submit-message' | 'regenerate-message';
@@ -1209,4 +1213,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",
@@ -2324,6 +2327,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 +2391,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);