ai 7.0.86 → 7.0.87

package/dist/internal/index.js

@@ -91,7 +91,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "7.0.86" : "0.0.0-test";
+var VERSION = true ? "7.0.87" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({

package/docs/04-ai-sdk-ui/03-chatbot-tool-usage.mdx

@@ -543,6 +543,13 @@ For manual approval requests, the reason for requiring approval is available as
 `part.approval.requestReason`. It remains separate from an optional response
 reason supplied to `addToolApprovalResponse`.
 
+Approval request chunks can also include an `approvalDescriptor` with opaque
+application-specific metadata. UI message processing exposes it as
+`part.approval.descriptor` in the `approval-requested` state and preserves it in
+subsequent approval-bearing states, including `approval-responded`. This lets
+clients render or persist server-computed approval metadata without using it to
+determine whether the tool was approved.
+
 ### Securing Approvals for Sensitive Tools
 
 In the `useChat` pattern, the client sends the full message history to the server each turn. Without additional protection, a modified client could fabricate an approval response. For tools that perform sensitive operations, add `experimental_toolApprovalSecret` to your `streamText` call so the server cryptographically verifies that it issued the approval:

package/docs/04-ai-sdk-ui/50-stream-protocol.mdx

@@ -367,11 +367,15 @@ Format: Server-Sent Event with JSON object
 Example:
 
 ```
-data: {"type":"tool-approval-request","toolCallId":"call_fJdQDqnXeGxTmr4E3YPSR7Ar","approvalId":"approval_123","reason":"Requires operator review"}
+data: {"type":"tool-approval-request","toolCallId":"call_fJdQDqnXeGxTmr4E3YPSR7Ar","approvalId":"approval_123","approvalDescriptor":{"scope":"account:delete"},"reason":"Requires operator review"}
 
 ```
 
-When `isAutomatic` is omitted, the request expects an explicit approval response from the client. `reason` is optional and explains why the tool call requires approval.
+When `isAutomatic` is omitted, the request expects an explicit approval response
+from the client. `reason` is optional and explains why the tool call requires
+approval. `approvalDescriptor` is optional opaque metadata for the approval.
+When the stream is processed into UI messages, it is available as
+`part.approval.descriptor` and is retained through subsequent approval states.
 
 ### Tool Approval Response Part
 

package/docs/07-reference/01-ai-sdk-core/31-ui-message.mdx

@@ -150,6 +150,36 @@ type ToolUIPart<TOOLS extends UITools = UITools> = ValueOf<{
         output?: never;
         errorText?: never;
       }
+    | {
+        state: 'approval-requested';
+        input: TOOLS[NAME]['input'];
+        output?: never;
+        errorText?: never;
+        approval: {
+          id: string;
+          approved?: never;
+          descriptor?: unknown;
+          requestReason?: string;
+          reason?: never;
+          isAutomatic?: boolean;
+          signature?: string;
+        };
+      }
+    | {
+        state: 'approval-responded';
+        input: TOOLS[NAME]['input'];
+        output?: never;
+        errorText?: never;
+        approval: {
+          id: string;
+          approved: boolean;
+          descriptor?: unknown;
+          requestReason?: string;
+          reason?: string;
+          isAutomatic?: boolean;
+          signature?: string;
+        };
+      }
     | {
         state: 'output-available';
         input: TOOLS[NAME]['input'];
@@ -168,6 +198,11 @@ type ToolUIPart<TOOLS extends UITools = UITools> = ValueOf<{
 }>;
 ```
 
+`approval.descriptor` contains optional opaque metadata supplied as
+`approvalDescriptor` on the approval request stream chunk. It is preserved when
+the tool part transitions from `approval-requested` to `approval-responded` and
+in later approval-bearing output states.
+
 ### `CustomContentUIPart`
 
 A provider-specific custom content part of a message.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "7.0.86",
+  "version": "7.0.87",
   "type": "module",
   "description": "AI SDK by Vercel - build apps like ChatGPT, Claude, Gemini, and more with a single interface for any model using the Vercel AI Gateway or go direct to OpenAI, Anthropic, Google, or any other model provider.",
   "license": "Apache-2.0",
@@ -47,13 +47,13 @@
     "@ai-sdk/provider-utils": "5.0.34"
   },
   "devDependencies": {
-    "@ai-sdk/amazon-bedrock": "5.0.68",
+    "@ai-sdk/amazon-bedrock": "5.0.69",
     "@ai-sdk/deepseek": "3.0.37",
-    "@ai-sdk/google": "4.0.58",
+    "@ai-sdk/google": "4.0.59",
     "@ai-sdk/groq": "4.0.35",
     "@ai-sdk/huggingface": "2.0.41",
     "@ai-sdk/moonshotai": "3.0.43",
-    "@ai-sdk/openai": "4.0.52",
+    "@ai-sdk/openai": "4.0.53",
     "@ai-sdk/test-server": "2.0.1",
     "@ai-sdk/xai": "4.0.50",
     "@edge-runtime/vm": "^5.0.0",

package/src/ui/process-ui-message-stream.ts

@@ -748,6 +748,9 @@ export function processUIMessageStream<UI_MESSAGE extends UIMessage>({
               toolInvocation.state = 'approval-requested';
               toolInvocation.approval = {
                 id: chunk.approvalId,
+                ...(chunk.approvalDescriptor != null
+                  ? { descriptor: chunk.approvalDescriptor }
+                  : {}),
                 ...(chunk.reason != null
                   ? { requestReason: chunk.reason }
                   : {}),
@@ -771,16 +774,10 @@ export function processUIMessageStream<UI_MESSAGE extends UIMessage>({
 
               toolInvocation.state = 'approval-responded';
               toolInvocation.approval = {
+                ...approval,
                 id: chunk.approvalId,
                 approved: chunk.approved,
-                ...(approval.requestReason != null
-                  ? { requestReason: approval.requestReason }
-                  : {}),
                 ...(chunk.reason != null ? { reason: chunk.reason } : {}),
-                ...(approval.isAutomatic === true ? { isAutomatic: true } : {}),
-                ...(approval.signature != null
-                  ? { signature: approval.signature }
-                  : {}),
               };
               if (chunk.providerExecuted != null) {
                 toolInvocation.providerExecuted = chunk.providerExecuted;

package/src/ui/ui-messages.ts

@@ -319,6 +319,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval: {
         id: string;
         approved?: never;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: never;
         isAutomatic?: boolean;
@@ -334,6 +335,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval: {
         id: string;
         approved: boolean;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;
@@ -351,6 +353,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;
@@ -368,6 +371,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;
@@ -383,6 +387,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval: {
         id: string;
         approved: false;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;
@@ -442,6 +447,7 @@ export type DynamicToolUIPart = {
       approval: {
         id: string;
         approved?: never;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: never;
         isAutomatic?: boolean;
@@ -457,6 +463,7 @@ export type DynamicToolUIPart = {
       approval: {
         id: string;
         approved: boolean;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;
@@ -474,6 +481,7 @@ export type DynamicToolUIPart = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;
@@ -490,6 +498,7 @@ export type DynamicToolUIPart = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;
@@ -505,6 +514,7 @@ export type DynamicToolUIPart = {
       approval: {
         id: string;
         approved: false;
+        descriptor?: unknown;
         requestReason?: string;
         reason?: string;
         isAutomatic?: boolean;

package/src/ui/validate-ui-messages.ts

@@ -153,6 +153,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.never().optional(),
+                    descriptor: z.unknown().optional(),
                     requestReason: z.string().optional(),
                     reason: z.never().optional(),
                     isAutomatic: z.boolean().optional(),
@@ -173,6 +174,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.boolean(),
+                    descriptor: z.unknown().optional(),
                     requestReason: z.string().optional(),
                     reason: z.string().optional(),
                     isAutomatic: z.boolean().optional(),
@@ -196,6 +198,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       requestReason: z.string().optional(),
                       reason: z.string().optional(),
                       isAutomatic: z.boolean().optional(),
@@ -220,6 +223,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       requestReason: z.string().optional(),
                       reason: z.string().optional(),
                       isAutomatic: z.boolean().optional(),
@@ -241,6 +245,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.literal(false),
+                    descriptor: z.unknown().optional(),
                     requestReason: z.string().optional(),
                     reason: z.string().optional(),
                     isAutomatic: z.boolean().optional(),
@@ -284,6 +289,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.never().optional(),
+                    descriptor: z.unknown().optional(),
                     requestReason: z.string().optional(),
                     reason: z.never().optional(),
                     isAutomatic: z.boolean().optional(),
@@ -303,6 +309,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.boolean(),
+                    descriptor: z.unknown().optional(),
                     requestReason: z.string().optional(),
                     reason: z.string().optional(),
                     isAutomatic: z.boolean().optional(),
@@ -325,6 +332,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       requestReason: z.string().optional(),
                       reason: z.string().optional(),
                       isAutomatic: z.boolean().optional(),
@@ -348,6 +356,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       requestReason: z.string().optional(),
                       reason: z.string().optional(),
                       isAutomatic: z.boolean().optional(),
@@ -368,6 +377,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.literal(false),
+                    descriptor: z.unknown().optional(),
                     requestReason: z.string().optional(),
                     reason: z.string().optional(),
                     isAutomatic: z.boolean().optional(),

package/src/ui-message-stream/ui-message-chunks.ts

@@ -85,6 +85,7 @@ export const uiMessageChunkSchema = lazySchema(() =>
         type: z.literal('tool-approval-request'),
         approvalId: z.string(),
         toolCallId: z.string(),
+        approvalDescriptor: z.unknown().optional(),
         reason: z.string().optional(),
         isAutomatic: z.boolean().optional(),
         signature: z.string().optional(),
@@ -299,6 +300,7 @@ export type UIMessageChunk<
       type: 'tool-approval-request';
       approvalId: string;
       toolCallId: string;
+      approvalDescriptor?: unknown;
       reason?: string;
       isAutomatic?: boolean;
       signature?: string;