ai 5.0.248 → 5.0.249

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 5.0.249
+
+### Patch Changes
+
+- 989be6f: add operation-level outcomes to UI message stream end callbacks
+
 ## 5.0.248
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1848,6 +1848,24 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
 };
 type InferUIMessageChunk<T extends UIMessage> = UIMessageChunk<InferUIMessageMetadata<T>, InferUIMessageData<T>>;
 
+/**
+ * The operation-level outcome of a UI message stream.
+ *
+ * This is separate from model finish reasons and individual stream chunks.
+ * Fatal stream-processing failures override outcomes declared by the stream
+ * owner.
+ */
+type UIMessageStreamOutcome = {
+    status: 'completed';
+} | {
+    status: 'failed';
+    error?: unknown;
+} | {
+    status: 'aborted';
+} | {
+    status: 'unknown';
+};
+
 type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
     /**
      * The updated list of UI messages.
@@ -1862,6 +1880,10 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
      * Indicates whether the stream was aborted.
      */
     isAborted: boolean;
+    /**
+     * The operation-level outcome of the stream.
+     */
+    outcome: UIMessageStreamOutcome;
     /**
      * The message that was sent to the client as a response
      * (including the original message if it was extended).
@@ -3862,6 +3884,17 @@ interface UIMessageStreamWriter<UI_MESSAGE extends UIMessage = UIMessage> {
      */
     onError: ErrorHandler | undefined;
 }
+interface UIMessageStreamWriterWithOutcome<UI_MESSAGE extends UIMessage = UIMessage> extends UIMessageStreamWriter<UI_MESSAGE> {
+    /**
+     * Declares the operation-level outcome of the composed stream.
+     *
+     * The first outcome declared through this method is retained. Fatal
+     * execution, merge, error-handling, or downstream processing failures
+     * override declared outcomes. Declaring an outcome does not write a chunk or
+     * close the stream.
+     */
+    setOutcome(outcome: UIMessageStreamOutcome): void;
+}
 
 /**
  * Creates a UI message stream that can be used to send messages to the client.
@@ -3879,7 +3912,7 @@ interface UIMessageStreamWriter<UI_MESSAGE extends UIMessage = UIMessage> {
 declare function createUIMessageStream<UI_MESSAGE extends UIMessage>({ execute, onError, // prevent leaking server error details to the client by default
 originalMessages, onFinish, generateId, }: {
     execute: (options: {
-        writer: UIMessageStreamWriter<UI_MESSAGE>;
+        writer: UIMessageStreamWriterWithOutcome<UI_MESSAGE>;
     }) => Promise<void> | void;
     onError?: (error: unknown) => string;
     /**
@@ -4481,4 +4514,4 @@ declare function validateUIMessages<UI_MESSAGE extends UIMessage>({ messages, me
     };
 }): Promise<Array<UI_MESSAGE>>;
 
-export { AbstractChat, AsyncIterableStream, CallSettings, CallWarning, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DownloadError, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, ErrorHandler, Agent as Experimental_Agent, AgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, Warning as Experimental_Warning, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoOutputSpecifiedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Output as OutputInterface, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StaticToolCall, StaticToolError, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, TypedToolCall, TypedToolError, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamOnFinishCallback, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, assistantModelMessageSchema, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapLanguageModel, wrapProvider };
+export { AbstractChat, AsyncIterableStream, CallSettings, CallWarning, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DownloadError, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, ErrorHandler, Agent as Experimental_Agent, AgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, Warning as Experimental_Warning, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoOutputSpecifiedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Output as OutputInterface, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StaticToolCall, StaticToolError, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, TypedToolCall, TypedToolError, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamOnFinishCallback, UIMessageStreamOptions, UIMessageStreamOutcome, UIMessageStreamWriter, UIMessageStreamWriterWithOutcome, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, assistantModelMessageSchema, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapLanguageModel, wrapProvider };

package/dist/index.d.ts

@@ -1848,6 +1848,24 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
 };
 type InferUIMessageChunk<T extends UIMessage> = UIMessageChunk<InferUIMessageMetadata<T>, InferUIMessageData<T>>;
 
+/**
+ * The operation-level outcome of a UI message stream.
+ *
+ * This is separate from model finish reasons and individual stream chunks.
+ * Fatal stream-processing failures override outcomes declared by the stream
+ * owner.
+ */
+type UIMessageStreamOutcome = {
+    status: 'completed';
+} | {
+    status: 'failed';
+    error?: unknown;
+} | {
+    status: 'aborted';
+} | {
+    status: 'unknown';
+};
+
 type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
     /**
      * The updated list of UI messages.
@@ -1862,6 +1880,10 @@ type UIMessageStreamOnFinishCallback<UI_MESSAGE extends UIMessage> = (event: {
      * Indicates whether the stream was aborted.
      */
     isAborted: boolean;
