@ai-sdk/provider-utils 5.0.0-beta.3 → 5.0.0-beta.30

package/src/types/index.ts

@@ -3,6 +3,7 @@ export type {
   AssistantModelMessage,
 } from './assistant-model-message';
 export type {
+  CustomPart,
   FilePart,
   ImagePart,
   ReasoningFilePart,
@@ -12,30 +13,44 @@ export type {
   ToolResultOutput,
   ToolResultPart,
 } from './content-part';
+export type { Context } from './context';
 export type { DataContent } from './data-content';
 export { executeTool } from './execute-tool';
+export type {
+  FileData,
+  FileDataData,
+  FileDataReference,
+  FileDataText,
+  FileDataUrl,
+} from './file-data';
+export { isExecutableTool, type ExecutableTool } from './executable-tool';
+export type { InferToolContext } from './infer-tool-context';
+export type { InferToolInput } from './infer-tool-input';
+export type { InferToolOutput } from './infer-tool-output';
+export type { InferToolSetContext } from './infer-tool-set-context';
 export type { ModelMessage } from './model-message';
 export type { ProviderOptions } from './provider-options';
+export type { ProviderReference } from './provider-reference';
+export type { SensitiveContext } from './sensitive-context';
 export type { SystemModelMessage } from './system-model-message';
 export {
   dynamicTool,
   tool,
-  type InferToolInput,
-  type InferToolOutput,
+  type DynamicTool,
+  type FunctionTool,
+  type ProviderDefinedTool,
+  type ProviderExecutedTool,
   type Tool,
-  type ToolExecutionOptions,
-  type ToolExecuteFunction,
-  type ToolNeedsApprovalFunction,
 } from './tool';
+export type {
+  ToolExecuteFunction,
+  ToolExecutionOptions,
+} from './tool-execute-function';
+export type { ToolNeedsApprovalFunction } from './tool-needs-approval-function';
+export type { ToolSet } from './tool-set';
 export type { ToolApprovalRequest } from './tool-approval-request';
 export type { ToolApprovalResponse } from './tool-approval-response';
 export type { ToolCall } from './tool-call';
 export type { ToolContent, ToolModelMessage } from './tool-model-message';
 export type { ToolResult } from './tool-result';
 export type { UserContent, UserModelMessage } from './user-model-message';
-import type { ToolExecutionOptions } from './tool';
-
-/**
- * @deprecated Use ToolExecutionOptions instead.
- */
-export type ToolCallOptions = ToolExecutionOptions;

package/src/types/infer-tool-context.ts

@@ -0,0 +1,12 @@
+import type { HasRequiredKey } from '../has-required-key';
+import type { Tool } from './tool';
+
+/**
+ * Infer the context type of a tool.
+ */
+export type InferToolContext<TOOL extends Tool> =
+  TOOL extends Tool<any, any, infer CONTEXT>
+    ? HasRequiredKey<CONTEXT> extends true
+      ? CONTEXT
+      : never
+    : never;

package/src/types/infer-tool-input.ts

@@ -0,0 +1,7 @@
+import type { Tool } from './tool';
+
+/**
+ * Infer the input type of a tool.
+ */
+export type InferToolInput<TOOL extends Tool<any, any, any>> =
+  TOOL extends Tool<infer INPUT, any, any> ? INPUT : never;

package/src/types/infer-tool-output.ts

@@ -0,0 +1,7 @@
+import type { Tool } from './tool';
+
+/**
+ * Infer the output type of a tool.
+ */
+export type InferToolOutput<TOOL extends Tool<any, any, any>> =
+  TOOL extends Tool<any, infer OUTPUT, any> ? OUTPUT : never;

package/src/types/infer-tool-set-context.ts

@@ -0,0 +1,15 @@
+import type { InferToolContext } from './infer-tool-context';
+import type { ToolSet } from './tool-set';
+
+/**
+ * Infer the context type for a tool set.
+ *
+ * The inferred type maps each tool name to its required context type.
+ *
+ * Tools without required context properties are omitted from the result.
+ */
+export type InferToolSetContext<TOOLS extends ToolSet> = {
+  [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never
+    ? never
+    : K]: InferToolContext<NoInfer<TOOLS[K]>>;
+};

package/src/types/model-message.ts

@@ -1,7 +1,7 @@
-import { AssistantModelMessage } from './assistant-model-message';
-import { SystemModelMessage } from './system-model-message';
-import { ToolModelMessage } from './tool-model-message';
-import { UserModelMessage } from './user-model-message';
+import type { AssistantModelMessage } from './assistant-model-message';
+import type { SystemModelMessage } from './system-model-message';
+import type { ToolModelMessage } from './tool-model-message';
+import type { UserModelMessage } from './user-model-message';
 
 /**
  * A message that can be used in the `messages` field of a prompt.

package/src/types/never-optional.ts

@@ -0,0 +1,7 @@
+// 0 extends 1 & N checks for any
+// [N] extends [never] checks for never
+export type NeverOptional<N, T> = 0 extends 1 & N
+  ? Partial<T>
+  : [N] extends [never]
+    ? Partial<Record<keyof T, undefined>>
+    : T;

package/src/types/provider-options.ts

@@ -1,4 +1,4 @@
-import { SharedV3ProviderOptions } from '@ai-sdk/provider';
+import type { SharedV4ProviderOptions } from '@ai-sdk/provider';
 
 /**
  * Additional provider-specific options.
@@ -6,4 +6,4 @@ import { SharedV3ProviderOptions } from '@ai-sdk/provider';
  * They are passed through to the provider from the AI SDK and enable
  * provider-specific functionality that can be fully encapsulated in the provider.
  */
-export type ProviderOptions = SharedV3ProviderOptions;
+export type ProviderOptions = SharedV4ProviderOptions;

package/src/types/provider-reference.ts

@@ -0,0 +1,10 @@
+import type { SharedV4ProviderReference } from '@ai-sdk/provider';
+
+/**
+ * A mapping of provider names to provider-specific file identifiers.
+ *
+ * Provider references allow files to be identified across different
+ * providers without re-uploading, by storing each provider's own
+ * identifier for the same logical file.
+ */
+export type ProviderReference = SharedV4ProviderReference;

package/src/types/sensitive-context.ts

@@ -0,0 +1,9 @@
+import type { Context } from './context';
+
+/**
+ * Top-level context properties that contain sensitive data and should be
+ * excluded from telemetry.
+ */
+export type SensitiveContext<CONTEXT extends Context | unknown | never> =
+  | { [KEY in keyof CONTEXT]?: boolean }
+  | undefined;

package/src/types/system-model-message.ts

@@ -1,4 +1,4 @@
-import { ProviderOptions } from './provider-options';
+import type { ProviderOptions } from './provider-options';
 
 /**
  * A system message. It can contain system information.

package/src/types/tool-approval-request.ts

@@ -13,4 +13,11 @@ export type ToolApprovalRequest = {
    * ID of the tool call that the approval request is for.
    */
   toolCallId: string;
+
+  /**
+   * Flag indicating whether the tool was automatically approved or denied.
+   *
+   * @default false
+   */
+  isAutomatic?: boolean;
 };

