ai 6.0.14 → 6.0.15

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ai
 
+## 6.0.15
+
+### Patch Changes
+
+- 3a73fb3: Include abort reason in stream chunks and document the new field
+
 ## 6.0.14
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1994,6 +1994,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     messageMetadata?: unknown;
 } | {
     type: "abort";
+    reason?: string | undefined;
 } | {
     type: "message-metadata";
     messageMetadata: unknown;
@@ -2117,6 +2118,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     messageMetadata?: METADATA;
 } | {
     type: 'abort';
+    reason?: string;
 } | {
     type: 'message-metadata';
     messageMetadata: METADATA;
@@ -2506,6 +2508,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     totalUsage: LanguageModelUsage;
 } | {
     type: 'abort';
+    reason?: string;
 } | {
     type: 'error';
     error: unknown;

package/dist/index.d.ts

@@ -1994,6 +1994,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     messageMetadata?: unknown;
 } | {
     type: "abort";
+    reason?: string | undefined;
 } | {
     type: "message-metadata";
     messageMetadata: unknown;
@@ -2117,6 +2118,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     messageMetadata?: METADATA;
 } | {
     type: 'abort';
+    reason?: string;
 } | {
     type: 'message-metadata';
     messageMetadata: METADATA;
@@ -2506,6 +2508,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     totalUsage: LanguageModelUsage;
 } | {
     type: 'abort';
+    reason?: string;
 } | {
     type: 'error';
     error: unknown;

package/dist/index.js

@@ -1001,7 +1001,7 @@ var import_provider_utils3 = require("@ai-sdk/provider-utils");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.14" : "0.0.0-test";
+var VERSION = true ? "6.0.15" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -4653,7 +4653,8 @@ var uiMessageChunkSchema = (0, import_provider_utils16.lazySchema)(
         messageMetadata: import_v47.z.unknown().optional()
       }),
       import_v47.z.strictObject({
-        type: import_v47.z.literal("abort")
+        type: import_v47.z.literal("abort"),
+        reason: import_v47.z.string().optional()
       }),
       import_v47.z.strictObject({
         type: import_v47.z.literal("message-metadata"),
@@ -6115,7 +6116,13 @@ var DefaultStreamTextResult = class {
       async pull(controller) {
         function abort() {
           onAbort == null ? void 0 : onAbort({ steps: recordedSteps });
-          controller.enqueue({ type: "abort" });
+          controller.enqueue({
+            type: "abort",
+            // The `reason` is usually of type DOMException, but it can also be of any type,
+            // so we use getErrorMessage for serialization because it is already designed to accept values of the unknown type.
+            // See: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/reason
+            ...(abortSignal == null ? void 0 : abortSignal.reason) !== void 0 ? { reason: (0, import_provider24.getErrorMessage)(abortSignal.reason) } : {}
+          });
           controller.close();
         }
         try {