@ai-sdk/provider-utils 4.0.10 → 4.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider-utils",
-  "version": "4.0.10",
+  "version": "4.0.11",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -35,7 +35,7 @@
   "dependencies": {
     "@standard-schema/spec": "^1.1.0",
     "eventsource-parser": "^3.0.6",
-    "@ai-sdk/provider": "3.0.5"
+    "@ai-sdk/provider": "3.0.6"
   },
   "devDependencies": {
     "@types/node": "20.17.24",

package/src/extract-response-headers.ts

@@ -1,9 +1,9 @@
 /**
-Extracts the headers from a response object and returns them as a key-value object.
-
-@param response - The response object to extract headers from.
-@returns The headers as a key-value object.
-*/
+ * Extracts the headers from a response object and returns them as a key-value object.
+ *
+ * @param response - The response object to extract headers from.
+ * @returns The headers as a key-value object.
+ */
 export function extractResponseHeaders(response: Response) {
   return Object.fromEntries<string>([...response.headers]);
 }

package/src/generate-id.ts

@@ -1,14 +1,14 @@
 import { InvalidArgumentError } from '@ai-sdk/provider';
 
 /**
-Creates an ID generator.
-The total length of the ID is the sum of the prefix, separator, and random part length.
-Not cryptographically secure.
-
-@param alphabet - The alphabet to use for the ID. Default: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'.
-@param prefix - The prefix of the ID to generate. Optional.
-@param separator - The separator between the prefix and the random part of the ID. Default: '-'.
-@param size - The size of the random part of the ID to generate. Default: 16.
+ * Creates an ID generator.
+ * The total length of the ID is the sum of the prefix, separator, and random part length.
+ * Not cryptographically secure.
+ *
+ * @param alphabet - The alphabet to use for the ID. Default: '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'.
+ * @param prefix - The prefix of the ID to generate. Optional.
+ * @param separator - The separator between the prefix and the random part of the ID. Default: '-'.
+ * @param size - The size of the random part of the ID to generate. Default: 16.
  */
 export const createIdGenerator = ({
   prefix,
@@ -46,12 +46,12 @@ export const createIdGenerator = ({
 };
 
 /**
-A function that generates an ID.
+ * A function that generates an ID.
  */
 export type IdGenerator = () => string;
 
 /**
-Generates a 16-character random string to use for IDs.
-Not cryptographically secure.
+ * Generates a 16-character random string to use for IDs.
+ * Not cryptographically secure.
  */
 export const generateId = createIdGenerator();

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

@@ -9,23 +9,23 @@ import { ProviderOptions } from './provider-options';
 import { ToolApprovalRequest } from './tool-approval-request';
 
 /**
-An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
+ * An assistant message. It can contain text, tool calls, or a combination of text and tool calls.
  */
 export type AssistantModelMessage = {
   role: 'assistant';
   content: AssistantContent;
 
   /**
-  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.
+   * 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;
 };
 
 /**
-Content of an assistant message.
-It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
+ * Content of an assistant message.
+ * It can be a string or an array of text, image, reasoning, redacted reasoning, and tool call parts.
  */
 export type AssistantContent =
   | string

package/src/types/content-part.ts

@@ -3,84 +3,84 @@ import { DataContent } from './data-content';
 import { ProviderOptions } from './provider-options';
 
 /**
-Text content part of a prompt. It contains a string of text.
+ * Text content part of a prompt. It contains a string of text.
  */
 export interface TextPart {
   type: 'text';
 
   /**
-The text content.
+   * The text content.
    */
   text: 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.
- */
+   * 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;
 }
 
 /**
-Image content part of a prompt. It contains an image.
+ * Image content part of a prompt. It contains an image.
  */
 export interface ImagePart {
   type: 'image';
 
   /**
-Image data. Can either be:
-
-- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
-- URL: a URL that points to the image
+   * Image data. Can either be:
+   *
+   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
+   * - URL: a URL that points to the image
    */
   image: DataContent | URL;
 
   /**
-Optional IANA media type of the image.
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
+   * Optional IANA media type of the image.
+   *
+   * @see https://www.iana.org/assignments/media-types/media-types.xhtml
    */
   mediaType?: 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.
- */
+   * 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;
 }
 
 /**
-File content part of a prompt. It contains a file.
+ * File content part of a prompt. It contains a file.
  */
 export interface FilePart {
   type: 'file';
 
   /**
-File data. Can either be:
-
-- data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
-- URL: a URL that points to the image
+   * File data. Can either be:
+   *
+   * - data: a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer
+   * - URL: a URL that points to the image
    */
   data: DataContent | URL;
 
   /**
-Optional filename of the file.
+   * Optional filename of the file.
    */
   filename?: string;
 
   /**
-IANA media type of the file.
-
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
+   * IANA media type of the file.
+   *
+   * @see https://www.iana.org/assignments/media-types/media-types.xhtml
    */
   mediaType: 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.
- */
+   * 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;
 }
 
@@ -91,78 +91,78 @@ export interface ReasoningPart {
   type: 'reasoning';
 
   /**
-The reasoning text.
+   * The reasoning text.
    */
   text: 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.
- */
+   * 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;
 }
 
 /**
-Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
+ * Tool call content part of a prompt. It contains a tool call (usually generated by the AI model).
  */
 export interface ToolCallPart {
   type: 'tool-call';
 
   /**
-ID of the tool call. This ID is used to match the tool call with the tool result.
- */
+   * ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
   toolCallId: string;
 
   /**
-Name of the tool that is being called.
- */
+   * Name of the tool that is being called.
+   */
   toolName: string;
 
   /**
-Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
    */
   input: unknown;
 
   /**
-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.
- */
+   * 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;
 
   /**
-Whether the tool call was executed by the provider.
- */
+   * Whether the tool call was executed by the provider.
+   */
   providerExecuted?: boolean;
 }
 
 /**
-Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
+ * Tool result content part of a prompt. It contains the result of the tool call with the matching ID.
  */
 export interface ToolResultPart {
   type: 'tool-result';
 
   /**
-ID of the tool call that this result is associated with.
- */
+   * ID of the tool call that this result is associated with.
+   */
   toolCallId: string;
 
   /**
-Name of the tool that generated this result.
-  */
+   * Name of the tool that generated this result.
+   */
   toolName: string;
 
   /**
-Result of the tool call. This is a JSON-serializable object.
+   * Result of the tool call. This is a JSON-serializable object.
    */
   output: ToolResultOutput;
 
   /**
-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.
- */
+   * 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;
 }
 
@@ -232,8 +232,8 @@ export type ToolResultOutput =
             type: 'text';
 
             /**
-Text content.
-*/
+             * Text content.
+             */
             text: string;
 
             /**
@@ -253,14 +253,14 @@ Text content.
             type: 'file-data';
 
             /**
-Base-64 encoded media data.
-*/
+             * Base-64 encoded media data.
+             */
             data: string;
 
             /**
-IANA media type.
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
-*/
+             * IANA media type.
+             * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+             */
             mediaType: string;
 
             /**
@@ -311,14 +311,14 @@ IANA media type.
             type: 'image-data';
 
             /**
-Base-64 encoded image data.
-*/
+             * Base-64 encoded image data.
+             */
             data: string;
 
             /**
-IANA media type.
-@see https://www.iana.org/assignments/media-types/media-types.xhtml
-*/
+             * IANA media type.
+             * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+             */
             mediaType: string;
 
             /**

package/src/types/data-content.ts

@@ -1,4 +1,4 @@
 /**
-Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
+ * Data content. Can either be a base64-encoded string, a Uint8Array, an ArrayBuffer, or a Buffer.
  */
 export type DataContent = string | Uint8Array | ArrayBuffer | Buffer;

package/src/types/model-message.ts

@@ -4,8 +4,8 @@ import { ToolModelMessage } from './tool-model-message';
 import { UserModelMessage } from './user-model-message';
 
 /**
-A message that can be used in the `messages` field of a prompt.
-It can be a user message, an assistant message, or a tool message.
+ * A message that can be used in the `messages` field of a prompt.
+ * It can be a user message, an assistant message, or a tool message.
  */
 export type ModelMessage =
   | SystemModelMessage

package/src/types/provider-options.ts

@@ -1,9 +1,9 @@
 import { SharedV3ProviderOptions } from '@ai-sdk/provider';
 
 /**
-Additional provider-specific options.
-
-They are passed through to the provider from the AI SDK and enable
-provider-specific functionality that can be fully encapsulated in the provider.
+ * Additional provider-specific options.
+ *
+ * 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;

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

@@ -1,20 +1,20 @@
 import { ProviderOptions } from './provider-options';
 
 /**
- A system message. It can contain system information.
-
- Note: using the "system" part of the prompt is strongly preferred
- to increase the resilience against prompt injection attacks,
- and because not all providers support several system messages.
+ * A system message. It can contain system information.
+ *
+ * Note: using the "system" part of the prompt is strongly preferred
+ * to increase the resilience against prompt injection attacks,
+ * and because not all providers support several system messages.
  */
 export type SystemModelMessage = {
   role: 'system';
   content: 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.
-     */
+   * 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;
 };

package/src/types/tool-call.ts

@@ -1,20 +1,20 @@
 /**
-Typed tool call that is returned by generateText and streamText.
-It contains the tool call ID, the tool name, and the tool arguments.
+ * Typed tool call that is returned by generateText and streamText.
+ * It contains the tool call ID, the tool name, and the tool arguments.
  */
 export interface ToolCall<NAME extends string, INPUT> {
   /**
-ID of the tool call. This ID is used to match the tool call with the tool result.
- */
+   * ID of the tool call. This ID is used to match the tool call with the tool result.
+   */
   toolCallId: string;
 
   /**
-Name of the tool that is being called.
- */
+   * Name of the tool that is being called.
+   */
   toolName: NAME;
 
   /**
-Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
    */
   input: INPUT;
 

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

@@ -3,21 +3,21 @@ import { ProviderOptions } from './provider-options';
 import { ToolApprovalResponse } from './tool-approval-response';
 
 /**
-A tool message. It contains the result of one or more tool calls.
+ * A tool message. It contains the result of one or more tool calls.
  */
 export type ToolModelMessage = {
   role: 'tool';
   content: ToolContent;
 
   /**
-  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.
+   * 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;
 };
 
 /**
-Content of a tool message. It is an array of tool result parts.
+ * Content of a tool message. It is an array of tool result parts.
  */
 export type ToolContent = Array<ToolResultPart | ToolApprovalResponse>;

package/src/types/tool-result.ts

@@ -1,26 +1,26 @@
 /**
-Typed tool result that is returned by `generateText` and `streamText`.
-It contains the tool call ID, the tool name, the tool arguments, and the tool result.
+ * Typed tool result that is returned by `generateText` and `streamText`.
+ * It contains the tool call ID, the tool name, the tool arguments, and the tool result.
  */
 export interface ToolResult<NAME extends string, INPUT, OUTPUT> {
   /**
-ID of the tool call. This ID is used to match the tool call with the tool result.
+   * ID of the tool call. This ID is used to match the tool call with the tool result.
    */
   toolCallId: string;
 
   /**
-Name of the tool that was called.
+   * Name of the tool that was called.
    */
   toolName: NAME;
 
   /**
-Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
-     */
+   * Arguments of the tool call. This is a JSON-serializable object that matches the tool's input schema.
+   */
   input: INPUT;
 
   /**
-Result of the tool call. This is the result of the tool's execution.
-     */
+   * Result of the tool call. This is the result of the tool's execution.
+   */
   output: OUTPUT;
 
   /**

package/src/types/tool.ts

@@ -82,12 +82,12 @@ type ToolOutputProperties<INPUT, OUTPUT> = NeverOptional<
   OUTPUT,
   | {
       /**
-An async function that is called with the arguments from the tool call and produces a result.
-If not provided, the tool will not be executed automatically.
-
-@args is the input of the tool call.
-@options.abortSignal is a signal that can be used to abort the tool call.
-    */
+       * An async function that is called with the arguments from the tool call and produces a result.
+       * If not provided, the tool will not be executed automatically.
+       *
+       * @args is the input of the tool call.
+       * @options.abortSignal is a signal that can be used to abort the tool call.
+       */
       execute: ToolExecuteFunction<INPUT, OUTPUT>;
 
       outputSchema?: FlexibleSchema<OUTPUT>;
@@ -100,19 +100,19 @@ If not provided, the tool will not be executed automatically.
 >;
 
 /**
-A tool contains the description and the schema of the input that the tool expects.
-This enables the language model to generate the input.
-
-The tool can also contain an optional execute function for the actual execution function of the tool.
+ * A tool contains the description and the schema of the input that the tool expects.
+ * This enables the language model to generate the input.
+ *
+ * The tool can also contain an optional execute function for the actual execution function of the tool.
  */
 export type Tool<
   INPUT extends JSONValue | unknown | never = any,
   OUTPUT extends JSONValue | unknown | never = any,
 > = {
   /**
-An optional description of what the tool does.
-Will be used by the language model to decide whether to use the tool.
-Not used for provider-defined tools.
+   * An optional description of what the tool does.
+   * Will be used by the language model to decide whether to use the tool.
+   * Not used for provider-defined tools.
    */
   description?: string;
 
@@ -122,9 +122,9 @@ Not used for provider-defined tools.
   title?: 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.
+   * 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;
 
@@ -211,31 +211,31 @@ functionality that can be fully encapsulated in the provider.
   } & (
     | {
         /**
-Tool with user-defined input and output schemas.
-     */
+         * Tool with user-defined input and output schemas.
+         */
         type?: undefined | 'function';
       }
     | {
         /**
-Tool that is defined at runtime (e.g. an MCP tool).
-The types of input and output are not known at development time.
-       */
+         * Tool that is defined at runtime (e.g. an MCP tool).
+         * The types of input and output are not known at development time.
+         */
         type: 'dynamic';
       }
     | {
         /**
-Tool with provider-defined input and output schemas.
-     */
+         * Tool with provider-defined input and output schemas.
+         */
         type: 'provider';
 
         /**
-The ID of the tool. Must follow the format `<provider-name>.<unique-tool-name>`.
-   */
+         * The ID of the tool. Must follow the format `<provider-name>.<unique-tool-name>`.
+         */
         id: `${string}.${string}`;
 
         /**
-The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
-     */
+         * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+         */
         args: Record<string, unknown>;
 
         /**
@@ -268,7 +268,7 @@ export type InferToolOutput<TOOL extends Tool> =
   TOOL extends Tool<any, infer OUTPUT> ? OUTPUT : never;
 
 /**
-Helper function for inferring the execute args of a tool.
+ * Helper function for inferring the execute args of a tool.
  */
 // Note: overload order is important for auto-completion
 export function tool<INPUT, OUTPUT>(