@ai-sdk/workflow 1.0.0-beta.3 → 1.0.0-beta.31

package/CHANGELOG.md

@@ -1,5 +1,266 @@
 # @ai-sdk/workflow
 
+## 1.0.0-beta.31
+
+### Patch Changes
+
+- ai@7.0.0-beta.116
+
+## 1.0.0-beta.30
+
+### Patch Changes
+
+- Updated dependencies [08d2129]
+- Updated dependencies [202f107]
+  - @ai-sdk/provider-utils@5.0.0-beta.30
+  - ai@7.0.0-beta.115
+
+## 1.0.0-beta.29
+
+### Patch Changes
+
+- 258c093: chore: ensure consistent import handling and avoid import duplicates or cycles
+- Updated dependencies [43a6750]
+- Updated dependencies [81caa5d]
+- Updated dependencies [1f7db50]
+- Updated dependencies [9bd6512]
+- Updated dependencies [258c093]
+- Updated dependencies [b6783da]
+- Updated dependencies [6147cdf]
+  - ai@7.0.0-beta.114
+  - @ai-sdk/provider-utils@5.0.0-beta.29
+  - @ai-sdk/provider@4.0.0-beta.14
+
+## 1.0.0-beta.28
+
+### Patch Changes
+
+- 9f0e36c: trigger release for all packages after provenance setup
+- Updated dependencies [9f0e36c]
+  - ai@7.0.0-beta.113
+  - @ai-sdk/provider@4.0.0-beta.13
+  - @ai-sdk/provider-utils@5.0.0-beta.28
+
+## 1.0.0-beta.27
+
+### Patch Changes
+
+- 29d8cf4: feat(ai): rename the core-event types
+- a0ca584: fix (workflow): preserve invalid tool calls as errors instead of emitting synthetic success results
+- Updated dependencies [785fe16]
+- Updated dependencies [5f3749c]
+- Updated dependencies [0a51f7d]
+- Updated dependencies [71d3022]
+- Updated dependencies [67df0a0]
+- Updated dependencies [4181cfe]
+- Updated dependencies [51ce232]
+- Updated dependencies [cf93359]
+- Updated dependencies [befb78c]
+- Updated dependencies [29d8cf4]
+- Updated dependencies [0458559]
+- Updated dependencies [58a2ad7]
+- Updated dependencies [5852c0a]
+- Updated dependencies [37d69b2]
+- Updated dependencies [1043274]
+- Updated dependencies [7f59f04]
+- Updated dependencies [7677c1e]
+- Updated dependencies [116c89f]
+- Updated dependencies [f58f9bc]
+- Updated dependencies [e1bfb9c]
+- Updated dependencies [e87d71b]
+- Updated dependencies [9d486aa]
+- Updated dependencies [9b0bc8a]
+- Updated dependencies [fc92055]
+- Updated dependencies [4e095b0]
+  - @ai-sdk/provider-utils@5.0.0-beta.27
+  - ai@7.0.0-beta.112
+
+## 1.0.0-beta.26
+
+### Major Changes
+
+- 1949571: feat(ai): make experimental_telemetry stable
+
+### Patch Changes
+
+- f32c750: refactoring(ai): simplify mergeAbortSignals
+- Updated dependencies [f319fde]
+- Updated dependencies [1949571]
+- Updated dependencies [511902c]
+- Updated dependencies [6542d93]
+- Updated dependencies [2e98477]
+- Updated dependencies [876fd3e]
+- Updated dependencies [f32c750]
+  - ai@7.0.0-beta.111
+  - @ai-sdk/provider-utils@5.0.0-beta.26
+
+## 1.0.0-beta.25
+
+### Patch Changes
+
+- Updated dependencies [72cb801]
+  - ai@7.0.0-beta.110
+
+## 1.0.0-beta.24
+
+### Patch Changes
+
+- eea8d98: refactoring: rename tool execution events
+- Updated dependencies [ec98264]
+- Updated dependencies [eea8d98]
+- Updated dependencies [75ef93e]
+  - ai@7.0.0-beta.109
+  - @ai-sdk/provider-utils@5.0.0-beta.25
+
+## 1.0.0-beta.23
+
+### Patch Changes
+
+- Updated dependencies [f807e45]
+  - @ai-sdk/provider-utils@5.0.0-beta.24
+  - ai@7.0.0-beta.108
+
+## 1.0.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [350ea38]
+  - @ai-sdk/provider-utils@5.0.0-beta.23
+  - ai@7.0.0-beta.107
+
+## 1.0.0-beta.21
+
+### Patch Changes
+
+- fbea042: refactor: replace duplicate `filterTools`/`filterToolSet` with shared `experimental_filterActiveTools` from `ai`
+
+## 1.0.0-beta.20
+
+### Patch Changes
+
+- ai@7.0.0-beta.106
+
+## 1.0.0-beta.19
+
+### Patch Changes
+
+- Updated dependencies [33d099c]
+  - ai@7.0.0-beta.105
+
+## 1.0.0-beta.18
+
+### Patch Changes
+
+- eba685c: Remove `maxSteps` option from `WorkflowAgent`. Use `stopWhen` with stop conditions like `isStepCount()` instead.
+- Updated dependencies [2a74d43]
+  - ai@7.0.0-beta.104
+
+## 1.0.0-beta.17
+
+### Patch Changes
+
+- 382d53b: refactoring: rename context to runtimeContext
+- c3d4019: chore(ai): rename 'TelemetrySettings' to 'TelemetryOptions'
+- 083947b: feat(ai): separate toolsContext from context
+- Updated dependencies [382d53b]
+- Updated dependencies [7bf7d7f]
+- Updated dependencies [c3d4019]
+- Updated dependencies [083947b]
+  - ai@7.0.0-beta.103
+  - @ai-sdk/provider-utils@5.0.0-beta.22
+
+## 1.0.0-beta.16
+
+### Patch Changes
+
+- ai@7.0.0-beta.102
+
+## 1.0.0-beta.15
+
+### Patch Changes
+
+- Updated dependencies [4873966]
+  - ai@7.0.0-beta.101
+
+## 1.0.0-beta.14
+
+### Patch Changes
+
+- Updated dependencies [add1126]
+  - @ai-sdk/provider-utils@5.0.0-beta.21
+  - ai@7.0.0-beta.100
+
+## 1.0.0-beta.13
+
+### Patch Changes
+
+- Updated dependencies [2a9c144]
+  - ai@7.0.0-beta.99
+
+## 1.0.0-beta.12
+
+### Patch Changes
+
+- ai@7.0.0-beta.98
+
+## 1.0.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [208d045]
+  - ai@7.0.0-beta.97
+
+## 1.0.0-beta.10
+
+### Patch Changes
+
+- ai@7.0.0-beta.96
+
+## 1.0.0-beta.9
+
+### Patch Changes
+
+- Updated dependencies [c4f4b5f]
+  - ai@7.0.0-beta.95
+
+## 1.0.0-beta.8
+
+### Patch Changes
+
+- 0455f24: Enrich WorkflowAgent callback event shapes to align with ToolLoopAgent:
+  - Add `stepNumber` to `onToolCallStart` and `onToolCallFinish`
+  - Add `steps` (previous step results) to `onStepStart`
+  - Adopt discriminated union pattern (`success: true/false`) for `onToolCallFinish`
+  - Add `durationMs` to `onToolCallFinish`
+
+## 1.0.0-beta.7
+
+### Patch Changes
+
+- Updated dependencies [1582efa]
+  - ai@7.0.0-beta.94
+
+## 1.0.0-beta.6
+
+### Patch Changes
+
+- Updated dependencies [bc47739]
+  - ai@7.0.0-beta.93
+
+## 1.0.0-beta.5
+
+### Patch Changes
+
+- bf6c17b: Add `id` property to WorkflowAgent for telemetry identification, matching ToolLoopAgent's API surface.
+- 3ca592a: Add `prompt` as an alternative to `messages` in `WorkflowAgent.stream()`, matching the `AgentCallParameters` pattern from ToolLoopAgent.
+- eb49d29: Add constructor-level defaults for `stopWhen`, `activeTools`, `output`, `experimental_repairToolCall`, and `experimental_download` to WorkflowAgent, matching ToolLoopAgent's pattern. Stream-level values override constructor defaults.
+
+## 1.0.0-beta.4
+
+### Patch Changes
+
+- ai@7.0.0-beta.92
+
 ## 1.0.0-beta.3
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4Prompt, LanguageModelV4CallOptions, LanguageModelV4StreamPart } from '@ai-sdk/provider';
-import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StepResult, StreamTextOnStepFinishCallback, ModelMessage, FinishReason, LanguageModelUsage, Experimental_LanguageModelStreamPart, StopCondition, LanguageModelResponseMetadata, ToolCallRepairFunction, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
+import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4CallOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
+import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, GenerateTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
 
 /**
@@ -15,10 +15,10 @@ type CompatibleLanguageModel = LanguageModelV4;
 
 /**
  * Callback function to be called after each step completes.
- * Alias for the AI SDK's StreamTextOnStepFinishCallback, using
+ * Alias for the AI SDK's GenerateTextOnStepFinishCallback, using
  * WorkflowAgent-consistent naming.
  */
