ai 5.0.0-beta.22 → 5.0.0-beta.24

package/dist/index.d.ts

@@ -1004,13 +1004,13 @@ Callback that is set using the `onError` option.
  */
 type StreamTextOnErrorCallback = (event: {
     error: unknown;
-}) => Promise<void> | void;
+}) => PromiseLike<void> | void;
 /**
 Callback that is set using the `onStepFinish` option.
 
 @param stepResult - The result of the step.
  */
-type StreamTextOnStepFinishCallback<TOOLS extends ToolSet> = (stepResult: StepResult<TOOLS>) => Promise<void> | void;
+type StreamTextOnStepFinishCallback<TOOLS extends ToolSet> = (stepResult: StepResult<TOOLS>) => PromiseLike<void> | void;
 /**
 Callback that is set using the `onChunk` option.
 
@@ -1020,7 +1020,7 @@ type StreamTextOnChunkCallback<TOOLS extends ToolSet> = (event: {
     chunk: Extract<TextStreamPart<TOOLS>, {
         type: 'text' | 'reasoning' | 'source' | 'tool-call' | 'tool-input-start' | 'tool-input-delta' | 'tool-result' | 'raw';
     }>;
-}) => Promise<void> | void;
+}) => PromiseLike<void> | void;
 /**
 Callback that is set using the `onFinish` option.
 
@@ -1035,7 +1035,18 @@ Details for all steps.
 Total usage for all steps. This is the sum of the usage of all steps.
      */
     readonly totalUsage: LanguageModelUsage;
-}) => Promise<void> | void;
+}) => PromiseLike<void> | void;
+/**
+Callback that is set using the `onAbort` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamTextOnAbortCallback<TOOLS extends ToolSet> = (event: {
+    /**
+  Details for all previously finished steps.
+     */
+    readonly steps: StepResult<TOOLS>[];
+}) => PromiseLike<void> | void;
 /**
 Generate a text and call tools for a given prompt using a language model.
 
@@ -1084,7 +1095,7 @@ If set and supported by the model, calls will generate deterministic results.
 @return
 A result object for accessing different stream types and additional information.
  */
-declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, includeRawChunks, onChunk, onError, onFinish, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
+declare function streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>({ model, tools, toolChoice, system, prompt, messages, maxRetries, abortSignal, headers, stopWhen, experimental_output: output, experimental_telemetry: telemetry, prepareStep, providerOptions, experimental_activeTools, activeTools, experimental_repairToolCall: repairToolCall, experimental_transform: transform, includeRawChunks, onChunk, onError, onFinish, onAbort, onStepFinish, _internal: { now, generateId, currentDate, }, ...settings }: CallSettings & Prompt & {
     /**
 The language model to use.
      */
@@ -1174,6 +1185,7 @@ Callback that is called when the LLM response and all request tool executions
 The usage is the combined usage of all steps.
      */
     onFinish?: StreamTextOnFinishCallback<TOOLS>;
+    onAbort?: StreamTextOnAbortCallback<TOOLS>;
     /**
 Callback that is called when each step (LLM call) is finished, including intermediate steps.
     */
@@ -1463,6 +1475,8 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
 } | {
     type: 'finish';
     messageMetadata?: METADATA;
+} | {
+    type: 'abort';
 } | {
     type: 'message-metadata';
     messageMetadata: METADATA;
@@ -1479,6 +1493,27 @@ type AsyncIterableStream<T> = AsyncIterable<T> & ReadableStream<T>;
 
 type ErrorHandler = (error: unknown) => void;
 
+type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
+    /**
+     * The updated list of UI messages.
+     */
+    messages: UI_MESSAGE[];
+    /**
+     * Indicates whether the response message is a continuation of the last original message,
+     * or if a new message was created.
+     */
+    isContinuation: boolean;
+    /**
+     * Indicates whether the stream was aborted.
+     */
+    isAborted: boolean;
+    /**
+     * The message that was sent to the client as a response
+     * (including the original message if it was extended).
+     */
+    responseMessage: UI_MESSAGE;
+}) => PromiseLike<void> | void;
+
 type UIMessageStreamOptions<UI_MESSAGE extends UIMessage> = {
     /**
      * The original messages. If they are provided, persistence mode is assumed,
@@ -1492,22 +1527,7 @@ type UIMessageStreamOptions<UI_MESSAGE extends UIMessage> = {
      * the original messages are provided and the last message is an assistant message).
      */
     generateMessageId?: IdGenerator;
-    onFinish?: (options: {
-        /**
-         * The updates list of UI messages.
-         */
-        messages: UI_MESSAGE[];
-        /**
-         * Indicates whether the response message is a continuation of the last original message,
-         * or if a new message was created.
-         */
-        isContinuation: boolean;
-        /**
-         * The message that was sent to the client as a response
-         * (including the original message if it was extended).
-         */
-        responseMessage: UI_MESSAGE;
-    }) => void;
+    onFinish?: UIMessageStreamOnFinishCallback<UI_MESSAGE>;
     /**
      * Extracts message metadata that will be send to the client.
      *
@@ -1698,7 +1718,7 @@ interface StreamTextResult<TOOLS extends ToolSet, PARTIAL_OUTPUT> {
   
     @return A UI message stream.
        */
-    toUIMessageStream<UI_MESSAGE extends UIMessage>(options?: UIMessageStreamOptions<UI_MESSAGE>): ReadableStream<InferUIMessageChunk<UI_MESSAGE>>;
+    toUIMessageStream<UI_MESSAGE extends UIMessage>(options?: UIMessageStreamOptions<UI_MESSAGE>): AsyncIterableStream<InferUIMessageChunk<UI_MESSAGE>>;
     /**
     Writes UI message stream output to a Node.js response-like object.
     @param response A Node.js response-like object (ServerResponse).
@@ -1806,6 +1826,8 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     type: 'finish';
     finishReason: FinishReason;
     totalUsage: LanguageModelUsage;
+} | {
+    type: 'abort';
 } | {
     type: 'error';
     error: unknown;
@@ -2638,6 +2660,21 @@ functionality that can be fully encapsulated in the provider.
     };
 }): Promise<GenerateObjectResult<RESULT>>;
 
+/**
+ * Consumes a ReadableStream until it's fully read.
+ *
+ * This function reads the stream chunk by chunk until the stream is exhausted.
+ * It doesn't process or return the data from the stream; it simply ensures
+ * that the entire stream is read.
+ *
+ * @param {ReadableStream} stream - The ReadableStream to be consumed.
+ * @returns {Promise<void>} A promise that resolves when the stream is fully consumed.
+ */
+declare function consumeStream({ stream, onError, }: {
+    stream: ReadableStream;
+    onError?: (error: unknown) => void;
+}): Promise<void>;
+
 /**
  * Calculates the cosine similarity between two vectors. This is a useful metric for
  * comparing the similarity of two vectors such as embeddings.
@@ -3588,22 +3625,7 @@ declare function createUIMessageStream<UI_MESSAGE extends UIMessage>({ execute,
      * and a message ID is provided for the response message.
      */
     originalMessages?: UI_MESSAGE[];
-    onFinish?: (options: {
-        /**
-         * The updates list of UI messages.
-         */
-        messages: UI_MESSAGE[];
-        /**
-         * Indicates whether the response message is a continuation of the last original message,
-         * or if a new message was created.
-         */
-        isContinuation: boolean;
-        /**
-         * The message that was sent to the client as a response
-         * (including the original message if it was extended).
-         */
-        responseMessage: UI_MESSAGE;
-    }) => void;
+    onFinish?: UIMessageStreamOnFinishCallback<UI_MESSAGE>;
     generateId?: IdGenerator;
 }): ReadableStream<InferUIMessageChunk<UI_MESSAGE>>;
 
@@ -4032,4 +4054,4 @@ declare global {
     var AI_SDK_DEFAULT_PROVIDER: ProviderV2 | undefined;
 }
 
