@ai-sdk/workflow 1.0.0-canary.82 → 1.0.0-canary.83

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @ai-sdk/workflow
 
+## 1.0.0-canary.83
+
+### Patch Changes
+
+- 19736ee: feat(ai): rename onStepFinish to onStepEnd
+- Updated dependencies [19736ee]
+- Updated dependencies [d66ae02]
+- Updated dependencies [e4182bd]
+  - ai@7.0.0-canary.166
+
 ## 1.0.0-canary.82
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4CallOptions, 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, StepResult, GenerateTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
+import { ToolSet, LanguageModel, Instructions, ToolChoice, TelemetryOptions as TelemetryOptions$1, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, GenerateTextOnStepEndCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
 
 /**
@@ -16,10 +16,17 @@ type CompatibleLanguageModel = LanguageModelV4;
 
 /**
  * Callback function to be called after each step completes.
- * Alias for the AI SDK's GenerateTextOnStepFinishCallback, using
+ * Alias for the AI SDK's GenerateTextOnStepEndCallback, using
  * WorkflowAgent-consistent naming.
  */
-type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet, TRuntimeContext extends Context = Context> = GenerateTextOnStepFinishCallback<TTools, TRuntimeContext>;
+type WorkflowAgentOnStepEndCallback<TTools extends ToolSet = ToolSet, TRuntimeContext extends Context = Context> = GenerateTextOnStepEndCallback<TTools, TRuntimeContext>;
+/**
+ * Callback function to be called after each step completes.
+ * Deprecated alias for `WorkflowAgentOnStepEndCallback`.
+ *
+ * @deprecated Use `WorkflowAgentOnStepEndCallback` instead.
+ */
+type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet, TRuntimeContext extends Context = Context> = WorkflowAgentOnStepEndCallback<TTools, TRuntimeContext>;
 /**
  * Infer the type of the tools of a workflow agent.
  */
@@ -358,6 +365,12 @@ type WorkflowAgentOptions<TTools extends ToolSet = ToolSet, TRuntimeContext exte
     /**
      * Callback function to be called after each step completes.
      */
+    onStepEnd?: WorkflowAgentOnStepEndCallback<TTools, TRuntimeContext>;
+    /**
+     * Callback function to be called after each step completes.
+     *
+     * @deprecated Use `onStepEnd` instead.
+     */
     onStepFinish?: WorkflowAgentOnStepFinishCallback<TTools, TRuntimeContext>;
     /**
      * Callback that is called when the LLM response and all request tool executions are finished.
@@ -684,6 +697,12 @@ type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, TRuntimeContex
     /**
      * Callback function to be called after each step completes.
      */
+    onStepEnd?: WorkflowAgentOnStepEndCallback<TTools, TRuntimeContext>;
+    /**
+     * Callback function to be called after each step completes.
+     *
+     * @deprecated Use `onStepEnd` instead.
+     */
     onStepFinish?: WorkflowAgentOnStepFinishCallback<TTools, TRuntimeContext>;
     /**
      * Callback that is invoked when an error occurs during streaming.
@@ -878,7 +897,7 @@ declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet, TRuntimeContex
     private experimentalRepairToolCall?;
     private experimentalDownload?;
     private prepareStep?;
-    private constructorOnStepFinish?;
+    private constructorOnStepEnd?;
     private constructorOnEnd?;
     private constructorOnStart?;
     private constructorOnStepStart?;
@@ -1056,4 +1075,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 WorkflowAgentOnEndCallback, 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 };
+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, toUIMessageChunk };

package/dist/index.mjs

@@ -301,6 +301,7 @@ async function* streamTextIterator({
   writable,
   model,
   stopConditions,
+  onStepEnd,
   onStepFinish,
   onStepStart,
   onError,
@@ -590,10 +591,11 @@ async function* streamTextIterator({
           `Unexpected finish reason: ${typeof (finish == null ? void 0 : finish.finishReason) === "object" ? JSON.stringify(finish == null ? void 0 : finish.finishReason) : finish == null ? void 0 : finish.finishReason}`
         );
       }
-      if (onStepFinish) {
-        await onStepFinish(step);
+      const resolvedOnStepEnd = onStepEnd != null ? onStepEnd : onStepFinish;
+      if (resolvedOnStepEnd) {
+        await resolvedOnStepEnd(step);
       }
-      await ((_j = telemetryDispatcher.onStepFinish) == null ? void 0 : _j.call(telemetryDispatcher, normalizeStepForTelemetry(step)));
+      await ((_j = telemetryDispatcher.onStepEnd) == null ? void 0 : _j.call(telemetryDispatcher, normalizeStepForTelemetry(step)));
     } catch (error) {
       if (onError) {
         await onError({ error });
@@ -647,7 +649,7 @@ 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 : {};
@@ -662,7 +664,7 @@ var WorkflowAgent = class {
     this.experimentalRepairToolCall = options.experimental_repairToolCall;
     this.experimentalDownload = options.experimental_download;
     this.prepareStep = options.prepareStep;
-    this.constructorOnStepFinish = options.onStepFinish;
+    this.constructorOnStepEnd = (_c = options.onStepEnd) != null ? _c : options.onStepFinish;
     const { onFinish, onEnd = onFinish } = options;
     this.constructorOnEnd = onEnd;
     this.constructorOnStart = options.experimental_onStart;
@@ -689,7 +691,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, _C, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N;
+    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, _D, _E, _F, _G, _H, _I, _J, _K, _L, _M, _N, _O;
     const { onFinish, onEnd = onFinish } = options;
     let effectiveModel = this.model;
     let effectiveInstructions = (_a = options.system) != null ? _a : this.instructions;
@@ -939,9 +941,9 @@ var WorkflowAgent = class {
         providerOptions: options.providerOptions
       }
     };
-    const mergedOnStepFinish = mergeCallbacks(
-      this.constructorOnStepFinish,
-      options.onStepFinish
+    const mergedOnStepEnd = mergeCallbacks(
+      this.constructorOnStepEnd,
+      (_n = options.onStepEnd) != null ? _n : options.onStepFinish
     );
     const mergedOnEnd = mergeCallbacks(
       this.constructorOnEnd,
@@ -964,11 +966,11 @@ var WorkflowAgent = class {
       options.onToolExecutionEnd
     );
     const effectiveToolChoice = effectiveToolChoiceFromPrepare;
-    const effectiveActiveTools = (_n = options.activeTools) != null ? _n : this.activeTools;
-    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? (_o = filterActiveTools2({
+    const effectiveActiveTools = (_o = options.activeTools) != null ? _o : this.activeTools;
+    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? (_p = filterActiveTools2({
       tools: this.tools,
       activeTools: effectiveActiveTools
-    })) != null ? _o : this.tools : this.tools;
+    })) != null ? _p : this.tools : this.tools;
     const effectiveModelInfo = getModelInfo2(effectiveModel);
     let runtimeContext = effectiveRuntimeContext;
     let toolsContext = effectiveToolsContext;
@@ -983,7 +985,7 @@ var WorkflowAgent = class {
         toolsContext
       });
     }
-    await ((_r = telemetryDispatcher.onStart) == null ? void 0 : _r.call(telemetryDispatcher, {
+    await ((_s = telemetryDispatcher.onStart) == null ? void 0 : _s.call(telemetryDispatcher, {
       callId: "workflow-agent",
       operationId: "ai.workflowAgent.stream",
       provider: effectiveModelInfo.provider,
@@ -1001,11 +1003,11 @@ var WorkflowAgent = class {
       frequencyPenalty: mergedGenerationSettings.frequencyPenalty,
       stopSequences: mergedGenerationSettings.stopSequences,
       seed: mergedGenerationSettings.seed,
-      maxRetries: (_p = mergedGenerationSettings.maxRetries) != null ? _p : 2,
+      maxRetries: (_q = mergedGenerationSettings.maxRetries) != null ? _q : 2,
       timeout: void 0,
       headers: mergedGenerationSettings.headers,
       providerOptions: mergedGenerationSettings.providerOptions,
-      output: (_q = options.output) != null ? _q : this.output,
+      output: (_r = options.output) != null ? _r : this.output,
       runtimeContext,
       toolsContext
     }));
@@ -1150,7 +1152,7 @@ var WorkflowAgent = class {
         }
       }));
     };
-    if ((_s = mergedGenerationSettings.abortSignal) == null ? void 0 : _s.aborted) {
+    if ((_t = mergedGenerationSettings.abortSignal) == null ? void 0 : _t.aborted) {
       if (options.onAbort) {
         await options.onAbort({ steps });
       }
@@ -1167,19 +1169,19 @@ var WorkflowAgent = class {
       tools: effectiveTools,
       writable: options.writable,
       prompt: modelPrompt,
-      stopConditions: (_t = options.stopWhen) != null ? _t : this.stopWhen,
-      onStepFinish: mergedOnStepFinish,
+      stopConditions: (_u = options.stopWhen) != null ? _u : this.stopWhen,
+      onStepEnd: mergedOnStepEnd,
       onStepStart: mergedOnStepStart,
       onError: options.onError,
-      prepareStep: (_u = options.prepareStep) != null ? _u : this.prepareStep,
+      prepareStep: (_v = options.prepareStep) != null ? _v : this.prepareStep,
       generationSettings: mergedGenerationSettings,
       toolChoice: effectiveToolChoice,
       runtimeContext,
       toolsContext,
       telemetry: effectiveTelemetry,
-      includeRawChunks: (_v = options.includeRawChunks) != null ? _v : false,
-      repairToolCall: (_w = options.experimental_repairToolCall) != null ? _w : this.experimentalRepairToolCall,
-      responseFormat: await ((_y = (_x = options.output) != null ? _x : this.output) == null ? void 0 : _y.responseFormat)
+      includeRawChunks: (_w = options.includeRawChunks) != null ? _w : false,
+      repairToolCall: (_x = options.experimental_repairToolCall) != null ? _x : this.experimentalRepairToolCall,
+      responseFormat: await ((_z = (_y = options.output) != null ? _y : this.output) == null ? void 0 : _z.responseFormat)
     });
     let finalMessages;
     let encounteredError;
@@ -1187,7 +1189,7 @@ var WorkflowAgent = class {
     try {
       let result = await iterator.next();
       while (!result.done) {
-        if ((_z = mergedGenerationSettings.abortSignal) == null ? void 0 : _z.aborted) {
+        if ((_A = mergedGenerationSettings.abortSignal) == null ? void 0 : _A.aborted) {
           wasAborted = true;
           if (options.onAbort) {
             await options.onAbort({ steps });
@@ -1314,8 +1316,8 @@ var WorkflowAgent = class {
               await mergedOnEnd({
                 steps,
                 messages: messages2,
-                text: (_A = lastStep == null ? void 0 : lastStep.text) != null ? _A : "",
-                finishReason: (_B = lastStep == null ? void 0 : lastStep.finishReason) != null ? _B : "other",
+                text: (_B = lastStep == null ? void 0 : lastStep.text) != null ? _B : "",
+                finishReason: (_C = lastStep == null ? void 0 : lastStep.finishReason) != null ? _C : "other",
                 usage: totalUsage,
                 totalUsage,
                 runtimeContext,
@@ -1327,7 +1329,7 @@ var WorkflowAgent = class {
               const telemetrySteps = steps.map(normalizeStepForTelemetry2);
               const lastStep = telemetrySteps[telemetrySteps.length - 1];
               const totalUsage = aggregateUsage(steps);
-              await ((_C = telemetryDispatcher.onEnd) == null ? void 0 : _C.call(telemetryDispatcher, {
+              await ((_D = telemetryDispatcher.onEnd) == null ? void 0 : _D.call(telemetryDispatcher, {
                 ...lastStep,
                 steps: telemetrySteps,
                 usage: totalUsage,
@@ -1352,8 +1354,8 @@ var WorkflowAgent = class {
               }
             }
             if (options.writable) {
-              const sendFinish = (_D = options.sendFinish) != null ? _D : true;
-              const preventClose = (_E = options.preventClose) != null ? _E : false;
+              const sendFinish = (_E = options.sendFinish) != null ? _E : true;
+              const preventClose = (_F = options.preventClose) != null ? _F : false;
               if (sendFinish || !preventClose) {
                 await closeStream(options.writable, preventClose, sendFinish);
               }
@@ -1461,10 +1463,10 @@ var WorkflowAgent = class {
       } else if (options.onError) {
         await options.onError({ error });
       }
-      await ((_F = telemetryDispatcher.onError) == null ? void 0 : _F.call(telemetryDispatcher, error));
+      await ((_G = telemetryDispatcher.onError) == null ? void 0 : _G.call(telemetryDispatcher, error));
     }
     const messages = finalMessages != null ? finalMessages : prompt.messages;
-    const effectiveOutput = (_G = options.output) != null ? _G : this.output;
+    const effectiveOutput = (_H = options.output) != null ? _H : this.output;
     let experimentalOutput = void 0;
     if (effectiveOutput && steps.length > 0) {
       const lastStep = steps[steps.length - 1];
@@ -1492,8 +1494,8 @@ var WorkflowAgent = class {
       await mergedOnEnd({
         steps,
         messages,
-        text: (_H = lastStep == null ? void 0 : lastStep.text) != null ? _H : "",
-        finishReason: (_I = lastStep == null ? void 0 : lastStep.finishReason) != null ? _I : "other",
+        text: (_I = lastStep == null ? void 0 : lastStep.text) != null ? _I : "",
+        finishReason: (_J = lastStep == null ? void 0 : lastStep.finishReason) != null ? _J : "other",
         usage: totalUsage,
         totalUsage,
         runtimeContext,
@@ -1505,7 +1507,7 @@ var WorkflowAgent = class {
       const telemetrySteps = steps.map(normalizeStepForTelemetry2);
       const lastStep = telemetrySteps[telemetrySteps.length - 1];
       const totalUsage = aggregateUsage(steps);
-      await ((_J = telemetryDispatcher.onEnd) == null ? void 0 : _J.call(telemetryDispatcher, {
+      await ((_K = telemetryDispatcher.onEnd) == null ? void 0 : _K.call(telemetryDispatcher, {
         ...lastStep,
         steps: telemetrySteps,
         usage: totalUsage,
@@ -1514,8 +1516,8 @@ var WorkflowAgent = class {
     }
     if (encounteredError) {
       if (options.writable) {
-        const sendFinish = (_K = options.sendFinish) != null ? _K : true;
-        const preventClose = (_L = options.preventClose) != null ? _L : false;
+        const sendFinish = (_L = options.sendFinish) != null ? _L : true;
+        const preventClose = (_M = options.preventClose) != null ? _M : false;
         if (sendFinish || !preventClose) {
           await closeStream(options.writable, preventClose, sendFinish);
         }
@@ -1523,8 +1525,8 @@ var WorkflowAgent = class {
       throw encounteredError;
     }
     if (options.writable) {
-      const sendFinish = (_M = options.sendFinish) != null ? _M : true;
-      const preventClose = (_N = options.preventClose) != null ? _N : false;
+      const sendFinish = (_N = options.sendFinish) != null ? _N : true;
+      const preventClose = (_O = options.preventClose) != null ? _O : false;
       if (sendFinish || !preventClose) {
         await closeStream(options.writable, preventClose, sendFinish);
       }