ai 3.4.11 → 3.4.13

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 3.4.13
+
+### Patch Changes
+
+- fc39158: fix (ai/core): add abortSignal to tool helper function
+
+## 3.4.12
+
+### Patch Changes
+
+- a23da5b: feat (ai/core): forward abort signal to tools
+
 ## 3.4.11
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1233,16 +1233,25 @@ interface CoreTool<PARAMETERS extends Parameters = any, RESULT = any> {
     /**
   An async function that is called with the arguments from the tool call and produces a result.
   If not provided, the tool will not be executed automatically.
+  
+  @args is the input of the tool call.
+  @options.abortSignal is a signal that can be used to abort the tool call.
      */
-    execute?: (args: inferParameters<PARAMETERS>) => PromiseLike<RESULT>;
+    execute?: (args: inferParameters<PARAMETERS>, options: {
+        abortSignal?: AbortSignal;
+    }) => PromiseLike<RESULT>;
 }
 /**
 Helper function for inferring the execute args of a tool.
  */
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: {
+        abortSignal?: AbortSignal;
+    }) => PromiseLike<RESULT>;
 }): CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: {
+        abortSignal?: AbortSignal;
+    }) => PromiseLike<RESULT>;
 };
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
     execute?: undefined;

package/dist/index.d.ts

@@ -1233,16 +1233,25 @@ interface CoreTool<PARAMETERS extends Parameters = any, RESULT = any> {
     /**
   An async function that is called with the arguments from the tool call and produces a result.
   If not provided, the tool will not be executed automatically.
+  
+  @args is the input of the tool call.
+  @options.abortSignal is a signal that can be used to abort the tool call.
      */
-    execute?: (args: inferParameters<PARAMETERS>) => PromiseLike<RESULT>;
+    execute?: (args: inferParameters<PARAMETERS>, options: {
+        abortSignal?: AbortSignal;
+    }) => PromiseLike<RESULT>;
 }
 /**
 Helper function for inferring the execute args of a tool.
  */
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: {
+        abortSignal?: AbortSignal;
+    }) => PromiseLike<RESULT>;
 }): CoreTool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>) => PromiseLike<RESULT>;
+    execute: (args: inferParameters<PARAMETERS>, options: {
+        abortSignal?: AbortSignal;
+    }) => PromiseLike<RESULT>;
 };
 declare function tool<PARAMETERS extends Parameters, RESULT>(tool: CoreTool<PARAMETERS, RESULT> & {
     execute?: undefined;

package/dist/index.js

@@ -3337,7 +3337,8 @@ async function generateText({
           toolCalls: currentToolCalls,
           tools,
           tracer,
-          telemetry
+          telemetry,
+          abortSignal
         });
         const currentUsage = calculateLanguageModelUsage(
           currentModelResponse.usage
@@ -3467,7 +3468,8 @@ async function executeTools({
   toolCalls,
   tools,
   tracer,
-  telemetry
+  telemetry,
+  abortSignal
 }) {
   const toolResults = await Promise.all(
     toolCalls.map(async (toolCall) => {
@@ -3493,7 +3495,7 @@ async function executeTools({
         }),
         tracer,
         fn: async (span) => {
-          const result2 = await tool2.execute(toolCall.args);
+          const result2 = await tool2.execute(toolCall.args, { abortSignal });
           try {
             span.setAttributes(
               selectTelemetryAttributes({
@@ -3703,7 +3705,8 @@ function runToolsTransformation({
   generatorStream,
   toolCallStreaming,
   tracer,
-  telemetry
+  telemetry,
+  abortSignal
 }) {
   let canClose = false;
   const outstandingToolCalls = /* @__PURE__ */ new Set();
@@ -3789,7 +3792,7 @@ function runToolsTransformation({
                   }
                 }),
                 tracer,
-                fn: async (span) => tool2.execute(toolCall.args).then(
+                fn: async (span) => tool2.execute(toolCall.args, { abortSignal }).then(
                   (result) => {
                     toolResultsStreamController.enqueue({
                       ...toolCall,
@@ -4010,7 +4013,8 @@ async function streamText({
               generatorStream: stream2,
               toolCallStreaming,
               tracer,
-              telemetry
+              telemetry,
+              abortSignal
             }),
             warnings: warnings2,
             rawResponse: rawResponse2