-export { AbstractChat, AsyncIterableStream, CallSettings, CallWarning, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, ErrorHandler, Agent as Experimental_Agent, AgentSettings as Experimental_AgentSettings, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RetryError, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolErrorUnion, ToolResultUnion, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, assistantModelMessageSchema, callCompletionApi, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, hasToolCall, isDeepEqualData, isToolUIPart, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, readUIMessageStream, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, userModelMessageSchema, wrapLanguageModel, wrapProvider };
+export { AbstractChat, AsyncIterableStream, CallSettings, CallWarning, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DownloadError, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, ErrorHandler, Agent as Experimental_Agent, AgentSettings as Experimental_AgentSettings, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONRPCError, JSONRPCMessage, JSONRPCNotification, JSONRPCRequest, JSONRPCResponse, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MCPClientError, MCPTransport, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputSpecifiedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningUIPart, RepairTextFunction, RetryError, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, ToolCallRepairError, ToolCallRepairFunction, ToolCallUnion, ToolChoice, ToolErrorUnion, ToolResultUnion, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamOnFinishCallback, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, assistantModelMessageSchema, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, createMCPClient as experimental_createMCPClient, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, hasToolCall, isDeepEqualData, isToolUIPart, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, readUIMessageStream, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, userModelMessageSchema, wrapLanguageModel, wrapProvider };

package/dist/index.js