-type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet> = StreamTextOnStepFinishCallback<TTools, any>;
+type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet> = GenerateTextOnStepFinishCallback<TTools, any>;
 /**
  * Infer the type of the tools of a workflow agent.
  */
@@ -55,7 +55,7 @@ type ProviderOptions = SharedV4ProviderOptions;
 /**
  * Telemetry settings for observability.
  */
-interface TelemetrySettings {
+interface TelemetryOptions {
     /**
      * Enable or disable telemetry. Defaults to true.
      */
@@ -252,7 +252,11 @@ interface PrepareCallOptions<TTools extends ToolSet = ToolSet> extends Partial<G
     tools: TTools;
     instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
     toolChoice?: ToolChoice<TTools>;
-    experimental_telemetry?: TelemetrySettings;
+    telemetry?: TelemetryOptions;
+    /**
+     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
+     */
+    experimental_telemetry?: TelemetryOptions;
     experimental_context?: unknown;
     messages: ModelMessage[];
 }
@@ -271,6 +275,10 @@ type PrepareCallCallback<TTools extends ToolSet = ToolSet> = (options: PrepareCa
  * Configuration options for creating a {@link WorkflowAgent} instance.
  */
 interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends GenerationSettings {
+    /**
+     * The id of the agent.
+     */
+    id?: string;
     /**
      * The model provider to use for the agent.
      *
@@ -299,9 +307,15 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
      */
     toolChoice?: ToolChoice<TTools>;
     /**
-     * Optional telemetry configuration (experimental).
+     * Optional telemetry configuration.
+     */
+    telemetry?: TelemetryOptions;
+    /**
+     * Optional telemetry configuration.
+     *
+     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
      */
-    experimental_telemetry?: TelemetrySettings;
+    experimental_telemetry?: TelemetryOptions;
     /**
      * Default context that is passed into tool execution for every stream call on this agent.
      *
@@ -310,6 +324,39 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
      * @default undefined
      */
     experimental_context?: unknown;
+    /**
+     * Default stop condition for the agent loop. When the condition is an array,
+     * any of the conditions can be met to stop the generation.
+     *
+     * Per-stream `stopWhen` values passed to `stream()` override this default.
+     */
+    stopWhen?: StopCondition<NoInfer<ToolSet>, any> | Array<StopCondition<NoInfer<ToolSet>, any>>;
+    /**
+     * Default set of active tools that limits which tools the model can call,
+     * without changing the tool call and result types in the result.
+     *
+     * Per-stream `activeTools` values passed to `stream()` override this default.
+     */
+    activeTools?: ActiveTools<NoInfer<TTools>>;
+    /**
+     * Default output specification for structured outputs.
+     * Use `Output.object({ schema })` for structured output or `Output.text()` for text output.
+     *
+     * Per-stream `output` values passed to `stream()` override this default.
+     */
+    output?: OutputSpecification<any, any>;
+    /**
+     * Default function that attempts to repair a tool call that failed to parse.
+     *
+     * Per-stream `experimental_repairToolCall` values passed to `stream()` override this default.
+     */
+    experimental_repairToolCall?: ToolCallRepairFunction<TTools>;
+    /**
+     * Default custom download function to use for URLs.
+     *
+     * Per-stream `experimental_download` values passed to `stream()` override this default.
+     */
+    experimental_download?: DownloadFunction;
     /**
      * Default callback function called before each step in the agent loop.
      * Use this to modify settings, manage context, or inject messages dynamically
@@ -337,11 +384,11 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
     /**
      * Callback called before a tool's execute function runs.
      */
-    experimental_onToolCallStart?: WorkflowAgentOnToolCallStartCallback;
+    experimental_onToolExecutionStart?: WorkflowAgentOnToolExecutionStartCallback;
     /**
      * Callback called after a tool execution completes.
      */
-    experimental_onToolCallFinish?: WorkflowAgentOnToolCallFinishCallback;
+    experimental_onToolExecutionEnd?: WorkflowAgentOnToolExecutionEndCallback;
     /**
      * Prepare the parameters for the stream call.
      * Called once before the agent loop starts. Use this to transform
@@ -410,40 +457,85 @@ type WorkflowAgentOnStartCallback = (event: {
 /**
  * Callback that is called before each step (LLM call) begins.
  */
-type WorkflowAgentOnStepStartCallback = (event: {
+type WorkflowAgentOnStepStartCallback<TTools extends ToolSet = ToolSet> = (event: {
     /** The current step number (0-based) */
     readonly stepNumber: number;
     /** The model being used for this step */
     readonly model: LanguageModel;
     /** The messages being sent for this step */
     readonly messages: ModelMessage[];
+    /** Results from all previously finished steps */
+    readonly steps: ReadonlyArray<StepResult<TTools, any>>;
 }) => PromiseLike<void> | void;
 /**
  * Callback that is called before a tool's execute function runs.
  */
-type WorkflowAgentOnToolCallStartCallback = (event: {
+type WorkflowAgentOnToolExecutionStartCallback = (event: {
     /** The tool call being executed */
     readonly toolCall: ToolCall;
+    /** The current step number (0-based) */
+    readonly stepNumber: number;
 }) => PromiseLike<void> | void;
 /**
  * Callback that is called after a tool execution completes.
+ * Uses a discriminated union pattern: check `success` to determine
+ * whether `output` or `error` is available.
  */
-type WorkflowAgentOnToolCallFinishCallback = (event: {
+type WorkflowAgentOnToolExecutionEndCallback = (event: {
     /** The tool call that was executed */
     readonly toolCall: ToolCall;
-    /** The tool result (undefined if execution failed) */
-    readonly result?: unknown;
-    /** The error if execution failed */
-    readonly error?: unknown;
+    /** The current step number (0-based) */
+    readonly stepNumber: number;
+    /** Execution time in milliseconds */
+    readonly durationMs: number;
+    /** Whether the tool call succeeded */
+    readonly success: true;
+    /** The tool result */
+    readonly output: unknown;
+    readonly error?: never;
+} | {
+    /** The tool call that was executed */
+    readonly toolCall: ToolCall;
+    /** The current step number (0-based) */
+    readonly stepNumber: number;
+    /** Execution time in milliseconds */
+    readonly durationMs: number;
+    /** Whether the tool call succeeded */
+    readonly success: false;
+    /** The error that occurred */
+    readonly error: unknown;
+    readonly output?: never;
 }) => PromiseLike<void> | void;
 /**
  * Options for the {@link WorkflowAgent.stream} method.
  */
-interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never> extends Partial<GenerationSettings> {
+type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never> = Partial<GenerationSettings> & ({
+    /**
+     * A prompt. It can be either a text prompt or a list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    prompt: string | Array<ModelMessage>;
+    /**
+     * A list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    messages?: never;
+} | {
     /**
      * The conversation messages to process. Should follow the AI SDK's ModelMessage format.
+     *
+     * You can either use `prompt` or `messages` but not both.
      */
-    messages: ModelMessage[];
+    messages: Array<ModelMessage>;
+    /**
+     * A prompt. It can be either a text prompt or a list of messages.
+     *
+     * You can either use `prompt` or `messages` but not both.
+     */
+    prompt?: never;
+}) & {
     /**
      * Optional system prompt override. If provided, overrides the system prompt from the constructor.
      */
@@ -476,12 +568,6 @@ interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT =
      * When the condition is an array, any of the conditions can be met to stop the generation.
      */
     stopWhen?: StopCondition<NoInfer<ToolSet>, any> | Array<StopCondition<NoInfer<ToolSet>, any>>;
-    /**
-     * Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
-     * A maximum number can be set to prevent infinite loops in the case of misconfigured tools.
-     * By default, it's unlimited (the agent loops until completion).
-     */
-    maxSteps?: number;
     /**
      * The tool choice strategy. Default: 'auto'.
      * Overrides the toolChoice from the constructor if provided.
@@ -491,11 +577,17 @@ interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT =
      * Limits the tools that are available for the model to call without
      * changing the tool call and result types in the result.
      */
-    activeTools?: Array<keyof NoInfer<TTools>>;
+    activeTools?: ActiveTools<NoInfer<TTools>>;
     /**
-     * Optional telemetry configuration (experimental).
+     * Optional telemetry configuration.
      */
-    experimental_telemetry?: TelemetrySettings;
+    telemetry?: TelemetryOptions;
+    /**
+     * Optional telemetry configuration.
+     *
+     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
+     */
+    experimental_telemetry?: TelemetryOptions;
     /**
      * Context that is passed into tool execution.
      * Experimental (can break in patch releases).
@@ -577,11 +669,11 @@ interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT =
     /**
      * Callback called before a tool's execute function runs.
      */
-    experimental_onToolCallStart?: WorkflowAgentOnToolCallStartCallback;
+    experimental_onToolExecutionStart?: WorkflowAgentOnToolExecutionStartCallback;
     /**
      * Callback called after a tool execution completes.
      */
-    experimental_onToolCallFinish?: WorkflowAgentOnToolCallFinishCallback;
+    experimental_onToolExecutionEnd?: WorkflowAgentOnToolExecutionEndCallback;
     /**
      * Callback function called before each step in the agent loop.
      * Use this to modify settings, manage context, or inject messages dynamically.
@@ -617,7 +709,7 @@ interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT =
      * @default false
      */
     preventClose?: boolean;
-}
+};
 /**
  * A tool call made by the model. Matches the AI SDK's tool call shape.
  */
@@ -717,6 +809,10 @@ interface WorkflowAgentStreamResult<TTools extends ToolSet = ToolSet, OUTPUT = n
  * ```
  */
 declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet> {
+    /**
+     * The id of the agent.
+     */
+    readonly id: string | undefined;
     private model;
     /**
      * The tool set configured for this agent.
@@ -727,13 +823,18 @@ declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet> {
     private toolChoice?;
     private telemetry?;
     private experimentalContext;
+    private stopWhen?;
+    private activeTools?;
+    private output?;
+    private experimentalRepairToolCall?;
+    private experimentalDownload?;
     private prepareStep?;
     private constructorOnStepFinish?;
     private constructorOnFinish?;
     private constructorOnStart?;
     private constructorOnStepStart?;
-    private constructorOnToolCallStart?;
-    private constructorOnToolCallFinish?;
+    private constructorOnToolExecutionStart?;
+    private constructorOnToolExecutionEnd?;
     private prepareCall?;
     constructor(options: WorkflowAgentOptions<TBaseTools>);
     generate(): void;
@@ -906,4 +1007,4 @@ declare class WorkflowChatTransport<UI_MESSAGE extends UIMessage> implements Cha
     private onFinish;
 }
 
-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 TelemetrySettings, WorkflowAgent, type WorkflowAgentOnAbortCallback, type WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolCallFinishCallback, type WorkflowAgentOnToolCallStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, toUIMessageChunk };
+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 WorkflowAgentOnErrorCallback, type WorkflowAgentOnFinishCallback, type WorkflowAgentOnStartCallback, type WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, toUIMessageChunk };