@ai-sdk/workflow 1.0.0-canary.71 → 1.0.0-canary.73

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @ai-sdk/workflow
 
+## 1.0.0-canary.73
+
+### Patch Changes
+
+- Updated dependencies [023550e]
+- Updated dependencies [e92fc45]
+  - ai@7.0.0-canary.156
+
+## 1.0.0-canary.72
+
+### Patch Changes
+
+- Updated dependencies [e67d80e]
+- Updated dependencies [6cca112]
+- Updated dependencies [82fc0ab]
+- Updated dependencies [76fd58c]
+  - ai@7.0.0-canary.155
+
 ## 1.0.0-canary.71
 
 ### Patch Changes

package/dist/index.d.mts

@@ -362,6 +362,12 @@ type WorkflowAgentOptions<TTools extends ToolSet = ToolSet, TRuntimeContext exte
     /**
      * Callback that is called when the LLM response and all request tool executions are finished.
      */
+    onEnd?: WorkflowAgentOnEndCallback<TTools, TRuntimeContext>;
+    /**
+     * Callback that is called when the LLM response and all request tool executions are finished.
+     *
+     * @deprecated Use `onEnd` instead.
+     */
     onFinish?: WorkflowAgentOnFinishCallback<TTools, TRuntimeContext>;
     /**
      * Callback called when the agent starts streaming, before any LLM calls.
@@ -389,7 +395,7 @@ type WorkflowAgentOptions<TTools extends ToolSet = ToolSet, TRuntimeContext exte
 /**
  * Callback that is called when the LLM response and all request tool executions are finished.
  */
