@ai-sdk/workflow 1.0.0-canary.84 → 1.0.0-canary.86

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @ai-sdk/workflow
 
+## 1.0.0-canary.86
+
+### Patch Changes
+
+- Updated dependencies [a5018ab]
+- Updated dependencies [21d3d60]
+- Updated dependencies [426dbbb]
+- Updated dependencies [7fd3360]
+  - ai@7.0.0-canary.169
+
+## 1.0.0-canary.85
+
+### Patch Changes
+
+- 1e4b350: Honor `tool.toModelOutput` in `WorkflowAgent`.
+
+  `WorkflowAgent` now routes successful local, provider-executed, and approved tool results through each tool's optional `toModelOutput` hook, matching `generateText`, `streamText`, and `ToolLoopAgent`. Previously the hook was ignored and results were always serialized as `text` or `json`.
+
+  Internally exports the shared tool-result model-output helpers from `ai/internal`, and uses the shared `getErrorMessage` behavior for workflow tool error results.
+
+- Updated dependencies [1e4b350]
+  - ai@7.0.0-canary.168
+
 ## 1.0.0-canary.84
 
 ### Patch Changes

package/dist/index.mjs

@@ -1,5 +1,6 @@
 // src/workflow-agent.ts
 import {
+  getErrorMessage,
   validateTypes
 } from "@ai-sdk/provider-utils";
 import {
@@ -14,6 +15,55 @@ import {
   standardizePrompt
 } from "ai/internal";
 
+// src/create-language-model-tool-result-output.ts
+import {
+  createDefaultDownloadFunction,
+  createToolModelOutput,
+  downloadAssets,
+  mapToolResultOutput
+} from "ai/internal";
+async function createLanguageModelToolResultOutput({
+  toolCallId,
+  toolName,
+  input,
+  output,
+  tool: tool2,
+  errorMode,
+  supportedUrls,
+  download = createDefaultDownloadFunction(),
+  provider
+}) {
+  const modelOutput = await createToolModelOutput({
+    toolCallId,
+    input,
+    output,
+    tool: tool2,
+    errorMode
+  });
+  const downloadedAssets = modelOutput.type === "content" ? await downloadAssets(
+    [
+      {
+        role: "tool",
+        content: [
+          {
+            type: "tool-result",
+            toolCallId,
+            toolName,
+            output: modelOutput
+          }
+        ]
+      }
+    ],
+    download,
+    supportedUrls
+  ) : {};
+  return mapToolResultOutput({
+    output: modelOutput,
+    provider,
+    downloadedAssets
+  });
+}
+
 // src/stream-text-iterator.ts
 import {
   experimental_filterActiveTools as filterActiveTools
@@ -763,10 +813,12 @@ var WorkflowAgent = class {
       // TODO: consider exposing this as a parameter
       ...effectivePrompt != null ? { prompt: effectivePrompt } : { messages: effectiveMessages }
     });
+    const download = (_i = options.experimental_download) != null ? _i : this.experimentalDownload;
     const { approvedToolApprovals, deniedToolApprovals } = collectToolApprovalsFromMessages(prompt.messages);
     if (approvedToolApprovals.length > 0 || deniedToolApprovals.length > 0) {
       const _toolResultMessages = [];
       const toolResultContent = [];
+      const approvedRawResults = [];
       for (const approval of approvedToolApprovals) {
         const tool2 = this.tools[approval.toolName];
         if (tool2 && typeof tool2.execute === "function") {
@@ -784,7 +836,7 @@ var WorkflowAgent = class {
               input: approval.input
             };
             const messages2 = prompt.messages;
-            await ((_i = telemetryDispatcher.onToolExecutionStart) == null ? void 0 : _i.call(telemetryDispatcher, {
+            await ((_j = telemetryDispatcher.onToolExecutionStart) == null ? void 0 : _j.call(telemetryDispatcher, {
               toolCall: toolCallEvent,
               stepNumber: 0,
               messages: messages2,
@@ -801,7 +853,7 @@ var WorkflowAgent = class {
               toolCallId: approval.toolCallId,
               execute: executeApprovedTool
             }) : await executeApprovedTool();
-            await ((_j = telemetryDispatcher.onToolExecutionEnd) == null ? void 0 : _j.call(telemetryDispatcher, {
+            await ((_k = telemetryDispatcher.onToolExecutionEnd) == null ? void 0 : _k.call(telemetryDispatcher, {
               toolCall: toolCallEvent,
               stepNumber: 0,
               durationMs: Date.now() - startTime,
@@ -814,10 +866,26 @@ var WorkflowAgent = class {
               type: "tool-result",
               toolCallId: approval.toolCallId,
               toolName: approval.toolName,
-              output: typeof toolResult === "string" ? { type: "text", value: toolResult } : { type: "json", value: toolResult }
+              output: await createLanguageModelToolResultOutput({
+                toolCallId: approval.toolCallId,
+                toolName: approval.toolName,
+                input: approval.input,
+                output: toolResult,
+                tool: tool2,
+                errorMode: "none",
+                supportedUrls: {},
+                download
+              })
+            });
+            approvedRawResults.push({
+              toolCallId: approval.toolCallId,
+              toolName: approval.toolName,
+              input: approval.input,
+              output: toolResult
             });
           } catch (error) {
-            await ((_k = telemetryDispatcher.onToolExecutionEnd) == null ? void 0 : _k.call(telemetryDispatcher, {
+            const errorMessage = getErrorMessage(error);
+            await ((_l = telemetryDispatcher.onToolExecutionEnd) == null ? void 0 : _l.call(telemetryDispatcher, {
               toolCall: {
                 type: "tool-call",
                 toolCallId: approval.toolCallId,
@@ -835,10 +903,22 @@ var WorkflowAgent = class {
               type: "tool-result",
               toolCallId: approval.toolCallId,
               toolName: approval.toolName,
-              output: {
-                type: "text",
-                value: getErrorMessage(error)
-              }
+              output: await createLanguageModelToolResultOutput({
+                toolCallId: approval.toolCallId,
+                toolName: approval.toolName,
+                input: approval.input,
+                output: errorMessage,
+                tool: tool2,
+                errorMode: "text",
+                supportedUrls: {},
+                download
+              })
+            });
+            approvedRawResults.push({
+              toolCallId: approval.toolCallId,
+              toolName: approval.toolName,
+              input: approval.input,
+              output: errorMessage
             });
           }
         }
@@ -882,21 +962,10 @@ var WorkflowAgent = class {
       }
       prompt.messages = cleanedMessages;
       if (options.writable && toolResultContent.length > 0) {
-        const approvedResults = toolResultContent.filter((r) => r.output.type !== "execution-denied").map((r) => {
-          var _a2;
-          return {
-            toolCallId: r.toolCallId,
-            toolName: r.toolName,
-            input: (_a2 = approvedToolApprovals.find(
-              (a) => a.toolCallId === r.toolCallId
-            )) == null ? void 0 : _a2.input,
-            output: "value" in r.output ? r.output.value : void 0
-          };
-        });
         const deniedResults = toolResultContent.filter((r) => r.output.type === "execution-denied").map((r) => ({ toolCallId: r.toolCallId }));
         await writeApprovalToolResults(
           options.writable,
-          approvedResults,
+          approvedRawResults,
           deniedResults
         );
       }
@@ -904,7 +973,7 @@ var WorkflowAgent = class {
     const modelPrompt = await convertToLanguageModelPrompt({
       prompt,
       supportedUrls: {},
-      download: (_l = options.experimental_download) != null ? _l : this.experimentalDownload
+      download
     });
     const effectiveAbortSignal = mergeAbortSignals(
       (_m = options.abortSignal) != null ? _m : effectiveGenerationSettings.abortSignal,
@@ -1043,7 +1112,7 @@ var WorkflowAgent = class {
       const startTime = Date.now();
       let result;
       try {
-        const execute = () => executeTool(toolCall, tools, messages2, resolvedContext);
+        const execute = () => executeTool(toolCall, tools, messages2, resolvedContext, download);
         result = telemetryDispatcher.executeTool != null ? await telemetryDispatcher.executeTool({
           callId: "workflow-agent",
           toolCallId: toolCall.toolCallId,
@@ -1075,8 +1144,7 @@ var WorkflowAgent = class {
       }
       const durationMs = Date.now() - startTime;
       if (mergedOnToolExecutionEnd) {
-        const isError = result.output && "type" in result.output && (result.output.type === "error-text" || result.output.type === "error-json");
-        if (isError) {
+        if (result.isError) {
           await mergedOnToolExecutionEnd({
             toolCall: toolCallEvent,
             stepNumber: currentStepNumber,
@@ -1084,7 +1152,7 @@ var WorkflowAgent = class {
             messages: modelMessages,
             toolContext: resolvedContext,
             success: false,
-            error: "value" in result.output ? result.output.value : void 0
+            error: result.rawOutput
           });
         } else {
           await mergedOnToolExecutionEnd({
@@ -1094,11 +1162,11 @@ var WorkflowAgent = class {
             messages: modelMessages,
             toolContext: resolvedContext,
             success: true,
-            output: result.output && "value" in result.output ? result.output.value : void 0
+            output: result.rawOutput
           });
         }
       }
-      if (result.output && "type" in result.output && (result.output.type === "error-text" || result.output.type === "error-json")) {
+      if (result.isError) {
         await ((_c2 = telemetryDispatcher.onToolExecutionEnd) == null ? void 0 : _c2.call(telemetryDispatcher, {
           toolCall: toolCallEvent,
           stepNumber: currentStepNumber,
@@ -1106,7 +1174,7 @@ var WorkflowAgent = class {
           messages: modelMessages,
           toolContext: resolvedContext,
           success: false,
-          error: "value" in result.output ? result.output.value : void 0
+          error: result.rawOutput
         }));
       } else {
         await ((_d2 = telemetryDispatcher.onToolExecutionEnd) == null ? void 0 : _d2.call(telemetryDispatcher, {
@@ -1116,7 +1184,7 @@ var WorkflowAgent = class {
           messages: modelMessages,
           toolContext: resolvedContext,
           success: true,
-          output: result.output && "value" in result.output ? result.output.value : void 0
+          output: result.rawOutput
         }));
       }
       return result;
@@ -1136,19 +1204,18 @@ var WorkflowAgent = class {
         messages: modelMessages,
         toolContext: void 0
       }));
-      const isError = result.output && "type" in result.output && (result.output.type === "error-text" || result.output.type === "error-json");
       await ((_b2 = telemetryDispatcher.onToolExecutionEnd) == null ? void 0 : _b2.call(telemetryDispatcher, {
         toolCall: toolCallEvent,
         stepNumber: currentStepNumber,
         durationMs: 0,
         messages: modelMessages,
         toolContext: void 0,
-        ...isError ? {
+        ...result.isError ? {
           success: false,
-          error: result.output && "value" in result.output ? result.output.value : void 0
+          error: result.rawOutput
         } : {
           success: true,
-          output: result.output && "value" in result.output ? result.output.value : void 0
+          output: result.rawOutput
         }
       }));
     };
@@ -1262,10 +1329,14 @@ var WorkflowAgent = class {
                 )
               )
             );
-            const providerResults = providerToolCalls.map(
-              (toolCall) => resolveProviderToolResult(
-                toolCall,
-                providerExecutedToolResults
+            const providerResults = await Promise.all(
+              providerToolCalls.map(
+                (toolCall) => resolveProviderToolResult(
+                  toolCall,
+                  providerExecutedToolResults,
+                  effectiveTools,
+                  download
+                )
               )
             );
             await Promise.all(
@@ -1282,8 +1353,8 @@ var WorkflowAgent = class {
               createInvalidToolResult
             );
             const resolvedResults = [
-              ...executableResults,
-              ...providerResults,
+              ...executableResults.map((result2) => result2.modelResult),
+              ...providerResults.map((result2) => result2.modelResult),
               ...continuationInvalidResults
             ];
             const executedResults = [...executableResults, ...providerResults];
@@ -1297,10 +1368,12 @@ var WorkflowAgent = class {
               var _a2;
               return {
                 type: "tool-result",
-                toolCallId: r.toolCallId,
-                toolName: r.toolName,
-                input: (_a2 = toolCalls.find((tc) => tc.toolCallId === r.toolCallId)) == null ? void 0 : _a2.input,
-                output: "value" in r.output ? r.output.value : void 0
+                toolCallId: r.modelResult.toolCallId,
+                toolName: r.modelResult.toolName,
+                input: (_a2 = toolCalls.find(
+                  (tc) => tc.toolCallId === r.modelResult.toolCallId
+                )) == null ? void 0 : _a2.input,
+                output: r.rawOutput
               };
             });
             if (resolvedResults.length > 0) {
@@ -1379,8 +1452,15 @@ var WorkflowAgent = class {
               )
             )
           );
-          const providerToolResults = providerToolCalls.map(
-            (toolCall) => resolveProviderToolResult(toolCall, providerExecutedToolResults)
+          const providerToolResults = await Promise.all(
+            providerToolCalls.map(
+              (toolCall) => resolveProviderToolResult(
+                toolCall,
+                providerExecutedToolResults,
+                effectiveTools,
+                download
+              )
+            )
           );
           await Promise.all(
             providerToolCalls.map(
@@ -1395,34 +1475,40 @@ var WorkflowAgent = class {
           const continuationInvalidToolResults = invalidToolCalls.map(
             createInvalidToolResult
           );
-          const continuationToolResults = toolCalls.flatMap((tc) => {
-            const invalidResult = continuationInvalidToolResults.find(
-              (r) => r.toolCallId === tc.toolCallId
-            );
-            if (invalidResult) return [invalidResult];
+          const executedToolResults = toolCalls.flatMap((tc) => {
             const clientResult = clientToolResults.find(
-              (r) => r.toolCallId === tc.toolCallId
+              (r) => r.modelResult.toolCallId === tc.toolCallId
             );
             if (clientResult) return [clientResult];
             const providerResult = providerToolResults.find(
-              (r) => r.toolCallId === tc.toolCallId
+              (r) => r.modelResult.toolCallId === tc.toolCallId
             );
             if (providerResult) return [providerResult];
             return [];
           });
-          const executedToolResults = continuationToolResults.filter(
-            (result2) => !invalidToolCalls.some((tc) => tc.toolCallId === result2.toolCallId)
-          );
+          const continuationToolResults = toolCalls.flatMap((tc) => {
+            const invalidResult = continuationInvalidToolResults.find(
+              (r) => r.toolCallId === tc.toolCallId
+            );
+            if (invalidResult) return [invalidResult];
+            const executedResult = executedToolResults.find(
+              (r) => r.modelResult.toolCallId === tc.toolCallId
+            );
+            if (executedResult) return [executedResult.modelResult];
+            return [];
+          });
           if (options.writable) {
             await writeToolResultsWithStepBoundary(
               options.writable,
               executedToolResults.map((r) => {
                 var _a2;
                 return {
-                  toolCallId: r.toolCallId,
-                  toolName: r.toolName,
-                  input: (_a2 = toolCalls.find((tc) => tc.toolCallId === r.toolCallId)) == null ? void 0 : _a2.input,
-                  output: "value" in r.output ? r.output.value : void 0
+                  toolCallId: r.modelResult.toolCallId,
+                  toolName: r.modelResult.toolName,
+                  input: (_a2 = toolCalls.find(
+                    (tc) => tc.toolCallId === r.modelResult.toolCallId
+                  )) == null ? void 0 : _a2.input,
+                  output: r.rawOutput
                 };
               })
             );
@@ -1437,10 +1523,12 @@ var WorkflowAgent = class {
             var _a2;
             return {
               type: "tool-result",
-              toolCallId: r.toolCallId,
-              toolName: r.toolName,
-              input: (_a2 = toolCalls.find((tc) => tc.toolCallId === r.toolCallId)) == null ? void 0 : _a2.input,
-              output: "value" in r.output ? r.output.value : void 0
+              toolCallId: r.modelResult.toolCallId,
+              toolName: r.modelResult.toolName,
+              input: (_a2 = toolCalls.find(
+                (tc) => tc.toolCallId === r.modelResult.toolCallId
+              )) == null ? void 0 : _a2.input,
+              output: r.rawOutput
             };
           });
           result = await iterator.next(continuationToolResults);
@@ -1654,47 +1742,46 @@ function aggregateUsage(steps) {
     totalTokens: inputTokens + outputTokens
   };
 }
-function getErrorMessage(error) {
-  if (error == null) {
-    return "unknown error";
-  }
-  if (typeof error === "string") {
-    return error;
-  }
-  if (error instanceof Error) {
-    return error.message;
-  }
-  return JSON.stringify(error);
-}
-function resolveProviderToolResult(toolCall, providerExecutedToolResults) {
+async function resolveProviderToolResult(toolCall, providerExecutedToolResults, tools, download) {
   const streamResult = providerExecutedToolResults == null ? void 0 : providerExecutedToolResults.get(toolCall.toolCallId);
   if (!streamResult) {
     console.warn(
       `[WorkflowAgent] Provider-executed tool "${toolCall.toolName}" (${toolCall.toolCallId}) did not receive a result from the stream. This may indicate a provider issue.`
     );
     return {
-      type: "tool-result",
-      toolCallId: toolCall.toolCallId,
-      toolName: toolCall.toolName,
-      output: {
-        type: "text",
-        value: ""
-      }
+      modelResult: {
+        type: "tool-result",
+        toolCallId: toolCall.toolCallId,
+        toolName: toolCall.toolName,
+        output: {
+          type: "text",
+          value: ""
+        }
+      },
+      rawOutput: "",
+      isError: false
     };
   }
   const result = streamResult.result;
-  const isString = typeof result === "string";
+  const errorMode = streamResult.isError ? typeof result === "string" ? "text" : "json" : "none";
   return {
-    type: "tool-result",
-    toolCallId: toolCall.toolCallId,
-    toolName: toolCall.toolName,
-    output: isString ? streamResult.isError ? { type: "error-text", value: result } : { type: "text", value: result } : streamResult.isError ? {
-      type: "error-json",
-      value: result
-    } : {
-      type: "json",
-      value: result
-    }
+    modelResult: {
+      type: "tool-result",
+      toolCallId: toolCall.toolCallId,
+      toolName: toolCall.toolName,
+      output: await createLanguageModelToolResultOutput({
+        toolCallId: toolCall.toolCallId,
+        toolName: toolCall.toolName,
+        input: toolCall.input,
+        output: result,
+        tool: tools == null ? void 0 : tools[toolCall.toolName],
+        errorMode,
+        supportedUrls: {},
+        download
+      })
+    },
+    rawOutput: result,
+    isError: streamResult.isError === true
   };
 }
 function createInvalidToolResult(toolCall) {
@@ -1713,7 +1800,7 @@ function getToolCallbackMessages(messages) {
   const withoutAssistantToolCall = ((_a = messages.at(-1)) == null ? void 0 : _a.role) === "assistant" ? messages.slice(0, -1) : messages;
   return withoutAssistantToolCall;
 }
-async function executeTool(toolCall, tools, messages, context) {
+async function executeTool(toolCall, tools, messages, context, download) {
   const tool2 = tools[toolCall.toolName];
   if (!tool2) throw new Error(`Tool "${toolCall.toolName}" not found`);
   if (typeof tool2.execute !== "function") {
@@ -1722,33 +1809,57 @@ async function executeTool(toolCall, tools, messages, context) {
     );
   }
   const parsedInput = toolCall.input;
+  let toolResult;
   try {
     const { execute } = tool2;
-    const toolResult = await execute(parsedInput, {
+    toolResult = await execute(parsedInput, {
       toolCallId: toolCall.toolCallId,
       // Pass the conversation messages to the tool so it has context about the conversation
       messages,
       // Pass per-tool context to the tool (resolved from `toolsContext`)
       context
     });
-    const output = typeof toolResult === "string" ? { type: "text", value: toolResult } : { type: "json", value: toolResult };
-    return {
-      type: "tool-result",
-      toolCallId: toolCall.toolCallId,
-      toolName: toolCall.toolName,
-      output
-    };
   } catch (error) {
+    const errorMessage = getErrorMessage(error);
     return {
+      modelResult: {
+        type: "tool-result",
+        toolCallId: toolCall.toolCallId,
+        toolName: toolCall.toolName,
+        output: await createLanguageModelToolResultOutput({
+          toolCallId: toolCall.toolCallId,
+          toolName: toolCall.toolName,
+          input: parsedInput,
+          output: errorMessage,
+          tool: tool2,
+          errorMode: "text",
+          supportedUrls: {},
+          download
+        })
+      },
+      rawOutput: errorMessage,
+      isError: true
+    };
+  }
+  return {
+    modelResult: {
       type: "tool-result",
       toolCallId: toolCall.toolCallId,
       toolName: toolCall.toolName,
-      output: {
-        type: "error-text",
-        value: getErrorMessage(error)
-      }
-    };
-  }
+      output: await createLanguageModelToolResultOutput({
+        toolCallId: toolCall.toolCallId,
+        toolName: toolCall.toolName,
+        input: parsedInput,
+        output: toolResult,
+        tool: tool2,
+        errorMode: "none",
+        supportedUrls: {},
+        download
+      })
+    },
+    rawOutput: toolResult,
+    isError: false
+  };
 }
 function collectToolApprovalsFromMessages(messages) {
   var _a;