@ai-sdk/react 2.0.0-canary.2 → 2.0.0-canary.21

package/CHANGELOG.md

@@ -1,5 +1,225 @@
 # @ai-sdk/react
 
+## 2.0.0-canary.21
+
+### Patch Changes
+
+- Updated dependencies [e7dc6c7]
+- Updated dependencies [a34eb39]
+- Updated dependencies [b33ed7a]
+- Updated dependencies [765f1cd]
+  - ai@5.0.0-canary.22
+
+## 2.0.0-canary.20
+
+### Patch Changes
+
+- Updated dependencies [d964901]
+- Updated dependencies [0560977]
+- Updated dependencies [66af894]
+- Updated dependencies [516be5b]
+- Updated dependencies [bfbfc4c]
+- Updated dependencies [ea7a7c9]
+- Updated dependencies [1409e13]
+  - ai@5.0.0-canary.21
+  - @ai-sdk/provider-utils@3.0.0-canary.17
+
+## 2.0.0-canary.19
+
+### Major Changes
+
+- 496bbc1: chore (ui): inline/remove ChatRequest type
+
+### Patch Changes
+
+- Updated dependencies [13fef90]
+- Updated dependencies [e90d45d]
+- Updated dependencies [bc3109f]
+- Updated dependencies [496bbc1]
+- Updated dependencies [da70d79]
+- Updated dependencies [bcea599]
+- Updated dependencies [48d675a]
+- Updated dependencies [c7710a9]
+- Updated dependencies [87b828f]
+- Updated dependencies [35fc02c]
+- Updated dependencies [b983b51]
+  - ai@5.0.0-canary.20
+  - @ai-sdk/provider-utils@3.0.0-canary.16
+
+## 2.0.0-canary.18
+
+### Patch Changes
+
+- Updated dependencies [2d03e19]
+- Updated dependencies [319b989]
+- Updated dependencies [441d042]
+- Updated dependencies [dcc549b]
+- Updated dependencies [cb2b53a]
+- Updated dependencies [e244a78]
+  - ai@5.0.0-canary.19
+
+## 2.0.0-canary.17
+
+### Patch Changes
+
+- Updated dependencies [a571d6e]
+- Updated dependencies [c60f895]
+- Updated dependencies [332167b]
+- Updated dependencies [a8c8bd5]
+- Updated dependencies [a662dea]
+- Updated dependencies [41fa418]
+  - @ai-sdk/provider-utils@3.0.0-canary.15
+  - ai@5.0.0-canary.18
+
+## 2.0.0-canary.16
+
+### Patch Changes
+
+- c34ccd7: feat (ui/react): support resuming an ongoing stream
+- Updated dependencies [f04fb4a]
+- Updated dependencies [fd1924b]
+- Updated dependencies [957b739]
+- Updated dependencies [fafc3f2]
+- Updated dependencies [c9ad635]
+- Updated dependencies [9bd5ab5]
+- Updated dependencies [92cb0a2]
+  - ai@5.0.0-canary.17
+  - @ai-sdk/provider-utils@3.0.0-canary.14
+
+## 2.0.0-canary.15
+
+### Patch Changes
+
+- 6a0ff37: fix (react): integrate addToolResult into UseChatHelpers type without intersection
+- Updated dependencies [ec78cdc]
+- Updated dependencies [9b4d074]
+- Updated dependencies [8b86e99]
+- Updated dependencies [28ad69e]
+- Updated dependencies [2524fc7]
+- Updated dependencies [ec5933d]
+- Updated dependencies [175b868]
+  - ai@5.0.0-canary.16
+
+## 2.0.0-canary.14
+
+### Patch Changes
+
+- Updated dependencies [d9209ca]
+- Updated dependencies [ea27cc6]
+- Updated dependencies [0ff02bb]
+- Updated dependencies [4bfe9ec]
+- Updated dependencies [2877a74]
+  - ai@5.0.0-canary.15
+  - @ai-sdk/provider-utils@3.0.0-canary.13
+
+## 2.0.0-canary.13
+
+### Patch Changes
+
+- Updated dependencies [9bf7291]
+- Updated dependencies [4617fab]
+- Updated dependencies [a76a62b]
+  - ai@5.0.0-canary.14
+  - @ai-sdk/provider-utils@3.0.0-canary.12
+
+## 2.0.0-canary.12
+
+### Patch Changes
+
+- Updated dependencies [14cb3be]
+- Updated dependencies [66962ed]
+- Updated dependencies [9301f86]
+  - ai@5.0.0-canary.13
+  - @ai-sdk/provider-utils@3.0.0-canary.11
+
+## 2.0.0-canary.11
+
+### Patch Changes
+
+- ai@5.0.0-canary.12
+- @ai-sdk/provider-utils@3.0.0-canary.10
+
+## 2.0.0-canary.10
+
+### Patch Changes
+
+- Updated dependencies [8e64e9c]
+  - ai@5.0.0-canary.11
+  - @ai-sdk/provider-utils@3.0.0-canary.9
+
+## 2.0.0-canary.9
+
+### Patch Changes
+
+- Updated dependencies [d8aeaef]
+- Updated dependencies [3e10408]
+  - ai@5.0.0-canary.10
+
+## 2.0.0-canary.8
+
+### Patch Changes
+
+- Updated dependencies [a847c3e]
+- Updated dependencies [5d142ab]
+- Updated dependencies [cb9c9e4]
+- Updated dependencies [8aa9e20]
+- Updated dependencies [b32e192]
+  - ai@5.0.0-canary.9
+  - @ai-sdk/provider-utils@3.0.0-canary.8
+
+## 2.0.0-canary.7
+
+### Patch Changes
+
+- Updated dependencies [5d1e3ba]
+- Updated dependencies [26735b5]
+- Updated dependencies [14c9410]
+- Updated dependencies [7827a49]
+- Updated dependencies [bd8a36c]
+- Updated dependencies [b6f9f3c]
+- Updated dependencies [92c8e66]
+- Updated dependencies [fd65bc6]
+- Updated dependencies [5bdff05]
+  - ai@5.0.0-canary.8
+  - @ai-sdk/provider-utils@3.0.0-canary.7
+
+## 2.0.0-canary.6
+
+### Patch Changes
+
+- Updated dependencies [0b78e17]
+- Updated dependencies [6fba4c7]
+- Updated dependencies [3e3b9df]
+- Updated dependencies [1766ede]
+- Updated dependencies [f10304b]
+  - ai@5.0.0-canary.7
+  - @ai-sdk/provider-utils@3.0.0-canary.6
+
+## 2.0.0-canary.5
+
+### Patch Changes
+
+- ai@5.0.0-canary.6
+- @ai-sdk/provider-utils@3.0.0-canary.5
+
+## 2.0.0-canary.4
+
+### Patch Changes
+
+- Updated dependencies [b71fe8d]
+- Updated dependencies [d91b50d]
+  - ai@5.0.0-canary.5
+  - @ai-sdk/provider-utils@3.0.0-canary.4
+
+## 2.0.0-canary.3
+
+### Patch Changes
+
+- Updated dependencies [a166433]
+- Updated dependencies [9f95b35]
+  - @ai-sdk/provider-utils@3.0.0-canary.3
+  - @ai-sdk/ui-utils@2.0.0-canary.3
+
 ## 2.0.0-canary.2
 
 ### Patch Changes