-type WorkflowAgentOnFinishCallback<TTools extends ToolSet = ToolSet, TRuntimeContext extends Context = Context, OUTPUT = never> = (event: {
+type WorkflowAgentOnEndCallback<TTools extends ToolSet = ToolSet, TRuntimeContext extends Context = Context, OUTPUT = never> = (event: {
     /**
      * Details for all steps.
      */
@@ -406,6 +412,10 @@ type WorkflowAgentOnFinishCallback<TTools extends ToolSet = ToolSet, TRuntimeCon
      * The finish reason from the last step.
      */
     readonly finishReason: FinishReason;
+    /**
+     * The total token usage across all steps.
+     */
+    readonly usage: LanguageModelUsage;
     /**
      * The total token usage across all steps.
      */
@@ -424,6 +434,12 @@ type WorkflowAgentOnFinishCallback<TTools extends ToolSet = ToolSet, TRuntimeCon
      */
     readonly output: OUTPUT;
 }) => PromiseLike<void> | void;
+/**
+ * Callback that is called when the LLM response and all request tool executions are finished.
+ *
+ * @deprecated Use `WorkflowAgentOnEndCallback` instead.
+ */
+type WorkflowAgentOnFinishCallback<TTools extends ToolSet = ToolSet, TRuntimeContext extends Context = Context, OUTPUT = never> = WorkflowAgentOnEndCallback<TTools, TRuntimeContext, OUTPUT>;
 /**
  * Callback that is invoked when an error occurs during streaming.
  */
@@ -678,6 +694,13 @@ type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, TRuntimeContex
      * Callback that is called when the LLM response and all request tool executions
      * (for tools that have an `execute` function) are finished.
      */
+    onEnd?: WorkflowAgentOnEndCallback<TTools, TRuntimeContext, OUTPUT>;
+    /**
+     * Callback that is called when the LLM response and all request tool executions
+     * (for tools that have an `execute` function) are finished.
+     *
+     * @deprecated Use `onEnd` instead.
+     */
     onFinish?: WorkflowAgentOnFinishCallback<TTools, TRuntimeContext, OUTPUT>;
     /**
      * Callback that is called when the operation is aborted.
@@ -856,7 +879,7 @@ declare class WorkflowAgent<TBaseTools extends ToolSet = ToolSet, TRuntimeContex
     private experimentalDownload?;
     private prepareStep?;
     private constructorOnStepFinish?;
-    private constructorOnFinish?;
+    private constructorOnEnd?;
     private constructorOnStart?;
     private constructorOnStepStart?;
     private constructorOnToolExecutionStart?;
@@ -1033,4 +1056,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 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 WorkflowAgentOnStepFinishCallback, type WorkflowAgentOnStepStartCallback, type WorkflowAgentOnToolExecutionEndCallback, type WorkflowAgentOnToolExecutionStartCallback, type WorkflowAgentOptions, type WorkflowAgentStreamOptions, type WorkflowAgentStreamResult, WorkflowChatTransport, type WorkflowChatTransportOptions, createModelCallToUIChunkTransform, toUIMessageChunk };

package/dist/index.mjs

@@ -269,7 +269,7 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
       stepTimeMs: 0,
       responseTimeMs: 0,
       toolExecutionMs: {},
-      timeToFirstOutputTokenMs: void 0
+      timeToFirstOutputMs: void 0
     },
     warnings,
     request: {
@@ -663,7 +663,8 @@ var WorkflowAgent = class {
     this.experimentalDownload = options.experimental_download;
     this.prepareStep = options.prepareStep;
     this.constructorOnStepFinish = options.onStepFinish;
-    this.constructorOnFinish = options.onFinish;
+    const { onFinish, onEnd = onFinish } = options;
+    this.constructorOnEnd = onEnd;
     this.constructorOnStart = options.experimental_onStart;
     this.constructorOnStepStart = options.experimental_onStepStart;
     this.constructorOnToolExecutionStart = options.onToolExecutionStart;
@@ -689,6 +690,7 @@ var WorkflowAgent = class {
   }
   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;
+    const { onFinish, onEnd = onFinish } = options;
     let effectiveModel = this.model;
     let effectiveInstructions = (_a = options.system) != null ? _a : this.instructions;
     let effectivePrompt = options.prompt;
@@ -941,9 +943,9 @@ var WorkflowAgent = class {
       this.constructorOnStepFinish,
       options.onStepFinish
     );
-    const mergedOnFinish = mergeCallbacks(
-      this.constructorOnFinish,
-      options.onFinish
+    const mergedOnEnd = mergeCallbacks(
+      this.constructorOnEnd,
+      onEnd
     );
     const mergedOnStart = mergeCallbacks(
       this.constructorOnStart,
@@ -1306,14 +1308,16 @@ var WorkflowAgent = class {
               });
             }
             const messages2 = iterMessages;
-            if (mergedOnFinish && !wasAborted) {
+            if (mergedOnEnd && !wasAborted) {
               const lastStep = steps[steps.length - 1];
-              await mergedOnFinish({
+              const totalUsage = aggregateUsage(steps);
+              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",
-                totalUsage: aggregateUsage(steps),
+                usage: totalUsage,
+                totalUsage,
                 runtimeContext,
                 toolsContext,
                 output: void 0
@@ -1322,10 +1326,12 @@ var WorkflowAgent = class {
             if (!wasAborted && steps.length > 0) {
               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, {
                 ...lastStep,
                 steps: telemetrySteps,
-                totalUsage: aggregateUsage(steps)
+                usage: totalUsage,
+                totalUsage
               }));
             }
             if (options.writable) {
@@ -1480,14 +1486,16 @@ var WorkflowAgent = class {
         }
       }
     }
-    if (mergedOnFinish && !wasAborted) {
+    if (mergedOnEnd && !wasAborted) {
       const lastStep = steps[steps.length - 1];
-      await mergedOnFinish({
+      const totalUsage = aggregateUsage(steps);
+      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",
-        totalUsage: aggregateUsage(steps),
+        usage: totalUsage,
+        totalUsage,
         runtimeContext,
         toolsContext,
         output: experimentalOutput
@@ -1496,10 +1504,12 @@ var WorkflowAgent = class {
     if (!wasAborted && steps.length > 0) {
       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, {
         ...lastStep,
         steps: telemetrySteps,
-        totalUsage: aggregateUsage(steps)
+        usage: totalUsage,
+        totalUsage
       }));
     }
     if (encounteredError) {
@@ -1935,16 +1945,16 @@ function toUIMessageChunk(part) {
     case "raw":
       return void 0;
     default: {
-      const p = part;
-      if (p.type === "tool-approval-request") {
+      const passthroughPart = part;
+      if (passthroughPart.type === "tool-approval-request") {
         return {
           type: "tool-approval-request",
-          approvalId: p.approvalId,
-          toolCallId: p.toolCallId
+          approvalId: passthroughPart.approvalId,
+          toolCallId: passthroughPart.toolCallId
         };
       }
-      if (p.type === "finish-step" || p.type === "start-step" || p.type === "tool-output-denied") {
-        return p;
+      if (passthroughPart.type === "finish-step" || passthroughPart.type === "start-step" || passthroughPart.type === "tool-output-denied") {
+        return passthroughPart;
       }
       return void 0;
     }
@@ -2043,7 +2053,7 @@ var WorkflowChatTransport = class {
       messageId
     }) : void 0;
     const url = (_a = requestConfig == null ? void 0 : requestConfig.api) != null ? _a : this.api;
-    const res = await this.fetch(url, {
+    const response = await this.fetch(url, {
       method: "POST",
       body: JSON.stringify(
         (_b = requestConfig == null ? void 0 : requestConfig.body) != null ? _b : { messages, ...options.body }
@@ -2052,21 +2062,21 @@ var WorkflowChatTransport = class {
       credentials: requestConfig == null ? void 0 : requestConfig.credentials,
       signal: abortSignal
     });
-    if (!res.ok || !res.body) {
+    if (!response.ok || !response.body) {
       throw new Error(
-        `Failed to fetch chat: ${res.status} ${await res.text()}`
+        `Failed to fetch chat: ${response.status} ${await response.text()}`
       );
     }
-    const workflowRunId = res.headers.get("x-workflow-run-id");
+    const workflowRunId = response.headers.get("x-workflow-run-id");
     if (!workflowRunId) {
       throw new Error(
         'Workflow run ID not found in "x-workflow-run-id" response header'
       );
     }
-    await ((_c = this.onChatSendMessage) == null ? void 0 : _c.call(this, res, options));
+    await ((_c = this.onChatSendMessage) == null ? void 0 : _c.call(this, response, options));
     try {
       const chunkStream = parseJsonEventStream({
-        stream: res.body,
+        stream: response.body,
         schema: uiMessageChunkSchema
       });
       for await (const chunk of createAsyncIterableStream(chunkStream)) {
@@ -2101,8 +2111,8 @@ var WorkflowChatTransport = class {
    * @throws Error if the reconnection request fails or returns a non-OK status
    */
   async reconnectToStream(options) {
-    const it = this.reconnectToStreamIterator(options);
-    return convertAsyncIteratorToReadableStream(it);
+    const reconnectIterator = this.reconnectToStreamIterator(options);
+    return convertAsyncIteratorToReadableStream(reconnectIterator);
   }
   async *reconnectToStreamIterator(options, workflowRunId, initialChunkIndex = 0) {
     var _a, _b;
@@ -2125,20 +2135,22 @@ var WorkflowChatTransport = class {
     while (!gotFinish) {
       const startIndex = useExplicitStartIndex ? explicitStartIndex : replayFromStart ? 0 : chunkIndex;
       const url = `${baseUrl}?startIndex=${startIndex}`;
-      const res = await this.fetch(url, {
+      const response = await this.fetch(url, {
         headers: requestConfig == null ? void 0 : requestConfig.headers,
         credentials: requestConfig == null ? void 0 : requestConfig.credentials,
         signal: options.abortSignal
       });
-      if (!res.ok || !res.body) {
+      if (!response.ok || !response.body) {
         throw new Error(
-          `Failed to fetch chat: ${res.status} ${await res.text()}`
+          `Failed to fetch chat: ${response.status} ${await response.text()}`
         );
       }
       if (useExplicitStartIndex && explicitStartIndex > 0) {
         chunkIndex = explicitStartIndex;
       } else if (useExplicitStartIndex && explicitStartIndex < 0) {
-        const tailIndexHeader = res.headers.get("x-workflow-stream-tail-index");
+        const tailIndexHeader = response.headers.get(
+          "x-workflow-stream-tail-index"
+        );
         const tailIndex = tailIndexHeader !== null ? parseInt(tailIndexHeader, 10) : NaN;
         if (!Number.isNaN(tailIndex)) {
           chunkIndex = Math.max(0, tailIndex + 1 + explicitStartIndex);
@@ -2152,7 +2164,7 @@ var WorkflowChatTransport = class {
       useExplicitStartIndex = false;
       try {
         const chunkStream = parseJsonEventStream({
-          stream: res.body,
+          stream: response.body,
           schema: uiMessageChunkSchema
         });
         for await (const chunk of createAsyncIterableStream(chunkStream)) {