package/src/types/tool-execute-function.ts

@@ -0,0 +1,50 @@
+import type { Context } from './context';
+import type { ModelMessage } from './model-message';
+
+/**
+ * Additional options that are sent into each tool execution.
+ */
+export interface ToolExecutionOptions<
+  CONTEXT extends Context | unknown | never,
+> {
+  /**
+   * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+   */
+  toolCallId: string;
+
+  /**
+   * Messages that were sent to the language model to initiate the response that contained the tool call.
+   * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
+   */
+  messages: ModelMessage[];
+
+  /**
+   * An optional abort signal that indicates that the overall operation should be aborted.
+   */
+  abortSignal?: AbortSignal;
+
+  /**
+   * Tool context as defined by the tool's context schema.
+   * The tool context is specific to the tool and is passed to the tool execution.
+   *
+   * Treat the context object as immutable inside tools.
+   * Mutating the context object can lead to race conditions and unexpected results
+   * when tools are called in parallel.
+   *
+   * If you need to mutate the context, analyze the tool calls and results
+   * in `prepareStep` and update it there.
+   */
+  context: CONTEXT;
+}
+
+/**
+ * Function that executes the tool and returns either a single result or a stream of results.
+ */
+export type ToolExecuteFunction<
+  INPUT,
+  OUTPUT,
+  CONTEXT extends Context | unknown | never,
+> = (
+  input: INPUT,
+  options: ToolExecutionOptions<CONTEXT>,
+) => AsyncIterable<OUTPUT> | PromiseLike<OUTPUT> | OUTPUT;

package/src/types/tool-model-message.ts

@@ -1,6 +1,6 @@
-import { ToolResultPart } from './content-part';
-import { ProviderOptions } from './provider-options';
-import { ToolApprovalResponse } from './tool-approval-response';
+import type { ToolResultPart } from './content-part';
+import type { ProviderOptions } from './provider-options';
+import type { ToolApprovalResponse } from './tool-approval-response';
 
 /**
  * A tool message. It contains the result of one or more tool calls.

package/src/types/tool-needs-approval-function.ts

@@ -0,0 +1,39 @@
+import type { Context } from './context';
+import type { ModelMessage } from './model-message';
+
+/**
+ * Function that is called to determine if the tool needs approval before it can be executed.
+ *
+ * @deprecated Tool approval is handled on a `generateText` / `streamText` level now.
+ */
+export type ToolNeedsApprovalFunction<
+  INPUT,
+  CONTEXT extends Context | unknown | never,
+> = (
+  input: INPUT,
+  options: {
+    /**
+     * The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.
+     */
+    toolCallId: string;
+
+    /**
+     * Messages that were sent to the language model to initiate the response that contained the tool call.
+     * The messages **do not** include the system prompt nor the assistant response that contained the tool call.
+     */
+    messages: ModelMessage[];
+
+    /**
+     * Tool context as defined by the tool's context schema.
+     * The tool context is specific to the tool and is passed to the tool execution.
+     *
+     * Treat the context object as immutable inside tools.
+     * Mutating the context object can lead to race conditions and unexpected results
+     * when tools are called in parallel.
+     *
+     * If you need to mutate the context, analyze the tool calls and results
+     * in `prepareStep` and update it there.
+     */
+    context: CONTEXT;
+  },
+) => boolean | PromiseLike<boolean>;

package/src/types/tool-set.ts

@@ -0,0 +1,22 @@
+import type { Tool } from './tool';
+
+/**
+ * A mapping of tool names to tool definitions.
+ */
+export type ToolSet = Record<
+  string,
+  (
+    | Tool<never, never, any>
+    | Tool<any, any, any>
+    | Tool<any, never, any>
+    | Tool<never, any, any>
+  ) &
+    Pick<
+      Tool<any, any, any>,
+      | 'execute'
+      | 'onInputAvailable'
+      | 'onInputStart'
+      | 'onInputDelta'
+      | 'needsApproval'
+    >
+>;