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

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @ai-sdk/react
 
+## 2.0.0-canary.23
+
+### Patch Changes
+
+- Updated dependencies [bedb239]
+- Updated dependencies [507ac1d]
+- Updated dependencies [2b9bbcd]
+- Updated dependencies [f7e8bf4]
+- Updated dependencies [cda32ba]
+- Updated dependencies [50f0362]
+- Updated dependencies [ed675de]
+- Updated dependencies [faf8446]
+- Updated dependencies [64f6d64]
+  - ai@5.0.0-canary.24
+  - @ai-sdk/provider-utils@3.0.0-canary.19
+
+## 2.0.0-canary.22
+
+### Major Changes
+
+- 40acf9b: feat (ui): introduce ChatStore and ChatTransport
+
+### Patch Changes
+
+- Updated dependencies [40acf9b]
+  - @ai-sdk/provider-utils@3.0.0-canary.18
+  - ai@5.0.0-canary.23
+
 ## 2.0.0-canary.21
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,9 +1,9 @@
-import { UIMessage, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+import { UIDataTypes, 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<MESSAGE_METADATA = unknown> = {
+type UseChatHelpers<MESSAGE_METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataTypes> = {
     /**
      * The id of the chat.
      */
@@ -18,7 +18,7 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
      */
     readonly status: 'submitted' | 'streaming' | 'ready' | 'error';
     /** Current messages in the chat */
-    readonly messages: UIMessage<MESSAGE_METADATA>[];
+    readonly messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[];
     /** The error object of the API request */
     readonly error: undefined | Error;
     /**
@@ -28,7 +28,7 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
      * @param message The message to append
      * @param options Additional options to pass to the API call
      */
-    append: (message: CreateUIMessage<MESSAGE_METADATA>, options?: ChatRequestOptions) => Promise<void>;
+    append: (message: CreateUIMessage<MESSAGE_METADATA, DATA_TYPES>, 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
@@ -48,7 +48,7 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
      * edit the messages on the client, and then trigger the `reload` method
      * manually to regenerate the AI response.
      */
-    setMessages: (messages: UIMessage<MESSAGE_METADATA>[] | ((messages: UIMessage<MESSAGE_METADATA>[]) => UIMessage<MESSAGE_METADATA>[])) => void;
+    setMessages: (messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[] | ((messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[]) => UIMessage<MESSAGE_METADATA, DATA_TYPES>[])) => void;
     /** The current value of the input */
     input: string;
     /** setState-powered method to update the input value */
@@ -66,27 +66,13 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
         result: any;
     }) => void;
 };
-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 requestBody The request body object passed in the chat request.
-     */
-    experimental_prepareRequestBody?: (options: {
-        id: string;
-        messages: UIMessage<MESSAGE_METADATA>[];
-        requestBody?: object;
-    }) => unknown;
+declare function useChat<MESSAGE_METADATA = unknown, DATA_TYPES extends Record<string, unknown> = Record<string, unknown>>({ id, initialInput, onToolCall, onFinish, onError, generateId, experimental_throttle: throttleWaitMs, chatStore: chatStoreArg, }?: UseChatOptions<MESSAGE_METADATA, DATA_TYPES> & {
     /**
   Custom throttle wait in ms for the chat messages and data updates.
   Default is undefined, which disables throttling.
      */
     experimental_throttle?: number;
-}): UseChatHelpers<MESSAGE_METADATA>;
+}): UseChatHelpers<MESSAGE_METADATA, DATA_TYPES>;
 
 type UseCompletionHelpers = {
     /** The current completion result */

package/dist/index.d.ts

@@ -1,9 +1,9 @@
-import { UIMessage, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+import { UIDataTypes, 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<MESSAGE_METADATA = unknown> = {
+type UseChatHelpers<MESSAGE_METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataTypes> = {
     /**
      * The id of the chat.
      */
@@ -18,7 +18,7 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
      */
     readonly status: 'submitted' | 'streaming' | 'ready' | 'error';
     /** Current messages in the chat */
-    readonly messages: UIMessage<MESSAGE_METADATA>[];
+    readonly messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[];
     /** The error object of the API request */
     readonly error: undefined | Error;
     /**
@@ -28,7 +28,7 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
      * @param message The message to append
      * @param options Additional options to pass to the API call
      */
-    append: (message: CreateUIMessage<MESSAGE_METADATA>, options?: ChatRequestOptions) => Promise<void>;
+    append: (message: CreateUIMessage<MESSAGE_METADATA, DATA_TYPES>, 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
@@ -48,7 +48,7 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
      * edit the messages on the client, and then trigger the `reload` method
      * manually to regenerate the AI response.
      */
-    setMessages: (messages: UIMessage<MESSAGE_METADATA>[] | ((messages: UIMessage<MESSAGE_METADATA>[]) => UIMessage<MESSAGE_METADATA>[])) => void;
+    setMessages: (messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[] | ((messages: UIMessage<MESSAGE_METADATA, DATA_TYPES>[]) => UIMessage<MESSAGE_METADATA, DATA_TYPES>[])) => void;
     /** The current value of the input */
     input: string;
     /** setState-powered method to update the input value */
@@ -66,27 +66,13 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
         result: any;
     }) => void;
 };
-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 requestBody The request body object passed in the chat request.
-     */
-    experimental_prepareRequestBody?: (options: {
-        id: string;
-        messages: UIMessage<MESSAGE_METADATA>[];
-        requestBody?: object;
-    }) => unknown;
+declare function useChat<MESSAGE_METADATA = unknown, DATA_TYPES extends Record<string, unknown> = Record<string, unknown>>({ id, initialInput, onToolCall, onFinish, onError, generateId, experimental_throttle: throttleWaitMs, chatStore: chatStoreArg, }?: UseChatOptions<MESSAGE_METADATA, DATA_TYPES> & {
     /**
   Custom throttle wait in ms for the chat messages and data updates.
   Default is undefined, which disables throttling.
      */
     experimental_throttle?: number;
-}): UseChatHelpers<MESSAGE_METADATA>;
+}): UseChatHelpers<MESSAGE_METADATA, DATA_TYPES>;
 
 type UseCompletionHelpers = {
     /** The current completion result */