@ai-sdk/workflow 1.0.0-beta.24 → 1.0.0-beta.27

package/CHANGELOG.md

@@ -1,5 +1,65 @@
 # @ai-sdk/workflow
 
+## 1.0.0-beta.27
+
+### Patch Changes
+
+- 29d8cf4: feat(ai): rename the core-event types
+- a0ca584: fix (workflow): preserve invalid tool calls as errors instead of emitting synthetic success results
+- Updated dependencies [785fe16]
+- Updated dependencies [5f3749c]
+- Updated dependencies [0a51f7d]
+- Updated dependencies [71d3022]
+- Updated dependencies [67df0a0]
+- Updated dependencies [4181cfe]
+- Updated dependencies [51ce232]
+- Updated dependencies [cf93359]
+- Updated dependencies [befb78c]
+- Updated dependencies [29d8cf4]
+- Updated dependencies [0458559]
+- Updated dependencies [58a2ad7]
+- Updated dependencies [5852c0a]
+- Updated dependencies [37d69b2]
+- Updated dependencies [1043274]
+- Updated dependencies [7f59f04]
+- Updated dependencies [7677c1e]
+- Updated dependencies [116c89f]
+- Updated dependencies [f58f9bc]
+- Updated dependencies [e1bfb9c]
+- Updated dependencies [e87d71b]
+- Updated dependencies [9d486aa]
+- Updated dependencies [9b0bc8a]
+- Updated dependencies [fc92055]
+- Updated dependencies [4e095b0]
+  - @ai-sdk/provider-utils@5.0.0-beta.27
+  - ai@7.0.0-beta.112
+
+## 1.0.0-beta.26
+
+### Major Changes
+
+- 1949571: feat(ai): make experimental_telemetry stable
+
+### Patch Changes
+
+- f32c750: refactoring(ai): simplify mergeAbortSignals
+- Updated dependencies [f319fde]
+- Updated dependencies [1949571]
+- Updated dependencies [511902c]
+- Updated dependencies [6542d93]
+- Updated dependencies [2e98477]
+- Updated dependencies [876fd3e]
+- Updated dependencies [f32c750]
+  - ai@7.0.0-beta.111
+  - @ai-sdk/provider-utils@5.0.0-beta.26
+
+## 1.0.0-beta.25
+
+### Patch Changes
+
+- Updated dependencies [72cb801]
+  - ai@7.0.0-beta.110
+
 ## 1.0.0-beta.24
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { LanguageModelV4, SharedV4ProviderOptions, LanguageModelV4CallOptions, LanguageModelV4Prompt, LanguageModelV4StreamPart } from '@ai-sdk/provider';
-import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StopCondition, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, StreamTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
+import { ToolSet, LanguageModel, SystemModelMessage, ToolChoice, StopCondition, ActiveTools, LanguageModelResponseMetadata, LanguageModelUsage, FinishReason, ToolCallRepairFunction, StepResult, GenerateTextOnStepFinishCallback, ModelMessage, Experimental_LanguageModelStreamPart, UIMessage, UIMessageChunk, ChatTransport, PrepareSendMessagesRequest, PrepareReconnectToStreamRequest, ChatRequestOptions } from 'ai';
 export { Experimental_LanguageModelStreamPart as ModelCallStreamPart, Output, ToolCallRepairFunction } from 'ai';
 
 /**
@@ -15,10 +15,10 @@ type CompatibleLanguageModel = LanguageModelV4;
 
 /**
  * Callback function to be called after each step completes.
- * Alias for the AI SDK's StreamTextOnStepFinishCallback, using
+ * Alias for the AI SDK's GenerateTextOnStepFinishCallback, using
  * WorkflowAgent-consistent naming.
  */
-type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet> = StreamTextOnStepFinishCallback<TTools, any>;
+type WorkflowAgentOnStepFinishCallback<TTools extends ToolSet = ToolSet> = GenerateTextOnStepFinishCallback<TTools, any>;
 /**
  * Infer the type of the tools of a workflow agent.
  */
