@ai-sdk/react 0.0.2 → 0.0.4

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
 
-> @ai-sdk/react@0.0.2 build /home/runner/work/ai/ai/packages/react
+> @ai-sdk/react@0.0.4 build /home/runner/work/ai/ai/packages/react
 > tsup
 
 CLI Building entry: src/index.ts
@@ -9,13 +9,13 @@
 CLI Target: es2018
 CJS Build start
 ESM Build start
-ESM dist/index.mjs     17.85 KB
-ESM dist/index.mjs.map 39.94 KB
-ESM ⚡️ Build success in 46ms
-CJS dist/index.js     20.18 KB
-CJS dist/index.js.map 40.03 KB
-CJS ⚡️ Build success in 48ms
+ESM dist/index.mjs     19.60 KB
+ESM dist/index.mjs.map 44.24 KB
+ESM ⚡️ Build success in 59ms
+CJS dist/index.js     22.06 KB
+CJS dist/index.js.map 44.36 KB
+CJS ⚡️ Build success in 65ms
 DTS Build start
-DTS ⚡️ Build success in 4923ms
-DTS dist/index.d.ts  7.36 KB
-DTS dist/index.d.mts 7.36 KB
+DTS ⚡️ Build success in 4971ms
+DTS dist/index.d.ts  8.76 KB
+DTS dist/index.d.mts 8.76 KB

package/.turbo/turbo-clean.log

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

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @ai-sdk/react
 
+## 0.0.4
+
+### Patch Changes
+
+- 008725ec: feat (@ai-sdk/react): add experimental_useObject to @ai-sdk/react
+- Updated dependencies [008725ec]
+  - @ai-sdk/ui-utils@0.0.4
+
+## 0.0.3
+
+### Patch Changes
+
+- Updated dependencies [85712895]
+- Updated dependencies [85712895]
+  - @ai-sdk/provider-utils@0.0.15
+  - @ai-sdk/ui-utils@0.0.3
+
 ## 0.0.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,5 +1,65 @@
-import { Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, AssistantStatus, UseAssistantOptions } from '@ai-sdk/ui-utils';
+import { Message, CreateMessage, AssistantStatus, UseAssistantOptions, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, DeepPartial } from '@ai-sdk/ui-utils';
 export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from '@ai-sdk/ui-utils';
+import z from 'zod';
+
+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;
 
 type UseChatHelpers = {
     /** Current messages in the chat */
@@ -127,63 +187,42 @@ type UseCompletionHelpers = {
 };
 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[];
+type Experimental_UseObjectOptions<RESULT> = {
     /**
-     * Update the message store with a new array of messages.
+     * The API endpoint. It should stream JSON that matches the schema as chunked text.
      */
-    setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
+    api: string;
     /**
-     * The current thread ID.
+     * A Zod schema that defines the shape of the complete object.
      */
-    threadId: string | undefined;
+    schema: z.Schema<RESULT>;
     /**
-     * The current value of the input field.
+     * An unique identifier. If not provided, a random one will be
+     * generated. When provided, the `useObject` hook with the same `id` will
+     * have shared states across components.
      */
-    input: string;
+    id?: 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
+     * An optional value for the initial object.
      */
-    append: (message: Message | CreateMessage, requestOptions?: {
-        data?: Record<string, string>;
-    }) => Promise<void>;
+    initialValue?: DeepPartial<RESULT>;
+};
+type Experimental_UseObjectHelpers<RESULT, INPUT> = {
     /**
-  Abort the current request immediately, keep the generated tokens if any.
+     * Calls the API with the provided input as JSON body.
      */
-    stop: () => void;
+    setInput: (input: INPUT) => void;
     /**
-     * setState-powered method to update the input value.
+     * The current value for the generated object. Updated as the API streams JSON chunks.
      */
-    setInput: React.Dispatch<React.SetStateAction<string>>;
+    object: DeepPartial<RESULT> | undefined;
     /**
-     * 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.
+     * The error object of the API request 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;
+declare function useObject<RESULT, INPUT = any>({ api, id, schema, // required, in the future we will use it for validation
+initialValue, }: Experimental_UseObjectOptions<RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
+declare const experimental_useObject: typeof useObject;
 
-export { UseAssistantHelpers, UseChatHelpers, UseCompletionHelpers, experimental_useAssistant, useAssistant, useChat, useCompletion };
+export { Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseAssistantHelpers, UseChatHelpers, UseCompletionHelpers, experimental_useAssistant, experimental_useObject, useAssistant, useChat, useCompletion };

package/dist/index.d.ts

@@ -1,5 +1,65 @@
-import { Message, CreateMessage, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, AssistantStatus, UseAssistantOptions } from '@ai-sdk/ui-utils';
+import { Message, CreateMessage, AssistantStatus, UseAssistantOptions, ChatRequestOptions, JSONValue, UseChatOptions, RequestOptions, UseCompletionOptions, DeepPartial } from '@ai-sdk/ui-utils';
 export { CreateMessage, Message, UseChatOptions, UseCompletionOptions } from '@ai-sdk/ui-utils';
+import z from 'zod';
+
+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;
 
 type UseChatHelpers = {
     /** Current messages in the chat */
@@ -127,63 +187,42 @@ type UseCompletionHelpers = {
 };
 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[];
+type Experimental_UseObjectOptions<RESULT> = {
     /**
-     * Update the message store with a new array of messages.
+     * The API endpoint. It should stream JSON that matches the schema as chunked text.
      */
-    setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
+    api: string;
     /**
-     * The current thread ID.
+     * A Zod schema that defines the shape of the complete object.
      */
-    threadId: string | undefined;
+    schema: z.Schema<RESULT>;
     /**
-     * The current value of the input field.
+     * An unique identifier. If not provided, a random one will be
+     * generated. When provided, the `useObject` hook with the same `id` will
+     * have shared states across components.
      */
-    input: string;
+    id?: 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
+     * An optional value for the initial object.
      */
-    append: (message: Message | CreateMessage, requestOptions?: {
-        data?: Record<string, string>;
-    }) => Promise<void>;
+    initialValue?: DeepPartial<RESULT>;
+};
+type Experimental_UseObjectHelpers<RESULT, INPUT> = {
     /**
-  Abort the current request immediately, keep the generated tokens if any.
+     * Calls the API with the provided input as JSON body.
      */
-    stop: () => void;
+    setInput: (input: INPUT) => void;
     /**
-     * setState-powered method to update the input value.
+     * The current value for the generated object. Updated as the API streams JSON chunks.
      */
-    setInput: React.Dispatch<React.SetStateAction<string>>;
+    object: DeepPartial<RESULT> | undefined;
     /**
-     * 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.
+     * The error object of the API request 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;
+declare function useObject<RESULT, INPUT = any>({ api, id, schema, // required, in the future we will use it for validation
+initialValue, }: Experimental_UseObjectOptions<RESULT>): Experimental_UseObjectHelpers<RESULT, INPUT>;
+declare const experimental_useObject: typeof useObject;
 
-export { UseAssistantHelpers, UseChatHelpers, UseCompletionHelpers, experimental_useAssistant, useAssistant, useChat, useCompletion };
+export { Experimental_UseObjectHelpers, Experimental_UseObjectOptions, UseAssistantHelpers, UseChatHelpers, UseCompletionHelpers, experimental_useAssistant, experimental_useObject, useAssistant, useChat, useCompletion };