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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/workflow",
-  "version": "1.0.0-beta.3",
+  "version": "1.0.0-beta.31",
   "description": "WorkflowAgent for building AI agents with AI SDK",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -27,9 +27,9 @@
   },
   "dependencies": {
     "ajv": "^8.18.0",
-    "@ai-sdk/provider": "4.0.0-beta.12",
-    "@ai-sdk/provider-utils": "5.0.0-beta.20",
-    "ai": "7.0.0-beta.91"
+    "@ai-sdk/provider": "4.0.0-beta.14",
+    "ai": "7.0.0-beta.116",
+    "@ai-sdk/provider-utils": "5.0.0-beta.30"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
@@ -47,12 +47,14 @@
     "node": ">=18"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "homepage": "https://ai-sdk.dev/docs",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/vercel/ai.git"
+    "url": "https://github.com/vercel/ai",
+    "directory": "packages/workflow"
   },
   "bugs": {
     "url": "https://github.com/vercel/ai/issues"

package/src/do-stream-step.ts

@@ -3,8 +3,9 @@ import type {
   LanguageModelV4Prompt,
 } from '@ai-sdk/provider';
 import {
-  type Experimental_LanguageModelStreamPart as ModelCallStreamPart,
   experimental_streamLanguageModelCall as streamModelCall,
+  gateway,
+  type Experimental_LanguageModelStreamPart as ModelCallStreamPart,
   type FinishReason,
   type LanguageModel,
   type LanguageModelUsage,
@@ -15,13 +16,11 @@ import {
   type ToolChoice,
   type ToolSet,
 } from 'ai';
-import { gateway } from 'ai';
-import type { ProviderOptions, TelemetrySettings } from './workflow-agent.js';
+import type { ProviderOptions, TelemetryOptions } from './workflow-agent.js';
 import {
   resolveSerializableTools,
   type SerializableToolDef,
 } from './serializable-schema.js';
-
 export type { Experimental_LanguageModelStreamPart as ModelCallStreamPart } from 'ai';
 
 export type ModelStopCondition = StopCondition<NoInfer<ToolSet>, any>;
@@ -54,7 +53,7 @@ export interface DoStreamStepOptions {
   providerOptions?: ProviderOptions;
   toolChoice?: ToolChoice<ToolSet>;
   includeRawChunks?: boolean;
-  experimental_telemetry?: TelemetrySettings;
+  telemetry?: TelemetryOptions;
   repairToolCall?: ToolCallRepairFunction<ToolSet>;
   responseFormat?: LanguageModelV4CallOptions['responseFormat'];
 }
@@ -115,6 +114,7 @@ export async function doStreamStep(
     // pre-converted LanguageModelV4Prompt. standardizePrompt inside
     // streamModelCall handles both formats.
     messages: conversationPrompt as unknown as ModelMessage[],
+    allowSystemInMessages: true,
     tools,
     toolChoice: options?.toolChoice,
     includeRawChunks: options?.includeRawChunks,
@@ -241,7 +241,8 @@ export async function doStreamStep(
     },
     functionId: undefined,
     metadata: undefined,
-    context: undefined,
+    runtimeContext: undefined,
+    toolsContext: {},
     content: [
       ...(text ? [{ type: 'text' as const, text }] : []),
       ...toolCalls

package/src/index.ts

@@ -22,12 +22,12 @@ export {
   type WorkflowAgentOnFinishCallback,
   type WorkflowAgentOnStepFinishCallback,
   type StreamTextTransform,
-  type TelemetrySettings,
+  type TelemetryOptions,
   type ToolCallRepairFunction,
   type WorkflowAgentOnStartCallback,
   type WorkflowAgentOnStepStartCallback,
-  type WorkflowAgentOnToolCallStartCallback,
-  type WorkflowAgentOnToolCallFinishCallback,
+  type WorkflowAgentOnToolExecutionStartCallback,
+  type WorkflowAgentOnToolExecutionEndCallback,
 } from './workflow-agent.js';
 
 export {

package/src/serializable-schema.ts

@@ -23,6 +23,8 @@ export type SerializableToolDef = {
   inputSchema: JSONSchema7;
   /** Present on provider tools (e.g. anthropic.tools.webSearch). */
   type?: 'provider';
+  /** Provider tool is executed by the provider. */
+  isProviderExecuted?: boolean;
   /** Provider tool ID, e.g. 'anthropic.web_search_20250305'. */
   id?: `${string}.${string}`;
   /** Provider tool configuration args (maxUses, allowedDomains, etc.). */
@@ -49,6 +51,7 @@ export function serializeToolSet(
       // them as provider-executed tools (e.g. anthropic webSearch).
       if ((t as any).type === 'provider') {
         def.type = 'provider';
+        def.isProviderExecuted = (t as any).isProviderExecuted ?? false;
         def.id = (t as any).id;
         def.args = (t as any).args;
       }
@@ -81,6 +84,7 @@ export function resolveSerializableTools(
             type: 'provider' as const,
             id: t.id!,
             args: t.args ?? {},
+            isProviderExecuted: t.isProviderExecuted ?? false,
             inputSchema: jsonSchema(t.inputSchema),
           }),
         ];

package/src/stream-text-iterator.ts

@@ -3,14 +3,15 @@ import type {
   LanguageModelV4Prompt,
   LanguageModelV4ToolResultPart,
 } from '@ai-sdk/provider';
-import type {
-  Experimental_LanguageModelStreamPart as ModelCallStreamPart,
-  LanguageModel,
-  ModelMessage,
-  StepResult,
-  ToolCallRepairFunction,
-  ToolChoice,
-  ToolSet,
+import {
+  experimental_filterActiveTools as filterActiveTools,
+  type Experimental_LanguageModelStreamPart as ModelCallStreamPart,
+  type LanguageModel,
+  type ModelMessage,
+  type StepResult,
+  type ToolCallRepairFunction,
+  type ToolChoice,
+  type ToolSet,
 } from 'ai';
 import {
   doStreamStep,
@@ -24,7 +25,7 @@ import type {
   PrepareStepCallback,
   WorkflowAgentOnErrorCallback,
   WorkflowAgentOnStepFinishCallback,
-  TelemetrySettings,
+  TelemetryOptions,
   WorkflowAgentOnStepStartCallback,
 } from './workflow-agent.js';
 
@@ -55,7 +56,6 @@ export async function* streamTextIterator({
   writable,
   model,
   stopConditions,
-  maxSteps,
   onStepFinish,
   onStepStart,
   onError,
@@ -63,7 +63,7 @@ export async function* streamTextIterator({
   generationSettings,
   toolChoice,
   experimental_context,
-  experimental_telemetry,
+  telemetry,
   includeRawChunks = false,
   repairToolCall,
   responseFormat,
@@ -73,7 +73,6 @@ export async function* streamTextIterator({
   writable?: WritableStream<ModelCallStreamPart<ToolSet>>;
   model: LanguageModel;
   stopConditions?: ModelStopCondition[] | ModelStopCondition;
-  maxSteps?: number;
   onStepFinish?: WorkflowAgentOnStepFinishCallback<any>;
   onStepStart?: WorkflowAgentOnStepStartCallback;
   onError?: WorkflowAgentOnErrorCallback;
@@ -81,7 +80,7 @@ export async function* streamTextIterator({
   generationSettings?: GenerationSettings;
   toolChoice?: ToolChoice<ToolSet>;
   experimental_context?: unknown;
-  experimental_telemetry?: TelemetrySettings;
+  telemetry?: TelemetryOptions;
   includeRawChunks?: boolean;
   repairToolCall?: ToolCallRepairFunction<ToolSet>;
   responseFormat?: LanguageModelV4CallOptions['responseFormat'];
@@ -104,16 +103,7 @@ export async function* streamTextIterator({
   let lastStep: StepResult<any, any> | undefined;
   let lastStepWasToolCalls = false;
 
-  // Default maxSteps to Infinity to preserve backwards compatibility
-  // (agent loops until completion unless explicitly limited)
-  const effectiveMaxSteps = maxSteps ?? Infinity;
-
   while (!done) {
-    // Check if we've exceeded the maximum number of steps
-    if (stepNumber >= effectiveMaxSteps) {
-      break;
-    }
-
     // Check for abort signal
     if (currentGenerationSettings.abortSignal?.aborted) {
       break;
@@ -242,6 +232,7 @@ export async function* streamTextIterator({
         stepNumber,
         model: currentModel,
         messages: conversationPrompt as unknown as ModelMessage[],
+        steps: [...steps],
       });
     }
 
@@ -249,7 +240,10 @@ export async function* streamTextIterator({
       // Filter tools if activeTools is specified
       const effectiveTools =
         currentActiveTools && currentActiveTools.length > 0
-          ? filterToolSet(tools, currentActiveTools)
+          ? (filterActiveTools({
+              tools,
+              activeTools: currentActiveTools,
+            }) ?? tools)
           : tools;
 
       // Serialize tools before crossing the step boundary — zod schemas
@@ -267,7 +261,7 @@ export async function* streamTextIterator({
             ...currentGenerationSettings,
             toolChoice: currentToolChoice,
             includeRawChunks,
-            experimental_telemetry,
+            telemetry,
             repairToolCall,
             responseFormat,
           },
@@ -393,19 +387,6 @@ export async function* streamTextIterator({
   return conversationPrompt;
 }
 
-/**
- * Filter a tool set to only include the specified active tools.
- */
-function filterToolSet(tools: ToolSet, activeTools: string[]): ToolSet {
-  const filtered: ToolSet = {};
-  for (const toolName of activeTools) {
-    if (toolName in tools) {
-      filtered[toolName] = tools[toolName];
-    }
-  }
-  return filtered;
-}
-
 /**
  * Strip OpenAI's itemId from providerMetadata (requires reasoning items we don't preserve).
  * Preserves all other provider metadata (e.g., Gemini's thoughtSignature).

package/src/telemetry.ts

@@ -1,4 +1,4 @@
-import type { TelemetrySettings } from './workflow-agent.js';
+import type { TelemetryOptions } from './workflow-agent.js';
 
 // Minimal OTel type shims so we don't depend on @opentelemetry/api at compile time.
 type Attributes = Record<string, unknown>;
@@ -62,7 +62,7 @@ async function ensureOtelApi(): Promise<OtelApi | null> {
  * Returns a no-op–equivalent `null` when telemetry is disabled, so callers
  * don't need a separate init step.
  */
-function getTracer(telemetry?: TelemetrySettings): Tracer | null {
+function getTracer(telemetry?: TelemetryOptions): Tracer | null {
   if (!telemetry?.isEnabled || !otelApi) return null;
   if (telemetry.tracer) return telemetry.tracer as Tracer;
   return otelApi.trace.getTracer('ai');
@@ -76,7 +76,7 @@ function getTracer(telemetry?: TelemetrySettings): Tracer | null {
  */
 function assembleOperationName(
   operationId: string,
-  telemetry?: TelemetrySettings,
+  telemetry?: TelemetryOptions,
 ): Attributes {
   return {
     'operation.name': `${operationId}${
@@ -94,7 +94,7 @@ function assembleOperationName(
  */
 function buildAttributes(
   operationId: string,
-  telemetry: TelemetrySettings | undefined,
+  telemetry: TelemetryOptions | undefined,
   extra?: Attributes,
 ): Attributes {
   if (!telemetry?.isEnabled) return {};
@@ -154,7 +154,7 @@ function recordErrorOnSpan(span: Span, error: unknown): void {
  */
 export async function recordSpan<T>(options: {
   name: string;
-  telemetry?: TelemetrySettings;
+  telemetry?: TelemetryOptions;
   attributes?: Attributes;
   fn: (span?: Span) => PromiseLike<T> | T;
 }): Promise<T> {

package/src/test/agent-e2e-workflows.ts

@@ -5,7 +5,7 @@ import { tool } from 'ai';
 import { WorkflowAgent } from '../workflow-agent.js';
 import { mockTextModel, mockSequenceModel } from '../providers/mock.js';
 import { FatalError, getWritable } from 'workflow';
-import z from 'zod';
+import { z } from 'zod';
 
 // ============================================================================
 // Tool step functions
@@ -334,10 +334,10 @@ export async function agentOnStepStartE2e() {
 }
 
 // ============================================================================
-// GAP tests — experimental_onToolCallStart
+// GAP tests — experimental_onToolExecutionStart
 // ============================================================================
 
-export async function agentOnToolCallStartE2e() {
+export async function agentonToolExecutionStartE2e() {
   'use workflow';
   const calls: string[] = [];
   const agent = new WorkflowAgent({
@@ -356,14 +356,14 @@ export async function agentOnToolCallStartE2e() {
         execute: echoStep,
       },
     },
-    experimental_onToolCallStart: async () => {
+    experimental_onToolExecutionStart: async () => {
       calls.push('constructor');
     },
   } as any);
   await agent.stream({
     messages: [{ role: 'user', content: 'test' }],
     writable: getWritable(),
-    experimental_onToolCallStart: async () => {
+    experimental_onToolExecutionStart: async () => {
       calls.push('method');
     },
   } as any);
@@ -371,10 +371,10 @@ export async function agentOnToolCallStartE2e() {
 }
 
 // ============================================================================
-// GAP tests — experimental_onToolCallFinish
+// GAP tests — experimental_onToolExecutionEnd
 // ============================================================================
 
-export async function agentOnToolCallFinishE2e() {
+export async function agentonToolExecutionEndE2e() {
   'use workflow';
   const calls: string[] = [];
   let capturedEvent: any = null;
@@ -394,14 +394,14 @@ export async function agentOnToolCallFinishE2e() {
         execute: addNumbers,
       },
     },
-    experimental_onToolCallFinish: async () => {
+    experimental_onToolExecutionEnd: async () => {
       calls.push('constructor');
     },
   } as any);
   await agent.stream({
     messages: [{ role: 'user', content: 'test' }],
     writable: getWritable(),
-    experimental_onToolCallFinish: async (event: any) => {
+    experimental_onToolExecutionEnd: async (event: any) => {
       calls.push('method');
       capturedEvent = {
         toolName: event?.toolCall?.toolName,

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

@@ -1,5 +1,8 @@
-import { type ToolSet, type UIMessageChunk } from 'ai';
-import type { Experimental_LanguageModelStreamPart as ModelCallStreamPart } from 'ai';
+import type {
+  Experimental_LanguageModelStreamPart as ModelCallStreamPart,
+  ToolSet,
+  UIMessageChunk,
+} from 'ai';
 
 /**
  * Convert a single ModelCallStreamPart to a UIMessageChunk.