@ai-sdk/provider-utils 4.0.57 → 4.0.58

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/provider-utils
 
+## 4.0.58
+
+### Patch Changes
+
+- 604b4d3: docs(provider-utils): clarify how `ToolApprovalResponse.reason` is handled for approved and denied tool calls
+
 ## 4.0.57
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1062,6 +1062,13 @@ type ToolApprovalResponse = {
     approved: boolean;
     /**
      * Optional reason for the approval or denial.
+     *
+     * For denied tool calls, the reason is included in the `execution-denied`
+     * tool result that is sent to the model. For approved tool calls that are
+     * executed by the SDK, the reason remains in the message history: it is not
+     * included in the model prompt and is not exposed through a dedicated tool
+     * execution option. For provider-executed tools, the approval response
+     * (including the reason) is forwarded to the provider.
      */
     reason?: string;
     /**

package/dist/index.d.ts

@@ -1062,6 +1062,13 @@ type ToolApprovalResponse = {
     approved: boolean;
     /**
      * Optional reason for the approval or denial.
+     *
+     * For denied tool calls, the reason is included in the `execution-denied`
+     * tool result that is sent to the model. For approved tool calls that are
+     * executed by the SDK, the reason remains in the message history: it is not
+     * included in the model prompt and is not exposed through a dedicated tool
+     * execution option. For provider-executed tools, the approval response
+     * (including the reason) is forwarded to the provider.
      */
     reason?: string;
     /**

package/dist/index.js

@@ -954,7 +954,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.57" : "0.0.0-test";
+var VERSION = true ? "4.0.58" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;

package/dist/index.mjs

@@ -848,7 +848,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.57" : "0.0.0-test";
+var VERSION = true ? "4.0.58" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider-utils",
-  "version": "4.0.57",
+  "version": "4.0.58",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",

package/src/types/tool-approval-response.ts

@@ -16,6 +16,13 @@ export type ToolApprovalResponse = {
 
   /**
    * Optional reason for the approval or denial.
+   *
+   * For denied tool calls, the reason is included in the `execution-denied`
+   * tool result that is sent to the model. For approved tool calls that are
+   * executed by the SDK, the reason remains in the message history: it is not
+   * included in the model prompt and is not exposed through a dedicated tool
+   * execution option. For provider-executed tools, the approval response
+   * (including the reason) is forwarded to the provider.
    */
   reason?: string;