@ai-sdk/provider-utils 3.1.0-beta.6 → 3.1.0-beta.8

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @ai-sdk/provider-utils
 
+## 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
+
+- e8109d3: feat: tool execution approval
+- Updated dependencies [046aa3b]
+- Updated dependencies [e8109d3]
+  - @ai-sdk/provider@2.1.0-beta.5
+
 ## 3.1.0-beta.6
 
 ### Patch Changes

package/dist/index.d.mts

@@ -517,6 +517,21 @@ interface ToolResultPart {
     providerOptions?: ProviderOptions;
 }
 
+/**
+ * Tool approval request prompt part.
+ */
+type ToolApprovalRequest = {
+    type: 'tool-approval-request';
+    /**
+     * ID of the tool approval.
+     */
+    approvalId: string;
+    /**
+     * ID of the tool call that the approval request is for.
+     */
+    toolCallId: string;
+};
+
 /**
 An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
  */
@@ -534,7 +549,7 @@ type AssistantModelMessage = {
 Content of an assistant message.
 It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
  */
-type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart>;
+type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart | ToolApprovalRequest>;
 
 /**
  A system message. It can contain system information.
@@ -554,6 +569,25 @@ type SystemModelMessage = {
     providerOptions?: ProviderOptions;
 };
 
+/**
+ * Tool approval response prompt part.
+ */
+type ToolApprovalResponse = {
+    type: 'tool-approval-response';
+    /**
+     * ID of the tool approval.
+     */
+    approvalId: string;
+    /**
+     * Flag indicating whether the approval was granted or denied.
+     */
+    approved: boolean;
+    /**
+     * Optional reason for the approval or denial.
+     */
+    reason?: string;
+};
+
 /**
 A tool message. It contains the result of one or more tool calls.
  */
@@ -570,7 +604,7 @@ type ToolModelMessage = {
 /**
 Content of a tool message. It is an array of tool result parts.
  */
-type ToolContent = Array<ToolResultPart>;
+type ToolContent = Array<ToolResultPart | ToolApprovalResponse>;
 
 /**
 A user message. It can contain text or a combination of text and images.
@@ -662,6 +696,10 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      */
     inputSchema: FlexibleSchema<INPUT>;
     /**
+  Whether the tool needs approval before it can be executed.
+     */
+    needsApproval?: boolean;
+    /**
      * Optional function that is called when the argument streaming starts.
      * Only called when the tool is used in a streaming context.
      */
@@ -746,6 +784,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'];
@@ -758,6 +797,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'];
@@ -908,4 +948,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
 
 declare const VERSION: string;
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.d.ts

@@ -517,6 +517,21 @@ interface ToolResultPart {
     providerOptions?: ProviderOptions;
 }
 
+/**
+ * Tool approval request prompt part.
+ */
+type ToolApprovalRequest = {
+    type: 'tool-approval-request';
+    /**
+     * ID of the tool approval.
+     */
+    approvalId: string;
+    /**
+     * ID of the tool call that the approval request is for.
+     */
+    toolCallId: string;
+};
+
 /**
 An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
  */
@@ -534,7 +549,7 @@ type AssistantModelMessage = {
 Content of an assistant message.
 It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
  */
-type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart>;
+type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | ToolCallPart | ToolResultPart | ToolApprovalRequest>;
 
 /**
  A system message. It can contain system information.
@@ -554,6 +569,25 @@ type SystemModelMessage = {
     providerOptions?: ProviderOptions;
 };
 
+/**
+ * Tool approval response prompt part.
+ */
+type ToolApprovalResponse = {
+    type: 'tool-approval-response';
+    /**
+     * ID of the tool approval.
+     */
+    approvalId: string;
+    /**
+     * Flag indicating whether the approval was granted or denied.
+     */
+    approved: boolean;
+    /**
+     * Optional reason for the approval or denial.
+     */
+    reason?: string;
+};
+
 /**
 A tool message. It contains the result of one or more tool calls.
  */
@@ -570,7 +604,7 @@ type ToolModelMessage = {
 /**
 Content of a tool message. It is an array of tool result parts.
  */
-type ToolContent = Array<ToolResultPart>;
+type ToolContent = Array<ToolResultPart | ToolApprovalResponse>;
 
 /**
 A user message. It can contain text or a combination of text and images.
@@ -662,6 +696,10 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      */
     inputSchema: FlexibleSchema<INPUT>;
     /**
+  Whether the tool needs approval before it can be executed.
+     */
+    needsApproval?: boolean;
+    /**
      * Optional function that is called when the argument streaming starts.
      * Only called when the tool is used in a streaming context.
      */
@@ -746,6 +784,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'];
@@ -758,6 +797,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'];
@@ -908,4 +948,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
 
 declare const VERSION: string;
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type AssistantContent, type AssistantModelMessage, type DataContent, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolResult, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, type Validator, asSchema, asValidator, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createJsonStreamResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isParsableJson, isUrlSupported, isValidator, jsonSchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, standardSchemaValidator, tool, validateTypes, validator, validatorSymbol, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.js

@@ -284,7 +284,7 @@ function handleFetchError({
 }
 
 // src/version.ts
-var VERSION = true ? "3.1.0-beta.6" : "0.0.0-test";
+var VERSION = true ? "3.1.0-beta.8" : "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,