package/README.md

@@ -1,7 +1,7 @@
 # AI SDK: React provider
 
-[React](https://react.dev/) UI components for the [AI SDK](https://sdk.vercel.ai/docs):
+[React](https://react.dev/) UI components for the [AI SDK](https://ai-sdk.dev/docs):
 
-- [`useChat`](https://sdk.vercel.ai/docs/reference/ai-sdk-ui/use-chat) hook
-- [`useCompletion`](https://sdk.vercel.ai/docs/reference/ai-sdk-ui/use-completion) hook
-- [`useObject`](https://sdk.vercel.ai/docs/reference/ai-sdk-ui/use-object) hook
+- [`useChat`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat) hook
+- [`useCompletion`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-completion) hook
+- [`useObject`](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-object) hook

package/dist/index.d.mts

@@ -1,20 +1,34 @@
-import { UIMessage, Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, Schema, DeepPartial } from '@ai-sdk/ui-utils';
-export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from '@ai-sdk/ui-utils';
+import { UIMessage, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+export { CreateUIMessage, UIMessage, UseChatOptions, UseCompletionOptions } from 'ai';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import z from 'zod';
 
-type UseChatHelpers = {
+type UseChatHelpers<MESSAGE_METADATA = unknown> = {
+    /**
+     * The id of the chat.
+     */
+    readonly id: string;
+    /**
+     * Hook status:
+     *
+     * - `submitted`: The message has been sent to the API and we're awaiting the start of the response stream.
+     * - `streaming`: The response is actively streaming in from the API, receiving chunks of data.
+     * - `ready`: The full response has been received and processed; a new user message can be submitted.
+     * - `error`: An error occurred during the API request, preventing successful completion.
+     */
+    readonly status: 'submitted' | 'streaming' | 'ready' | 'error';
     /** Current messages in the chat */
-    messages: UIMessage[];
+    readonly messages: UIMessage<MESSAGE_METADATA>[];
     /** The error object of the API request */
-    error: undefined | Error;
+    readonly error: undefined | Error;
     /**
      * Append a user message to the chat list. This triggers the API call to fetch
      * the assistant's response.
+     *
      * @param message The message to append
      * @param options Additional options to pass to the API call
      */
-    append: (message: Message | CreateMessage, chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
+    append: (message: CreateUIMessage<MESSAGE_METADATA>, options?: ChatRequestOptions) => Promise<void>;
     /**
      * Reload the last AI chat response for the given chat history. If the last
      * message isn't from the assistant, it will request the API to generate a
@@ -25,12 +39,16 @@ type UseChatHelpers = {
      * Abort the current request immediately, keep the generated tokens if any.
      */
     stop: () => void;
+    /**
+     * Resume an ongoing chat generation stream. This does not resume an aborted generation.
+     */
+    experimental_resume: () => void;
     /**
      * Update the `messages` state locally. This is useful when you want to
      * edit the messages on the client, and then trigger the `reload` method
      * manually to regenerate the AI response.
      */
-    setMessages: (messages: Message[] | ((messages: Message[]) => Message[])) => void;
+    setMessages: (messages: UIMessage<MESSAGE_METADATA>[] | ((messages: UIMessage<MESSAGE_METADATA>[]) => UIMessage<MESSAGE_METADATA>[])) => void;
     /** The current value of the input */
     input: string;
     /** setState-powered method to update the input value */
@@ -40,45 +58,27 @@ type UseChatHelpers = {
     /** Form submission handler to automatically reset input and append a user message */
     handleSubmit: (event?: {
         preventDefault?: () => void;
-    }, chatRequestOptions?: ChatRequestOptions) => void;
-    metadata?: Object;
-    /**
-     * Whether the API request is in progress
-     *
-     * @deprecated use `status` instead
-     */
-    isLoading: boolean;
-    /**
-     * Hook status:
-     *
-     * - `submitted`: The message has been sent to the API and we're awaiting the start of the response stream.
-     * - `streaming`: The response is actively streaming in from the API, receiving chunks of data.
-     * - `ready`: The full response has been received and processed; a new user message can be submitted.
-     * - `error`: An error occurred during the API request, preventing successful completion.
-     */
-    status: 'submitted' | 'streaming' | 'ready' | 'error';
-    /** Additional data added on the server via StreamData. */
-    data?: JSONValue[];
-    /** Set the data of the chat. You can use this to transform or clear the chat data. */
-    setData: (data: JSONValue[] | undefined | ((data: JSONValue[] | undefined) => JSONValue[] | undefined)) => void;
-    /** The id of the chat */
-    id: string;
+    }, chatRequestOptions?: ChatRequestOptions & {
+        files?: FileList | FileUIPart[];
+    }) => void;
+    addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
 };
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onResponse, onFinish, onError, credentials, headers, body, generateId, fetch, keepLastMessageOnError, experimental_throttle: throttleWaitMs, }?: UseChatOptions & {
-    key?: string;
+declare function useChat<MESSAGE_METADATA>({ api, id, initialMessages, initialInput, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onFinish, onError, credentials, headers, body, generateId, fetch, experimental_throttle: throttleWaitMs, messageMetadataSchema, }?: UseChatOptions<MESSAGE_METADATA> & {
     /**
      * Experimental (React only). When a function is provided, it will be used
      * to prepare the request body for the chat API. This can be useful for
      * customizing the request body based on the messages and data in the chat.
      *
+     * @param id The id of the chat.
      * @param messages The current messages in the chat.
-     * @param requestData The data object passed in the chat request.
      * @param requestBody The request body object passed in the chat request.
      */
     experimental_prepareRequestBody?: (options: {
         id: string;
-        messages: UIMessage[];
-        requestData?: JSONValue;
+        messages: UIMessage<MESSAGE_METADATA>[];
         requestBody?: object;
     }) => unknown;
     /**
@@ -86,21 +86,7 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
   Default is undefined, which disables throttling.
      */
     experimental_throttle?: number;
-    /**
-  Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
-  Must be at least 1.
-  
-  A maximum number is required to prevent infinite loops in the case of misconfigured tools.
-  
-  By default, it's set to 1, which means that only a single LLM call is made.
-   */
-    maxSteps?: number;
-}): UseChatHelpers & {
-    addToolResult: ({ toolCallId, result, }: {
-        toolCallId: string;
-        result: any;
-    }) => void;
-};
+}): UseChatHelpers<MESSAGE_METADATA>;
 
 type UseCompletionHelpers = {
     /** The current completion result */
@@ -108,7 +94,7 @@ type UseCompletionHelpers = {
     /**
      * Send a new prompt to the API endpoint and update the completion state.
      */
-    complete: (prompt: string, options?: RequestOptions) => Promise<string | null | undefined>;
+    complete: (prompt: string, options?: CompletionRequestOptions) => Promise<string | null | undefined>;
     /** The error object of the API request */
     error: undefined | Error;
     /**
@@ -145,10 +131,8 @@ type UseCompletionHelpers = {
     }) => void;
     /** Whether the API request is in progress */
     isLoading: boolean;
-    /** Additional data added on the server via StreamData */
-    data?: JSONValue[];
 };
-declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamProtocol, fetch, onResponse, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
+declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamProtocol, fetch, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
     /**
      * Custom throttle wait in ms for the completion and data updates.
      * Default is undefined, which disables throttling.

package/dist/index.d.ts

@@ -1,20 +1,34 @@
-import { UIMessage, Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, Schema, DeepPartial } from '@ai-sdk/ui-utils';
-export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from '@ai-sdk/ui-utils';
+import { UIMessage, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+export { CreateUIMessage, UIMessage, UseChatOptions, UseCompletionOptions } from 'ai';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import z from 'zod';
 
-type UseChatHelpers = {
+type UseChatHelpers<MESSAGE_METADATA = unknown> = {
+    /**
+     * The id of the chat.
+     */
+    readonly id: string;
+    /**
+     * Hook status:
+     *
+     * - `submitted`: The message has been sent to the API and we're awaiting the start of the response stream.
+     * - `streaming`: The response is actively streaming in from the API, receiving chunks of data.
+     * - `ready`: The full response has been received and processed; a new user message can be submitted.
+     * - `error`: An error occurred during the API request, preventing successful completion.
+     */
+    readonly status: 'submitted' | 'streaming' | 'ready' | 'error';
     /** Current messages in the chat */
-    messages: UIMessage[];
+    readonly messages: UIMessage<MESSAGE_METADATA>[];
     /** The error object of the API request */
-    error: undefined | Error;
+    readonly error: undefined | Error;
     /**
      * Append a user message to the chat list. This triggers the API call to fetch
      * the assistant's response.
+     *
      * @param message The message to append
      * @param options Additional options to pass to the API call
      */
-    append: (message: Message | CreateMessage, chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
+    append: (message: CreateUIMessage<MESSAGE_METADATA>, options?: ChatRequestOptions) => Promise<void>;
     /**
      * Reload the last AI chat response for the given chat history. If the last
      * message isn't from the assistant, it will request the API to generate a
@@ -25,12 +39,16 @@ type UseChatHelpers = {
      * Abort the current request immediately, keep the generated tokens if any.
      */
     stop: () => void;
+    /**
+     * Resume an ongoing chat generation stream. This does not resume an aborted generation.
+     */
+    experimental_resume: () => void;
     /**
      * Update the `messages` state locally. This is useful when you want to
      * edit the messages on the client, and then trigger the `reload` method
      * manually to regenerate the AI response.
      */
-    setMessages: (messages: Message[] | ((messages: Message[]) => Message[])) => void;
+    setMessages: (messages: UIMessage<MESSAGE_METADATA>[] | ((messages: UIMessage<MESSAGE_METADATA>[]) => UIMessage<MESSAGE_METADATA>[])) => void;
     /** The current value of the input */
     input: string;
     /** setState-powered method to update the input value */
@@ -40,45 +58,27 @@ type UseChatHelpers = {
     /** Form submission handler to automatically reset input and append a user message */
     handleSubmit: (event?: {
         preventDefault?: () => void;
-    }, chatRequestOptions?: ChatRequestOptions) => void;
-    metadata?: Object;
-    /**
-     * Whether the API request is in progress
-     *
-     * @deprecated use `status` instead
-     */
-    isLoading: boolean;
-    /**
-     * Hook status:
-     *
-     * - `submitted`: The message has been sent to the API and we're awaiting the start of the response stream.
-     * - `streaming`: The response is actively streaming in from the API, receiving chunks of data.
-     * - `ready`: The full response has been received and processed; a new user message can be submitted.
-     * - `error`: An error occurred during the API request, preventing successful completion.
-     */
-    status: 'submitted' | 'streaming' | 'ready' | 'error';
-    /** Additional data added on the server via StreamData. */
-    data?: JSONValue[];
-    /** Set the data of the chat. You can use this to transform or clear the chat data. */
-    setData: (data: JSONValue[] | undefined | ((data: JSONValue[] | undefined) => JSONValue[] | undefined)) => void;
-    /** The id of the chat */
-    id: string;
+    }, chatRequestOptions?: ChatRequestOptions & {
+        files?: FileList | FileUIPart[];
+    }) => void;
+    addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
 };
-declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onResponse, onFinish, onError, credentials, headers, body, generateId, fetch, keepLastMessageOnError, experimental_throttle: throttleWaitMs, }?: UseChatOptions & {
-    key?: string;
+declare function useChat<MESSAGE_METADATA>({ api, id, initialMessages, initialInput, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onFinish, onError, credentials, headers, body, generateId, fetch, experimental_throttle: throttleWaitMs, messageMetadataSchema, }?: UseChatOptions<MESSAGE_METADATA> & {
     /**
      * Experimental (React only). When a function is provided, it will be used
      * to prepare the request body for the chat API. This can be useful for
      * customizing the request body based on the messages and data in the chat.
      *
+     * @param id The id of the chat.
      * @param messages The current messages in the chat.
-     * @param requestData The data object passed in the chat request.
      * @param requestBody The request body object passed in the chat request.
      */
     experimental_prepareRequestBody?: (options: {
         id: string;
-        messages: UIMessage[];
-        requestData?: JSONValue;
+        messages: UIMessage<MESSAGE_METADATA>[];
         requestBody?: object;
     }) => unknown;
     /**
@@ -86,21 +86,7 @@ declare function useChat({ api, id, initialMessages, initialInput, sendExtraMess
   Default is undefined, which disables throttling.
      */
     experimental_throttle?: number;
-    /**
-  Maximum number of sequential LLM calls (steps), e.g. when you use tool calls.
-  Must be at least 1.
-  
-  A maximum number is required to prevent infinite loops in the case of misconfigured tools.
-  
-  By default, it's set to 1, which means that only a single LLM call is made.
-   */
-    maxSteps?: number;
-}): UseChatHelpers & {
-    addToolResult: ({ toolCallId, result, }: {
-        toolCallId: string;
-        result: any;
-    }) => void;
-};
+}): UseChatHelpers<MESSAGE_METADATA>;
 
 type UseCompletionHelpers = {
     /** The current completion result */
@@ -108,7 +94,7 @@ type UseCompletionHelpers = {
     /**
      * Send a new prompt to the API endpoint and update the completion state.
      */
-    complete: (prompt: string, options?: RequestOptions) => Promise<string | null | undefined>;
+    complete: (prompt: string, options?: CompletionRequestOptions) => Promise<string | null | undefined>;
     /** The error object of the API request */
     error: undefined | Error;
     /**
@@ -145,10 +131,8 @@ type UseCompletionHelpers = {
     }) => void;
     /** Whether the API request is in progress */
     isLoading: boolean;
-    /** Additional data added on the server via StreamData */
-    data?: JSONValue[];
 };
-declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamProtocol, fetch, onResponse, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
+declare function useCompletion({ api, id, initialCompletion, initialInput, credentials, headers, body, streamProtocol, fetch, onFinish, onError, experimental_throttle: throttleWaitMs, }?: UseCompletionOptions & {
     /**
      * Custom throttle wait in ms for the completion and data updates.
      * Default is undefined, which disables throttling.