ai 4.1.29 → 4.1.31

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # ai
 
+## 4.1.31
+
+### Patch Changes
+
+- b30b1cc: feat (ai/core): add onError callback to streamObject
+
+## 4.1.30
+
+### Patch Changes
+
+- 4ee5b6f: fix (core): remove invalid providerOptions from streamObject onFinish callback
+
 ## 4.1.29
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1226,6 +1226,19 @@ type ObjectStreamPart<PARTIAL> = {
     providerMetadata?: ProviderMetadata;
 };
 
+/**
+Callback that is set using the `onError` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamObjectOnErrorCallback = (event: {
+    error: unknown;
+}) => Promise<void> | void;
+/**
+Callback that is set using the `onFinish` option.
+
+@param event - The event that is passed to the callback.
+ */
 type StreamObjectOnFinishCallback<RESULT> = (event: {
     /**
   The token usage of the generated response.
@@ -1248,13 +1261,9 @@ type StreamObjectOnFinishCallback<RESULT> = (event: {
   */
     warnings?: CallWarning[];
     /**
-  Additional provider-specific options. They are passed through
+  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;
-    /**
-  @deprecated Use `providerOptions` instead.
   */
     experimental_providerMetadata?: ProviderMetadata;
 }) => Promise<void> | void;
@@ -1317,6 +1326,12 @@ functionality that can be fully encapsulated in the provider.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
+   */
+    onError?: StreamObjectOnErrorCallback;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: StreamObjectOnFinishCallback<OBJECT>;
@@ -1388,6 +1403,12 @@ functionality that can be fully encapsulated in the provider.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
+   */
+    onError?: StreamObjectOnErrorCallback;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: StreamObjectOnFinishCallback<Array<ELEMENT>>;
@@ -1433,6 +1454,12 @@ functionality that can be fully encapsulated in the provider.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
+   */
+    onError?: StreamObjectOnErrorCallback;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: StreamObjectOnFinishCallback<JSONValue>;

package/dist/index.d.ts

@@ -1226,6 +1226,19 @@ type ObjectStreamPart<PARTIAL> = {
     providerMetadata?: ProviderMetadata;
 };
 
+/**
+Callback that is set using the `onError` option.
+
+@param event - The event that is passed to the callback.
+ */
+type StreamObjectOnErrorCallback = (event: {
+    error: unknown;
+}) => Promise<void> | void;
+/**
+Callback that is set using the `onFinish` option.
+
+@param event - The event that is passed to the callback.
+ */
 type StreamObjectOnFinishCallback<RESULT> = (event: {
     /**
   The token usage of the generated response.
@@ -1248,13 +1261,9 @@ type StreamObjectOnFinishCallback<RESULT> = (event: {
   */
     warnings?: CallWarning[];
     /**
-  Additional provider-specific options. They are passed through
+  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;
-    /**
-  @deprecated Use `providerOptions` instead.
   */
     experimental_providerMetadata?: ProviderMetadata;
 }) => Promise<void> | void;
@@ -1317,6 +1326,12 @@ functionality that can be fully encapsulated in the provider.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
+   */
+    onError?: StreamObjectOnErrorCallback;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: StreamObjectOnFinishCallback<OBJECT>;
@@ -1388,6 +1403,12 @@ functionality that can be fully encapsulated in the provider.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
+   */
+    onError?: StreamObjectOnErrorCallback;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: StreamObjectOnFinishCallback<Array<ELEMENT>>;
@@ -1433,6 +1454,12 @@ functionality that can be fully encapsulated in the provider.
 */
     experimental_providerMetadata?: ProviderMetadata;
     /**
+Callback that is invoked when an error occurs during streaming.
+You can use it to log errors.
+The stream processing will pause until the callback promise is resolved.
+   */
+    onError?: StreamObjectOnErrorCallback;
+    /**
 Callback that is called when the LLM response and the final object validation are finished.
    */
     onFinish?: StreamObjectOnFinishCallback<JSONValue>;

package/dist/index.js

@@ -2211,9 +2211,7 @@ var arrayOutputStrategy = (schema) => {
                 }
                 case "text-delta":
                 case "finish":
-                  break;
                 case "error":
