@ai-sdk/workflow 1.0.0-beta.1 → 1.0.0-beta.10

package/CHANGELOG.md

@@ -1,5 +1,68 @@
 # @ai-sdk/workflow
 
+## 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
+
+- 0e462a7: Use `LanguageModel` type for model parameter, aligning with `ToolLoopAgent`. Remove async factory model form. Rename callback types to use `WorkflowAgentOn*` prefix.
+
+## 1.0.0-beta.2
+
+### Patch Changes
+
+- ai@7.0.0-beta.91
+
 ## 1.0.0-beta.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
-import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4Prompt, LanguageModelV4CallOptions, LanguageModelV4StreamPart } from '@ai-sdk/provider';
-import { ToolSet, 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, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, StreamTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
 
 /**
@@ -13,6 +13,12 @@ export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, To
  */
 type CompatibleLanguageModel = LanguageModelV4;
 
+/**
+ * Callback function to be called after each step completes.
+ * Alias for the AI SDK's StreamTextOnStepFinishCallback, using
+ * WorkflowAgent-consistent naming.
+ */
+type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet> = StreamTextOnStepFinishCallback<TTools, any>;
 /**
  * Infer the type of the tools of a workflow agent.
  */
@@ -181,7 +187,7 @@ interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
      * The current model configuration (string or function).
      * The function should return a LanguageModelV4 instance.
      */
-    model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model: LanguageModel;
     /**
      * The current step number (0-indexed).
      */
@@ -207,9 +213,8 @@ interface PrepareStepInfo<TTools extends ToolSet = ToolSet> {
 interface PrepareStepResult extends Partial<GenerationSettings> {
     /**
      * Override the model for this step.
-     * The function should return a LanguageModelV4 instance.
      */
-    model?: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model?: LanguageModel;
     /**
      * Override the system message for this step.
      */
@@ -243,7 +248,7 @@ type PrepareStepCallback<TTools extends ToolSet = ToolSet> = (info: PrepareStepI
  * Options passed to the prepareCall callback.
  */
 interface PrepareCallOptions<TTools extends ToolSet = ToolSet> extends Partial<GenerationSettings> {
-    model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model: LanguageModel;
     tools: TTools;
     instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
     toolChoice?: ToolChoice<TTools>;
@@ -266,13 +271,17 @@ 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.
      *
      * This should be a string compatible with the Vercel AI Gateway (e.g., 'anthropic/claude-opus'),
-     * or a step function that returns a LanguageModelV4 instance.
+     * or a LanguageModelV4 instance from a provider.
      */
-    model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    model: LanguageModel;
     /**
      * A set of tools available to the agent.
      * Tools can be implemented as workflow steps for automatic retries and persistence,
@@ -305,6 +314,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?: Array<keyof 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
@@ -316,11 +358,11 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
     /**
      * Callback function to be called after each step completes.
      */
-    onStepFinish?: StreamTextOnStepFinishCallback<ToolSet, any>;
+    onStepFinish?: WorkflowAgentOnStepFinishCallback<ToolSet>;
     /**
      * Callback that is called when the LLM response and all request tool executions are finished.
      */
-    onFinish?: StreamTextOnFinishCallback<ToolSet>;
+    onFinish?: WorkflowAgentOnFinishCallback<ToolSet>;
     /**
      * Callback called when the agent starts streaming, before any LLM calls.
      */
@@ -347,7 +389,7 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
 /**
  * Callback that is called when the LLM response and all request tool executions are finished.
  */
-type StreamTextOnFinishCallback<TTools extends ToolSet = ToolSet, OUTPUT = never> = (event: {
+type WorkflowAgentOnFinishCallback<TTools extends ToolSet = ToolSet, OUTPUT = never> = (event: {
     /**
      * Details for all steps.
      */
@@ -381,13 +423,13 @@ type StreamTextOnFinishCallback<TTools extends ToolSet = ToolSet, OUTPUT = never
 /**
  * Callback that is invoked when an error occurs during streaming.
  */
-type StreamTextOnErrorCallback = (event: {
+type WorkflowAgentOnErrorCallback = (event: {
     error: unknown;
 }) => PromiseLike<void> | void;
 /**
  * Callback that is set using the `onAbort` option.
  */
-type StreamTextOnAbortCallback<TTools extends ToolSet = ToolSet> = (event: {
+type WorkflowAgentOnAbortCallback<TTools extends ToolSet = ToolSet> = (event: {
     /**
      * Details for all previously finished steps.
      */
@@ -398,20 +440,22 @@ type StreamTextOnAbortCallback<TTools extends ToolSet = ToolSet> = (event: {
  */
 type WorkflowAgentOnStartCallback = (event: {
     /** The model being used */
-    readonly model: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    readonly model: LanguageModel;
     /** The messages being sent */
     readonly messages: ModelMessage[];
 }) => PromiseLike<void> | void;
 /**
  * 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: string | CompatibleLanguageModel | (() => Promise<CompatibleLanguageModel>);
+    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.
@@ -419,26 +463,69 @@ type WorkflowAgentOnStepStartCallback = (event: {
 type WorkflowAgentOnToolCallStartCallback = (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: {
     /** 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.
      */
@@ -546,21 +633,21 @@ interface WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT =
     /**
      * Callback function to be called after each step completes.
      */
-    onStepFinish?: StreamTextOnStepFinishCallback<TTools, any>;
+    onStepFinish?: WorkflowAgentOnStepFinishCallback<TTools>;
     /**
      * Callback that is invoked when an error occurs during streaming.
      * You can use it to log errors.
      */
-    onError?: StreamTextOnErrorCallback;
+    onError?: WorkflowAgentOnErrorCallback;
     /**
      * Callback that is called when the LLM response and all request tool executions
      * (for tools that have an `execute` function) are finished.
      */
-    onFinish?: StreamTextOnFinishCallback<TTools, OUTPUT>;
+    onFinish?: WorkflowAgentOnFinishCallback<TTools, OUTPUT>;
     /**
      * Callback that is called when the operation is aborted.
      */
-    onAbort?: StreamTextOnAbortCallback<TTools>;
+    onAbort?: WorkflowAgentOnAbortCallback<TTools>;
     /**
      * Callback called when the agent starts streaming, before any LLM calls.
      */
@@ -612,7 +699,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.
  */
@@ -712,6 +799,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.
@@ -722,6 +813,11 @@ 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?;
@@ -901,4 +997,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 StreamTextOnAbortCallback, type StreamTextOnErrorCallback, type StreamTextOnFinishCallback, type StreamTextTransform, type TelemetrySettings, WorkflowAgent, type WorkflowAgentOnStartCallback, 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 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 };