ai 6.0.0-beta.48 → 6.0.0-beta.49

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # ai
 
+## 6.0.0-beta.49
+
+### Patch Changes
+
+- 703459a: feat: tool execution approval for dynamic tools
+- Updated dependencies [703459a]
+  - @ai-sdk/provider-utils@4.0.0-beta.17
+  - @ai-sdk/gateway@2.0.0-beta.31
+
 ## 6.0.0-beta.48
 
 ### Patch Changes

package/dist/index.d.mts

@@ -291,7 +291,7 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
-type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta'>>;
+type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta' | 'needsApproval'>>;
 
 type BaseToolCall = {
     type: 'tool-call';
@@ -1673,12 +1673,36 @@ type DynamicToolUIPart = {
     input: unknown | undefined;
     output?: never;
     errorText?: never;
+    approval?: never;
 } | {
     state: 'input-available';
     input: unknown;
     output?: never;
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
+    approval?: never;
+} | {
+    state: 'approval-requested';
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved?: never;
+        reason?: never;
+    };
+} | {
+    state: 'approval-responded';
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: boolean;
+        reason?: string;
+    };
 } | {
     state: 'output-available';
     input: unknown;
@@ -1686,12 +1710,33 @@ type DynamicToolUIPart = {
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
     preliminary?: boolean;
+    approval?: {
+        id: string;
+        approved: true;
+        reason?: string;
+    };
 } | {
     state: 'output-error';
     input: unknown;
     output?: never;
     errorText: string;
     callProviderMetadata?: ProviderMetadata;
+    approval?: {
+        id: string;
+        approved: true;
+        reason?: string;
+    };
+} | {
+    state: 'output-denied';
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: false;
+        reason?: string;
+    };
 });
 declare function isToolUIPart<TOOLS extends UITools>(part: UIMessagePart<UIDataTypes, TOOLS>): part is ToolUIPart<TOOLS>;
 declare function isToolOrDynamicToolUIPart<TOOLS extends UITools>(part: UIMessagePart<UIDataTypes, TOOLS>): part is ToolUIPart<TOOLS> | DynamicToolUIPart;

package/dist/index.d.ts

@@ -291,7 +291,7 @@ onlyBar('bar');
 */
 type ValueOf<ObjectType, ValueType extends keyof ObjectType = keyof ObjectType> = ObjectType[ValueType];
 
-type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta'>>;
+type ToolSet = Record<string, (Tool<never, never> | Tool<any, any> | Tool<any, never> | Tool<never, any>) & Pick<Tool<any, any>, 'execute' | 'onInputAvailable' | 'onInputStart' | 'onInputDelta' | 'needsApproval'>>;
 
 type BaseToolCall = {
     type: 'tool-call';
@@ -1673,12 +1673,36 @@ type DynamicToolUIPart = {
     input: unknown | undefined;
     output?: never;
     errorText?: never;
+    approval?: never;
 } | {
     state: 'input-available';
     input: unknown;
     output?: never;
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
+    approval?: never;
+} | {
+    state: 'approval-requested';
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved?: never;
+        reason?: never;
+    };
+} | {
+    state: 'approval-responded';
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: boolean;
+        reason?: string;
+    };
 } | {
     state: 'output-available';
     input: unknown;
@@ -1686,12 +1710,33 @@ type DynamicToolUIPart = {
     errorText?: never;
     callProviderMetadata?: ProviderMetadata;
     preliminary?: boolean;
+    approval?: {
+        id: string;
+        approved: true;
+        reason?: string;
+    };
 } | {
     state: 'output-error';
     input: unknown;
     output?: never;
     errorText: string;
     callProviderMetadata?: ProviderMetadata;
+    approval?: {
+        id: string;
+        approved: true;
+        reason?: string;
+    };
+} | {
+    state: 'output-denied';
+    input: unknown;
+    output?: never;
+    errorText?: never;
+    callProviderMetadata?: ProviderMetadata;
+    approval: {
+        id: string;
+        approved: false;
+        reason?: string;
+    };
 });
 declare function isToolUIPart<TOOLS extends UITools>(part: UIMessagePart<UIDataTypes, TOOLS>): part is ToolUIPart<TOOLS>;
 declare function isToolOrDynamicToolUIPart<TOOLS extends UITools>(part: UIMessagePart<UIDataTypes, TOOLS>): part is ToolUIPart<TOOLS> | DynamicToolUIPart;

package/dist/index.js

@@ -868,7 +868,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.48" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.49" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -1486,6 +1486,10 @@ var outputSchema = import_v44.z.discriminatedUnion("type", [
     type: import_v44.z.literal("json"),
     value: jsonValueSchema
   }),
