@ai-sdk/react 2.0.0-canary.8 → 2.0.0

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,106 +1,44 @@
-import { UIMessage, Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
-export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from 'ai';
-import { FetchFunction } from '@ai-sdk/provider-utils';
-import z from 'zod';
+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';
 
-type UseChatHelpers = {
-    /** Current messages in the chat */
-    messages: UIMessage[];
-    /** The error object of the API request */
-    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>;
-    /**
-     * 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>;
+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> = {
     /**
-     * Abort the current request immediately, keep the generated tokens if any.
+     * The id of the chat.
      */
-    stop: () => 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: Message[] | ((messages: Message[]) => Message[])) => 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) => 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;
-};
-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;
-    /**
-     * 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;
+    setMessages: (messages: UI_MESSAGE[] | ((messages: UI_MESSAGE[]) => UI_MESSAGE[])) => void;
+    error: Error | undefined;
+} & Pick<AbstractChat<UI_MESSAGE>, 'sendMessage' | 'regenerate' | 'stop' | 'resumeStream' | 'addToolResult' | 'status' | 'messages' | 'clearError'>;
+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;
     /**
-  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;
+     * 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 */
@@ -108,7 +46,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 +83,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.
@@ -156,7 +92,7 @@ declare function useCompletion({ api, id, initialCompletion, initialInput, crede
     experimental_throttle?: number;
 }): UseCompletionHelpers;
 
-type Experimental_UseObjectOptions<RESULT> = {
+type Experimental_UseObjectOptions<SCHEMA extends z4.core.$ZodType | z3.Schema | Schema, RESULT> = {
     /**
      * The API endpoint. It should stream JSON that matches the schema as chunked text.
      */
@@ -164,7 +100,7 @@ type Experimental_UseObjectOptions<RESULT> = {
     /**
      * A Zod schema that defines the shape of the complete object.
      */
-    schema: z.Schema<RESULT, z.ZodTypeDef, any> | Schema<RESULT>;
+    schema: SCHEMA;
     /**
      * An unique identifier. If not provided, a random one will be
      * generated. When provided, the `useObject` hook with the same `id` will
@@ -230,9 +166,13 @@ type Experimental_UseObjectHelpers<RESULT, INPUT> = {
      * Abort the current request immediately, keep the current partial object if any.
      */
     stop: () => void;
+    /**
+     * Clear the object state.
+     */
+    clear: () => void;
 };
-declare function useObject<RESULT, INPUT = any>({ api, id, schema, // required, in the future we will use it for validation
-initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
+declare function useObject<SCHEMA extends z4.core.$ZodType | z3.Schema | Schema, RESULT = InferSchema<SCHEMA>, INPUT = any>({ api, id, schema, // required, in the future we will use it for validation
+initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<SCHEMA, RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
 declare const experimental_useObject: typeof useObject;
 
-export { Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };
+export { Chat, Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseChatOptions, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };

package/dist/index.d.ts

@@ -1,106 +1,44 @@
-import { UIMessage, Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, Schema, DeepPartial } from 'ai';
-export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from 'ai';
-import { FetchFunction } from '@ai-sdk/provider-utils';
-import z from 'zod';
+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';
 
-type UseChatHelpers = {
-    /** Current messages in the chat */
-    messages: UIMessage[];
-    /** The error object of the API request */
-    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>;
-    /**
-     * 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>;
+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> = {
     /**
-     * Abort the current request immediately, keep the generated tokens if any.
+     * The id of the chat.
      */
-    stop: () => 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: Message[] | ((messages: Message[]) => Message[])) => 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) => 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;
-};
-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;
-    /**
-     * 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;
+    setMessages: (messages: UI_MESSAGE[] | ((messages: UI_MESSAGE[]) => UI_MESSAGE[])) => void;
+    error: Error | undefined;
+} & Pick<AbstractChat<UI_MESSAGE>, 'sendMessage' | 'regenerate' | 'stop' | 'resumeStream' | 'addToolResult' | 'status' | 'messages' | 'clearError'>;
+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;
     /**
-  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;
+     * 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 */
@@ -108,7 +46,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 +83,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.
@@ -156,7 +92,7 @@ declare function useCompletion({ api, id, initialCompletion, initialInput, crede
     experimental_throttle?: number;
 }): UseCompletionHelpers;
 
-type Experimental_UseObjectOptions<RESULT> = {
+type Experimental_UseObjectOptions<SCHEMA extends z4.core.$ZodType | z3.Schema | Schema, RESULT> = {
     /**
      * The API endpoint. It should stream JSON that matches the schema as chunked text.
      */
@@ -164,7 +100,7 @@ type Experimental_UseObjectOptions<RESULT> = {
     /**
      * A Zod schema that defines the shape of the complete object.
      */
-    schema: z.Schema<RESULT, z.ZodTypeDef, any> | Schema<RESULT>;
+    schema: SCHEMA;
     /**
      * An unique identifier. If not provided, a random one will be
      * generated. When provided, the `useObject` hook with the same `id` will
@@ -230,9 +166,13 @@ type Experimental_UseObjectHelpers<RESULT, INPUT> = {
      * Abort the current request immediately, keep the current partial object if any.
      */
     stop: () => void;
+    /**
+     * Clear the object state.
+     */
+    clear: () => void;
 };
-declare function useObject<RESULT, INPUT = any>({ api, id, schema, // required, in the future we will use it for validation
-initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
+declare function useObject<SCHEMA extends z4.core.$ZodType | z3.Schema | Schema, RESULT = InferSchema<SCHEMA>, INPUT = any>({ api, id, schema, // required, in the future we will use it for validation
+initialValue, fetch, onError, onFinish, headers, credentials, }: Experimental_UseObjectOptions<SCHEMA, RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
 declare const experimental_useObject: typeof useObject;
 
-export { Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };
+export { Chat, Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseChatHelpers, UseChatOptions, UseCompletionHelpers, experimental_useObject, useChat, useCompletion };