@ai-sdk/react 2.0.0-alpha.8 → 2.0.0-beta.1

package/CHANGELOG.md

@@ -1,5 +1,109 @@
 # @ai-sdk/react
 
+## 2.0.0-beta.1
+
+### Patch Changes
+
+- Updated dependencies [d88455d]
+- Updated dependencies [45c1ea2]
+- Updated dependencies [9ad0484]
+- Updated dependencies [e025824]
+- Updated dependencies [4048ce3]
+- Updated dependencies [f2b041e]
+- Updated dependencies [cb68df0]
+- Updated dependencies [26695a3]
+- Updated dependencies [bfdca8d]
+- Updated dependencies [e7d2ce3]
+- Updated dependencies [102b066]
+- Updated dependencies [71f938d]
+- Updated dependencies [28a5ed5]
+- Updated dependencies [e862b5b]
+- Updated dependencies [7bd025b]
+  - ai@5.0.0-beta.1
+  - @ai-sdk/provider-utils@3.0.0-beta.1
+
+## 2.0.0-alpha.15
+
+### Patch Changes
+
+- ae0dc0a: feat (ui/react): add resume flag to useChat
+- Updated dependencies [b1e3abd]
+- Updated dependencies [8ba77a7]
+- Updated dependencies [04d5063]
+- Updated dependencies [b4b4bb2]
+- Updated dependencies [d884051]
+- Updated dependencies [954aa73]
+- Updated dependencies [142576e]
+- Updated dependencies [395c85e]
+- Updated dependencies [60e2c56]
+  - ai@5.0.0-alpha.15
+  - @ai-sdk/provider-utils@3.0.0-alpha.15
+
+## 2.0.0-alpha.14
+
+### Patch Changes
+
+- 995baa0: fix (react): structuredClone message in replaceMessage
+- Updated dependencies [63f9e9b]
+  - ai@5.0.0-alpha.14
+  - @ai-sdk/provider-utils@3.0.0-alpha.14
+
+## 2.0.0-alpha.13
+
+### Major Changes
+
+- 0a710d8: feat (ui): typed tool parts in ui messages
+- 901df02: feat (ui): use UI_MESSAGE generic
+
+### Patch Changes
+
+- Updated dependencies [0a710d8]
+- Updated dependencies [6a83f7d]
+- Updated dependencies [1f55c21]
+- Updated dependencies [33eb499]
+- Updated dependencies [901df02]
+  - ai@5.0.0-alpha.13
+  - @ai-sdk/provider-utils@3.0.0-alpha.13
+
+## 2.0.0-alpha.12
+
+### Patch Changes
+
+- Updated dependencies [da1e6f0]
+- Updated dependencies [4892798]
+  - ai@5.0.0-alpha.12
+  - @ai-sdk/provider-utils@3.0.0-alpha.12
+
+## 2.0.0-alpha.11
+
+### Patch Changes
+
+- Updated dependencies [e8324c5]
+  - ai@5.0.0-alpha.11
+  - @ai-sdk/provider-utils@3.0.0-alpha.11
+
+## 2.0.0-alpha.10
+
+### Major Changes
+
+- 98f25e5: chore (ui): remove managed chat inputs
+
+### Patch Changes
+
+- Updated dependencies [98f25e5]
+- Updated dependencies [7bb58d4]
+  - ai@5.0.0-alpha.10
+  - @ai-sdk/provider-utils@3.0.0-alpha.10
+
+## 2.0.0-alpha.9
+
+### Patch Changes
+
+- Updated dependencies [8255639]
+- Updated dependencies [9ae327d]
+  - ai@5.0.0-alpha.9
+  - @ai-sdk/provider-utils@3.0.0-alpha.9
+
 ## 2.0.0-alpha.8
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,79 +1,44 @@
-import { UIDataPartSchemas, UIMessage, InferUIDataParts, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial, ChatStoreOptions, ChatStore } from 'ai';
-export { CreateUIMessage, UIMessage, UseChatOptions, UseCompletionOptions } from 'ai';
+import { UIMessage, AbstractChat, ChatInit, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+export { CreateUIMessage, UIMessage, UseCompletionOptions } from 'ai';
 import { FetchFunction, InferSchema } from '@ai-sdk/provider-utils';
 import * as z3 from 'zod/v3';
 import * as z4 from 'zod/v4/core';
 
-type UseChatHelpers<MESSAGE_METADATA = unknown, DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas> = {
+declare class Chat<UI_MESSAGE extends UIMessage> extends AbstractChat<UI_MESSAGE> {
+    #private;
+    constructor({ messages, ...init }: ChatInit<UI_MESSAGE>);
+    '~registerMessagesCallback': (onChange: () => void, throttleWaitMs?: number) => (() => void);
+    '~registerStatusCallback': (onChange: () => void) => (() => void);
+    '~registerErrorCallback': (onChange: () => void) => (() => void);
+}
+
+type UseChatHelpers<UI_MESSAGE extends UIMessage> = {
     /**
      * The id of the chat.
      */
-    readonly chatId: 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 */
-    readonly messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[];
-    /** The error object of the API request */
-    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: CreateUIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>, 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
-     * new response.
-     */
-    reload: (chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
-    /**
-     * 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;
+    readonly id: string;
     /**
      * 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: UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[] | ((messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[]) => UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[])) => void;
-    /** The current value of the input */
-    input: string;
-    /** setState-powered method to update the input value */
-    setInput: React.Dispatch<React.SetStateAction<string>>;
-    /** An input/textarea-ready onChange handler to control the value of the input */
-    handleInputChange: (e: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
-    /** Form submission handler to automatically reset input and append a user message */
-    handleSubmit: (event?: {
-        preventDefault?: () => void;
-    }, chatRequestOptions?: ChatRequestOptions & {
-        files?: FileList | FileUIPart[];
-    }) => void;
-    addToolResult: ({ toolCallId, result, }: {
-        toolCallId: string;
-        result: any;
-    }) => void;
-};
-declare function useChat<MESSAGE_METADATA = unknown, DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas>({ chatId, initialInput, onToolCall, onFinish, onError, generateId, experimental_throttle: throttleWaitMs, chatStore: chatStoreArg, }?: UseChatOptions<MESSAGE_METADATA, DATA_PART_SCHEMAS> & {
+    setMessages: (messages: UI_MESSAGE[] | ((messages: UI_MESSAGE[]) => UI_MESSAGE[])) => void;
+    error: Error | undefined;
+} & Pick<AbstractChat<UI_MESSAGE>, 'sendMessage' | 'regenerate' | 'stop' | 'resumeStream' | 'addToolResult' | 'status' | 'messages'>;
+type UseChatOptions<UI_MESSAGE extends UIMessage> = ({
+    chat: Chat<UI_MESSAGE>;
+} | ChatInit<UI_MESSAGE>) & {
     /**
   Custom throttle wait in ms for the chat messages and data updates.
   Default is undefined, which disables throttling.
      */
     experimental_throttle?: number;
-}): UseChatHelpers<MESSAGE_METADATA, DATA_PART_SCHEMAS>;
+    /**
+     * Whether to resume an ongoing chat generation stream.
+     */
+    resume?: boolean;
+};
+declare function useChat<UI_MESSAGE extends UIMessage = UIMessage>({ experimental_throttle: throttleWaitMs, resume, ...options }?: UseChatOptions<UI_MESSAGE>): UseChatHelpers<UI_MESSAGE>;
 
 type UseCompletionHelpers = {
     /** The current completion result */
@@ -206,6 +171,4 @@ declare function useObject<SCHEMA extends z4.$ZodType | z3.Schema | Schema, RESU
 initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<SCHEMA, RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
 declare const experimental_useObject: typeof useObject;
 
-declare function createChatStore<MESSAGE_METADATA = unknown, DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas>(options: ChatStoreOptions<MESSAGE_METADATA, DATA_PART_SCHEMAS>): ChatStore<MESSAGE_METADATA, DATA_PART_SCHEMAS>;
-
-export { Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseCompletionHelpers, createChatStore, experimental_useObject, useChat, useCompletion };
+export { Chat, Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseChatOptions, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };

package/dist/index.d.ts

@@ -1,79 +1,44 @@
-import { UIDataPartSchemas, UIMessage, InferUIDataParts, CreateUIMessage, ChatRequestOptions, FileUIPart, UseChatOptions, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial, ChatStoreOptions, ChatStore } from 'ai';
-export { CreateUIMessage, UIMessage, UseChatOptions, UseCompletionOptions } from 'ai';
+import { UIMessage, AbstractChat, ChatInit, CompletionRequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
+export { CreateUIMessage, UIMessage, UseCompletionOptions } from 'ai';
 import { FetchFunction, InferSchema } from '@ai-sdk/provider-utils';
 import * as z3 from 'zod/v3';
 import * as z4 from 'zod/v4/core';
 
-type UseChatHelpers<MESSAGE_METADATA = unknown, DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas> = {
+declare class Chat<UI_MESSAGE extends UIMessage> extends AbstractChat<UI_MESSAGE> {
+    #private;
+    constructor({ messages, ...init }: ChatInit<UI_MESSAGE>);
+    '~registerMessagesCallback': (onChange: () => void, throttleWaitMs?: number) => (() => void);
+    '~registerStatusCallback': (onChange: () => void) => (() => void);
+    '~registerErrorCallback': (onChange: () => void) => (() => void);
+}
+
+type UseChatHelpers<UI_MESSAGE extends UIMessage> = {
     /**
      * The id of the chat.
      */
-    readonly chatId: 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 */
-    readonly messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[];
-    /** The error object of the API request */
-    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: CreateUIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>, 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
-     * new response.
-     */
-    reload: (chatRequestOptions?: ChatRequestOptions) => Promise<string | null | undefined>;
-    /**
-     * 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;
+    readonly id: string;
     /**
      * 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: UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[] | ((messages: UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[]) => UIMessage<MESSAGE_METADATA, InferUIDataParts<DATA_PART_SCHEMAS>>[])) => void;
-    /** The current value of the input */
-    input: string;
-    /** setState-powered method to update the input value */
-    setInput: React.Dispatch<React.SetStateAction<string>>;
-    /** An input/textarea-ready onChange handler to control the value of the input */
-    handleInputChange: (e: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
-    /** Form submission handler to automatically reset input and append a user message */
-    handleSubmit: (event?: {
-        preventDefault?: () => void;
-    }, chatRequestOptions?: ChatRequestOptions & {
-        files?: FileList | FileUIPart[];
-    }) => void;
-    addToolResult: ({ toolCallId, result, }: {
-        toolCallId: string;
-        result: any;
-    }) => void;
-};
-declare function useChat<MESSAGE_METADATA = unknown, DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas>({ chatId, initialInput, onToolCall, onFinish, onError, generateId, experimental_throttle: throttleWaitMs, chatStore: chatStoreArg, }?: UseChatOptions<MESSAGE_METADATA, DATA_PART_SCHEMAS> & {
+    setMessages: (messages: UI_MESSAGE[] | ((messages: UI_MESSAGE[]) => UI_MESSAGE[])) => void;
+    error: Error | undefined;
+} & Pick<AbstractChat<UI_MESSAGE>, 'sendMessage' | 'regenerate' | 'stop' | 'resumeStream' | 'addToolResult' | 'status' | 'messages'>;
+type UseChatOptions<UI_MESSAGE extends UIMessage> = ({
+    chat: Chat<UI_MESSAGE>;
+} | ChatInit<UI_MESSAGE>) & {
     /**
   Custom throttle wait in ms for the chat messages and data updates.
   Default is undefined, which disables throttling.
      */
     experimental_throttle?: number;
-}): UseChatHelpers<MESSAGE_METADATA, DATA_PART_SCHEMAS>;
+    /**
+     * Whether to resume an ongoing chat generation stream.
+     */
+    resume?: boolean;
+};
+declare function useChat<UI_MESSAGE extends UIMessage = UIMessage>({ experimental_throttle: throttleWaitMs, resume, ...options }?: UseChatOptions<UI_MESSAGE>): UseChatHelpers<UI_MESSAGE>;
 
 type UseCompletionHelpers = {
     /** The current completion result */
@@ -206,6 +171,4 @@ declare function useObject<SCHEMA extends z4.$ZodType | z3.Schema | Schema, RESU
 initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<SCHEMA, RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
 declare const experimental_useObject: typeof useObject;
 
-declare function createChatStore<MESSAGE_METADATA = unknown, DATA_PART_SCHEMAS extends UIDataPartSchemas = UIDataPartSchemas>(options: ChatStoreOptions<MESSAGE_METADATA, DATA_PART_SCHEMAS>): ChatStore<MESSAGE_METADATA, DATA_PART_SCHEMAS>;
-
-export { Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseCompletionHelpers, createChatStore, experimental_useObject, useChat, useCompletion };
+export { Chat, Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseChatOptions, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };