ai 6.0.273 → 6.0.274

package/dist/internal/index.js

@@ -164,7 +164,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.273" : "0.0.0-test";
+var VERSION = true ? "6.0.274" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({

package/dist/internal/index.mjs

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

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

@@ -480,6 +480,13 @@ export default function Chat() {
 }
 ```
 
+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
+the `approval-responded` state after `addToolApprovalResponse` is called. This
+lets clients render or persist server-computed approval metadata without using
+it to determine whether the tool was approved.
+
 ### Auto-Submit After Approval
 
 <Note>

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

@@ -324,6 +324,24 @@ data: {"type":"tool-input-available","toolCallId":"call_fJdQDqnXeGxTmr4E3YPSR7Ar
 
 ```
 
+### Tool Approval Request Part
+
+Indicates that a tool call requires approval.
+
+Format: Server-Sent Event with JSON object
+
+Example:
+
+```
+data: {"type":"tool-approval-request","toolCallId":"call_fJdQDqnXeGxTmr4E3YPSR7Ar","approvalId":"approval_123","approvalDescriptor":{"scope":"account:delete"}}
+
+```
+
+`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 when the client records an approval
+response.
+
 ### Tool Output Available Part
 
 Contains the result of tool execution.

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

@@ -150,6 +150,32 @@ 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;
+          reason?: never;
+          signature?: string;
+        };
+      }
+    | {
+        state: 'approval-responded';
+        input: TOOLS[NAME]['input'];
+        output?: never;
+        errorText?: never;
+        approval: {
+          id: string;
+          approved: boolean;
+          descriptor?: unknown;
+          reason?: string;
+          signature?: string;
+        };
+      }
     | {
         state: 'output-available';
         input: TOOLS[NAME]['input'];
@@ -168,6 +194,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 client transitions the tool part from `approval-requested` to
+`approval-responded`, and in later approval-bearing output states.
+
 ### `SourceUrlUIPart`
 
 A source URL part of a message.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "6.0.273",
+  "version": "6.0.274",
   "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",
   "sideEffects": false,

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

@@ -718,6 +718,9 @@ export function processUIMessageStream<UI_MESSAGE extends UIMessage>({
               toolInvocation.state = 'approval-requested';
               toolInvocation.approval = {
                 id: chunk.approvalId,
+                ...(chunk.approvalDescriptor != null
+                  ? { descriptor: chunk.approvalDescriptor }
+                  : {}),
                 ...(chunk.signature != null
                   ? { signature: chunk.signature }
                   : {}),

package/src/ui/ui-messages.ts

@@ -260,6 +260,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval: {
         id: string;
         approved?: never;
+        descriptor?: unknown;
         reason?: never;
         signature?: string;
       };
@@ -273,6 +274,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval: {
         id: string;
         approved: boolean;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };
@@ -288,6 +290,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };
@@ -303,6 +306,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };
@@ -316,6 +320,7 @@ export type UIToolInvocation<TOOL extends UITool | Tool> = {
       approval: {
         id: string;
         approved: false;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };
@@ -373,6 +378,7 @@ export type DynamicToolUIPart = {
       approval: {
         id: string;
         approved?: never;
+        descriptor?: unknown;
         reason?: never;
         signature?: string;
       };
@@ -386,6 +392,7 @@ export type DynamicToolUIPart = {
       approval: {
         id: string;
         approved: boolean;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };
@@ -401,6 +408,7 @@ export type DynamicToolUIPart = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };
@@ -415,6 +423,7 @@ export type DynamicToolUIPart = {
       approval?: {
         id: string;
         approved: true;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };
@@ -428,6 +437,7 @@ export type DynamicToolUIPart = {
       approval: {
         id: string;
         approved: false;
+        descriptor?: unknown;
         reason?: string;
         signature?: string;
       };

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

@@ -143,6 +143,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.never().optional(),
+                    descriptor: z.unknown().optional(),
                     reason: z.never().optional(),
                     signature: z.string().optional(),
                   }),
@@ -161,6 +162,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.boolean(),
+                    descriptor: z.unknown().optional(),
                     reason: z.string().optional(),
                     signature: z.string().optional(),
                   }),
@@ -182,6 +184,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       reason: z.string().optional(),
                       signature: z.string().optional(),
                     })
@@ -204,6 +207,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       reason: z.string().optional(),
                       signature: z.string().optional(),
                     })
@@ -223,6 +227,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.literal(false),
+                    descriptor: z.unknown().optional(),
                     reason: z.string().optional(),
                     signature: z.string().optional(),
                   }),
@@ -264,6 +269,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.never().optional(),
+                    descriptor: z.unknown().optional(),
                     reason: z.never().optional(),
                     signature: z.string().optional(),
                   }),
@@ -281,6 +287,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.boolean(),
+                    descriptor: z.unknown().optional(),
                     reason: z.string().optional(),
                     signature: z.string().optional(),
                   }),
@@ -301,6 +308,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       reason: z.string().optional(),
                       signature: z.string().optional(),
                     })
@@ -322,6 +330,7 @@ const uiMessagesSchema = lazySchema(() =>
                     .object({
                       id: z.string(),
                       approved: z.literal(true),
+                      descriptor: z.unknown().optional(),
                       reason: z.string().optional(),
                       signature: z.string().optional(),
                     })
@@ -340,6 +349,7 @@ const uiMessagesSchema = lazySchema(() =>
                   approval: z.object({
                     id: z.string(),
                     approved: z.literal(false),
+                    descriptor: z.unknown().optional(),
                     reason: z.string().optional(),
                     signature: z.string().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(),
         signature: z.string().optional(),
       }),
       z.looseObject({
@@ -270,6 +271,7 @@ export type UIMessageChunk<
       type: 'tool-approval-request';
       approvalId: string;
       toolCallId: string;
+      approvalDescriptor?: unknown;
       signature?: string;
     }
   | {