@ai-sdk/provider-utils 5.0.0-beta.20 → 5.0.0-beta.21

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-beta.21
+
+### Patch Changes
+
+- add1126: refactoring: executeTool uses tool as parameter
+
 ## 5.0.0-beta.20
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { ImageModelV4File, LanguageModelV4FunctionTool, LanguageModelV4ProviderTool, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV4Prompt, LanguageModelV4FilePart, SharedV4ProviderReference, LanguageModelV4CallOptions, SharedV4Warning, SharedV4ProviderOptions, JSONObject, TypeValidationContext } from '@ai-sdk/provider';
+export { getErrorMessage } from '@ai-sdk/provider';
 import { StandardSchemaV1, StandardJSONSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
 import * as z3 from 'zod/v3';
@@ -199,8 +200,6 @@ type IdGenerator = () => string;
  */
 declare const generateId: IdGenerator;
 
-declare function getErrorMessage(error: unknown | undefined): string;
-
 /**
  * Used to mark schemas so we can support both Zod and custom schemas.
  */
@@ -1549,35 +1548,15 @@ declare function withUserAgentSuffix(headers: HeadersInit | Record<string, strin
 declare function withoutTrailingSlash(url: string | undefined): string | undefined;
 
 /**
- * Executes a tool function, supporting both synchronous and streaming/asynchronous results.
- *
- * This generator yields intermediate ("preliminary") outputs as they're produced, allowing callers
- * to stream partial tool results before completion. When execution is finished, it yields a final output,
- * ensuring all consumers receive a conclusive result.
- *
- * - If the tool's `execute` function returns an `AsyncIterable`, all intermediate values are yielded
- *   as `{ type: "preliminary", output }` except the last, which is yielded as `{ type: "final", output }`.
- * - If the tool returns a direct value or Promise, a single `{ type: "final", output }` is yielded.
- *
- * @template INPUT Input type for the tool execution.
- * @template OUTPUT Output type for the tool execution.
- * @template CONTEXT Context object extension for execution (extends Context).
- * @param params.execute The tool execute function.
- * @param params.input Input value to pass to the execute function.
- * @param params.options Additional options for tool execution.
- * @yields An object containing either a preliminary or final output from the tool.
+ * A tool that is guaranteed to expose an execute function.
  */
-declare function executeTool<INPUT, OUTPUT, CONTEXT extends Context>({ execute, input, options, }: {
-    execute: ToolExecuteFunction<INPUT, OUTPUT, CONTEXT>;
-    input: INPUT;
-    options: ToolExecutionOptions<NoInfer<CONTEXT>>;
-}): AsyncGenerator<{
-    type: 'preliminary';
-    output: OUTPUT;
-} | {
-    type: 'final';
-    output: OUTPUT;
-}>;
+type ExecutableTool<TOOL extends Tool = Tool> = TOOL & {
+    execute: NonNullable<TOOL['execute']>;
+};
+/**
+ * Checks whether a tool exposes an execute function.
+ */
+declare function isExecutableTool<TOOL extends Tool>(tool: TOOL | undefined): tool is ExecutableTool<TOOL>;
 
 /**
  * Infer the context type of a tool.
@@ -1594,6 +1573,32 @@ type InferToolInput<TOOL extends Tool<any, any, any>> = TOOL extends Tool<infer
  */
 type InferToolOutput<TOOL extends Tool<any, any, any>> = TOOL extends Tool<any, infer OUTPUT, any> ? OUTPUT : never;
 
+/**
+ * Executes a tool function and normalizes its results into a stream of outputs.
+ *
+ * - If the tool's `execute` function returns an `AsyncIterable`, each yielded value is emitted as
+ *   `{ type: "preliminary", output }`. After iteration completes, the last yielded value is emitted
+ *   again as `{ type: "final", output }`.
+ * - If the tool returns a direct value or Promise, a single `{ type: "final", output }` is yielded.
+ *
+ * @param params.tool The tool whose `execute` function should be invoked.
+ * @param params.input The input value to pass to the tool.
+ * @param params.options Additional options for tool execution.
+ * @yields A preliminary output for each streamed value, followed by a final output, or a single final
+ * output for non-streaming tools.
+ */
+declare function executeTool<TOOL extends Tool>({ tool, input, options, }: {
+    tool: ExecutableTool<TOOL>;
+    input: InferToolInput<TOOL>;
+    options: ToolExecutionOptions<InferToolContext<TOOL>>;
+}): AsyncGenerator<{
+    type: 'preliminary';
+    output: InferToolOutput<TOOL>;
+} | {
+    type: 'final';
+    output: InferToolOutput<TOOL>;
+}>;
+
 /**
  * A mapping of tool names to tool definitions.
  */
@@ -1684,4 +1689,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type FetchFunction, type FilePart, type FlexibleSchema, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderReference, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isCustomReasoning, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type ExecutableTool, type FetchFunction, type FilePart, type FlexibleSchema, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderOptions, type ProviderReference, type ProviderToolFactory, type ProviderToolFactoryWithOutputSchema, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactory, createProviderToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, generateId, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isCustomReasoning, isExecutableTool, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.js

@@ -445,18 +445,7 @@ var createIdGenerator = ({
 var generateId = createIdGenerator();
 
 // src/get-error-message.ts
-function getErrorMessage(error) {
-  if (error == null) {
-    return "unknown error";
-  }
-  if (typeof error === "string") {
-    return error;
-  }
-  if (error instanceof Error) {
-    return error.toString();
-  }
-  return JSON.stringify(error);
-}
+import { getErrorMessage } from "@ai-sdk/provider";
 
 // src/get-from-api.ts
 import { APICallError as APICallError2 } from "@ai-sdk/provider";
@@ -577,7 +566,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "5.0.0-beta.20" : "0.0.0-test";
+var VERSION = true ? "5.0.0-beta.21" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;
@@ -2794,11 +2783,11 @@ function isAsyncIterable(obj) {
 
 // src/types/execute-tool.ts
 async function* executeTool({
-  execute,
+  tool: tool2,
   input,
   options
 }) {
-  const result = execute(input, options);
+  const result = tool2.execute(input, options);
   if (isAsyncIterable(result)) {
     let lastOutput;
     for await (const output of result) {
@@ -2811,6 +2800,11 @@ async function* executeTool({
   }
 }
 
+// src/types/executable-tool.ts
+function isExecutableTool(tool2) {
+  return tool2 != null && typeof tool2.execute === "function";
+}
+
 // src/index.ts
 import { WORKFLOW_DESERIALIZE, WORKFLOW_SERIALIZE } from "@workflow/serde";
 import {
@@ -2853,6 +2847,7 @@ export {
   injectJsonInstructionIntoMessages,
   isAbortError,
   isCustomReasoning,
+  isExecutableTool,
   isNonNullable,
   isParsableJson,
   isProviderReference,