[Changes] Expose metadata for use in react assistant API

content/docs/07-reference/ai-sdk-ui/20-use-assistant.mdx

@@ -113,6 +113,12 @@ This works in conjunction with [`AssistantResponse`](./assistant-response) in th
       description:
         "Set the current thread ID. Specifying a thread ID will switch to that thread, if it exists. If set to 'undefined', a new thread will be created. For both cases, `threadId` will be updated with the new value and `messages` will be cleared.",
     },
+    // Lines 117-121 have been added by Hypercontext for internal use
+    [
+      name: 'sendMessageMetadata',
+      type: 'boolean',
+      description: 'An optional flag to send metadata in the message object. Defaults to `false`.',
+    ],
     {
       name: 'input',
       type: 'string',

package.json

@@ -26,7 +26,7 @@
     "@playwright/test": "^1.44.1",
     "chalk": "^5.3.0",
     "eslint": "^7.32.0",
-    "eslint-config-vercel-ai": "workspace:*",
+    "eslint-config-vercel-ai": "tools/eslint-config",
     "husky": "^8.0.0",
     "lint-staged": "^15.2.4",
     "next": "15.0.0-canary.23",
@@ -57,5 +57,6 @@
     "singleQuote": true,
     "arrowParens": "avoid",
     "trailingComma": "all"
-  }
+  },
+  "workspaces": ["tools/eslint-config"]
 }

packages/ai/react/index.ts

@@ -3,7 +3,7 @@ import {
   useCompletion as useCompletionReact,
   useAssistant as useAssistantReact,
   experimental_useObject as experimental_useObjectReact,
-} from '@ai-sdk/react';
+} from '../../react/src';
 
 export const useChat = useChatReact;
 export const useCompletion = useCompletionReact;
@@ -14,4 +14,4 @@ export type {
   Message,
   UseChatOptions,
   UseChatHelpers,
-} from '@ai-sdk/react';
+} from '../../react/src';

packages/react/src/use-assistant.ts

@@ -1,12 +1,12 @@
-import { isAbortError } from '@ai-sdk/provider-utils';
+import { isAbortError } from '../../provider-utils/src';
 import {
   AssistantStatus,
   CreateMessage,
   Message,
   UseAssistantOptions,
   generateId,
   readDataStream,
-} from '@ai-sdk/ui-utils';
+} from '../../ui-utils/src';
 import { useCallback, useRef, useState } from 'react';
 
 // use function to allow for mocking in tests:
@@ -89,6 +89,13 @@ Abort the current request immediately, keep the generated tokens if any.
    * The error thrown during the assistant message processing, if any.
    */
   error: undefined | Error;
+
+  /**
+   * Added by Hypercontext for internal use
+   *
+   * An optional flag to retrieve metadata of each message
+   */
+  sendMessageMetadata?: boolean;
 };
 
 export function useAssistant({
@@ -99,6 +106,7 @@ export function useAssistant({
   body,
   onError,
   fetch,
+  sendMessageMetadata, // Added by Hypercontext for internal use
 }: UseAssistantOptions): UseAssistantHelpers {
   const [messages, setMessages] = useState<Message[]>([]);
   const [input, setInput] = useState('');
@@ -187,6 +195,7 @@ export function useAssistant({
                 id: value.id,
                 role: value.role,
                 content: value.content[0].text.value,
+                ...(sendMessageMetadata ? { metadata: value.metadata} : {}), // Added by Hypercontext for internal use
               },
             ]);
             break;
@@ -202,6 +211,7 @@ export function useAssistant({
                   id: lastMessage.id,
                   role: lastMessage.role,
                   content: lastMessage.content + value,
+                  metadata: lastMessage.metadata, // Added by Hypercontext for internal use
                 },
               ];
             });
@@ -285,6 +295,7 @@ export function useAssistant({
     setMessages,
     threadId: currentThreadId,
     setThreadId,
+    sendMessageMetadata, // Added by Hypercontext for internal use
     input,
     setInput,
     handleInputChange,

packages/ui-utils/src/types.ts

@@ -160,6 +160,14 @@ Text content of the message.
    */
   content: string;
 
+  /**
+   * Added by Hypercontext for internal use
+   *
+   * If the sendMessageMetadata flag is enabled, this could be defined.
+   * Otherwise it should be null
+   */
+  metadata?: unknown;
+
   /**
    * Additional attachments to be sent along with the message.
    */
@@ -609,6 +617,7 @@ export type AssistantMessage = {
       value: string;
     };
   }>;
+  metadata?: unknown; // Added by Hypercontext for internal use
 };
 
 /*

packages/ui-utils/src/use-assistant-types.ts

@@ -43,4 +43,11 @@ Custom fetch implementation. You can use it as a middleware to intercept request
 or to provide a custom fetch implementation for e.g. testing.
     */
   fetch?: FetchFunction;
+
+  /**
+   * Added by Hypercontext for internal use
+   *
+   * An optional flag to retrieve metadata of each message
+   */
+  sendMessageMetadata?: boolean;
 };