+    /**
+     * The operation-level outcome of the stream.
+     */
+    outcome: UIMessageStreamOutcome;
     /**
      * The message that was sent to the client as a response
      * (including the original message if it was extended).
@@ -3862,6 +3884,17 @@ interface UIMessageStreamWriter<UI_MESSAGE extends UIMessage = UIMessage> {
      */
     onError: ErrorHandler | undefined;
 }
+interface UIMessageStreamWriterWithOutcome<UI_MESSAGE extends UIMessage = UIMessage> extends UIMessageStreamWriter<UI_MESSAGE> {
+    /**
+     * Declares the operation-level outcome of the composed stream.
+     *
+     * The first outcome declared through this method is retained. Fatal
+     * execution, merge, error-handling, or downstream processing failures
+     * override declared outcomes. Declaring an outcome does not write a chunk or
+     * close the stream.
+     */
+    setOutcome(outcome: UIMessageStreamOutcome): void;
+}
 
 /**
  * Creates a UI message stream that can be used to send messages to the client.
@@ -3879,7 +3912,7 @@ interface UIMessageStreamWriter<UI_MESSAGE extends UIMessage = UIMessage> {
 declare function createUIMessageStream<UI_MESSAGE extends UIMessage>({ execute, onError, // prevent leaking server error details to the client by default
 originalMessages, onFinish, generateId, }: {
     execute: (options: {
-        writer: UIMessageStreamWriter<UI_MESSAGE>;
+        writer: UIMessageStreamWriterWithOutcome<UI_MESSAGE>;
     }) => Promise<void> | void;
     onError?: (error: unknown) => string;
     /**
@@ -4481,4 +4514,4 @@ declare function validateUIMessages<UI_MESSAGE extends UIMessage>({ messages, me
     };
 }): Promise<Array<UI_MESSAGE>>;
 
-export { AbstractChat, AsyncIterableStream, CallSettings, CallWarning, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DownloadError, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, ErrorHandler, Agent as Experimental_Agent, AgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, Warning as Experimental_Warning, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoOutputSpecifiedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Output as OutputInterface, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StaticToolCall, StaticToolError, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, TypedToolCall, TypedToolError, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamOnFinishCallback, UIMessageStreamOptions, UIMessageStreamWriter, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, assistantModelMessageSchema, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapLanguageModel, wrapProvider };
+export { AbstractChat, AsyncIterableStream, CallSettings, CallWarning, ChatInit, ChatOnDataCallback, ChatOnErrorCallback, ChatOnFinishCallback, ChatOnToolCallCallback, ChatRequestOptions, ChatState, ChatStatus, ChatTransport, ChunkDetector, CompletionRequestOptions, ContentPart, CoreAssistantMessage, CoreMessage, CoreSystemMessage, CoreToolMessage, CoreUserMessage, CreateUIMessage, DataUIPart, DeepPartial, DefaultChatTransport, DownloadError, DynamicToolCall, DynamicToolError, DynamicToolResult, DynamicToolUIPart, EmbedManyResult, EmbedResult, Embedding, EmbeddingModel, EmbeddingModelUsage, ErrorHandler, Agent as Experimental_Agent, AgentSettings as Experimental_AgentSettings, DownloadFunction as Experimental_DownloadFunction, GenerateImageResult as Experimental_GenerateImageResult, GeneratedFile as Experimental_GeneratedImage, InferAgentUIMessage as Experimental_InferAgentUIMessage, LogWarningsFunction as Experimental_LogWarningsFunction, SpeechResult as Experimental_SpeechResult, TranscriptionResult as Experimental_TranscriptionResult, Warning as Experimental_Warning, FileUIPart, FinishReason, GenerateObjectResult, GenerateTextOnStepFinishCallback, GenerateTextResult, GeneratedAudioFile, GeneratedFile, HttpChatTransport, HttpChatTransportInitOptions, ImageModel, ImageGenerationWarning as ImageModelCallWarning, ImageModelProviderMetadata, ImageModelResponseMetadata, InferUIDataParts, InferUIMessageChunk, InferUITool, InferUITools, InvalidArgumentError, InvalidDataContentError, InvalidMessageRoleError, InvalidStreamPartError, InvalidToolInputError, JSONValue, JsonToSseTransformStream, LanguageModel, LanguageModelMiddleware, LanguageModelRequestMetadata, LanguageModelResponseMetadata, LanguageModelUsage, MessageConversionError, NoImageGeneratedError, NoObjectGeneratedError, NoOutputGeneratedError, NoOutputSpecifiedError, NoSpeechGeneratedError, NoSuchProviderError, NoSuchToolError, ObjectStreamPart, output as Output, Output as OutputInterface, PrepareReconnectToStreamRequest, PrepareSendMessagesRequest, PrepareStepFunction, PrepareStepResult, Prompt, Provider, ProviderMetadata, ProviderRegistryProvider, ReasoningOutput, ReasoningUIPart, RepairTextFunction, RetryError, SafeValidateUIMessagesResult, SerialJobExecutor, SourceDocumentUIPart, SourceUrlUIPart, SpeechModel, SpeechModelResponseMetadata, SpeechWarning, StaticToolCall, StaticToolError, StaticToolResult, StepResult, StepStartUIPart, StopCondition, StreamObjectOnFinishCallback, StreamObjectResult, StreamTextOnChunkCallback, StreamTextOnErrorCallback, StreamTextOnFinishCallback, StreamTextOnStepFinishCallback, StreamTextResult, StreamTextTransform, TelemetrySettings, TextStreamChatTransport, TextStreamPart, TextUIPart, ToolCallRepairError, ToolCallRepairFunction, ToolChoice, ToolSet, ToolUIPart, TranscriptionModel, TranscriptionModelResponseMetadata, TranscriptionWarning, TypedToolCall, TypedToolError, TypedToolResult, UIDataPartSchemas, UIDataTypes, UIMessage, UIMessageChunk, UIMessagePart, UIMessageStreamOnFinishCallback, UIMessageStreamOptions, UIMessageStreamOutcome, UIMessageStreamWriter, UIMessageStreamWriterWithOutcome, UITool, UIToolInvocation, UITools, UI_MESSAGE_STREAM_HEADERS, UnsupportedModelVersionError, UseCompletionOptions, assistantModelMessageSchema, callCompletionApi, consumeStream, convertFileListToFileUIParts, convertToCoreMessages, convertToModelMessages, coreAssistantMessageSchema, coreMessageSchema, coreSystemMessageSchema, coreToolMessageSchema, coreUserMessageSchema, cosineSimilarity, createDownload, createProviderRegistry, createTextStreamResponse, createUIMessageStream, createUIMessageStreamResponse, customProvider, defaultSettingsMiddleware, embed, embedMany, experimental_createProviderRegistry, experimental_customProvider, generateImage as experimental_generateImage, generateSpeech as experimental_generateSpeech, transcribe as experimental_transcribe, extractReasoningMiddleware, generateObject, generateText, getTextFromDataUrl, getToolName, getToolOrDynamicToolName, hasToolCall, isDataUIPart, isDeepEqualData, isFileUIPart, isReasoningUIPart, isTextUIPart, isToolOrDynamicToolUIPart, isToolUIPart, lastAssistantMessageIsCompleteWithToolCalls, modelMessageSchema, parsePartialJson, pipeTextStreamToResponse, pipeUIMessageStreamToResponse, pruneMessages, readUIMessageStream, safeValidateUIMessages, simulateReadableStream, simulateStreamingMiddleware, smoothStream, stepCountIs, streamObject, streamText, systemModelMessageSchema, toolModelMessageSchema, uiMessageChunkSchema, userModelMessageSchema, validateUIMessages, wrapLanguageModel, wrapProvider };

package/dist/index.js

@@ -816,7 +816,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "5.0.248" : "0.0.0-test";
+var VERSION = true ? "5.0.249" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({
@@ -4141,7 +4141,8 @@ function handleUIMessageStreamFinish({
   originalMessages = [],
   onFinish,
   onError,
-  stream
+  stream,
+  getOutcome
 }) {
   let lastMessage = originalMessages == null ? void 0 : originalMessages[originalMessages.length - 1];
   if ((lastMessage == null ? void 0 : lastMessage.role) !== "assistant") {
@@ -4150,19 +4151,34 @@ function handleUIMessageStreamFinish({
     messageId = lastMessage.id;
   }
   let isAborted = false;
+  let hasProcessingFailure = false;
+  let processingError;
+  const recordProcessingFailure = (error) => {
+    hasProcessingFailure = true;
+    processingError = error;
+  };
   const idInjectedStream = stream.pipeThrough(
     new TransformStream({
       transform(chunk, controller) {
-        if (chunk.type === "start") {
-          const startChunk = chunk;
-          if (startChunk.messageId == null && messageId != null) {
-            startChunk.messageId = messageId;
+        try {
+          let outputChunk = chunk;
+          if (chunk.type === "start") {
+            const startChunk = chunk;
+            if (startChunk.messageId == null && messageId != null) {
+              outputChunk = {
+                ...startChunk,
+                messageId
+              };
+            }
           }
+          if (chunk.type === "abort") {
+            isAborted = true;
+          }
+          controller.enqueue(outputChunk);
+        } catch (error) {
+          recordProcessingFailure(error);
+          throw error;
         }
-        if (chunk.type === "abort") {
-          isAborted = true;
-        }
-        controller.enqueue(chunk);
       }
     })
   );
@@ -4175,19 +4191,28 @@ function handleUIMessageStreamFinish({
     // will be overridden by the stream
   });
   const runUpdateMessageJob = async (job) => {
-    await job({ state, write: () => {
-    } });
+    try {
+      await job({ state, write: () => {
+      } });
+    } catch (error) {
+      recordProcessingFailure(error);
+      throw error;
+    }
   };
   let finishCalled = false;
   const callOnFinish = async () => {
+    var _a16;
     if (finishCalled || !onFinish) {
       return;
     }
     finishCalled = true;
     const isContinuation = state.message.id === (lastMessage == null ? void 0 : lastMessage.id);
+    const declaredOutcome = (_a16 = getOutcome == null ? void 0 : getOutcome()) != null ? _a16 : { status: "unknown" };
+    const outcome = hasProcessingFailure ? { status: "failed", error: processingError } : declaredOutcome.status === "unknown" && isAborted ? { status: "aborted" } : declaredOutcome;
     await onFinish({
-      isAborted,
+      isAborted: isAborted || outcome.status === "aborted",
       isContinuation,
+      outcome,
       responseMessage: state.message,
       messages: [
         ...isContinuation ? originalMessages.slice(0, -1) : originalMessages,
@@ -5780,6 +5805,17 @@ var DefaultStreamTextResult = class {
     onError = () => "An error occurred."
     // prevent leaking server error details to the client by default
   } = {}) {
+    let outcome = { status: "unknown" };
+    let hasFatalFailure = false;
+    const setSourceOutcome = (newOutcome) => {
+      if (!hasFatalFailure && outcome.status !== "completed" && outcome.status !== "aborted" && newOutcome.status !== "unknown" && (outcome.status === "unknown" || newOutcome.status !== "failed")) {
+        outcome = newOutcome;
+      }
+    };
+    const failOutcome = (error) => {
+      hasFatalFailure = true;
+      outcome = { status: "failed", error };
+    };
     const responseMessageId = generateMessageId != null ? getResponseUIMessageId({
       originalMessages,
       responseMessageId: generateMessageId
@@ -5791,7 +5827,48 @@ var DefaultStreamTextResult = class {
       const dynamic = ((_b = (_a16 = this.tools) == null ? void 0 : _a16[toolName]) == null ? void 0 : _b.type) === "dynamic";
       return dynamic ? true : void 0;
     };
-    const baseStream = this.fullStream.pipeThrough(
+    const sourceReader = this.fullStream.getReader();
+    let sourceReaderReleased = false;
+    let sourceStreamCancelled = false;
+    const releaseSourceReader = () => {
+      if (!sourceReaderReleased) {
+        sourceReader.releaseLock();
+        sourceReaderReleased = true;
+      }
+    };
+    const sourceStream = new ReadableStream({
+      async pull(controller) {
+        try {
+          const { done, value } = await sourceReader.read();
+          if (done) {
+            releaseSourceReader();
+            if (!sourceStreamCancelled) {
+              controller.close();
+            }
+          } else {
+            controller.enqueue(value);
+          }
+        } catch (error) {
+          releaseSourceReader();
+          if (!sourceStreamCancelled) {
+            failOutcome(error);
+            controller.error(error);
+          }
+        }
+      },
+      async cancel(reason) {
+        sourceStreamCancelled = true;
+        if (sourceReaderReleased) {
+          return;
+        }
+        try {
+          await sourceReader.cancel(reason);
+        } finally {
+          releaseSourceReader();
+        }
+      }
+    });
+    const baseStream = sourceStream.pipeThrough(
       new TransformStream({
         transform: async (part, controller) => {
           const messageMetadataValue = messageMetadata == null ? void 0 : messageMetadata({ part });
@@ -6005,16 +6082,65 @@ var DefaultStreamTextResult = class {
               messageMetadata: messageMetadataValue
             });
           }
+          if (part.type === "finish") {
+            setSourceOutcome({ status: "completed" });
+          } else if (part.type === "abort") {
+            setSourceOutcome({ status: "aborted" });
+          } else if (part.type === "error") {
+            setSourceOutcome({ status: "failed", error: part.error });
+          }
         }
       })
     );
+    const baseStreamReader = baseStream.getReader();
+    let baseStreamReaderReleased = false;
+    let baseStreamCancelled = false;
+    const releaseBaseStreamReader = () => {
+      if (!baseStreamReaderReleased) {
+        baseStreamReader.releaseLock();
+        baseStreamReaderReleased = true;
+      }
+    };
+    const trackedBaseStream = new ReadableStream({
+      async pull(controller) {
+        try {
+          const { done, value } = await baseStreamReader.read();
+          if (done) {
+            releaseBaseStreamReader();
+            if (!baseStreamCancelled) {
+              controller.close();
+            }
+          } else {
+            controller.enqueue(value);
+          }
+        } catch (error) {
+          releaseBaseStreamReader();
+          if (!baseStreamCancelled) {
+            failOutcome(error);
+            controller.error(error);
+          }
+        }
+      },
+      async cancel(reason) {
+        baseStreamCancelled = true;
+        if (baseStreamReaderReleased) {
+          return;
+        }
+        try {
+          await baseStreamReader.cancel(reason);
+        } finally {
+          releaseBaseStreamReader();
+        }
+      }
+    });
     return createAsyncIterableStream(
       handleUIMessageStreamFinish({
-        stream: baseStream,
+        stream: trackedBaseStream,
         messageId: responseMessageId != null ? responseMessageId : generateMessageId == null ? void 0 : generateMessageId(),
         originalMessages,
         onFinish,
-        onError
+        onError,
+        getOutcome: () => outcome
       })
     );
   }
@@ -10316,6 +10442,7 @@ function createUIMessageStream({
 }) {
   let controller;
   const ongoingStreamPromises = [];
+  let outcome = { status: "unknown" };
   const stream = new ReadableStream({
     start(controllerArg) {
       controller = controllerArg;
@@ -10327,6 +10454,35 @@ function createUIMessageStream({
     } catch (error) {
     }
   }
+  function setOutcome(newOutcome) {
+    if (outcome.status === "unknown" && newOutcome.status !== "unknown") {
+      outcome = newOutcome;
+    }
+  }
+  function failOutcome(error) {
+    outcome = { status: "failed", error };
+  }
+  function safeError(error) {
+    try {
+      controller.error(error);
+    } catch (e) {
+    }
+  }
+  function handleError(error) {
+    failOutcome(error);
+    let errorText;
+    try {
+      errorText = onError(error);
+    } catch (onErrorError) {
+      failOutcome(onErrorError);
+      safeError(onErrorError);
+      return;
+    }
+    safeEnqueue({
+      type: "error",
+      errorText
+    });
+  }
   try {
     const result = execute({
       writer: {
@@ -10344,38 +10500,29 @@ function createUIMessageStream({
                 safeEnqueue(value);
               }
             })().catch((error) => {
-              safeEnqueue({
-                type: "error",
-                errorText: onError(error)
-              });
+              handleError(error);
             })
           );
         },
+        setOutcome,
         onError
       }
     });
     if (result) {
       ongoingStreamPromises.push(
         result.catch((error) => {
-          safeEnqueue({
-            type: "error",
-            errorText: onError(error)
-          });
+          handleError(error);
         })
       );
     }
   } catch (error) {
-    safeEnqueue({
-      type: "error",
-      errorText: onError(error)
-    });
+    handleError(error);
   }
-  const waitForStreams = new Promise(async (resolve2) => {
+  const waitForStreams = (async () => {
     while (ongoingStreamPromises.length > 0) {
       await ongoingStreamPromises.shift();
     }
-    resolve2();
-  });
+  })();
   waitForStreams.finally(() => {
     try {
       controller.close();
@@ -10387,7 +10534,8 @@ function createUIMessageStream({
     messageId: generateId3(),
     originalMessages,
     onFinish,
-    onError
+    onError,
+    getOutcome: () => outcome
   });
 }