@@ -252,6 +252,10 @@ interface PrepareCallOptions<TTools extends ToolSet = ToolSet> extends Partial<G
     tools: TTools;
     instructions?: string | SystemModelMessage | Array<SystemModelMessage>;
     toolChoice?: ToolChoice<TTools>;
+    telemetry?: TelemetryOptions;
+    /**
+     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
+     */
     experimental_telemetry?: TelemetryOptions;
     experimental_context?: unknown;
     messages: ModelMessage[];
@@ -303,7 +307,13 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
      */
     toolChoice?: ToolChoice<TTools>;
     /**
-     * Optional telemetry configuration (experimental).
+     * Optional telemetry configuration.
+     */
+    telemetry?: TelemetryOptions;
+    /**
+     * Optional telemetry configuration.
+     *
+     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
      */
     experimental_telemetry?: TelemetryOptions;
     /**
@@ -327,7 +337,7 @@ interface WorkflowAgentOptions<TTools extends ToolSet = ToolSet> extends Generat
      *
      * Per-stream `activeTools` values passed to `stream()` override this default.
      */
-    activeTools?: Array<keyof NoInfer<TTools>>;
+    activeTools?: ActiveTools<NoInfer<TTools>>;
     /**
      * Default output specification for structured outputs.
      * Use `Output.object({ schema })` for structured output or `Output.text()` for text output.
@@ -567,9 +577,15 @@ type WorkflowAgentStreamOptions<TTools extends ToolSet = ToolSet, OUTPUT = never
      * Limits the tools that are available for the model to call without
      * changing the tool call and result types in the result.
      */