@@ -59,6 +59,7 @@ __export(src_exports, {
   asSchema: () => import_provider_utils29.asSchema,
   assistantModelMessageSchema: () => assistantModelMessageSchema,
   callCompletionApi: () => callCompletionApi,
+  consumeStream: () => consumeStream,
   convertFileListToFileUIParts: () => convertFileListToFileUIParts,
   convertToCoreMessages: () => convertToCoreMessages,
   convertToModelMessages: () => convertToModelMessages,
@@ -2736,6 +2737,9 @@ var uiMessageChunkSchema = import_v47.z.union([
     type: import_v47.z.literal("finish"),
     messageMetadata: import_v47.z.unknown().optional()
   }),
+  import_v47.z.strictObject({
+    type: import_v47.z.literal("abort")
+  }),
   import_v47.z.strictObject({
     type: import_v47.z.literal("message-metadata"),
     messageMetadata: import_v47.z.unknown()
@@ -3120,7 +3124,7 @@ function isToolUIPart(part) {
   return part.type.startsWith("tool-");
 }
 function getToolName(part) {
-  return part.type.split("-")[1];
+  return part.type.split("-").slice(1).join("-");
 }
 
 // src/ui/process-ui-message-stream.ts
@@ -3479,6 +3483,7 @@ function handleUIMessageStreamFinish({
   } else {
     messageId = lastMessage.id;
   }
+  let isAborted = false;
   const idInjectedStream = stream.pipeThrough(
     new TransformStream({
       transform(chunk, controller) {
@@ -3488,6 +3493,9 @@ function handleUIMessageStreamFinish({
             startChunk.messageId = messageId;
           }
         }
+        if (chunk.type === "abort") {
+          isAborted = true;
+        }
         controller.enqueue(chunk);
       }
     })
@@ -3513,9 +3521,10 @@ function handleUIMessageStreamFinish({
       transform(chunk, controller) {
         controller.enqueue(chunk);
       },
-      flush() {
+      async flush() {
         const isContinuation = state.message.id === (lastMessage == null ? void 0 : lastMessage.id);
-        onFinish({
+        await onFinish({
+          isAborted,
           isContinuation,
           responseMessage: state.message,
           messages: [
@@ -3609,6 +3618,13 @@ function createStitchableStream() {
   let controller = null;
   let isClosed = false;
   let waitForNewStream = createResolvablePromise();
+  const terminate = () => {
+    isClosed = true;
+    waitForNewStream.resolve();
+    innerStreamReaders.forEach((reader) => reader.cancel());
+    innerStreamReaders = [];
+    controller == null ? void 0 : controller.close();
+  };
   const processPull = async () => {
     if (isClosed && innerStreamReaders.length === 0) {
       controller == null ? void 0 : controller.close();
@@ -3634,9 +3650,7 @@ function createStitchableStream() {
     } catch (error) {
       controller == null ? void 0 : controller.error(error);
       innerStreamReaders.shift();
-      if (isClosed && innerStreamReaders.length === 0) {
-        controller == null ? void 0 : controller.close();
-      }
+      terminate();
     }
   };
   return {
@@ -3675,13 +3689,7 @@ function createStitchableStream() {
      * Immediately close the outer stream. This will cancel all inner streams
      * and close the outer stream.
      */
-    terminate: () => {
-      isClosed = true;
-      waitForNewStream.resolve();
-      innerStreamReaders.forEach((reader) => reader.cancel());
-      innerStreamReaders = [];
-      controller == null ? void 0 : controller.close();
-    }
+    terminate
   };
 }
 
@@ -3729,6 +3737,30 @@ function now() {
   return (_b = (_a16 = globalThis == null ? void 0 : globalThis.performance) == null ? void 0 : _a16.now()) != null ? _b : Date.now();
 }
 
+// src/util/filter-stream-errors.ts
+function filterStreamErrors(readable, onError) {
+  return new ReadableStream({
+    async start(controller) {
+      const reader = readable.getReader();
+      try {
+        while (true) {
+          const { done, value } = await reader.read();
+          if (done) {
+            controller.close();
+            break;
+          }
+          controller.enqueue(value);
+        }
+      } catch (error) {
+        await onError({ error, controller });
+      }
+    },
+    cancel(reason) {
+      return readable.cancel(reason);
+    }
+  });
+}
+
 // src/generate-text/run-tools-transformation.ts
 var import_provider_utils12 = require("@ai-sdk/provider-utils");
 function runToolsTransformation({
@@ -3977,6 +4009,7 @@ function streamText({
     console.error(error);
   },
   onFinish,
+  onAbort,
   onStepFinish,
   _internal: {
     now: now2 = now,
@@ -4008,6 +4041,7 @@ function streamText({
     onChunk,
     onError,
     onFinish,
+    onAbort,
     onStepFinish,
     now: now2,
     currentDate,
@@ -4106,6 +4140,7 @@ var DefaultStreamTextResult = class {
     onChunk,
     onError,
     onFinish,
+    onAbort,
     onStepFinish
   }) {
     this._totalUsage = new DelayedPromise();
@@ -4113,7 +4148,6 @@ var DefaultStreamTextResult = class {
     this._steps = new DelayedPromise();
     this.output = output;
     this.includeRawChunks = includeRawChunks;
-    this.generateId = generateId3;
     let stepFinish;
     let recordedContent = [];
     const recordedResponseMessages = [];
@@ -4316,6 +4350,15 @@ var DefaultStreamTextResult = class {
     this.addStream = stitchableStream.addStream;
     this.closeStream = stitchableStream.close;
     let stream = stitchableStream.stream;
+    stream = filterStreamErrors(stream, ({ error, controller }) => {
+      if ((0, import_provider_utils13.isAbortError)(error) && (abortSignal == null ? void 0 : abortSignal.aborted)) {
+        onAbort == null ? void 0 : onAbort({ steps: recordedSteps });
+        controller.enqueue({ type: "abort" });
+        controller.close();
+      } else {
+        controller.error(error);
+      }
+    });
     stream = stream.pipeThrough(
       new TransformStream({
         start(controller) {
@@ -5058,6 +5101,10 @@ var DefaultStreamTextResult = class {
               }
               break;
             }
+            case "abort": {
+              controller.enqueue(part);
+              break;
+            }
             case "tool-input-end": {
               break;
             }
@@ -5078,13 +5125,15 @@ var DefaultStreamTextResult = class {
         }
       })
     );
-    return handleUIMessageStreamFinish({
-      stream: baseStream,
-      messageId: responseMessageId != null ? responseMessageId : generateMessageId == null ? void 0 : generateMessageId(),
-      originalMessages,
-      onFinish,
-      onError
-    });
+    return createAsyncIterableStream(
+      handleUIMessageStreamFinish({
+        stream: baseStream,
+        messageId: responseMessageId != null ? responseMessageId : generateMessageId == null ? void 0 : generateMessageId(),
+        originalMessages,
+        onFinish,
+        onError
+      })
+    );
   }
   pipeUIMessageStreamToResponse(response, {
     originalMessages,
@@ -9326,6 +9375,7 @@ function readUIMessageStream({
   asSchema,
   assistantModelMessageSchema,
   callCompletionApi,
+  consumeStream,
   convertFileListToFileUIParts,
   convertToCoreMessages,
   convertToModelMessages,