-                  controller.error(chunk.error);
                   break;
                 default: {
                   const _exhaustiveCheck = chunk;
@@ -2980,6 +2978,7 @@ function streamObject({
   experimental_telemetry: telemetry,
   experimental_providerMetadata,
   providerOptions = experimental_providerMetadata,
+  onError,
   onFinish,
   _internal: {
     generateId: generateId3 = originalGenerateId2,
@@ -3014,6 +3013,7 @@ function streamObject({
     schemaDescription,
     providerOptions,
     mode,
+    onError,
     onFinish,
     generateId: generateId3,
     currentDate,
@@ -3036,6 +3036,7 @@ var DefaultStreamObjectResult = class {
     schemaDescription,
     providerOptions,
     mode,
+    onError,
     onFinish,
     generateId: generateId3,
     currentDate,
@@ -3047,7 +3048,6 @@ var DefaultStreamObjectResult = class {
     this.warningsPromise = new DelayedPromise();
     this.requestPromise = new DelayedPromise();
     this.responsePromise = new DelayedPromise();
-    this.stitchableStream = createStitchableStream();
     const { maxRetries, retry } = prepareRetries({
       maxRetries: maxRetriesArg
     });
@@ -3059,6 +3059,16 @@ var DefaultStreamObjectResult = class {
     });
     const tracer = getTracer(telemetry);
     const self = this;
+    const stitchableStream = createStitchableStream();
+    const eventProcessor = new TransformStream({
+      transform(chunk, controller) {
+        controller.enqueue(chunk);
+        if (chunk.type === "error") {
+          onError == null ? void 0 : onError({ error: chunk.error });
+        }
+      }
+    });
+    this.baseStream = stitchableStream.stream.pipeThrough(eventProcessor);
     recordSpan({
       name: "ai.streamObject",
       attributes: selectTelemetryAttributes({
@@ -3402,25 +3412,26 @@ var DefaultStreamObjectResult = class {
                   experimental_providerMetadata: providerMetadata
                 }));
               } catch (error2) {
-                controller.error(error2);
+                controller.enqueue({ type: "error", error: error2 });
               } finally {
                 rootSpan.end();
               }
             }
           })
         );
-        self.stitchableStream.addStream(transformedStream);
+        stitchableStream.addStream(transformedStream);
       }
     }).catch((error) => {
-      self.stitchableStream.addStream(
+      stitchableStream.addStream(
         new ReadableStream({
           start(controller) {
-            controller.error(error);
+            controller.enqueue({ type: "error", error });
+            controller.close();
           }
         })
       );
     }).finally(() => {
-      self.stitchableStream.close();
+      stitchableStream.close();
     });
     this.outputStrategy = outputStrategy;
   }
@@ -3444,7 +3455,7 @@ var DefaultStreamObjectResult = class {
   }
   get partialObjectStream() {
     return createAsyncIterableStream(
-      this.stitchableStream.stream.pipeThrough(
+      this.baseStream.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
             switch (chunk.type) {
@@ -3453,9 +3464,7 @@ var DefaultStreamObjectResult = class {
                 break;
               case "text-delta":
               case "finish":
-                break;
               case "error":
-                controller.error(chunk.error);
                 break;
               default: {
                 const _exhaustiveCheck = chunk;
@@ -3468,13 +3477,11 @@ var DefaultStreamObjectResult = class {
     );
   }
   get elementStream() {
-    return this.outputStrategy.createElementStream(
-      this.stitchableStream.stream
-    );
+    return this.outputStrategy.createElementStream(this.baseStream);
   }
   get textStream() {
     return createAsyncIterableStream(
-      this.stitchableStream.stream.pipeThrough(
+      this.baseStream.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
             switch (chunk.type) {
@@ -3483,9 +3490,7 @@ var DefaultStreamObjectResult = class {
                 break;
               case "object":
               case "finish":
-                break;
               case "error":
-                controller.error(chunk.error);
                 break;
               default: {
                 const _exhaustiveCheck = chunk;
@@ -3498,7 +3503,7 @@ var DefaultStreamObjectResult = class {
     );
   }
   get fullStream() {
-    return createAsyncIterableStream(this.stitchableStream.stream);
+    return createAsyncIterableStream(this.baseStream);
   }
   pipeTextStreamToResponse(response, init) {
     writeToServerResponse({