+  import_v44.z.object({
+    type: import_v44.z.literal("execution-denied"),
+    reason: import_v44.z.string().optional()
+  }),
   import_v44.z.object({
     type: import_v44.z.literal("error-text"),
     value: import_v44.z.string()
@@ -3846,27 +3850,15 @@ function processUIMessageStream({
         await runUpdateMessageJob(async ({ state, write }) => {
           var _a17, _b, _c, _d;
           function getToolInvocation(toolCallId) {
-            const toolInvocations = state.message.parts.filter(isToolUIPart);
-            const toolInvocation = toolInvocations.find(
-              (invocation) => invocation.toolCallId === toolCallId
-            );
-            if (toolInvocation == null) {
-              throw new Error(
-                "tool-output-error must be preceded by a tool-input-available"
-              );
-            }
-            return toolInvocation;
-          }
-          function getDynamicToolInvocation(toolCallId) {
             const toolInvocations = state.message.parts.filter(
-              (part) => part.type === "dynamic-tool"
+              isToolOrDynamicToolUIPart
             );
             const toolInvocation = toolInvocations.find(
               (invocation) => invocation.toolCallId === toolCallId
             );
             if (toolInvocation == null) {
               throw new Error(
-                "tool-output-error must be preceded by a tool-input-available"
+                `no tool invocation found for tool call ${toolCallId}`
               );
             }
             return toolInvocation;
@@ -4141,9 +4133,7 @@ function processUIMessageStream({
             case "tool-approval-request": {
               const toolInvocation = getToolInvocation(chunk.toolCallId);
               toolInvocation.state = "approval-requested";
-              toolInvocation.approval = {
-                id: chunk.approvalId
-              };
+              toolInvocation.approval = { id: chunk.approvalId };
               write();
               break;
             }
@@ -4154,10 +4144,8 @@ function processUIMessageStream({
               break;
             }
             case "tool-output-available": {
-              if (chunk.dynamic) {
-                const toolInvocation = getDynamicToolInvocation(
-                  chunk.toolCallId
-                );
+              const toolInvocation = getToolInvocation(chunk.toolCallId);
+              if (toolInvocation.type === "dynamic-tool") {
                 updateDynamicToolPart({
                   toolCallId: chunk.toolCallId,
                   toolName: toolInvocation.toolName,
@@ -4167,7 +4155,6 @@ function processUIMessageStream({
                   preliminary: chunk.preliminary
                 });
               } else {
-                const toolInvocation = getToolInvocation(chunk.toolCallId);
                 updateToolPart({
                   toolCallId: chunk.toolCallId,
                   toolName: getToolName(toolInvocation),
@@ -4182,10 +4169,8 @@ function processUIMessageStream({
               break;
             }
             case "tool-output-error": {
-              if (chunk.dynamic) {
-                const toolInvocation = getDynamicToolInvocation(
-                  chunk.toolCallId
-                );
+              const toolInvocation = getToolInvocation(chunk.toolCallId);
+              if (toolInvocation.type === "dynamic-tool") {
                 updateDynamicToolPart({
                   toolCallId: chunk.toolCallId,
                   toolName: toolInvocation.toolName,
@@ -4194,7 +4179,6 @@ function processUIMessageStream({
                   errorText: chunk.errorText
                 });
               } else {
-                const toolInvocation = getToolInvocation(chunk.toolCallId);
                 updateToolPart({
                   toolCallId: chunk.toolCallId,
                   toolName: getToolName(toolInvocation),
@@ -6315,6 +6299,13 @@ function convertToModelMessages(messages, options) {
                     ...part.callProviderMetadata != null ? { providerOptions: part.callProviderMetadata } : {}
                   });
                 }
+                if (part.approval != null) {
+                  content.push({
+                    type: "tool-approval-request",
+                    approvalId: part.approval.id,
+                    toolCallId: part.toolCallId
+                  });
+                }
               } else if (isToolUIPart(part)) {
                 const toolName = getToolName(part);
                 if (part.state !== "input-streaming") {
@@ -6365,7 +6356,7 @@ function convertToModelMessages(messages, options) {
                   (toolPart) => {
                     var _a18, _b2, _c;
                     const outputs = [];
-                    if (toolPart.type !== "dynamic-tool" && ((_a18 = toolPart.approval) == null ? void 0 : _a18.approved) != null) {
+                    if (((_a18 = toolPart.approval) == null ? void 0 : _a18.approved) != null) {
                       outputs.push({
                         type: "tool-approval-response",
                         approvalId: toolPart.approval.id,
@@ -6378,7 +6369,7 @@ function convertToModelMessages(messages, options) {
                         outputs.push({
                           type: "tool-result",
                           toolCallId: toolPart.toolCallId,
-                          toolName: getToolName(toolPart),
+                          toolName: getToolOrDynamicToolName(toolPart),
                           output: {
                             type: "error-text",
                             value: (_b2 = toolPart.approval.reason) != null ? _b2 : "Tool execution denied."
@@ -6388,7 +6379,7 @@ function convertToModelMessages(messages, options) {
                       }
                       case "output-error":
                       case "output-available": {
-                        const toolName = toolPart.type === "dynamic-tool" ? toolPart.toolName : getToolName(toolPart);
+                        const toolName = getToolOrDynamicToolName(toolPart);
                         outputs.push({
                           type: "tool-result",
                           toolCallId: toolPart.toolCallId,
@@ -6412,7 +6403,7 @@ function convertToModelMessages(messages, options) {
           var processBlock = processBlock2;
           let block = [];
           for (const part of message.parts) {
-            if (part.type === "text" || part.type === "reasoning" || part.type === "file" || part.type === "dynamic-tool" || isToolUIPart(part)) {
+            if (part.type === "text" || part.type === "reasoning" || part.type === "file" || isToolOrDynamicToolUIPart(part)) {
               block.push(part);
             } else if (part.type === "step-start") {
               processBlock2();
@@ -10284,7 +10275,7 @@ var AbstractChat = class {
       var _a17, _b;
       const messages = this.state.messages;
       const lastMessage = messages[messages.length - 1];
-      const updatePart = (part) => isToolUIPart(part) && part.state === "approval-requested" && part.approval.id === id ? {
+      const updatePart = (part) => isToolOrDynamicToolUIPart(part) && part.state === "approval-requested" && part.approval.id === id ? {
         ...part,
         state: "approval-responded",
         approval: { id, approved, reason }
@@ -10652,7 +10643,8 @@ var uiMessagesSchema = (0, import_provider_utils35.lazySchema)(
               state: import_v410.z.literal("input-streaming"),
               input: import_v410.z.unknown().optional(),
               output: import_v410.z.never().optional(),
-              errorText: import_v410.z.never().optional()
+              errorText: import_v410.z.never().optional(),
+              approval: import_v410.z.never().optional()
             }),
             import_v410.z.object({
               type: import_v410.z.literal("dynamic-tool"),
@@ -10662,7 +10654,38 @@ var uiMessagesSchema = (0, import_provider_utils35.lazySchema)(
               input: import_v410.z.unknown(),
               output: import_v410.z.never().optional(),
               errorText: import_v410.z.never().optional(),
-              callProviderMetadata: providerMetadataSchema.optional()
+              callProviderMetadata: providerMetadataSchema.optional(),
+              approval: import_v410.z.never().optional()
+            }),
+            import_v410.z.object({
+              type: import_v410.z.literal("dynamic-tool"),
+              toolName: import_v410.z.string(),
+              toolCallId: import_v410.z.string(),
+              state: import_v410.z.literal("approval-requested"),
+              input: import_v410.z.unknown(),
+              output: import_v410.z.never().optional(),
+              errorText: import_v410.z.never().optional(),
+              callProviderMetadata: providerMetadataSchema.optional(),
+              approval: import_v410.z.object({
+                id: import_v410.z.string(),
+                approved: import_v410.z.never().optional(),
+                reason: import_v410.z.never().optional()
+              })
+            }),
+            import_v410.z.object({
+              type: import_v410.z.literal("dynamic-tool"),
+              toolName: import_v410.z.string(),
+              toolCallId: import_v410.z.string(),
+              state: import_v410.z.literal("approval-responded"),
+              input: import_v410.z.unknown(),
+              output: import_v410.z.never().optional(),
+              errorText: import_v410.z.never().optional(),
+              callProviderMetadata: providerMetadataSchema.optional(),
+              approval: import_v410.z.object({
+                id: import_v410.z.string(),
+                approved: import_v410.z.boolean(),
+                reason: import_v410.z.string().optional()
+              })
             }),
             import_v410.z.object({
               type: import_v410.z.literal("dynamic-tool"),
@@ -10673,7 +10696,12 @@ var uiMessagesSchema = (0, import_provider_utils35.lazySchema)(
               output: import_v410.z.unknown(),
               errorText: import_v410.z.never().optional(),
               callProviderMetadata: providerMetadataSchema.optional(),
-              preliminary: import_v410.z.boolean().optional()
+              preliminary: import_v410.z.boolean().optional(),
+              approval: import_v410.z.object({
+                id: import_v410.z.string(),
+                approved: import_v410.z.literal(true),
+                reason: import_v410.z.string().optional()
+              }).optional()
             }),
             import_v410.z.object({
               type: import_v410.z.literal("dynamic-tool"),
@@ -10683,7 +10711,27 @@ var uiMessagesSchema = (0, import_provider_utils35.lazySchema)(
               input: import_v410.z.unknown(),
               output: import_v410.z.never().optional(),
               errorText: import_v410.z.string(),
-              callProviderMetadata: providerMetadataSchema.optional()
+              callProviderMetadata: providerMetadataSchema.optional(),
+              approval: import_v410.z.object({
+                id: import_v410.z.string(),
+                approved: import_v410.z.literal(true),
+                reason: import_v410.z.string().optional()
+              }).optional()
+            }),
+            import_v410.z.object({
+              type: import_v410.z.literal("dynamic-tool"),
+              toolName: import_v410.z.string(),
+              toolCallId: import_v410.z.string(),
+              state: import_v410.z.literal("output-denied"),
+              input: import_v410.z.unknown(),
+              output: import_v410.z.never().optional(),
+              errorText: import_v410.z.never().optional(),
+              callProviderMetadata: providerMetadataSchema.optional(),
+              approval: import_v410.z.object({
+                id: import_v410.z.string(),
+                approved: import_v410.z.literal(false),
+                reason: import_v410.z.string().optional()
+              })
             }),
             import_v410.z.object({
               type: import_v410.z.string().startsWith("tool-"),