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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/workflow",
-  "version": "1.0.0-canary.71",
+  "version": "1.0.0-canary.73",
   "description": "WorkflowAgent for building AI agents with AI SDK",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -29,7 +29,7 @@
     "ajv": "^8.20.0",
     "@ai-sdk/provider": "4.0.0-canary.17",
     "@ai-sdk/provider-utils": "5.0.0-canary.44",
-    "ai": "7.0.0-canary.154"
+    "ai": "7.0.0-canary.156"
   },
   "devDependencies": {
     "@types/node": "22.19.19",

package/src/do-stream-step.ts

@@ -333,7 +333,7 @@ export async function doStreamStep(
       stepTimeMs: 0,
       responseTimeMs: 0,
       toolExecutionMs: {},
-      timeToFirstOutputTokenMs: undefined,
+      timeToFirstOutputMs: undefined,
     },
     warnings,
     request: {

package/src/index.ts

@@ -18,6 +18,7 @@ export {
   type PrepareStepResult,
   type ProviderOptions,
   type WorkflowAgentOnAbortCallback,
+  type WorkflowAgentOnEndCallback,
   type WorkflowAgentOnErrorCallback,
   type WorkflowAgentOnFinishCallback,
   type WorkflowAgentOnStepFinishCallback,

package/src/providers/mock.ts

@@ -47,13 +47,13 @@ export function mockTextModel(text: string) {
 export function mockSequenceModel(responses: MockResponseDescriptor[]) {
   return mockProvider({
     doStream: async (options: any) => {
-      const idx = Math.min(
+      const responseIndex = Math.min(
         options.prompt.filter((m: any) => m.role === 'assistant').length,
         responses.length - 1,
       );
-      const r = responses[idx];
+      const selectedResponse = responses[responseIndex];
       const parts =
-        r.type === 'text'
+        selectedResponse.type === 'text'
           ? [
               { type: 'stream-start', warnings: [] },
               {
@@ -63,7 +63,7 @@ export function mockSequenceModel(responses: MockResponseDescriptor[]) {
                 timestamp: new Date(),
               },
               { type: 'text-start', id: '1' },
-              { type: 'text-delta', id: '1', delta: r.text },
+              { type: 'text-delta', id: '1', delta: selectedResponse.text },
               { type: 'text-end', id: '1' },
               {
                 type: 'finish',
@@ -84,9 +84,9 @@ export function mockSequenceModel(responses: MockResponseDescriptor[]) {
               },
               {
                 type: 'tool-call',
-                toolCallId: `call-${idx + 1}`,
-                toolName: r.toolName,
-                input: r.input,
+                toolCallId: `call-${responseIndex + 1}`,
+                toolName: selectedResponse.toolName,
+                input: selectedResponse.input,
               },
               {
                 type: 'finish',
@@ -100,7 +100,7 @@ export function mockSequenceModel(responses: MockResponseDescriptor[]) {
       return {
         stream: new ReadableStream({
           start(c) {
-            for (const p of parts as any[]) c.enqueue(p);
+            for (const streamPart of parts as any[]) c.enqueue(streamPart);
             c.close();
           },
         }),

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

@@ -191,20 +191,20 @@ export function toUIMessageChunk(
       // standard ModelCallStreamPart types but are written by the
       // WorkflowAgent between tool execution and the next model step
       // to ensure proper message splitting in convertToModelMessages.
-      const p = part as any;
-      if (p.type === 'tool-approval-request') {
+      const passthroughPart = part as any;
+      if (passthroughPart.type === 'tool-approval-request') {
         return {
           type: 'tool-approval-request',
-          approvalId: p.approvalId,
-          toolCallId: p.toolCallId,
+          approvalId: passthroughPart.approvalId,
+          toolCallId: passthroughPart.toolCallId,
         } as UIMessageChunk;
       }
       if (
-        p.type === 'finish-step' ||
-        p.type === 'start-step' ||
-        p.type === 'tool-output-denied'
+        passthroughPart.type === 'finish-step' ||
+        passthroughPart.type === 'start-step' ||
+        passthroughPart.type === 'tool-output-denied'
       ) {
-        return p as UIMessageChunk;
+        return passthroughPart as UIMessageChunk;
       }
       return undefined;
     }

package/src/workflow-agent.ts

@@ -497,6 +497,13 @@ export type WorkflowAgentOptions<
     /**
      * 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>;
 
     /**
@@ -536,7 +543,7 @@ export type WorkflowAgentOptions<
 /**
  * Callback that is called when the LLM response and all request tool executions are finished.
  */
-export type WorkflowAgentOnFinishCallback<
+export type WorkflowAgentOnEndCallback<
   TTools extends ToolSet = ToolSet,
   TRuntimeContext extends Context = Context,
   OUTPUT = never,
@@ -561,6 +568,11 @@ export type WorkflowAgentOnFinishCallback<
    */
   readonly finishReason: FinishReason;
 
+  /**
+   * The total token usage across all steps.
+   */
+  readonly usage: LanguageModelUsage;
+
   /**
    * The total token usage across all steps.
    */
@@ -583,6 +595,17 @@ export type WorkflowAgentOnFinishCallback<
   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.
+ */
+export 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.
  */
@@ -894,6 +917,14 @@ export type WorkflowAgentStreamOptions<
      * 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>;
 
     /**
@@ -1107,7 +1138,7 @@ export class WorkflowAgent<
     TBaseTools,
     TRuntimeContext
   >;
-  private constructorOnFinish?: WorkflowAgentOnFinishCallback<
+  private constructorOnEnd?: WorkflowAgentOnEndCallback<
     TBaseTools,
     TRuntimeContext
   >;
@@ -1140,7 +1171,8 @@ export class WorkflowAgent<
     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;
@@ -1180,6 +1212,8 @@ export class WorkflowAgent<
       PARTIAL_OUTPUT
     >,
   ): Promise<WorkflowAgentStreamResult<TTools, OUTPUT>> {
+    const { onFinish, onEnd = onFinish } = options;
+
     // Call prepareCall to transform parameters before the agent loop
     let effectiveModel: LanguageModel = this.model;
     let effectiveInstructions = options.system ?? this.instructions;
@@ -1505,11 +1539,11 @@ export class WorkflowAgent<
         | undefined,
       options.onStepFinish,
     );
-    const mergedOnFinish = mergeCallbacks(
-      this.constructorOnFinish as
-        | WorkflowAgentOnFinishCallback<TTools, TRuntimeContext, OUTPUT>
+    const mergedOnEnd = mergeCallbacks(
+      this.constructorOnEnd as
+        | WorkflowAgentOnEndCallback<TTools, TRuntimeContext, OUTPUT>
         | undefined,
-      options.onFinish,
+      onEnd,
     );
     const mergedOnStart = mergeCallbacks(
       this.constructorOnStart as
@@ -2006,14 +2040,16 @@ export class WorkflowAgent<
 
             const messages = iterMessages as unknown as ModelMessage[];
 
-            if (mergedOnFinish && !wasAborted) {
+            if (mergedOnEnd && !wasAborted) {
               const lastStep = steps[steps.length - 1];
-              await mergedOnFinish({
+              const totalUsage = aggregateUsage(steps);
+              await mergedOnEnd({
                 steps,
                 messages,
                 text: lastStep?.text ?? '',
                 finishReason: lastStep?.finishReason ?? 'other',
-                totalUsage: aggregateUsage(steps),
+                usage: totalUsage,
+                totalUsage,
                 runtimeContext,
                 toolsContext:
                   toolsContext as unknown as InferToolSetContext<TTools>,
@@ -2023,10 +2059,12 @@ export class WorkflowAgent<
             if (!wasAborted && steps.length > 0) {
               const telemetrySteps = steps.map(normalizeStepForTelemetry);
               const lastStep = telemetrySteps[telemetrySteps.length - 1];
+              const totalUsage = aggregateUsage(steps);
               await telemetryDispatcher.onEnd?.({
                 ...lastStep,
                 steps: telemetrySteps,
-                totalUsage: aggregateUsage(steps),
+                usage: totalUsage,
+                totalUsage,
               });
             }
 
@@ -2181,7 +2219,7 @@ export class WorkflowAgent<
         await options.onError({ error });
       }
       await telemetryDispatcher.onError?.(error);
-      // Don't throw yet - we want to call onFinish first
+      // Don't throw yet - we want to call onEnd first
     }
 
     // Use the final messages from the iterator, or fall back to standardized messages
@@ -2214,15 +2252,17 @@ export class WorkflowAgent<
       }
     }
 
-    // Call onFinish callback if provided (always call, even on errors, but not on abort)
-    if (mergedOnFinish && !wasAborted) {
+    // Call onEnd callback if provided (always call, even on errors, but not on abort)
+    if (mergedOnEnd && !wasAborted) {
       const lastStep = steps[steps.length - 1];
-      await mergedOnFinish({
+      const totalUsage = aggregateUsage(steps);
+      await mergedOnEnd({
         steps,
         messages: messages as ModelMessage[],
         text: lastStep?.text ?? '',
         finishReason: lastStep?.finishReason ?? 'other',
-        totalUsage: aggregateUsage(steps),
+        usage: totalUsage,
+        totalUsage,
         runtimeContext,
         toolsContext: toolsContext as unknown as InferToolSetContext<TTools>,
         output: experimentalOutput,
@@ -2231,10 +2271,12 @@ export class WorkflowAgent<
     if (!wasAborted && steps.length > 0) {
       const telemetrySteps = steps.map(normalizeStepForTelemetry);
       const lastStep = telemetrySteps[telemetrySteps.length - 1];
+      const totalUsage = aggregateUsage(steps);
       await telemetryDispatcher.onEnd?.({
         ...lastStep,
         steps: telemetrySteps,
-        totalUsage: aggregateUsage(steps),
+        usage: totalUsage,
+        totalUsage,
       });
     }
 

package/src/workflow-chat-transport.ts

@@ -216,7 +216,7 @@ export class WorkflowChatTransport<
       : undefined;
 
     const url = requestConfig?.api ?? this.api;
-    const res = await this.fetch(url, {
+    const response = await this.fetch(url, {
       method: 'POST',
       body: JSON.stringify(
         requestConfig?.body ?? { messages, ...options.body },
@@ -226,13 +226,13 @@ export class WorkflowChatTransport<
       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',
@@ -242,12 +242,12 @@ export class WorkflowChatTransport<
     // Notify the caller that the chat POST request was sent.
     // This is useful for tracking the chat history on the client
     // side and allows for inspecting response headers.
-    await this.onChatSendMessage?.(res, options);
+    await this.onChatSendMessage?.(response, options);
 
     // Flush the initial stream until the end or an error occurs
     try {
       const chunkStream = parseJsonEventStream({
-        stream: res.body,
+        stream: response.body,
         schema: uiMessageChunkSchema,
       });
       for await (const chunk of createAsyncIterableStream(chunkStream)) {
@@ -292,8 +292,8 @@ export class WorkflowChatTransport<
   async reconnectToStream(
     options: ReconnectToStreamOptions & ChatRequestOptions,
   ): Promise<ReadableStream<UIMessageChunk> | null> {
-    const it = this.reconnectToStreamIterator(options);
-    return convertAsyncIteratorToReadableStream(it);
+    const reconnectIterator = this.reconnectToStreamIterator(options);
+    return convertAsyncIteratorToReadableStream(reconnectIterator);
   }
 
   private async *reconnectToStreamIterator(
@@ -344,15 +344,15 @@ export class WorkflowChatTransport<
           : chunkIndex;
 
       const url = `${baseUrl}?startIndex=${startIndex}`;
-      const res = await this.fetch(url, {
+      const response = await this.fetch(url, {
         headers: requestConfig?.headers,
         credentials: 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()}`,
         );
       }
 
@@ -365,7 +365,9 @@ export class WorkflowChatTransport<
         // resume from (explicitStartIndex + chunks received).
         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;
 
@@ -389,7 +391,7 @@ export class WorkflowChatTransport<
 
       try {
         const chunkStream = parseJsonEventStream({
-          stream: res.body,
+          stream: response.body,
           schema: uiMessageChunkSchema,
         });
         for await (const chunk of createAsyncIterableStream(chunkStream)) {