ai 5.0.0-canary.12 → 5.0.0-canary.14

package/dist/internal/index.d.mts

@@ -1,4 +1,4 @@
-import { SharedV2ProviderOptions, LanguageModelV2Usage, LanguageModelV2Source, JSONValue as JSONValue$1, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
+import { SharedV2ProviderOptions, LanguageModelV2Source, LanguageModelV2Usage, LanguageModelV2FinishReason, JSONValue as JSONValue$1, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ToolCall, ToolResult, Validator } from '@ai-sdk/provider-utils';
 import { JSONSchema7 } from 'json-schema';
@@ -117,26 +117,6 @@ interface ReasoningPart {
      */
     text: string;
     /**
-  An optional signature for verifying that the reasoning originated from the model.
-     */
-    signature?: 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;
-}
-/**
-Redacted reasoning content part of a prompt.
- */
-interface RedactedReasoningPart {
-    type: 'redacted-reasoning';
-    /**
-  Redacted reasoning data.
-     */
-    data: 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.
@@ -251,7 +231,7 @@ type CoreAssistantMessage = {
 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 | RedactedReasoningPart | ToolCallPart>;
+type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | ToolCallPart>;
 /**
 A tool message. It contains the result of one or more tool calls.
  */
@@ -275,6 +255,10 @@ It can be a user message, an assistant message, or a tool message.
  */
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 
+/**
+A source that has been used as input to generate the response.
+*/
+type Source = LanguageModelV2Source;
 /**
 Tool choice for the generation. It supports the following settings:
 
@@ -418,14 +402,10 @@ type ReasoningUIPart = {
      * The reasoning text.
      */
     reasoning: string;
-    details: Array<{
-        type: 'text';
-        text: string;
-        signature?: string;
-    } | {
-        type: 'redacted';
-        data: string;
-    }>;
+    /**
+     * The provider metadata.
+     */
+    providerMetadata?: Record<string, any>;
 };
 /**
  * A tool invocation part of a message.
@@ -477,6 +457,81 @@ type JSONValue = null | string | number | boolean | {
     [value: string]: JSONValue;
 } | Array<JSONValue>;
 
+type DataStreamString = `${(typeof DataStreamStringPrefixes)[keyof typeof DataStreamStringPrefixes]}:${string}\n`;
+interface DataStreamPart<CODE extends string, NAME extends string, TYPE> {
+    code: CODE;
+    name: NAME;
+    parse: (value: JSONValue) => {
+        type: NAME;
+        value: TYPE;
+    };
+}
+declare const dataStreamParts: readonly [DataStreamPart<"0", "text", string>, DataStreamPart<"2", "data", JSONValue[]>, DataStreamPart<"3", "error", string>, DataStreamPart<"8", "message_annotations", JSONValue[]>, DataStreamPart<"9", "tool_call", ToolCall<string, any>>, DataStreamPart<"a", "tool_result", Omit<ToolResult<string, any, any>, "toolName" | "args">>, DataStreamPart<"b", "tool_call_streaming_start", {
+    toolCallId: string;
+    toolName: string;
+}>, DataStreamPart<"c", "tool_call_delta", {
+    toolCallId: string;
+    argsTextDelta: string;
+}>, DataStreamPart<"d", "finish_message", {
+    finishReason: LanguageModelV2FinishReason;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+}>, DataStreamPart<"e", "finish_step", {
+    isContinued: boolean;
+    finishReason: LanguageModelV2FinishReason;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+}>, DataStreamPart<"f", "start_step", {
+    messageId: string;
+}>, DataStreamPart<"g", "reasoning", {
+    text: string;
+    providerMetadata?: Record<string, any> | undefined;
+}>, DataStreamPart<"h", "source", LanguageModelV2Source>, DataStreamPart<"l", "reasoning_part_finish", {}>, DataStreamPart<"k", "file", {
+    data: string;
+    mimeType: string;
+}>];
+type DataStreamParts = (typeof dataStreamParts)[number];
+/**
+ * Maps the type of a stream part to its value type.
+ */
+type DataStreamPartValueType = {
+    [P in DataStreamParts as P['name']]: ReturnType<P['parse']>['value'];
+};
+/**
+ * The map of prefixes for data in the stream
+ *
+ * - 0: Text from the LLM response
+ * - 1: (OpenAI) function_call responses
+ * - 2: custom JSON added by the user using `Data`
+ * - 6: (OpenAI) tool_call responses
+ *
+ * Example:
+ * ```
+ * 0:Vercel
+ * 0:'s
+ * 0: AI
+ * 0: AI
+ * 0: SDK
+ * 0: is great
+ * 0:!
+ * 2: { "someJson": "value" }
+ * 1: {"function_call": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}
+ * 6: {"tool_call": {"id": "tool_0", "type": "function", "function": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}}
+ *```
+ */
+declare const DataStreamStringPrefixes: { [K in DataStreamParts["name"]]: (typeof dataStreamParts)[number]["code"]; };
+/**
+Prepends a string with a prefix from the `StreamChunkPrefixes`, JSON-ifies it,
+and appends a new line.
+
+It ensures type-safety for the part type and value.
+ */
+declare function formatDataStreamPart<T extends keyof DataStreamPartValueType>(type: T, value: DataStreamPartValueType[T]): DataStreamString;
+
 /**
  * Used to mark schemas so we can support both Zod and custom schemas.
  */
@@ -588,11 +643,6 @@ type Prompt = {
 };
 
 type StandardizedPrompt = {
-    /**
-     * Original prompt type. This is forwarded to the providers and can be used
-     * to write send raw text to providers that support it.
-     */
-    type: 'prompt' | 'messages';
     /**
      * System message.
      */
@@ -605,7 +655,7 @@ type StandardizedPrompt = {
 declare function standardizePrompt<TOOLS extends ToolSet>({ prompt, tools, }: {
     prompt: Prompt;
     tools: undefined | TOOLS;
-}): StandardizedPrompt;
+}): Promise<StandardizedPrompt>;
 
 type CallSettings = {
     /**
@@ -682,6 +732,52 @@ type CallSettings = {
     headers?: Record<string, string | undefined>;
 };
 
+interface DataStreamWriter {
+    /**
+     * Appends a data part to the stream.
+     */
+    write(data: DataStreamString): void;
+    /**
+     * Appends a data part to the stream.
+     */
+    writeData(value: JSONValue$1): void;
+    /**
+     * Appends a message annotation to the stream.
+     */
+    writeMessageAnnotation(value: JSONValue$1): void;
+    /**
+     * Appends a source part to the stream.
+     */
+    writeSource(source: Source): void;
+    /**
+     * Merges the contents of another stream to this stream.
+     */
+    merge(stream: ReadableStream<DataStreamString>): void;
+    /**
+     * Error handler that is used by the data stream writer.
+     * This is intended for forwarding when merging streams
+     * to prevent duplicated error masking.
+     */
+    onError: ((error: unknown) => string) | undefined;
+}
+
+/**
+ * A stream wrapper to send custom JSON-encoded data back to the client.
+ *
+ * @deprecated Please use `createDataStream`, `createDataStreamResponse`, and `pipeDataStreamToResponse` instead.
+ */
+declare class StreamData {
+    private encoder;
+    private controller;
+    stream: ReadableStream<Uint8Array>;
+    private isClosed;
+    private warningTimeout;
+    constructor();
+    close(): Promise<void>;
+    append(value: JSONValue): void;
+    appendMessageAnnotation(value: JSONValue): void;
+}
+
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
     tools: TOOLS | undefined;
     toolChoice: ToolChoice<TOOLS> | undefined;
@@ -723,10 +819,73 @@ declare function convertToLanguageModelPrompt({ prompt, supportedUrls, downloadI
     downloadImplementation?: typeof download;
 }): Promise<LanguageModelV2Prompt>;
 
+/**
+ * Merges two readable streams into a single readable stream, emitting values
+ * from each stream as they become available.
+ *
+ * The first stream is prioritized over the second stream. If both streams have
+ * values available, the first stream's value is emitted first.
+ *
+ * @template VALUE1 - The type of values emitted by the first stream.
+ * @template VALUE2 - The type of values emitted by the second stream.
+ * @param {ReadableStream<VALUE1>} stream1 - The first readable stream.
+ * @param {ReadableStream<VALUE2>} stream2 - The second readable stream.
+ * @returns {ReadableStream<VALUE1 | VALUE2>} A new readable stream that emits values from both input streams.
+ */
+declare function mergeStreams<VALUE1, VALUE2>(stream1: ReadableStream<VALUE1>, stream2: ReadableStream<VALUE2>): ReadableStream<VALUE1 | VALUE2>;
+
+declare function prepareResponseHeaders(headers: HeadersInit | undefined, { contentType, dataStreamVersion, }: {
+    contentType: string;
+    dataStreamVersion?: 'v1' | undefined;
+}): Headers;
+
+/**
+ * Configuration options and helper callback methods for stream lifecycle events.
+ */
+interface StreamCallbacks {
+    /** `onStart`: Called once when the stream is initialized. */
+    onStart?: () => Promise<void> | void;
+    /**
+     * `onCompletion`: Called for each tokenized message.
+     *
+     * @deprecated Use `onFinal` instead.
+     */
+    onCompletion?: (completion: string) => Promise<void> | void;
+    /** `onFinal`: Called once when the stream is closed with the final completion message. */
+    onFinal?: (completion: string) => Promise<void> | void;
+    /** `onToken`: Called for each tokenized message. */
+    onToken?: (token: string) => Promise<void> | void;
+    /** `onText`: Called for each text chunk. */
+    onText?: (text: string) => Promise<void> | void;
+}
+/**
+ * Creates a transform stream that encodes input messages and invokes optional callback functions.
+ * The transform stream uses the provided callbacks to execute custom logic at different stages of the stream's lifecycle.
+ * - `onStart`: Called once when the stream is initialized.
+ * - `onToken`: Called for each tokenized message.
+ * - `onCompletion`: Called every time a completion message is received. This can occur multiple times when using e.g. OpenAI functions
+ * - `onFinal`: Called once when the stream is closed with the final completion message.
+ *
+ * This function is useful when you want to process a stream of messages and perform specific actions during the stream's lifecycle.
+ *
+ * @param {StreamCallbacks} [callbacks] - An object containing the callback functions.
+ * @return {TransformStream<string, Uint8Array>} A transform stream that encodes input messages as Uint8Array and allows the execution of custom logic through callbacks.
+ *
+ * @example
+ * const callbacks = {
+ *   onStart: async () => console.log('Stream started'),
+ *   onToken: async (token) => console.log(`Token: ${token}`),
+ *   onCompletion: async (completion) => console.log(`Completion: ${completion}`)
+ *   onFinal: async () => data.close()
+ * };
+ * const transformer = createCallbacksTransformer(callbacks);
+ */
+declare function createCallbacksTransformer(callbacks?: StreamCallbacks | undefined): TransformStream<string, Uint8Array>;
+
 /**
  * Warning time for notifying developers that a stream is hanging in dev mode
  * using a console.warn.
  */
 declare const HANGING_STREAM_WARNING_TIME_MS: number;
 
-export { HANGING_STREAM_WARNING_TIME_MS, calculateLanguageModelUsage, convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { DataStreamWriter, HANGING_STREAM_WARNING_TIME_MS, StreamCallbacks, StreamData, calculateLanguageModelUsage, convertToLanguageModelPrompt, createCallbacksTransformer, formatDataStreamPart, mergeStreams, prepareCallSettings, prepareResponseHeaders, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };

package/dist/internal/index.d.ts

@@ -1,4 +1,4 @@
-import { SharedV2ProviderOptions, LanguageModelV2Usage, LanguageModelV2Source, JSONValue as JSONValue$1, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
+import { SharedV2ProviderOptions, LanguageModelV2Source, LanguageModelV2Usage, LanguageModelV2FinishReason, JSONValue as JSONValue$1, JSONObject, LanguageModelV2FunctionTool, LanguageModelV2ProviderDefinedTool, LanguageModelV2ToolChoice, LanguageModelV2Prompt } from '@ai-sdk/provider';
 import { z } from 'zod';
 import { ToolCall, ToolResult, Validator } from '@ai-sdk/provider-utils';
 import { JSONSchema7 } from 'json-schema';
@@ -117,26 +117,6 @@ interface ReasoningPart {
      */
     text: string;
     /**
-  An optional signature for verifying that the reasoning originated from the model.
-     */
-    signature?: 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;
-}
-/**
-Redacted reasoning content part of a prompt.
- */
-interface RedactedReasoningPart {
-    type: 'redacted-reasoning';
-    /**
-  Redacted reasoning data.
-     */
-    data: 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.
@@ -251,7 +231,7 @@ type CoreAssistantMessage = {
 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 | RedactedReasoningPart | ToolCallPart>;
+type AssistantContent = string | Array<TextPart | FilePart | ReasoningPart | ToolCallPart>;
 /**
 A tool message. It contains the result of one or more tool calls.
  */
@@ -275,6 +255,10 @@ It can be a user message, an assistant message, or a tool message.
  */
 type CoreMessage = CoreSystemMessage | CoreUserMessage | CoreAssistantMessage | CoreToolMessage;
 
+/**
+A source that has been used as input to generate the response.
+*/
+type Source = LanguageModelV2Source;
 /**
 Tool choice for the generation. It supports the following settings:
 
@@ -418,14 +402,10 @@ type ReasoningUIPart = {
      * The reasoning text.
      */
     reasoning: string;
-    details: Array<{
-        type: 'text';
-        text: string;
-        signature?: string;
-    } | {
-        type: 'redacted';
-        data: string;
-    }>;
+    /**
+     * The provider metadata.
+     */
+    providerMetadata?: Record<string, any>;
 };
 /**
  * A tool invocation part of a message.
@@ -477,6 +457,81 @@ type JSONValue = null | string | number | boolean | {
     [value: string]: JSONValue;
 } | Array<JSONValue>;
 
+type DataStreamString = `${(typeof DataStreamStringPrefixes)[keyof typeof DataStreamStringPrefixes]}:${string}\n`;
+interface DataStreamPart<CODE extends string, NAME extends string, TYPE> {
+    code: CODE;
+    name: NAME;
+    parse: (value: JSONValue) => {
+        type: NAME;
+        value: TYPE;
+    };
+}
+declare const dataStreamParts: readonly [DataStreamPart<"0", "text", string>, DataStreamPart<"2", "data", JSONValue[]>, DataStreamPart<"3", "error", string>, DataStreamPart<"8", "message_annotations", JSONValue[]>, DataStreamPart<"9", "tool_call", ToolCall<string, any>>, DataStreamPart<"a", "tool_result", Omit<ToolResult<string, any, any>, "toolName" | "args">>, DataStreamPart<"b", "tool_call_streaming_start", {
+    toolCallId: string;
+    toolName: string;
+}>, DataStreamPart<"c", "tool_call_delta", {
+    toolCallId: string;
+    argsTextDelta: string;
+}>, DataStreamPart<"d", "finish_message", {
+    finishReason: LanguageModelV2FinishReason;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+}>, DataStreamPart<"e", "finish_step", {
+    isContinued: boolean;
+    finishReason: LanguageModelV2FinishReason;
+    usage?: {
+        promptTokens: number;
+        completionTokens: number;
+    };
+}>, DataStreamPart<"f", "start_step", {
+    messageId: string;
+}>, DataStreamPart<"g", "reasoning", {
+    text: string;
+    providerMetadata?: Record<string, any> | undefined;
+}>, DataStreamPart<"h", "source", LanguageModelV2Source>, DataStreamPart<"l", "reasoning_part_finish", {}>, DataStreamPart<"k", "file", {
+    data: string;
+    mimeType: string;
+}>];
+type DataStreamParts = (typeof dataStreamParts)[number];
+/**
+ * Maps the type of a stream part to its value type.
+ */
+type DataStreamPartValueType = {
+    [P in DataStreamParts as P['name']]: ReturnType<P['parse']>['value'];
+};
+/**
+ * The map of prefixes for data in the stream
+ *
+ * - 0: Text from the LLM response
+ * - 1: (OpenAI) function_call responses
+ * - 2: custom JSON added by the user using `Data`
+ * - 6: (OpenAI) tool_call responses
+ *
+ * Example:
+ * ```
+ * 0:Vercel
+ * 0:'s
+ * 0: AI
+ * 0: AI
+ * 0: SDK
+ * 0: is great
+ * 0:!
+ * 2: { "someJson": "value" }
+ * 1: {"function_call": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}
+ * 6: {"tool_call": {"id": "tool_0", "type": "function", "function": {"name": "get_current_weather", "arguments": "{\\n\\"location\\": \\"Charlottesville, Virginia\\",\\n\\"format\\": \\"celsius\\"\\n}"}}}
+ *```
+ */
+declare const DataStreamStringPrefixes: { [K in DataStreamParts["name"]]: (typeof dataStreamParts)[number]["code"]; };
+/**
+Prepends a string with a prefix from the `StreamChunkPrefixes`, JSON-ifies it,
+and appends a new line.
+
+It ensures type-safety for the part type and value.
+ */
+declare function formatDataStreamPart<T extends keyof DataStreamPartValueType>(type: T, value: DataStreamPartValueType[T]): DataStreamString;
+
 /**
  * Used to mark schemas so we can support both Zod and custom schemas.
  */
@@ -588,11 +643,6 @@ type Prompt = {
 };
 
 type StandardizedPrompt = {
-    /**
-     * Original prompt type. This is forwarded to the providers and can be used
-     * to write send raw text to providers that support it.
-     */
-    type: 'prompt' | 'messages';
     /**
      * System message.
      */
@@ -605,7 +655,7 @@ type StandardizedPrompt = {
 declare function standardizePrompt<TOOLS extends ToolSet>({ prompt, tools, }: {
     prompt: Prompt;
     tools: undefined | TOOLS;
-}): StandardizedPrompt;
+}): Promise<StandardizedPrompt>;
 
 type CallSettings = {
     /**
@@ -682,6 +732,52 @@ type CallSettings = {
     headers?: Record<string, string | undefined>;
 };
 
+interface DataStreamWriter {
+    /**
+     * Appends a data part to the stream.
+     */
+    write(data: DataStreamString): void;
+    /**
+     * Appends a data part to the stream.
+     */
+    writeData(value: JSONValue$1): void;
+    /**
+     * Appends a message annotation to the stream.
+     */
+    writeMessageAnnotation(value: JSONValue$1): void;
+    /**
+     * Appends a source part to the stream.
+     */
+    writeSource(source: Source): void;
+    /**
+     * Merges the contents of another stream to this stream.
+     */
+    merge(stream: ReadableStream<DataStreamString>): void;
+    /**
+     * Error handler that is used by the data stream writer.
+     * This is intended for forwarding when merging streams
+     * to prevent duplicated error masking.
+     */
+    onError: ((error: unknown) => string) | undefined;
+}
+
+/**
+ * A stream wrapper to send custom JSON-encoded data back to the client.
+ *
+ * @deprecated Please use `createDataStream`, `createDataStreamResponse`, and `pipeDataStreamToResponse` instead.
+ */
+declare class StreamData {
+    private encoder;
+    private controller;
+    stream: ReadableStream<Uint8Array>;
+    private isClosed;
+    private warningTimeout;
+    constructor();
+    close(): Promise<void>;
+    append(value: JSONValue): void;
+    appendMessageAnnotation(value: JSONValue): void;
+}
+
 declare function prepareToolsAndToolChoice<TOOLS extends ToolSet>({ tools, toolChoice, activeTools, }: {
     tools: TOOLS | undefined;
     toolChoice: ToolChoice<TOOLS> | undefined;
@@ -723,10 +819,73 @@ declare function convertToLanguageModelPrompt({ prompt, supportedUrls, downloadI
     downloadImplementation?: typeof download;
 }): Promise<LanguageModelV2Prompt>;
 
+/**
+ * Merges two readable streams into a single readable stream, emitting values
+ * from each stream as they become available.
+ *
+ * The first stream is prioritized over the second stream. If both streams have
+ * values available, the first stream's value is emitted first.
+ *
+ * @template VALUE1 - The type of values emitted by the first stream.
+ * @template VALUE2 - The type of values emitted by the second stream.
+ * @param {ReadableStream<VALUE1>} stream1 - The first readable stream.
+ * @param {ReadableStream<VALUE2>} stream2 - The second readable stream.
+ * @returns {ReadableStream<VALUE1 | VALUE2>} A new readable stream that emits values from both input streams.
+ */
+declare function mergeStreams<VALUE1, VALUE2>(stream1: ReadableStream<VALUE1>, stream2: ReadableStream<VALUE2>): ReadableStream<VALUE1 | VALUE2>;
+
+declare function prepareResponseHeaders(headers: HeadersInit | undefined, { contentType, dataStreamVersion, }: {
+    contentType: string;
+    dataStreamVersion?: 'v1' | undefined;
+}): Headers;
+
+/**
+ * Configuration options and helper callback methods for stream lifecycle events.
+ */
+interface StreamCallbacks {
+    /** `onStart`: Called once when the stream is initialized. */
+    onStart?: () => Promise<void> | void;
+    /**
+     * `onCompletion`: Called for each tokenized message.
+     *
+     * @deprecated Use `onFinal` instead.
+     */
+    onCompletion?: (completion: string) => Promise<void> | void;
+    /** `onFinal`: Called once when the stream is closed with the final completion message. */
+    onFinal?: (completion: string) => Promise<void> | void;
+    /** `onToken`: Called for each tokenized message. */
+    onToken?: (token: string) => Promise<void> | void;
+    /** `onText`: Called for each text chunk. */
+    onText?: (text: string) => Promise<void> | void;
+}
+/**
+ * Creates a transform stream that encodes input messages and invokes optional callback functions.
+ * The transform stream uses the provided callbacks to execute custom logic at different stages of the stream's lifecycle.
+ * - `onStart`: Called once when the stream is initialized.
+ * - `onToken`: Called for each tokenized message.
+ * - `onCompletion`: Called every time a completion message is received. This can occur multiple times when using e.g. OpenAI functions
+ * - `onFinal`: Called once when the stream is closed with the final completion message.
+ *
+ * This function is useful when you want to process a stream of messages and perform specific actions during the stream's lifecycle.
+ *
+ * @param {StreamCallbacks} [callbacks] - An object containing the callback functions.
+ * @return {TransformStream<string, Uint8Array>} A transform stream that encodes input messages as Uint8Array and allows the execution of custom logic through callbacks.
+ *
+ * @example
+ * const callbacks = {
+ *   onStart: async () => console.log('Stream started'),
+ *   onToken: async (token) => console.log(`Token: ${token}`),
+ *   onCompletion: async (completion) => console.log(`Completion: ${completion}`)
+ *   onFinal: async () => data.close()
+ * };
+ * const transformer = createCallbacksTransformer(callbacks);
+ */
+declare function createCallbacksTransformer(callbacks?: StreamCallbacks | undefined): TransformStream<string, Uint8Array>;
+
 /**
  * Warning time for notifying developers that a stream is hanging in dev mode
  * using a console.warn.
  */
 declare const HANGING_STREAM_WARNING_TIME_MS: number;
 
-export { HANGING_STREAM_WARNING_TIME_MS, calculateLanguageModelUsage, convertToLanguageModelPrompt, prepareCallSettings, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };
+export { DataStreamWriter, HANGING_STREAM_WARNING_TIME_MS, StreamCallbacks, StreamData, calculateLanguageModelUsage, convertToLanguageModelPrompt, createCallbacksTransformer, formatDataStreamPart, mergeStreams, prepareCallSettings, prepareResponseHeaders, prepareRetries, prepareToolsAndToolChoice, standardizePrompt };