ai 6.0.80 → 6.0.82

package/dist/internal/index.js

@@ -153,7 +153,7 @@ var import_provider_utils2 = require("@ai-sdk/provider-utils");
 var import_provider_utils3 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.80" : "0.0.0-test";
+var VERSION = true ? "6.0.82" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {

package/dist/internal/index.mjs

@@ -128,7 +128,7 @@ import {
 } from "@ai-sdk/provider-utils";
 
 // src/version.ts
-var VERSION = true ? "6.0.80" : "0.0.0-test";
+var VERSION = true ? "6.0.82" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {

package/docs/02-foundations/04-tools.mdx

@@ -178,9 +178,11 @@ const { text } = await generateText({
 
 You can publish your own tool packages to npm for others to use. Simply export your tool objects from your package:
 
-```ts
-// my-tools/index.ts
-export const myTool = {
+```ts filename="my-tools/index.ts"
+import { tool } from 'ai';
+import { z } from 'zod';
+
+export const myTool = tool({
   description: 'A helpful tool',
   inputSchema: z.object({
     query: z.string(),
@@ -189,7 +191,7 @@ export const myTool = {
     // your tool logic
     return result;
   },
-};
+});
 ```
 
 Anyone can then install and use your tools by importing them.

package/docs/07-reference/01-ai-sdk-core/20-tool.mdx

@@ -132,7 +132,7 @@ export const weatherTool = tool({
               isOptional: true,
               type: 'Zod Schema | JSON Schema',
               description:
-                'The schema of the output that the tool produces. Used for validation and type inference.',
+                'The schema of the output that the tool produces. Used for type inference.',
             },
             {
               name: 'toModelOutput',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "6.0.80",
+  "version": "6.0.82",
   "description": "AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@opentelemetry/api": "1.9.0",
-    "@ai-sdk/gateway": "3.0.41",
+    "@ai-sdk/gateway": "3.0.42",
     "@ai-sdk/provider": "3.0.8",
     "@ai-sdk/provider-utils": "4.0.14"
   },

package/src/ui-message-stream/create-ui-message-stream.ts

@@ -7,6 +7,7 @@ import { UIMessage } from '../ui/ui-messages';
 import { handleUIMessageStreamFinish } from './handle-ui-message-stream-finish';
 import { InferUIMessageChunk } from './ui-message-chunks';
 import { UIMessageStreamOnFinishCallback } from './ui-message-stream-on-finish-callback';
+import { UIMessageStreamOnStepFinishCallback } from './ui-message-stream-on-step-finish-callback';
 import { UIMessageStreamWriter } from './ui-message-stream-writer';
 
 /**
@@ -16,6 +17,7 @@ import { UIMessageStreamWriter } from './ui-message-stream-writer';
  * @param options.onError - A function that extracts an error message from an error. Defaults to `getErrorMessage`.
  * @param options.originalMessages - The original messages. If provided, persistence mode is assumed
  *   and a message ID is provided for the response message.
+ * @param options.onStepFinish - A callback that is called when each step finishes. Useful for persisting intermediate messages.
  * @param options.onFinish - A callback that is called when the stream finishes.
  * @param options.generateId - A function that generates a unique ID. Defaults to the built-in ID generator.
  *
@@ -25,6 +27,7 @@ export function createUIMessageStream<UI_MESSAGE extends UIMessage>({
   execute,
   onError = getErrorMessage,
   originalMessages,
+  onStepFinish,
   onFinish,
   generateId = generateIdFunc,
 }: {
@@ -39,6 +42,11 @@ export function createUIMessageStream<UI_MESSAGE extends UIMessage>({
    */
   originalMessages?: UI_MESSAGE[];
 
+  /**
+   * Callback that is called when each step finishes during multi-step agent runs.
+   */
+  onStepFinish?: UIMessageStreamOnStepFinishCallback<UI_MESSAGE>;
+
   onFinish?: UIMessageStreamOnFinishCallback<UI_MESSAGE>;
 
   generateId?: IdGenerator;
@@ -130,6 +138,7 @@ export function createUIMessageStream<UI_MESSAGE extends UIMessage>({
     stream,
     messageId: generateId(),
     originalMessages,
+    onStepFinish,
     onFinish,
     onError,
   });

package/src/ui-message-stream/handle-ui-message-stream-finish.ts

@@ -7,10 +7,12 @@ import { UIMessage } from '../ui/ui-messages';
 import { ErrorHandler } from '../util/error-handler';
 import { InferUIMessageChunk, UIMessageChunk } from './ui-message-chunks';
 import { UIMessageStreamOnFinishCallback } from './ui-message-stream-on-finish-callback';
+import { UIMessageStreamOnStepFinishCallback } from './ui-message-stream-on-step-finish-callback';
 
 export function handleUIMessageStreamFinish<UI_MESSAGE extends UIMessage>({
   messageId,
   originalMessages = [],
+  onStepFinish,
   onFinish,
   onError,
   stream,
@@ -30,6 +32,11 @@ export function handleUIMessageStreamFinish<UI_MESSAGE extends UIMessage>({
 
   onError: ErrorHandler;
 
+  /**
+   * Callback that is called when each step finishes during multi-step agent runs.
+   */
+  onStepFinish?: UIMessageStreamOnStepFinishCallback<UI_MESSAGE>;
+
   onFinish?: UIMessageStreamOnFinishCallback<UI_MESSAGE>;
 }): ReadableStream<InferUIMessageChunk<UI_MESSAGE>> {
   // last message is only relevant for assistant messages
@@ -69,7 +76,8 @@ export function handleUIMessageStreamFinish<UI_MESSAGE extends UIMessage>({
     }),
   );
 
-  if (onFinish == null) {
+  // Only process the stream if we need to track state for callbacks
+  if (onFinish == null && onStepFinish == null) {
     return idInjectedStream;
   }
 
@@ -110,6 +118,29 @@ export function handleUIMessageStreamFinish<UI_MESSAGE extends UIMessage>({
     });
   };
 
+  const callOnStepFinish = async () => {
+    if (!onStepFinish) {
+      return;
+    }
+
+    const isContinuation = state.message.id === lastMessage?.id;
+
+    try {
+      await onStepFinish({
+        isContinuation,
+        responseMessage: structuredClone(state.message) as UI_MESSAGE,
+        messages: [
+          ...(isContinuation
+            ? originalMessages.slice(0, -1)
+            : originalMessages),
+          structuredClone(state.message),
+        ] as UI_MESSAGE[],
+      });
+    } catch (error) {
+      onError(error);
+    }
+  };
+
   return processUIMessageStream<UI_MESSAGE>({
     stream: idInjectedStream,
     runUpdateMessageJob,
@@ -119,7 +150,11 @@ export function handleUIMessageStreamFinish<UI_MESSAGE extends UIMessage>({
       InferUIMessageChunk<UI_MESSAGE>,
       InferUIMessageChunk<UI_MESSAGE>
     >({
-      transform(chunk, controller) {
+      async transform(chunk, controller) {
+        if (chunk.type === 'finish-step') {
+          await callOnStepFinish();
+        }
+
         controller.enqueue(chunk);
       },
       // @ts-expect-error cancel is still new and missing from types https://developer.mozilla.org/en-US/docs/Web/API/TransformStream#browser_compatibility

package/src/ui-message-stream/index.ts

@@ -10,4 +10,5 @@ export {
 } from './ui-message-chunks';
 export { UI_MESSAGE_STREAM_HEADERS } from './ui-message-stream-headers';
 export type { UIMessageStreamOnFinishCallback } from './ui-message-stream-on-finish-callback';
+export type { UIMessageStreamOnStepFinishCallback } from './ui-message-stream-on-step-finish-callback';
 export type { UIMessageStreamWriter } from './ui-message-stream-writer';

package/src/ui-message-stream/ui-message-stream-on-step-finish-callback.ts

@@ -0,0 +1,25 @@
+import { UIMessage } from '../ui/ui-messages';
+
+/**
+ * Callback that is called when a step finishes during streaming.
+ * This is useful for persisting intermediate UI messages during multi-step agent runs.
+ */
+export type UIMessageStreamOnStepFinishCallback<UI_MESSAGE extends UIMessage> =
+  (event: {
+    /**
+     * The updated list of UI messages at the end of this step.
+     */
+    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;
+  }) => PromiseLike<void> | void;