@ai-sdk/react 0.0.1

package/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ['vercel-ai'],
+};

package/.turbo/turbo-build.log

@@ -0,0 +1,21 @@
+
+> @ai-sdk/react@0.0.1 build /home/runner/work/ai/ai/packages/react
+> tsup
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.2.0
+CLI Using tsup config: /home/runner/work/ai/ai/packages/react/tsup.config.ts
+CLI Target: es2018
+CJS Build start
+ESM Build start
+CJS dist/index.js     20.18 KB
+CJS dist/index.js.map 40.03 KB
+CJS ⚡️ Build success in 43ms
+ESM dist/index.mjs     17.85 KB
+ESM dist/index.mjs.map 39.94 KB
+ESM ⚡️ Build success in 46ms
+DTS Build start
+DTS ⚡️ Build success in 4168ms
+DTS dist/index.d.ts  7.36 KB
+DTS dist/index.d.mts 7.36 KB

package/.turbo/turbo-clean.log

@@ -0,0 +1,4 @@
+
+> @ai-sdk/react@0.0.1 clean /home/runner/work/ai/ai/packages/react
+> rm -rf dist
+

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @ai-sdk/react
+
+## 0.0.1
+
+### Patch Changes
+
+- 85f209a4: chore: extracted ui library support into separate modules
+- Updated dependencies [85f209a4]
+  - @ai-sdk/ui-utils@0.0.1

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Vercel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,7 @@
+# Vercel AI SDK: React provider
+
+[React](https://react.dev/) UI components for the [Vercel AI SDK](https://sdk.vercel.ai/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
+- [`useAssistant`](https://sdk.vercel.ai/docs/reference/ai-sdk-ui/use-assistant) hook

package/dist/index.d.mts

@@ -0,0 +1,189 @@
+import { Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, AssistantStatus, UseAssistantOptions } from '@ai-sdk/ui-utils';
+export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from '@ai-sdk/ui-utils';
+
+type UseChatHelpers = {
+    /** Current messages in the chat */
+    messages: Message[];
+    /** 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>;
+    /**
+     * Abort the current request immediately, keep the generated tokens if any.
+     */
+    stop: () => 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[]) => 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: (e: React.FormEvent<HTMLFormElement>, chatRequestOptions?: ChatRequestOptions) => void;
+    metadata?: Object;
+    /** Whether the API request is in progress */
+    isLoading: boolean;
+    /** Additional data added on the server via StreamData */
+    data?: JSONValue[];
+};
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_maxAutomaticRoundtrips, maxAutomaticRoundtrips, maxToolRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
+    api?: string;
+    key?: string;
+    /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    experimental_maxAutomaticRoundtrips?: number;
+    /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
+  Maximal number of automatic roundtrips for tool calls.
+  
+  An automatic tool call roundtrip is a call to the server with the
+  tool call results when all tool calls in the last assistant
+  message have results.
+  
+  A maximum number is required to prevent infinite loops in the
+  case of misconfigured tools.
+  
+  By default, it's set to 0, which will disable the feature.
+     */
+    maxToolRoundtrips?: number;
+}): UseChatHelpers & {
+    /**
+     * @deprecated Use `addToolResult` instead.
+     */
+    experimental_addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
+    addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
+};
+
+type UseCompletionHelpers = {
+    /** The current completion result */
+    completion: string;
+    /**
+     * Send a new prompt to the API endpoint and update the completion state.
+     */
+    complete: (prompt: string, options?: RequestOptions) => Promise<string | null | undefined>;
+    /** The error object of the API request */
+    error: undefined | Error;
+    /**
+     * Abort the current API request but keep the generated tokens.
+     */
+    stop: () => void;
+    /**
+     * Update the `completion` state locally.
+     */
+    setCompletion: (completion: string) => 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
+     * @example
+     * ```jsx
+     * <input onChange={handleInputChange} value={input} />
+     * ```
+     */
+    handleInputChange: (e: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
+    /**
+     * Form submission handler to automatically reset input and append a user message
+     * @example
+     * ```jsx
+     * <form onSubmit={handleSubmit}>
+     *  <input onChange={handleInputChange} value={input} />
+     * </form>
+     * ```
+     */
+    handleSubmit: (e: React.FormEvent<HTMLFormElement>) => 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, streamMode, onResponse, onFinish, onError, }?: UseCompletionOptions): UseCompletionHelpers;
+
+type UseAssistantHelpers = {
+    /**
+     * The current array of chat messages.
+     */
+    messages: Message[];
+    /**
+     * Update the message store with a new array of messages.
+     */
+    setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
+    /**
+     * The current thread ID.
+     */
+    threadId: string | undefined;
+    /**
+     * The current value of the input field.
+     */
+    input: string;
+    /**
+     * 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 requestOptions Additional options to pass to the API call
+     */
+    append: (message: Message | CreateMessage, requestOptions?: {
+        data?: Record<string, string>;
+    }) => Promise<void>;
+    /**
+  Abort the current request immediately, keep the generated tokens if any.
+     */
+    stop: () => void;
+    /**
+     * setState-powered method to update the input value.
+     */
+    setInput: React.Dispatch<React.SetStateAction<string>>;
+    /**
+     * Handler for the `onChange` event of the input field to control the input's value.
+     */
+    handleInputChange: (event: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
+    /**
+     * Form submission handler that automatically resets the input field and appends a user message.
+     */
+    submitMessage: (event?: React.FormEvent<HTMLFormElement>, requestOptions?: {
+        data?: Record<string, string>;
+    }) => Promise<void>;
+    /**
+     * The current status of the assistant. This can be used to show a loading indicator.
+     */
+    status: AssistantStatus;
+    /**
+     * The error thrown during the assistant message processing, if any.
+     */
+    error: undefined | unknown;
+};
+declare function useAssistant({ api, threadId: threadIdParam, credentials, headers, body, onError, }: UseAssistantOptions): UseAssistantHelpers;
+/**
+@deprecated Use `useAssistant` instead.
+ */
+declare const experimental_useAssistant: typeof useAssistant;
+
+export { UseAssistantHelpers, UseChatHelpers, UseCompletionHelpers, experimental_useAssistant, useAssistant, useChat, useCompletion };

package/dist/index.d.ts

@@ -0,0 +1,189 @@
+import { Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, AssistantStatus, UseAssistantOptions } from '@ai-sdk/ui-utils';
+export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from '@ai-sdk/ui-utils';
+
+type UseChatHelpers = {
+    /** Current messages in the chat */
+    messages: Message[];
+    /** 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>;
+    /**
+     * Abort the current request immediately, keep the generated tokens if any.
+     */
+    stop: () => 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[]) => 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: (e: React.FormEvent<HTMLFormElement>, chatRequestOptions?: ChatRequestOptions) => void;
+    metadata?: Object;
+    /** Whether the API request is in progress */
+    isLoading: boolean;
+    /** Additional data added on the server via StreamData */
+    data?: JSONValue[];
+};
+declare function useChat({ api, id, initialMessages, initialInput, sendExtraMessageFields, experimental_onFunctionCall, experimental_onToolCall, onToolCall, experimental_maxAutomaticRoundtrips, maxAutomaticRoundtrips, maxToolRoundtrips, streamMode, onResponse, onFinish, onError, credentials, headers, body, generateId, }?: Omit<UseChatOptions, 'api'> & {
+    api?: string;
+    key?: string;
+    /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    experimental_maxAutomaticRoundtrips?: number;
+    /**
+  @deprecated Use `maxToolRoundtrips` instead.
+     */
+    maxAutomaticRoundtrips?: number;
+    /**
+  Maximal number of automatic roundtrips for tool calls.
+  
+  An automatic tool call roundtrip is a call to the server with the
+  tool call results when all tool calls in the last assistant
+  message have results.
+  
+  A maximum number is required to prevent infinite loops in the
+  case of misconfigured tools.
+  
+  By default, it's set to 0, which will disable the feature.
+     */
+    maxToolRoundtrips?: number;
+}): UseChatHelpers & {
+    /**
+     * @deprecated Use `addToolResult` instead.
+     */
+    experimental_addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
+    addToolResult: ({ toolCallId, result, }: {
+        toolCallId: string;
+        result: any;
+    }) => void;
+};
+
+type UseCompletionHelpers = {
+    /** The current completion result */
+    completion: string;
+    /**
+     * Send a new prompt to the API endpoint and update the completion state.
+     */
+    complete: (prompt: string, options?: RequestOptions) => Promise<string | null | undefined>;
+    /** The error object of the API request */
+    error: undefined | Error;
+    /**
+     * Abort the current API request but keep the generated tokens.
+     */
+    stop: () => void;
+    /**
+     * Update the `completion` state locally.
+     */
+    setCompletion: (completion: string) => 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
+     * @example
+     * ```jsx
+     * <input onChange={handleInputChange} value={input} />
+     * ```
+     */
+    handleInputChange: (e: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
+    /**
+     * Form submission handler to automatically reset input and append a user message
+     * @example
+     * ```jsx
+     * <form onSubmit={handleSubmit}>
+     *  <input onChange={handleInputChange} value={input} />
+     * </form>
+     * ```
+     */
+    handleSubmit: (e: React.FormEvent<HTMLFormElement>) => 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, streamMode, onResponse, onFinish, onError, }?: UseCompletionOptions): UseCompletionHelpers;
+
+type UseAssistantHelpers = {
+    /**
+     * The current array of chat messages.
+     */
+    messages: Message[];
+    /**
+     * Update the message store with a new array of messages.
+     */
+    setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
+    /**
+     * The current thread ID.
+     */
+    threadId: string | undefined;
+    /**
+     * The current value of the input field.
+     */
+    input: string;
+    /**
+     * 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 requestOptions Additional options to pass to the API call
+     */
+    append: (message: Message | CreateMessage, requestOptions?: {
+        data?: Record<string, string>;
+    }) => Promise<void>;
+    /**
+  Abort the current request immediately, keep the generated tokens if any.
+     */
+    stop: () => void;
+    /**
+     * setState-powered method to update the input value.
+     */
+    setInput: React.Dispatch<React.SetStateAction<string>>;
+    /**
+     * Handler for the `onChange` event of the input field to control the input's value.
+     */
+    handleInputChange: (event: React.ChangeEvent<HTMLInputElement> | React.ChangeEvent<HTMLTextAreaElement>) => void;
+    /**
+     * Form submission handler that automatically resets the input field and appends a user message.
+     */
+    submitMessage: (event?: React.FormEvent<HTMLFormElement>, requestOptions?: {
+        data?: Record<string, string>;
+    }) => Promise<void>;
+    /**
+     * The current status of the assistant. This can be used to show a loading indicator.
+     */
+    status: AssistantStatus;
+    /**
+     * The error thrown during the assistant message processing, if any.
+     */
+    error: undefined | unknown;
+};
+declare function useAssistant({ api, threadId: threadIdParam, credentials, headers, body, onError, }: UseAssistantOptions): UseAssistantHelpers;
+/**
+@deprecated Use `useAssistant` instead.
+ */
+declare const experimental_useAssistant: typeof useAssistant;
+
+export { UseAssistantHelpers, UseChatHelpers, UseCompletionHelpers, experimental_useAssistant, useAssistant, useChat, useCompletion };