-    activeTools?: Array<keyof NoInfer<TTools>>;
+    activeTools?: ActiveTools<NoInfer<TTools>>;
+    /**
+     * Optional telemetry configuration.
+     */
+    telemetry?: TelemetryOptions;
     /**
-     * Optional telemetry configuration (experimental).
+     * Optional telemetry configuration.
+     *
+     * @deprecated Use `telemetry` instead. This alias will be removed in a future major release.
      */
     experimental_telemetry?: TelemetryOptions;
     /**

package/dist/index.mjs

@@ -28,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;
       }
@@ -45,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,
@@ -53,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)
           })
         ];
@@ -91,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,
@@ -279,7 +283,7 @@ async function* streamTextIterator({
   generationSettings,
   toolChoice,
   experimental_context,
-  experimental_telemetry,
+  telemetry,
   includeRawChunks = false,
   repairToolCall,
   responseFormat
@@ -427,7 +431,7 @@ async function* streamTextIterator({
           ...currentGenerationSettings,
           toolChoice: currentToolChoice,
           includeRawChunks,
-          experimental_telemetry,
+          telemetry,
           repairToolCall,
           responseFormat
         }
@@ -544,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;
@@ -584,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, _B;
+    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;
@@ -592,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,
@@ -616,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;
@@ -641,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);
@@ -737,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,
@@ -800,11 +809,11 @@ var WorkflowAgent = class {
     );
     const effectiveToolChoice = effectiveToolChoiceFromPrepare;
     const effectiveTelemetry = effectiveTelemetryFromPrepare;
-    const effectiveActiveTools = (_h = options.activeTools) != null ? _h : this.activeTools;
-    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? (_i = filterActiveTools2({
+    const effectiveActiveTools = (_i = options.activeTools) != null ? _i : this.activeTools;
+    const effectiveTools = effectiveActiveTools && effectiveActiveTools.length > 0 ? (_j = filterActiveTools2({
       tools: this.tools,
       activeTools: effectiveActiveTools
-    })) != null ? _i : this.tools : this.tools;
+    })) != null ? _j : this.tools : this.tools;
     let experimentalContext = effectiveExperimentalContext;
     const steps = [];
     let lastStepToolCalls = [];
@@ -868,7 +877,7 @@ var WorkflowAgent = class {
       }
       return result;
     };
-    if ((_j = mergedGenerationSettings.abortSignal) == null ? void 0 : _j.aborted) {
+    if ((_k = mergedGenerationSettings.abortSignal) == null ? void 0 : _k.aborted) {
       if (options.onAbort) {
         await options.onAbort({ steps });
       }
@@ -885,18 +894,18 @@ var WorkflowAgent = class {
       tools: effectiveTools,
       writable: options.writable,
       prompt: modelPrompt,
-      stopConditions: (_k = options.stopWhen) != null ? _k : this.stopWhen,
+      stopConditions: (_l = options.stopWhen) != null ? _l : this.stopWhen,
       onStepFinish: mergedOnStepFinish,
       onStepStart: mergedOnStepStart,
       onError: options.onError,
-      prepareStep: (_l = options.prepareStep) != null ? _l : this.prepareStep,
+      prepareStep: (_m = options.prepareStep) != null ? _m : this.prepareStep,
       generationSettings: mergedGenerationSettings,
       toolChoice: effectiveToolChoice,
       experimental_context: experimentalContext,
-      experimental_telemetry: effectiveTelemetry,
-      includeRawChunks: (_m = options.includeRawChunks) != null ? _m : false,
-      repairToolCall: (_n = options.experimental_repairToolCall) != null ? _n : this.experimentalRepairToolCall,
-      responseFormat: await ((_p = (_o = options.output) != null ? _o : this.output) == null ? void 0 : _p.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;
@@ -904,7 +913,7 @@ var WorkflowAgent = class {
     try {
       let result = await iterator.next();
       while (!result.done) {
-        if ((_q = mergedGenerationSettings.abortSignal) == null ? void 0 : _q.aborted) {
+        if ((_r = mergedGenerationSettings.abortSignal) == null ? void 0 : _r.aborted) {
           wasAborted = true;
           if (options.onAbort) {
             await options.onAbort({ steps });
@@ -926,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];
@@ -970,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",
@@ -999,8 +1020,8 @@ var WorkflowAgent = class {
               await mergedOnFinish({
                 steps,
                 messages: messages2,
-                text: (_r = lastStep == null ? void 0 : lastStep.text) != null ? _r : "",
-                finishReason: (_s = lastStep == null ? void 0 : lastStep.finishReason) != null ? _s : "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
@@ -1024,8 +1045,8 @@ var WorkflowAgent = class {
               }
             }
             if (options.writable) {
-              const sendFinish = (_t = options.sendFinish) != null ? _t : true;
-              const preventClose = (_u = options.preventClose) != null ? _u : 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);
               }
@@ -1052,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,
@@ -1088,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",
@@ -1098,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 = [];
@@ -1120,7 +1146,7 @@ var WorkflowAgent = class {
       }
     }
     const messages = finalMessages != null ? finalMessages : prompt.messages;
-    const effectiveOutput = (_v = options.output) != null ? _v : 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];
@@ -1147,8 +1173,8 @@ var WorkflowAgent = class {
       await mergedOnFinish({
         steps,
         messages,
-        text: (_w = lastStep == null ? void 0 : lastStep.text) != null ? _w : "",
-        finishReason: (_x = lastStep == null ? void 0 : lastStep.finishReason) != null ? _x : "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
@@ -1156,8 +1182,8 @@ var WorkflowAgent = class {
     }
     if (encounteredError) {
       if (options.writable) {
-        const sendFinish = (_y = options.sendFinish) != null ? _y : true;
-        const preventClose = (_z = options.preventClose) != null ? _z : 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);
         }
@@ -1165,8 +1191,8 @@ var WorkflowAgent = class {
       throw encounteredError;
     }
     if (options.writable) {
-      const sendFinish = (_A = options.sendFinish) != null ? _A : true;
-      const preventClose = (_B = options.preventClose) != null ? _B : 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);
       }
@@ -1310,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`);