@ai-sdk/provider-utils 5.0.0-beta.4 → 5.0.0-beta.49

package/src/types/content-part.ts

@@ -1,6 +1,8 @@
-import { JSONValue } from '@ai-sdk/provider';
-import { DataContent } from './data-content';
-import { ProviderOptions } from './provider-options';
+import type { JSONValue } from '@ai-sdk/provider';
+import type { DataContent } from './data-content';
+import type { FileData, FileDataData, FileDataUrl } from './file-data';
+import type { ProviderOptions } from './provider-options';
+import type { ProviderReference } from './provider-reference';
 
 /**
  * Text content part of a prompt. It contains a string of text.
@@ -23,6 +25,9 @@ export interface TextPart {
 
 /**
  * Image content part of a prompt. It contains an image.
+ *
+ * @deprecated Use `FilePart` with `mediaType: 'image'` instead:
+ * `{ type: 'file', mediaType: 'image', data: { type: 'data', data } }`.
  */
 export interface ImagePart {
   type: 'image';
@@ -32,8 +37,9 @@ export interface ImagePart {
    *
    * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
    * - URL: a URL that points to the image
+   * - ProviderReference: a provider reference from `uploadFile`
    */
-  image: DataContent | URL;
+  image: DataContent | URL | ProviderReference;
 
   /**
    * Optional IANA media type of the image.
@@ -57,12 +63,16 @@ export interface FilePart {
   type: 'file';
 
   /**
-   * File data. Can either be:
+   * File data. Either a tagged shape or a bare shorthand:
    *
-   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
-   * - URL: a URL that points to the image
+   * - `{ type: 'data', data }` or bare `DataContent`: raw bytes
+   *   (base64 string, Uint8Array, ArrayBuffer, Buffer)
+   * - `{ type: 'url', url }` or bare `URL`: a URL that points to the file
+   * - `{ type: 'reference', reference }` or bare `ProviderReference`:
+   *   a provider reference from `uploadFile`
+   * - `{ type: 'text', text }`: inline text content (tagged only)
    */
-  data: DataContent | URL;
+  data: FileData | DataContent | URL | ProviderReference;
 
   /**
    * Optional filename of the file.
@@ -70,7 +80,14 @@ export interface FilePart {
   filename?: string;
 
   /**
-   * IANA media type of the file.
+   * Either a full IANA media type (`type/subtype`, e.g. `image/png`) or just
+   * the top-level IANA segment (e.g. `image`, `audio`, `video`, `text`).
+   *
+   * `*`-subtype wildcards (e.g. `image/*`) are normalized as equivalent to the
+   * top-level segment alone (e.g. `image`). Providers can use the helpers in
+   * `@ai-sdk/provider-utils` (`isFullMediaType`, `getTopLevelMediaType`,
+   * `detectMediaType`) to resolve the field according to their API
+   * requirements.
    *
    * @see https://www.iana.org/assignments/media-types/media-types.xhtml
    */
@@ -103,6 +120,26 @@ export interface ReasoningPart {
   providerOptions?: ProviderOptions;
 }
 
+/**
+ * Custom content part of a prompt. It contains no standardized payload beyond
+ * provider-specific options.
+ */
+export interface CustomPart {
+  type: 'custom';
+
+  /**
+   * The kind of custom content, in the format `{provider}.{provider-type}`.
+   */
+  kind: `${string}.${string}`;
+
+  /**
+   * Additional provider-specific metadata. They are passed through
+   * to the provider from the AI SDK and enable provider-specific
+   * functionality that can be fully encapsulated in the provider.
+   */
+  providerOptions?: ProviderOptions;
+}
+
 /**
  * Reasoning file content part of a prompt. It contains a file generated as part of reasoning.
  */
@@ -110,12 +147,21 @@ export interface ReasoningFilePart {
   type: 'reasoning-file';
 
   /**
-   * File data. Can either be:
+   * Reasoning file data.
    *
-   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
-   * - URL: a URL that points to the file
+   * Reasoning files originate from a model's reasoning output and are always
+   * raw bytes or a fetchable URL. Unlike `FilePart.data`, the `reference` and
+   * `text` shapes are not supported here: provider references describe files
+   * uploaded by the user (not produced as model output), and reasoning text is
+   * carried by `ReasoningPart` rather than as a file.
+   *
+   * Either a tagged shape or a bare shorthand:
+   *
+   * - `{ type: 'data', data }` or bare `DataContent`: raw bytes
+   *   (base64 string, Uint8Array, ArrayBuffer, Buffer)
+   * - `{ type: 'url', url }` or bare `URL`: a URL that points to the file
    */
-  data: DataContent | URL;
+  data: FileDataData | FileDataUrl | DataContent | URL;
 
   /**
    * IANA media type of the file.
@@ -271,14 +317,50 @@ export type ToolResultOutput =
             providerOptions?: ProviderOptions;
           }
         | {
+            type: 'file';
+
             /**
-             * @deprecated Use image-data or file-data instead.
+             * File data as a tagged discriminated union:
+             *
+             * - `{ type: 'data', data }`: raw bytes
+             *   (base64 string, Uint8Array, ArrayBuffer, Buffer)
+             * - `{ type: 'url', url }`: a URL that points to the file
+             * - `{ type: 'reference', reference }`: a provider reference
+             *   from `uploadFile`
+             * - `{ type: 'text', text }`: inline text content (e.g. an inline
+             *   text document)
+             */
+            data: FileData;
+
+            /**
+             * Either a full IANA media type (`type/subtype`, e.g. `image/png`) or just
+             * the top-level IANA segment (e.g. `image`, `audio`, `video`, `text`).
+             *
+             * `*`-subtype wildcards (e.g. `image/*`) are normalized as equivalent to the
+             * top-level segment alone (e.g. `image`). Providers can use the helpers in
+             * `@ai-sdk/provider-utils` (`isFullMediaType`, `getTopLevelMediaType`,
+             * `detectMediaType`) to resolve the field according to their API
+             * requirements.
+             *
+             * @see https://www.iana.org/assignments/media-types/media-types.xhtml
              */
-            type: 'media';
-            data: string;
             mediaType: string;
+
+            /**
+             * Optional filename of the file.
+             */
+            filename?: string;
+
+            /**
+             * Provider-specific options.
+             */
+            providerOptions?: ProviderOptions;
           }
         | {
+            /**
+             * @deprecated Use 'file' with mediaType + tagged data instead:
+             * `{ type: 'file', mediaType, data: { type: 'data', data } }`.
+             */
             type: 'file-data';
 
             /**
@@ -303,6 +385,10 @@ export type ToolResultOutput =
             providerOptions?: ProviderOptions;
           }
         | {
+            /**
+             * @deprecated Use 'file' with mediaType and tagged data instead:
+             * `{ type: 'file', mediaType, data: { type: 'url', url: new URL(url) } }`.
+             */
             type: 'file-url';
 
             /**
@@ -310,12 +396,22 @@ export type ToolResultOutput =
              */
             url: string;
 
+            /**
+             * IANA media type.
+             * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+             */
+            mediaType?: string;
+
             /**
              * Provider-specific options.
              */
             providerOptions?: ProviderOptions;
           }
         | {
+            /**
+             * @deprecated Use 'file' with tagged data instead:
+             * `{ type: 'file', mediaType, data: { type: 'reference', reference } }`.
+             */
             type: 'file-id';
 
             /**
@@ -335,7 +431,27 @@ export type ToolResultOutput =
           }
         | {
             /**
-             * Images that are referenced using base64 encoded data.
+             * @deprecated Use 'file' with tagged data instead:
+             * `{ type: 'file', mediaType, data: { type: 'reference', reference } }`.
+             */
+            type: 'file-reference';
+
+            /**
+             * Provider-specific references for the file.
+             * The key is the provider name, e.g. 'openai' or 'anthropic'.
+             */
+            providerReference: ProviderReference;
+
+            /**
+             * Provider-specific options.
+             */
+            providerOptions?: ProviderOptions;
+          }
+        | {
+            /**
+             * @deprecated Use 'file' with mediaType (e.g. 'image' or a specific
+             * `image/*` subtype) and tagged data instead:
+             * `{ type: 'file', mediaType: 'image', data: { type: 'data', data } }`.
              */
             type: 'image-data';
 
@@ -357,7 +473,9 @@ export type ToolResultOutput =
           }
         | {
             /**
-             * Images that are referenced using a URL.
+             * @deprecated Use 'file' with `mediaType: 'image'` (or a specific
+             * `image/*` subtype) and tagged data instead:
+             * `{ type: 'file', mediaType: 'image', data: { type: 'url', url: new URL(url) } }`.
              */
             type: 'image-url';
 
@@ -373,7 +491,9 @@ export type ToolResultOutput =
           }
         | {
             /**
-             * Images that are referenced using a provider file id.
+             * @deprecated Use 'file' with `mediaType: 'image'` (or a specific
+             * `image/*` subtype) and tagged data instead:
+             * `{ type: 'file', mediaType: 'image', data: { type: 'reference', reference } }`.
              */
             type: 'image-file-id';
 
@@ -387,6 +507,25 @@ export type ToolResultOutput =
              */
             fileId: string | Record<string, string>;
 
+            /**
+             * Provider-specific options.
+             */
+            providerOptions?: ProviderOptions;
+          }
+        | {
+            /**
+             * @deprecated Use 'file' with `mediaType: 'image'` (or a specific
+             * `image/*` subtype) and tagged data instead:
+             * `{ type: 'file', mediaType: 'image', data: { type: 'reference', reference } }`.
+             */
+            type: 'image-file-reference';
+
+            /**
+             * Provider-specific references for the image file.
+             * The key is the provider name, e.g. 'openai' or 'anthropic'.
+             */
+            providerReference: ProviderReference;
+
             /**
              * Provider-specific options.
              */

package/src/types/context.ts

@@ -0,0 +1,4 @@
+/**
+ * A context object that is passed into tool execution.
+ */
+export type Context = Record<string, unknown>;

package/src/types/executable-tool.ts

@@ -0,0 +1,17 @@
+import type { Tool } from './tool';
+
+/**
+ * A tool that is guaranteed to expose an execute function.
+ */
+export type ExecutableTool<TOOL extends Tool = Tool> = TOOL & {
+  execute: NonNullable<TOOL['execute']>;
+};
+
+/**
+ * Checks whether a tool exposes an execute function.
+ */
+export function isExecutableTool<TOOL extends Tool>(
+  tool: TOOL | undefined,
+): tool is ExecutableTool<TOOL> {
+  return tool != null && typeof tool.execute === 'function';
+}

package/src/types/execute-tool.ts

@@ -1,21 +1,41 @@
 import { isAsyncIterable } from '../is-async-iterable';
-import { ToolExecutionOptions, ToolExecuteFunction } from './tool';
+import type { ExecutableTool } from './executable-tool';
+import type { InferToolContext } from './infer-tool-context';
+import type { InferToolInput } from './infer-tool-input';
+import type { InferToolOutput } from './infer-tool-output';
+import type { Tool } from './tool';
+import type { ToolExecutionOptions } from './tool-execute-function';
 
-export async function* executeTool<INPUT, OUTPUT>({
-  execute,
+/**
+ * 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.
+ */
+export async function* executeTool<TOOL extends Tool>({
+  tool,
   input,
   options,
 }: {
-  execute: ToolExecuteFunction<INPUT, OUTPUT>;
-  input: INPUT;
-  options: ToolExecutionOptions;
+  tool: ExecutableTool<TOOL>;
+  input: InferToolInput<TOOL>;
+  options: ToolExecutionOptions<InferToolContext<TOOL>>;
 }): AsyncGenerator<
-  { type: 'preliminary'; output: OUTPUT } | { type: 'final'; output: OUTPUT }
+  | { type: 'preliminary'; output: InferToolOutput<TOOL> }
+  | { type: 'final'; output: InferToolOutput<TOOL> }
 > {
-  const result = execute(input, options);
+  const result = tool.execute(input, options);
 
   if (isAsyncIterable(result)) {
-    let lastOutput: OUTPUT | undefined;
+    let lastOutput: InferToolOutput<TOOL> | undefined;
     for await (const output of result) {
       lastOutput = output;
       yield { type: 'preliminary', output };

package/src/types/file-data.ts

@@ -0,0 +1,48 @@
+import type {
+  SharedV4FileDataReference,
+  SharedV4FileDataText,
+  SharedV4FileDataUrl,
+} from '@ai-sdk/provider';
+import type { DataContent } from './data-content';
+
+/**
+ * File data variant containing raw bytes (`Uint8Array`, `ArrayBuffer`, or
+ * `Buffer`) or a base64-encoded string.
+ *
+ * This is slightly more permissive than `SharedV4FileDataData`.
+ */
+export interface FileDataData {
+  type: 'data';
+  data: DataContent;
+}
+
+/**
+ * File data variant containing a URL that points to the file.
+ */
+export type FileDataUrl = SharedV4FileDataUrl;
+
+/**
+ * File data variant containing a provider reference (`{ [provider]: id }`).
+ */
+export type FileDataReference = SharedV4FileDataReference;
+
+/**
+ * File data variant containing inline text content (e.g. an inline text
+ * document).
+ */
+export type FileDataText = SharedV4FileDataText;
+
+/**
+ * File data as a tagged discriminated union:
+ *
+ * - `{ type: 'data', data }`: raw bytes (`Uint8Array`, `ArrayBuffer`, or
+ *   `Buffer`) or a base64-encoded string.
+ * - `{ type: 'url', url }`: a URL that points to the file.
+ * - `{ type: 'reference', reference }`: a provider reference (`{ [provider]: id }`).
+ * - `{ type: 'text', text }`: inline text content (e.g. an inline text document).
+ */
+export type FileData =
+  | FileDataData
+  | FileDataUrl
+  | FileDataReference
+  | FileDataText;

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,47 @@ export type {
   ToolResultOutput,
   ToolResultPart,
 } from './content-part';
+export type { Context } from './context';
 export type { DataContent } from './data-content';
+export { isExecutableTool, type ExecutableTool } from './executable-tool';
 export { executeTool } from './execute-tool';
+export type {
+  FileData,
+  FileDataData,
+  FileDataReference,
+  FileDataText,
+  FileDataUrl,
+} from './file-data';
+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 {
+  SandboxSession as Experimental_SandboxSession,
+  SandboxProcess as Experimental_SandboxProcess,
+} from './sandbox';
 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 { ToolApprovalRequest } from './tool-approval-request';
 export type { ToolApprovalResponse } from './tool-approval-response';
 export type { ToolCall } from './tool-call';
+export type {
+  ToolExecuteFunction,
+  ToolExecutionOptions,
+} from './tool-execute-function';
 export type { ToolContent, ToolModelMessage } from './tool-model-message';
+export type { ToolNeedsApprovalFunction } from './tool-needs-approval-function';
 export type { ToolResult } from './tool-result';
+export type { ToolSet } from './tool-set';
 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,41 @@
+import type { Context } from './context';
+import type { Tool } from './tool';
+
+/**
+ * Detects the `any` type so untyped tools can be treated as having no explicit
+ * context type.
+ */
+type IsAny<T> = 0 extends 1 & T ? true : false;
+
+/**
+ * Detects exact empty object contexts, including `{}` combined with
+ * `undefined`, which do not provide tool-specific context properties.
+ */
+type IsEmptyObject<T> = keyof NonNullable<T> extends never ? true : false;
+
+/**
+ * Detects context types that come from omitted or broad context declarations
+ * rather than a concrete tool context schema.
+ */
+type IsUntypedContext<CONTEXT> =
+  IsAny<CONTEXT> extends true
+    ? true
+    : unknown extends CONTEXT
+      ? true
+      : IsEmptyObject<CONTEXT> extends true
+        ? true
+        : string extends keyof CONTEXT
+          ? CONTEXT extends Context
+            ? true
+            : false
+          : false;
+
+/**
+ * Infer the context type of a tool.
+ */
+export type InferToolContext<TOOL extends Tool> =
+  TOOL extends Tool<any, any, infer CONTEXT>
+    ? IsUntypedContext<CONTEXT> extends true
+      ? never
+      : CONTEXT
+    : 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,44 @@
+import type { InferToolContext } from './infer-tool-context';
+import type { ToolSet } from './tool-set';
+
+/**
+ * Builds the required portion of the tool context map for tools whose context
+ * type does not include `undefined`.
+ */
+type RequiredToolSetContext<TOOLS extends ToolSet> = {
+  [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never
+    ? never
+    : undefined extends InferToolContext<NoInfer<TOOLS[K]>>
+      ? never
+      : K]: InferToolContext<NoInfer<TOOLS[K]>>;
+};
+
+/**
+ * Builds the optional portion of the tool context map for tools whose context
+ * object itself may be `undefined`.
+ */
+type OptionalToolSetContext<TOOLS extends ToolSet> = {
+  [K in keyof TOOLS as InferToolContext<NoInfer<TOOLS[K]>> extends never
+    ? never
+    : undefined extends InferToolContext<NoInfer<TOOLS[K]>>
+      ? K
+      : never]?: InferToolContext<NoInfer<TOOLS[K]>>;
+};
+
+/**
+ * Flattens intersected mapped types so type equality assertions and editor
+ * hovers show the resulting object shape.
+ */
+type Normalize<OBJECT> = { [KEY in keyof OBJECT]: OBJECT[KEY] };
+
+/**
+ * Infer the context type for a tool set.
+ *
+ * The inferred type maps each contextual tool name to its context type.
+ *
+ * Tools without concrete context are omitted. Tool contexts that include
+ * `undefined` are represented as optional properties.
+ */
+export type InferToolSetContext<TOOLS extends ToolSet> = Normalize<
+  RequiredToolSetContext<TOOLS> & OptionalToolSetContext<TOOLS>
+>;

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 { SharedV4ProviderOptions } from '@ai-sdk/provider';
+import type { SharedV4ProviderOptions } from '@ai-sdk/provider';
 
 /**
  * Additional provider-specific options.

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;