@ai-sdk/workflow 1.0.0-beta.9 → 1.0.0-canary.33

package/dist/index.mjs

@@ -1,6 +1,7 @@
 // src/workflow-agent.ts
 import {
-  Output
+  Output,
+  experimental_filterActiveTools as filterActiveTools2
 } from "ai";
 import {
   convertToLanguageModelPrompt,
@@ -9,11 +10,16 @@ import {
   standardizePrompt
 } from "ai/internal";
 
+// src/stream-text-iterator.ts
+import {
+  experimental_filterActiveTools as filterActiveTools
+} from "ai";
+
 // src/do-stream-step.ts
 import {
-  experimental_streamLanguageModelCall as streamModelCall
+  experimental_streamLanguageModelCall as streamModelCall,
+  gateway
 } from "ai";
-import { gateway } from "ai";
 
 // src/serializable-schema.ts
 import { asSchema, jsonSchema } from "@ai-sdk/provider-utils";
@@ -22,12 +28,14 @@ import Ajv from "ajv";
 function serializeToolSet(tools) {
   return Object.fromEntries(
     Object.entries(tools).map(([name, t]) => {
+      var _a;
       const def = {
         description: t.description,
         inputSchema: asSchema(t.inputSchema).jsonSchema
       };
       if (t.type === "provider") {
         def.type = "provider";
+        def.isProviderExecuted = (_a = t.isProviderExecuted) != null ? _a : false;
         def.id = t.id;
         def.args = t.args;
       }
@@ -39,7 +47,7 @@ function resolveSerializableTools(tools) {
   const ajv = new Ajv();
   return Object.fromEntries(
     Object.entries(tools).map(([name, t]) => {
-      var _a;
+      var _a, _b;
       if (t.type === "provider") {
         return [
           name,
@@ -47,6 +55,7 @@ function resolveSerializableTools(tools) {
             type: "provider",
             id: t.id,
             args: (_a = t.args) != null ? _a : {},
+            isProviderExecuted: (_b = t.isProviderExecuted) != null ? _b : false,
             inputSchema: jsonSchema(t.inputSchema)
           })
         ];
@@ -85,6 +94,7 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
     // pre-converted LanguageModelV4Prompt. standardizePrompt inside
     // streamModelCall handles both formats.
     messages: conversationPrompt,
+    allowSystemInMessages: true,
     tools,
     toolChoice: options == null ? void 0 : options.toolChoice,
     includeRawChunks: options == null ? void 0 : options.includeRawChunks,
@@ -187,7 +197,8 @@ async function doStreamStep(conversationPrompt, modelInit, writable, serializedT
     },
     functionId: void 0,
     metadata: void 0,
-    context: void 0,
+    runtimeContext: void 0,
+    toolsContext: {},
     content: [
       ...text ? [{ type: "text", text }] : [],
       ...toolCalls.filter((tc) => !tc.invalid).map((tc) => ({
@@ -265,7 +276,6 @@ async function* streamTextIterator({
   writable,
   model,
   stopConditions,
-  maxSteps,
   onStepFinish,
   onStepStart,
   onError,
@@ -273,12 +283,12 @@ async function* streamTextIterator({
   generationSettings,
   toolChoice,
   experimental_context,
-  experimental_telemetry,
+  telemetry,
   includeRawChunks = false,
   repairToolCall,
   responseFormat
 }) {
-  var _a;
+  var _a, _b;
   let conversationPrompt = [...prompt];
   let currentModel = model;
   let currentGenerationSettings = generationSettings != null ? generationSettings : {};
@@ -291,11 +301,7 @@ async function* streamTextIterator({
   let stepNumber = 0;
   let lastStep;
   let lastStepWasToolCalls = false;
-  const effectiveMaxSteps = maxSteps != null ? maxSteps : Infinity;
   while (!done) {
-    if (stepNumber >= effectiveMaxSteps) {
-      break;
-    }
     if ((_a = currentGenerationSettings.abortSignal) == null ? void 0 : _a.aborted) {
       break;
     }
@@ -411,7 +417,10 @@ async function* streamTextIterator({
       });
     }
     try {
-      const effectiveTools = currentActiveTools && currentActiveTools.length > 0 ? filterToolSet(tools, currentActiveTools) : tools;
+      const effectiveTools = currentActiveTools && currentActiveTools.length > 0 ? (_b = filterActiveTools({
+        tools,
+        activeTools: currentActiveTools
+      })) != null ? _b : tools : tools;
       const serializedTools = serializeToolSet(effectiveTools);
       const { toolCalls, finish, step, providerExecutedToolResults } = await doStreamStep(
         conversationPrompt,
@@ -422,7 +431,7 @@ async function* streamTextIterator({
           ...currentGenerationSettings,
           toolChoice: currentToolChoice,
           includeRawChunks,
-          experimental_telemetry,
+          telemetry,
           repairToolCall,
           responseFormat
         }
@@ -515,15 +524,6 @@ async function* streamTextIterator({
   }
   return conversationPrompt;
 }
-function filterToolSet(tools, activeTools) {
-  const filtered = {};
-  for (const toolName of activeTools) {
-    if (toolName in tools) {
-      filtered[toolName] = tools[toolName];
-    }
-  }
-  return filtered;
-}
 function sanitizeProviderMetadataForToolCall(metadata) {
   if (metadata == null) return void 0;
   const meta = metadata;
@@ -548,13 +548,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;
@@ -566,8 +566,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,
@@ -588,7 +588,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;
+    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;
@@ -596,14 +596,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,
@@ -620,7 +621,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;
@@ -645,6 +648,8 @@ var WorkflowAgent = class {
     }
     const prompt = await standardizePrompt({
       system: effectiveInstructions,
+      allowSystemInMessages: true,
+      // TODO: consider exposing this as a parameter
       ...effectivePrompt != null ? { prompt: effectivePrompt } : { messages: effectiveMessages }
     });
     const { approvedToolApprovals, deniedToolApprovals } = collectToolApprovalsFromMessages(prompt.messages);
@@ -741,11 +746,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,
@@ -794,18 +799,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 ? filterTools(this.tools, effectiveActiveTools) : this.tools;
+    const effectiveActiveTools = (_i = options.activeTools) != null ? _i : this.activeTools;
+    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? (_j = filterActiveTools2({
+      tools: this.tools,
+      activeTools: effectiveActiveTools
+    })) != null ? _j : this.tools : this.tools;
     let experimentalContext = effectiveExperimentalContext;
     const steps = [];
     let lastStepToolCalls = [];
@@ -823,8 +831,8 @@ var WorkflowAgent = class {
         toolName: toolCall.toolName,
         input: toolCall.input
       };
-      if (mergedOnToolCallStart) {
-        await mergedOnToolCallStart({
+      if (mergedOnToolExecutionStart) {
+        await mergedOnToolExecutionStart({
           toolCall: toolCallEvent,
           stepNumber: currentStepNumber
         });
@@ -835,8 +843,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,
@@ -847,10 +855,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,
@@ -858,7 +866,7 @@ var WorkflowAgent = class {
             error: "value" in result.output ? result.output.value : void 0
           });
         } else {
-          await mergedOnToolCallFinish({
+          await mergedOnToolExecutionEnd({
             toolCall: toolCallEvent,
             stepNumber: currentStepNumber,
             durationMs,
@@ -869,7 +877,7 @@ var WorkflowAgent = class {
       }
       return result;
     };
-    if ((_i = mergedGenerationSettings.abortSignal) == null ? void 0 : _i.aborted) {
+    if ((_k = mergedGenerationSettings.abortSignal) == null ? void 0 : _k.aborted) {
       if (options.onAbort) {
         await options.onAbort({ steps });
       }
@@ -886,19 +894,18 @@ var WorkflowAgent = class {
       tools: effectiveTools,
       writable: options.writable,
       prompt: modelPrompt,
-      stopConditions: (_j = options.stopWhen) != null ? _j : this.stopWhen,
-      maxSteps: options.maxSteps,
+      stopConditions: (_l = options.stopWhen) != null ? _l : this.stopWhen,
       onStepFinish: mergedOnStepFinish,
       onStepStart: mergedOnStepStart,
       onError: options.onError,
-      prepareStep: (_k = options.prepareStep) != null ? _k : this.prepareStep,
+      prepareStep: (_m = options.prepareStep) != null ? _m : this.prepareStep,
       generationSettings: mergedGenerationSettings,
       toolChoice: effectiveToolChoice,
       experimental_context: experimentalContext,
-      experimental_telemetry: effectiveTelemetry,
-      includeRawChunks: (_l = options.includeRawChunks) != null ? _l : false,
-      repairToolCall: (_m = options.experimental_repairToolCall) != null ? _m : this.experimentalRepairToolCall,
-      responseFormat: await ((_o = (_n = options.output) != null ? _n : this.output) == null ? void 0 : _o.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;
@@ -906,7 +913,7 @@ var WorkflowAgent = class {
     try {
       let result = await iterator.next();
       while (!result.done) {
-        if ((_p = mergedGenerationSettings.abortSignal) == null ? void 0 : _p.aborted) {
+        if ((_r = mergedGenerationSettings.abortSignal) == null ? void 0 : _r.aborted) {
           wasAborted = true;
           if (options.onAbort) {
             await options.onAbort({ steps });
@@ -928,10 +935,14 @@ var WorkflowAgent = class {
           experimentalContext = context;
         }
         if (toolCalls.length > 0) {
-          const nonProviderToolCalls = toolCalls.filter(
+          const invalidToolCalls = toolCalls.filter((tc) => tc.invalid === true);
+          const validToolCalls = toolCalls.filter((tc) => tc.invalid !== true);
+          const nonProviderToolCalls = validToolCalls.filter(
             (tc) => !tc.providerExecuted
           );
-          const providerToolCalls = toolCalls.filter((tc) => tc.providerExecuted);
+          const providerToolCalls = validToolCalls.filter(
+            (tc) => tc.providerExecuted
+          );
           const approvalNeeded = await Promise.all(
             nonProviderToolCalls.map(async (tc) => {
               const tool2 = effectiveTools[tc.toolName];
@@ -972,14 +983,22 @@ var WorkflowAgent = class {
                 providerExecutedToolResults
               )
             );
-            const resolvedResults = [...executableResults, ...providerResults];
+            const continuationInvalidResults = invalidToolCalls.map(
+              createInvalidToolResult
+            );
+            const resolvedResults = [
+              ...executableResults,
+              ...providerResults,
+              ...continuationInvalidResults
+            ];
+            const executedResults = [...executableResults, ...providerResults];
             const allToolCalls = toolCalls.map((tc) => ({
               type: "tool-call",
               toolCallId: tc.toolCallId,
               toolName: tc.toolName,
               input: tc.input
             }));
-            const allToolResults = resolvedResults.map((r) => {
+            const allToolResults = executedResults.map((r) => {
               var _a2;
               return {
                 type: "tool-result",
@@ -1001,8 +1020,8 @@ var WorkflowAgent = class {
               await mergedOnFinish({
                 steps,
                 messages: messages2,
-                text: (_q = lastStep == null ? void 0 : lastStep.text) != null ? _q : "",
-                finishReason: (_r = lastStep == null ? void 0 : lastStep.finishReason) != null ? _r : "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
@@ -1026,8 +1045,8 @@ var WorkflowAgent = class {
               }
             }
             if (options.writable) {
-              const sendFinish = (_s = options.sendFinish) != null ? _s : true;
-              const preventClose = (_t = options.preventClose) != null ? _t : 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);
               }
@@ -1054,26 +1073,31 @@ var WorkflowAgent = class {
           const providerToolResults = providerToolCalls.map(
             (toolCall) => resolveProviderToolResult(toolCall, providerExecutedToolResults)
           );
-          const toolResults = toolCalls.map((tc) => {
+          const continuationInvalidToolResults = invalidToolCalls.map(
+            createInvalidToolResult
+          );
+          const continuationToolResults = toolCalls.flatMap((tc) => {
+            const invalidResult = continuationInvalidToolResults.find(
+              (r) => r.toolCallId === tc.toolCallId
+            );
+            if (invalidResult) return [invalidResult];
             const clientResult = clientToolResults.find(
               (r) => r.toolCallId === tc.toolCallId
             );
-            if (clientResult) return clientResult;
+            if (clientResult) return [clientResult];
             const providerResult = providerToolResults.find(
               (r) => r.toolCallId === tc.toolCallId
             );
-            if (providerResult) return providerResult;
-            return {
-              type: "tool-result",
-              toolCallId: tc.toolCallId,
-              toolName: tc.toolName,
-              output: { type: "text", value: "" }
-            };
+            if (providerResult) return [providerResult];
+            return [];
           });
+          const executedToolResults = continuationToolResults.filter(
+            (result2) => !invalidToolCalls.some((tc) => tc.toolCallId === result2.toolCallId)
+          );
           if (options.writable) {
             await writeToolResultsWithStepBoundary(
               options.writable,
-              toolResults.map((r) => {
+              executedToolResults.map((r) => {
                 var _a2;
                 return {
                   toolCallId: r.toolCallId,
@@ -1090,7 +1114,7 @@ var WorkflowAgent = class {
             toolName: tc.toolName,
             input: tc.input
           }));
-          lastStepToolResults = toolResults.map((r) => {
+          lastStepToolResults = executedToolResults.map((r) => {
             var _a2;
             return {
               type: "tool-result",
@@ -1100,7 +1124,7 @@ var WorkflowAgent = class {
               output: "value" in r.output ? r.output.value : void 0
             };
           });
-          result = await iterator.next(toolResults);
+          result = await iterator.next(continuationToolResults);
         } else {
           lastStepToolCalls = [];
           lastStepToolResults = [];
@@ -1122,7 +1146,7 @@ var WorkflowAgent = class {
       }
     }
     const messages = finalMessages != null ? finalMessages : prompt.messages;
-    const effectiveOutput = (_u = options.output) != null ? _u : 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];
@@ -1149,8 +1173,8 @@ var WorkflowAgent = class {
       await mergedOnFinish({
         steps,
         messages,
-        text: (_v = lastStep == null ? void 0 : lastStep.text) != null ? _v : "",
-        finishReason: (_w = lastStep == null ? void 0 : lastStep.finishReason) != null ? _w : "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
@@ -1158,8 +1182,8 @@ var WorkflowAgent = class {
     }
     if (encounteredError) {
       if (options.writable) {
-        const sendFinish = (_x = options.sendFinish) != null ? _x : true;
-        const preventClose = (_y = options.preventClose) != null ? _y : 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);
         }
@@ -1167,8 +1191,8 @@ var WorkflowAgent = class {
       throw encounteredError;
     }
     if (options.writable) {
-      const sendFinish = (_z = options.sendFinish) != null ? _z : true;
-      const preventClose = (_A = options.preventClose) != null ? _A : 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);
       }
@@ -1269,15 +1293,6 @@ function aggregateUsage(steps) {
     totalTokens: inputTokens + outputTokens
   };
 }
-function filterTools(tools, activeTools) {
-  const filtered = {};
-  for (const toolName of activeTools) {
-    if (toolName in tools) {
-      filtered[toolName] = tools[toolName];
-    }
-  }
-  return filtered;
-}
 function getErrorMessage(error) {
   if (error == null) {
     return "unknown error";
@@ -1321,6 +1336,17 @@ function resolveProviderToolResult(toolCall, providerExecutedToolResults) {
     }
   };
 }
+function createInvalidToolResult(toolCall) {
+  return {
+    type: "tool-result",
+    toolCallId: toolCall.toolCallId,
+    toolName: toolCall.toolName,
+    output: {
+      type: "error-text",
+      value: getErrorMessage(toolCall.error)
+    }
+  };
+}
 async function executeTool(toolCall, tools, messages, experimentalContext) {
   const tool2 = tools[toolCall.toolName];
   if (!tool2) throw new Error(`Tool "${toolCall.toolName}" not found`);