@ai-sdk/workflow 1.0.0-beta.23 → 1.0.0-beta.26

package/CHANGELOG.md

@@ -1,5 +1,42 @@
 # @ai-sdk/workflow
 
+## 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

package/dist/index.d.mts

@@ -252,6 +252,10 @@ interface PrepareCallOptions<TTools extends ToolSet = ToolSet> extends Partial<G
     tools: TTools;
     instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
     toolChoice?: ToolChoice<TTools>;
+    telemetry?: TelemetryOptions;
+    /**
+     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
+     */
     experimental_telemetry?: TelemetryOptions;
     experimental_context?: unknown;
     messages: ModelMessage[];
@@ -303,7 +307,13 @@ 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?: TelemetryOptions;
     /**
@@ -374,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
@@ -460,7 +470,7 @@ type WorkflowAgentOnStepStartCallback<TTools extends ToolSet = ToolSet> = (event
 /**
  * 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) */
@@ -471,7 +481,7 @@ type WorkflowAgentOnToolCallStartCallback = (event: {
  * 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 current step number (0-based) */
@@ -569,7 +579,13 @@ type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT = never
      */
     activeTools?: Array<keyof NoInfer<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?: TelemetryOptions;
     /**
@@ -653,11 +669,11 @@ type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT = never
     /**
      * 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.
@@ -817,8 +833,8 @@ declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet> {
     private constructorOnFinish?;
     private constructorOnStart?;
     private constructorOnStepStart?;
-    private constructorOnToolCallStart?;
-    private constructorOnToolCallFinish?;
+    private constructorOnToolExecutionStart?;
+    private constructorOnToolExecutionEnd?;
     private prepareCall?;
     constructor(options: WorkflowAgentOptions<TBaseTools>);
     generate(): void;
@@ -991,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 TelemetryOptions, 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 };

package/dist/index.mjs

@@ -279,7 +279,7 @@ async function* streamTextIterator({
   generationSettings,
   toolChoice,
   experimental_context,
-  experimental_telemetry,
+  telemetry,
   includeRawChunks = false,
   repairToolCall,
   responseFormat
@@ -427,7 +427,7 @@ async function* streamTextIterator({
           ...currentGenerationSettings,
           toolChoice: currentToolChoice,
           includeRawChunks,
-          experimental_telemetry,
+          telemetry,
           repairToolCall,
           responseFormat
         }
@@ -544,13 +544,13 @@ function sanitizeProviderMetadataForToolCall(metadata) {
 // src/workflow-agent.ts
 var WorkflowAgent = class {
   constructor(options) {
-    var _a, _b;
+    var _a, _b, _c;
     this.id = options.id;
     this.model = options.model;
     this.tools = (_a = options.tools) != null ? _a : {};
     this.instructions = (_b = options.instructions) != null ? _b : options.system;
     this.toolChoice = options.toolChoice;
-    this.telemetry = options.experimental_telemetry;
+    this.telemetry = (_c = options.telemetry) != null ? _c : options.experimental_telemetry;
     this.experimentalContext = options.experimental_context;
     this.stopWhen = options.stopWhen;
     this.activeTools = options.activeTools;
@@ -562,8 +562,8 @@ var WorkflowAgent = class {
     this.constructorOnFinish = options.onFinish;
     this.constructorOnStart = options.experimental_onStart;
     this.constructorOnStepStart = options.experimental_onStepStart;
-    this.constructorOnToolCallStart = options.experimental_onToolCallStart;
-    this.constructorOnToolCallFinish = options.experimental_onToolCallFinish;
+    this.constructorOnToolExecutionStart = options.experimental_onToolExecutionStart;
+    this.constructorOnToolExecutionEnd = options.experimental_onToolExecutionEnd;
     this.prepareCall = options.prepareCall;
     this.generationSettings = {
       maxOutputTokens: options.maxOutputTokens,
@@ -584,7 +584,7 @@ var WorkflowAgent = class {
     throw new Error("Not implemented");
   }
   async stream(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C;
     let effectiveModel = this.model;
     let effectiveInstructions = (_a = options.system) != null ? _a : this.instructions;
     let effectivePrompt = options.prompt;
@@ -592,14 +592,15 @@ var WorkflowAgent = class {
     let effectiveGenerationSettings = { ...this.generationSettings };
     let effectiveExperimentalContext = (_b = options.experimental_context) != null ? _b : this.experimentalContext;
     let effectiveToolChoiceFromPrepare = (_c = options.toolChoice) != null ? _c : this.toolChoice;
-    let effectiveTelemetryFromPrepare = (_d = options.experimental_telemetry) != null ? _d : this.telemetry;
-    const resolvedMessagesForPrepareCall = (_e = effectiveMessages != null ? effectiveMessages : typeof effectivePrompt === "string" ? [{ role: "user", content: effectivePrompt }] : effectivePrompt) != null ? _e : [];
+    let effectiveTelemetryFromPrepare = (_e = (_d = options.telemetry) != null ? _d : options.experimental_telemetry) != null ? _e : this.telemetry;
+    const resolvedMessagesForPrepareCall = (_f = effectiveMessages != null ? effectiveMessages : typeof effectivePrompt === "string" ? [{ role: "user", content: effectivePrompt }] : effectivePrompt) != null ? _f : [];
     if (this.prepareCall) {
       const prepared = await this.prepareCall({
         model: effectiveModel,
         tools: this.tools,
         instructions: effectiveInstructions,
         toolChoice: effectiveToolChoiceFromPrepare,
+        telemetry: effectiveTelemetryFromPrepare,
         experimental_telemetry: effectiveTelemetryFromPrepare,
         experimental_context: effectiveExperimentalContext,
         messages: resolvedMessagesForPrepareCall,
@@ -616,7 +617,9 @@ var WorkflowAgent = class {
         effectiveExperimentalContext = prepared.experimental_context;
       if (prepared.toolChoice !== void 0)
         effectiveToolChoiceFromPrepare = prepared.toolChoice;
-      if (prepared.experimental_telemetry !== void 0)
+      if (prepared.telemetry !== void 0)
+        effectiveTelemetryFromPrepare = prepared.telemetry;
+      else if (prepared.experimental_telemetry !== void 0)
         effectiveTelemetryFromPrepare = prepared.experimental_telemetry;
       if (prepared.maxOutputTokens !== void 0)
         effectiveGenerationSettings.maxOutputTokens = prepared.maxOutputTokens;
@@ -737,11 +740,11 @@ var WorkflowAgent = class {
     const modelPrompt = await convertToLanguageModelPrompt({
       prompt,
       supportedUrls: {},
-      download: (_f = options.experimental_download) != null ? _f : this.experimentalDownload
+      download: (_g = options.experimental_download) != null ? _g : this.experimentalDownload
     });
     const effectiveAbortSignal = mergeAbortSignals(
-      (_g = options.abortSignal) != null ? _g : effectiveGenerationSettings.abortSignal,
-      options.timeout != null ? AbortSignal.timeout(options.timeout) : void 0
+      (_h = options.abortSignal) != null ? _h : effectiveGenerationSettings.abortSignal,
+      options.timeout
     );
     const mergedGenerationSettings = {
       ...effectiveGenerationSettings,
@@ -790,21 +793,21 @@ var WorkflowAgent = class {
       this.constructorOnStepStart,
       options.experimental_onStepStart
     );
-    const mergedOnToolCallStart = mergeCallbacks(
-      this.constructorOnToolCallStart,
-      options.experimental_onToolCallStart
+    const mergedOnToolExecutionStart = mergeCallbacks(
+      this.constructorOnToolExecutionStart,
+      options.experimental_onToolExecutionStart
     );
-    const mergedOnToolCallFinish = mergeCallbacks(
-      this.constructorOnToolCallFinish,
-      options.experimental_onToolCallFinish
+    const mergedOnToolExecutionEnd = mergeCallbacks(
+      this.constructorOnToolExecutionEnd,
+      options.experimental_onToolExecutionEnd
     );
     const effectiveToolChoice = effectiveToolChoiceFromPrepare;
     const effectiveTelemetry = effectiveTelemetryFromPrepare;
-    const effectiveActiveTools = (_h = options.activeTools) != null ? _h : this.activeTools;
-    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? (_i = filterActiveTools2({
+    const effectiveActiveTools = (_i = options.activeTools) != null ? _i : this.activeTools;
+    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? (_j = filterActiveTools2({
       tools: this.tools,
       activeTools: effectiveActiveTools
-    })) != null ? _i : this.tools : this.tools;
+    })) != null ? _j : this.tools : this.tools;
     let experimentalContext = effectiveExperimentalContext;
     const steps = [];
     let lastStepToolCalls = [];
@@ -822,8 +825,8 @@ var WorkflowAgent = class {
         toolName: toolCall.toolName,
         input: toolCall.input
       };
-      if (mergedOnToolCallStart) {
-        await mergedOnToolCallStart({
+      if (mergedOnToolExecutionStart) {
+        await mergedOnToolExecutionStart({
           toolCall: toolCallEvent,
           stepNumber: currentStepNumber
         });
@@ -834,8 +837,8 @@ var WorkflowAgent = class {
         result = await executeTool(toolCall, tools, messages2, context);
       } catch (err) {
         const durationMs2 = Date.now() - startTime;
-        if (mergedOnToolCallFinish) {
-          await mergedOnToolCallFinish({
+        if (mergedOnToolExecutionEnd) {
+          await mergedOnToolExecutionEnd({
             toolCall: toolCallEvent,
             stepNumber: currentStepNumber,
             durationMs: durationMs2,
@@ -846,10 +849,10 @@ var WorkflowAgent = class {
         throw err;
       }
       const durationMs = Date.now() - startTime;
-      if (mergedOnToolCallFinish) {
+      if (mergedOnToolExecutionEnd) {
         const isError = result.output && "type" in result.output && (result.output.type === "error-text" || result.output.type === "error-json");
         if (isError) {
-          await mergedOnToolCallFinish({
+          await mergedOnToolExecutionEnd({
             toolCall: toolCallEvent,
             stepNumber: currentStepNumber,
             durationMs,
@@ -857,7 +860,7 @@ var WorkflowAgent = class {
             error: "value" in result.output ? result.output.value : void 0
           });
         } else {
-          await mergedOnToolCallFinish({
+          await mergedOnToolExecutionEnd({
             toolCall: toolCallEvent,
             stepNumber: currentStepNumber,
             durationMs,
@@ -868,7 +871,7 @@ var WorkflowAgent = class {
       }
       return result;
     };
-    if ((_j = mergedGenerationSettings.abortSignal) == null ? void 0 : _j.aborted) {
+    if ((_k = mergedGenerationSettings.abortSignal) == null ? void 0 : _k.aborted) {
       if (options.onAbort) {
         await options.onAbort({ steps });
       }
@@ -885,18 +888,18 @@ var WorkflowAgent = class {
       tools: effectiveTools,
       writable: options.writable,
       prompt: modelPrompt,
-      stopConditions: (_k = options.stopWhen) != null ? _k : this.stopWhen,
+      stopConditions: (_l = options.stopWhen) != null ? _l : this.stopWhen,
       onStepFinish: mergedOnStepFinish,
       onStepStart: mergedOnStepStart,
       onError: options.onError,
-      prepareStep: (_l = options.prepareStep) != null ? _l : this.prepareStep,
+      prepareStep: (_m = options.prepareStep) != null ? _m : this.prepareStep,
       generationSettings: mergedGenerationSettings,
       toolChoice: effectiveToolChoice,
       experimental_context: experimentalContext,
-      experimental_telemetry: effectiveTelemetry,
-      includeRawChunks: (_m = options.includeRawChunks) != null ? _m : false,
-      repairToolCall: (_n = options.experimental_repairToolCall) != null ? _n : this.experimentalRepairToolCall,
-      responseFormat: await ((_p = (_o = options.output) != null ? _o : this.output) == null ? void 0 : _p.responseFormat)
+      telemetry: effectiveTelemetry,
+      includeRawChunks: (_n = options.includeRawChunks) != null ? _n : false,
+      repairToolCall: (_o = options.experimental_repairToolCall) != null ? _o : this.experimentalRepairToolCall,
+      responseFormat: await ((_q = (_p = options.output) != null ? _p : this.output) == null ? void 0 : _q.responseFormat)
     });
     let finalMessages;
     let encounteredError;
@@ -904,7 +907,7 @@ var WorkflowAgent = class {
     try {
       let result = await iterator.next();
       while (!result.done) {
-        if ((_q = mergedGenerationSettings.abortSignal) == null ? void 0 : _q.aborted) {
+        if ((_r = mergedGenerationSettings.abortSignal) == null ? void 0 : _r.aborted) {
           wasAborted = true;
           if (options.onAbort) {
             await options.onAbort({ steps });
@@ -999,8 +1002,8 @@ var WorkflowAgent = class {
               await mergedOnFinish({
                 steps,
                 messages: messages2,
-                text: (_r = lastStep == null ? void 0 : lastStep.text) != null ? _r : "",
-                finishReason: (_s = lastStep == null ? void 0 : lastStep.finishReason) != null ? _s : "other",
+                text: (_s = lastStep == null ? void 0 : lastStep.text) != null ? _s : "",
+                finishReason: (_t = lastStep == null ? void 0 : lastStep.finishReason) != null ? _t : "other",
                 totalUsage: aggregateUsage(steps),
                 experimental_context: experimentalContext,
                 output: void 0
@@ -1024,8 +1027,8 @@ var WorkflowAgent = class {
               }
             }
             if (options.writable) {
-              const sendFinish = (_t = options.sendFinish) != null ? _t : true;
-              const preventClose = (_u = options.preventClose) != null ? _u : false;
+              const sendFinish = (_u = options.sendFinish) != null ? _u : true;
+              const preventClose = (_v = options.preventClose) != null ? _v : false;
               if (sendFinish || !preventClose) {
                 await closeStream(options.writable, preventClose, sendFinish);
               }
@@ -1120,7 +1123,7 @@ var WorkflowAgent = class {
       }
     }
     const messages = finalMessages != null ? finalMessages : prompt.messages;
-    const effectiveOutput = (_v = options.output) != null ? _v : this.output;
+    const effectiveOutput = (_w = options.output) != null ? _w : this.output;
     let experimentalOutput = void 0;
     if (effectiveOutput && steps.length > 0) {
       const lastStep = steps[steps.length - 1];
@@ -1147,8 +1150,8 @@ var WorkflowAgent = class {
       await mergedOnFinish({
         steps,
         messages,
-        text: (_w = lastStep == null ? void 0 : lastStep.text) != null ? _w : "",
-        finishReason: (_x = lastStep == null ? void 0 : lastStep.finishReason) != null ? _x : "other",
+        text: (_x = lastStep == null ? void 0 : lastStep.text) != null ? _x : "",
+        finishReason: (_y = lastStep == null ? void 0 : lastStep.finishReason) != null ? _y : "other",
         totalUsage: aggregateUsage(steps),
         experimental_context: experimentalContext,
         output: experimentalOutput
@@ -1156,8 +1159,8 @@ var WorkflowAgent = class {
     }
     if (encounteredError) {
       if (options.writable) {
-        const sendFinish = (_y = options.sendFinish) != null ? _y : true;
-        const preventClose = (_z = options.preventClose) != null ? _z : false;
+        const sendFinish = (_z = options.sendFinish) != null ? _z : true;
+        const preventClose = (_A = options.preventClose) != null ? _A : false;
         if (sendFinish || !preventClose) {
           await closeStream(options.writable, preventClose, sendFinish);
         }
@@ -1165,8 +1168,8 @@ var WorkflowAgent = class {
       throw encounteredError;
     }
     if (options.writable) {
-      const sendFinish = (_A = options.sendFinish) != null ? _A : true;
-      const preventClose = (_B = options.preventClose) != null ? _B : false;
+      const sendFinish = (_B = options.sendFinish) != null ? _B : true;
+      const preventClose = (_C = options.preventClose) != null ? _C : false;
       if (sendFinish || !preventClose) {
         await closeStream(options.writable, preventClose, sendFinish);
       }