@ai-sdk/react 2.0.0-canary.20 → 2.0.0-canary.22

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @ai-sdk/react
 
+## 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
+
+- 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

package/dist/index.d.mts

@@ -1,20 +1,34 @@
-import { UIMessage, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, JSONValue, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+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<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<MESSAGE_METADATA>[];
+    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: UIMessage<MESSAGE_METADATA> | CreateUIMessage<MESSAGE_METADATA>, 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
@@ -47,45 +61,12 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
     }, chatRequestOptions?: ChatRequestOptions & {
         files?: FileList | FileUIPart[];
     }) => 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';
     addToolResult: ({ toolCallId, result, }: {
         toolCallId: string;
         result: any;
     }) => void;
-    /** The id of the chat */
-    id: string;
 };
-declare function useChat<MESSAGE_METADATA>({ api, id, initialMessages, initialInput, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onResponse, 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 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;
-        requestBody?: object;
-    }) => unknown;
+declare function useChat<MESSAGE_METADATA>({ id, initialInput, onToolCall, onFinish, onError, generateId, experimental_throttle: throttleWaitMs, chatStore: chatStoreArg, }?: UseChatOptions<MESSAGE_METADATA> & {
     /**
   Custom throttle wait in ms for the chat messages and data updates.
   Default is undefined, which disables throttling.
@@ -137,7 +118,7 @@ type UseCompletionHelpers = {
     /** Whether the API request is in progress */
     isLoading: boolean;
 };
-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, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, JSONValue, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+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<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<MESSAGE_METADATA>[];
+    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: UIMessage<MESSAGE_METADATA> | CreateUIMessage<MESSAGE_METADATA>, 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
@@ -47,45 +61,12 @@ type UseChatHelpers<MESSAGE_METADATA = unknown> = {
     }, chatRequestOptions?: ChatRequestOptions & {
         files?: FileList | FileUIPart[];
     }) => 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';
     addToolResult: ({ toolCallId, result, }: {
         toolCallId: string;
         result: any;
     }) => void;
-    /** The id of the chat */
-    id: string;
 };
-declare function useChat<MESSAGE_METADATA>({ api, id, initialMessages, initialInput, onToolCall, experimental_prepareRequestBody, maxSteps, streamProtocol, onResponse, 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 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;
-        requestBody?: object;
-    }) => unknown;
+declare function useChat<MESSAGE_METADATA>({ id, initialInput, onToolCall, onFinish, onError, generateId, experimental_throttle: throttleWaitMs, chatStore: chatStoreArg, }?: UseChatOptions<MESSAGE_METADATA> & {
     /**
   Custom throttle wait in ms for the chat messages and data updates.
   Default is undefined, which disables throttling.
@@ -137,7 +118,7 @@ type UseCompletionHelpers = {
     /** Whether the API request is in progress */
     isLoading: boolean;
 };
-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.