@ai-sdk/provider-utils 3.1.0-beta.7 → 3.1.0-beta.9

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/provider-utils
 
+## 3.1.0-beta.9
+
+### Patch Changes
+
+- 521c537: feat(ai): Tool.needsApproval can be a function
+
+## 3.1.0-beta.8
+
+### Patch Changes
+
+- e06565c: feat(provider-utils): add needsApproval support to provider-defined tools
+
 ## 3.1.0-beta.7
 
 ### Patch Changes

package/dist/index.d.mts

@@ -698,7 +698,23 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
     /**
   Whether the tool needs approval before it can be executed.
      */
-    needsApproval?: boolean;
+    needsApproval?: boolean | ((input: [INPUT] extends [never] ? unknown : INPUT, options: {
+        /**
+         * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+         */
+        toolCallId: string;
+        /**
+         * Messages that were sent to the language model to initiate the response that contained the tool call.
+         * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
+         */
+        messages: ModelMessage[];
+        /**
+         * Additional context.
+         *
+         * Experimental (can break in patch releases).
+         */
+        experimental_context?: unknown;
+    }) => boolean | PromiseLike<boolean>);
     /**
      * Optional function that is called when the argument streaming starts.
      * Only called when the tool is used in a streaming context.
@@ -716,7 +732,7 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      * even if the execute function is not provided.
      */
     onInputAvailable?: (options: {
-        input: [INPUT] extends [never] ? undefined : INPUT;
+        input: [INPUT] extends [never] ? unknown : INPUT;
     } & ToolCallOptions) => void | PromiseLike<void>;
 } & ToolOutputProperties<INPUT, OUTPUT> & {
     /**
@@ -784,6 +800,7 @@ declare function dynamicTool(tool: {
 
 type ProviderDefinedToolFactory<INPUT, ARGS extends object> = <OUTPUT>(options: ARGS & {
     execute?: ToolExecuteFunction<INPUT, OUTPUT>;
+    needsApproval?: Tool<INPUT, OUTPUT>['needsApproval'];
     toModelOutput?: Tool<INPUT, OUTPUT>['toModelOutput'];
     onInputStart?: Tool<INPUT, OUTPUT>['onInputStart'];
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];
@@ -796,6 +813,7 @@ declare function createProviderDefinedToolFactory<INPUT, ARGS extends object>({
 }): ProviderDefinedToolFactory<INPUT, ARGS>;
 type ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object> = (options: ARGS & {
     execute?: ToolExecuteFunction<INPUT, OUTPUT>;
+    needsApproval?: Tool<INPUT, OUTPUT>['needsApproval'];
     toModelOutput?: Tool<INPUT, OUTPUT>['toModelOutput'];
     onInputStart?: Tool<INPUT, OUTPUT>['onInputStart'];
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];

package/dist/index.d.ts

@@ -698,7 +698,23 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
     /**
   Whether the tool needs approval before it can be executed.
      */
-    needsApproval?: boolean;
+    needsApproval?: boolean | ((input: [INPUT] extends [never] ? unknown : INPUT, options: {
+        /**
+         * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+         */
+        toolCallId: string;
+        /**
+         * Messages that were sent to the language model to initiate the response that contained the tool call.
+         * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
+         */
+        messages: ModelMessage[];
+        /**
+         * Additional context.
+         *
+         * Experimental (can break in patch releases).
+         */
+        experimental_context?: unknown;
+    }) => boolean | PromiseLike<boolean>);
     /**
      * Optional function that is called when the argument streaming starts.
      * Only called when the tool is used in a streaming context.
@@ -716,7 +732,7 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      * even if the execute function is not provided.
      */
     onInputAvailable?: (options: {
-        input: [INPUT] extends [never] ? undefined : INPUT;
+        input: [INPUT] extends [never] ? unknown : INPUT;
     } & ToolCallOptions) => void | PromiseLike<void>;
 } & ToolOutputProperties<INPUT, OUTPUT> & {
     /**
@@ -784,6 +800,7 @@ declare function dynamicTool(tool: {
 
 type ProviderDefinedToolFactory<INPUT, ARGS extends object> = <OUTPUT>(options: ARGS & {
     execute?: ToolExecuteFunction<INPUT, OUTPUT>;
+    needsApproval?: Tool<INPUT, OUTPUT>['needsApproval'];
     toModelOutput?: Tool<INPUT, OUTPUT>['toModelOutput'];
     onInputStart?: Tool<INPUT, OUTPUT>['onInputStart'];
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];
@@ -796,6 +813,7 @@ declare function createProviderDefinedToolFactory<INPUT, ARGS extends object>({
 }): ProviderDefinedToolFactory<INPUT, ARGS>;
 type ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object> = (options: ARGS & {
     execute?: ToolExecuteFunction<INPUT, OUTPUT>;
+    needsApproval?: Tool<INPUT, OUTPUT>['needsApproval'];
     toModelOutput?: Tool<INPUT, OUTPUT>['toModelOutput'];
     onInputStart?: Tool<INPUT, OUTPUT>['onInputStart'];
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];

package/dist/index.js

@@ -284,7 +284,7 @@ function handleFetchError({
 }
 
 // src/version.ts
-var VERSION = true ? "3.1.0-beta.7" : "0.0.0-test";
+var VERSION = true ? "3.1.0-beta.9" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;
@@ -844,6 +844,7 @@ function createProviderDefinedToolFactory({
   return ({
     execute,
     outputSchema,
+    needsApproval,
     toModelOutput,
     onInputStart,
     onInputDelta,
@@ -857,6 +858,7 @@ function createProviderDefinedToolFactory({
     inputSchema,
     outputSchema,
     execute,
+    needsApproval,
     toModelOutput,
     onInputStart,
     onInputDelta,
@@ -871,6 +873,7 @@ function createProviderDefinedToolFactoryWithOutputSchema({
 }) {
   return ({
     execute,
+    needsApproval,
     toModelOutput,
     onInputStart,
     onInputDelta,
@@ -884,6 +887,7 @@ function createProviderDefinedToolFactoryWithOutputSchema({
     inputSchema,
     outputSchema,
     execute,
+    needsApproval,
     toModelOutput,
     onInputStart,
     onInputDelta,