@assistant-ui/react 0.7.28 → 0.7.30

package/src/runtimes/edge/streams/AssistantStreamChunkType.ts

@@ -1,9 +1,10 @@
-import { LanguageModelV1StreamPart } from "@ai-sdk/provider";
+import { JSONValue, LanguageModelV1StreamPart } from "@ai-sdk/provider";
 
 export enum AssistantStreamChunkType {
   TextDelta = "0",
   Data = "2",
   Error = "3",
+  Annotation = "8",
   ToolCall = "9",
   ToolCallResult = "a",
   ToolCallBegin = "b",
@@ -14,7 +15,8 @@ export enum AssistantStreamChunkType {
 
 export type AssistantStreamChunk = {
   [AssistantStreamChunkType.TextDelta]: string;
-  [AssistantStreamChunkType.Data]: unknown;
+  [AssistantStreamChunkType.Data]: JSONValue[];
+  [AssistantStreamChunkType.Annotation]: JSONValue[];
   [AssistantStreamChunkType.ToolCall]: {
     toolCallId: string;
     toolName: string;
@@ -55,4 +57,3 @@ export type AssistantStreamChunk = {
     "type"
   >;
 };
- 

package/src/runtimes/edge/streams/assistantDecoderStream.ts

@@ -131,8 +131,15 @@ export function assistantDecoderStream() {
           break;
         }
 
-        // TODO
         case AssistantStreamChunkType.Data:
+          controller.enqueue({
+            type: "data",
+            data: value,
+          });
+          break;
+
+        // TODO
+        case AssistantStreamChunkType.Annotation:
           break;
 
         default: {

package/src/runtimes/edge/streams/assistantEncoderStream.ts

@@ -44,6 +44,14 @@ export function assistantEncoderStream() {
           break;
         }
 
+        case "data": {
+          controller.enqueue({
+            type: AssistantStreamChunkType.Data,
+            value: chunk.data,
+          });
+          break;
+        }
+
         // ignore
         case "tool-call":
         case "response-metadata":

package/src/runtimes/edge/streams/runResultStream.ts

@@ -1,16 +1,16 @@
-import { ChatModelRunResult } from "../../local/ChatModelAdapter";
+import { CoreChatModelRunResult } from "../../local/ChatModelAdapter";
 import { parsePartialJson } from "../partial-json/parse-partial-json";
 import { LanguageModelV1StreamPart } from "@ai-sdk/provider";
 import { ToolResultStreamPart } from "./toolResultStream";
 import { MessageStatus, ToolCallContentPart } from "../../../types";
 
 export function runResultStream() {
-  let message: ChatModelRunResult = {
+  let message: CoreChatModelRunResult = {
     content: [],
     status: { type: "running" },
   };
 
-  return new TransformStream<ToolResultStreamPart, ChatModelRunResult>({
+  return new TransformStream<ToolResultStreamPart, CoreChatModelRunResult>({
     transform(chunk, controller) {
       const chunkType = chunk.type;
       switch (chunkType) {
@@ -34,9 +34,16 @@ export function runResultStream() {
         }
 
         case "tool-call":
+        // ignoring tool call events because they are converted to tool-call-delta as well
         case "response-metadata":
           break;
 
+        case "data": {
+          message = appendData(message, chunk);
+          controller.enqueue(message);
+          break;
+        }
+
         case "tool-result": {
           message = appendOrUpdateToolResult(
             message,
@@ -48,7 +55,7 @@ export function runResultStream() {
           break;
         }
         case "step-finish": {
-          message = appendOrUpdateStepFinish(message, chunk);
+          message = appendStepFinish(message, chunk);
           controller.enqueue(message);
           break;
         }
@@ -92,7 +99,10 @@ export function runResultStream() {
   });
 }
 
-const appendOrUpdateText = (message: ChatModelRunResult, textDelta: string) => {
+const appendOrUpdateText = (
+  message: CoreChatModelRunResult,
+  textDelta: string,
+) => {
   let contentParts = message.content ?? [];
   let contentPart = message.content?.at(-1);
   if (contentPart?.type !== "text") {
@@ -108,11 +118,11 @@ const appendOrUpdateText = (message: ChatModelRunResult, textDelta: string) => {
 };
 
 const appendOrUpdateToolCall = (
-  message: ChatModelRunResult,
+  message: CoreChatModelRunResult,
   toolCallId: string,
   toolName: string,
   argsTextDelta: string,
-): ChatModelRunResult => {
+): CoreChatModelRunResult => {
   let contentParts = message.content ?? [];
   const contentPartIdx = contentParts.findIndex(
     (c) => c.type === "tool-call" && c.toolCallId === toolCallId,
@@ -152,7 +162,7 @@ const appendOrUpdateToolCall = (
 };
 
 const appendOrUpdateToolResult = (
-  message: ChatModelRunResult,
+  message: CoreChatModelRunResult,
   toolCallId: string,
   toolName: string,
   result: any,
@@ -184,10 +194,23 @@ const appendOrUpdateToolResult = (
   };
 };
 
-const appendOrUpdateStepFinish = (
-  message: ChatModelRunResult,
+const appendData = (
+  message: CoreChatModelRunResult,
+  chunk: ToolResultStreamPart & { type: "data" },
+): CoreChatModelRunResult => {
+  return {
+    ...message,
+    metadata: {
+      ...message.metadata,
+      unstable_data: [...(message.metadata?.unstable_data ?? []), chunk.data],
+    },
+  };
+};
+
+const appendStepFinish = (
+  message: CoreChatModelRunResult,
   chunk: ToolResultStreamPart & { type: "step-finish" },
-): ChatModelRunResult => {
+): CoreChatModelRunResult => {
   const { type, ...rest } = chunk;
   const steps = [
     ...(message.metadata?.steps ?? []),
@@ -205,9 +228,9 @@ const appendOrUpdateStepFinish = (
 };
 
 const appendOrUpdateFinish = (
-  message: ChatModelRunResult,
+  message: CoreChatModelRunResult,
   chunk: LanguageModelV1StreamPart & { type: "finish" },
-): ChatModelRunResult => {
+): CoreChatModelRunResult => {
   const { type, ...rest } = chunk;
 
   const steps = [
@@ -254,8 +277,8 @@ const getStatus = (
 };
 
 const appendOrUpdateCancel = (
-  message: ChatModelRunResult,
-): ChatModelRunResult => {
+  message: CoreChatModelRunResult,
+): CoreChatModelRunResult => {
   return {
     ...message,
     status: {

package/src/runtimes/edge/streams/toolResultStream.ts

@@ -1,10 +1,14 @@
 import { Tool } from "../../../types/ModelConfigTypes";
-import { LanguageModelV1StreamPart } from "@ai-sdk/provider";
+import { JSONValue, LanguageModelV1StreamPart } from "@ai-sdk/provider";
 import { z } from "zod";
 import sjson from "secure-json-parse";
 
 export type ToolResultStreamPart =
   | LanguageModelV1StreamPart
+  | {
+      type: "data";
+      data: JSONValue[];
+    }
   | {
       type: "tool-result";
       toolCallType: "function";
@@ -107,6 +111,7 @@ export function toolResultStream(
         case "finish":
         case "error":
         case "response-metadata":
+        case "data":
           break;
 
         default: {

package/src/runtimes/external-store/ExternalStoreAdapter.tsx

@@ -1,4 +1,3 @@
-import { PropsWithChildren } from "react";
 import { AppendMessage, ThreadMessage } from "../../types";
 import { AttachmentAdapter } from "../attachment";
 import {
@@ -54,11 +53,6 @@ type ExternalStoreAdapterBase<T> = {
   isRunning?: boolean | undefined;
   messages: T[];
   suggestions?: readonly ThreadSuggestion[] | undefined;
-
-  /**
-   * @deprecated This field is deprecated and will be removed in 0.8.0. 
-   * Please migrate to `Provider` and a custom react context provider component instead.
-   */
   extras?: unknown;
 
   setMessages?: ((messages: T[]) => void) | undefined;
@@ -88,8 +82,6 @@ type ExternalStoreAdapterBase<T> = {
         copy?: boolean | undefined;
       }
     | undefined;
-
-  unstable_Provider?: React.ComponentType<PropsWithChildren> | undefined;
 };
 
 export type ExternalStoreAdapter<T = ThreadMessage> =

package/src/runtimes/external-store/ExternalStoreRuntimeCore.tsx

@@ -2,9 +2,6 @@ import { BaseAssistantRuntimeCore } from "../../internal";
 import { ExternalStoreThreadListRuntimeCore } from "./ExternalStoreThreadListRuntimeCore";
 import { ExternalStoreAdapter } from "./ExternalStoreAdapter";
 import { ExternalStoreThreadRuntimeCore } from "./ExternalStoreThreadRuntimeCore";
-import { Fragment } from "react/jsx-runtime";
-import { PropsWithChildren } from "react";
-import { create } from "zustand";
 
 const getThreadListAdapter = (store: ExternalStoreAdapter<any>) => {
   return {
@@ -15,13 +12,8 @@ const getThreadListAdapter = (store: ExternalStoreAdapter<any>) => {
 export class ExternalStoreRuntimeCore extends BaseAssistantRuntimeCore {
   public readonly threadList;
 
-  private useRenderComponent;
-
   constructor(adapter: ExternalStoreAdapter<any>) {
     super();
-    this.useRenderComponent = create(() => ({
-      RenderComponent: adapter.unstable_Provider ?? Fragment,
-    }));
     this.threadList = new ExternalStoreThreadListRuntimeCore(
       getThreadListAdapter(adapter),
       () =>
@@ -33,17 +25,5 @@ export class ExternalStoreRuntimeCore extends BaseAssistantRuntimeCore {
     // Update the thread list adapter and propagate store changes to the main thread
     this.threadList.__internal_setAdapter(getThreadListAdapter(adapter));
     this.threadList.getMainThreadRuntimeCore().__internal_setAdapter(adapter);
-
-    const RenderComponent = adapter.unstable_Provider ?? Fragment;
-    if (
-      RenderComponent !== this.useRenderComponent.getState().RenderComponent
-    ) {
-      this.useRenderComponent.setState({ RenderComponent }, true);
-    }
   }
-
-  public readonly Provider = ({ children }: PropsWithChildren) => {
-    const RenderComponent = this.useRenderComponent.getState().RenderComponent;
-    return <RenderComponent>{children}</RenderComponent>;
-  };
 }

package/src/runtimes/external-store/ThreadMessageLike.tsx

@@ -22,7 +22,7 @@ export type ThreadMessageLike = {
   role: "assistant" | "user" | "system";
   content:
     | string
-    | (
+    | readonly (
         | TextContentPart
         | ImageContentPart
         | Unstable_AudioContentPart
@@ -33,9 +33,10 @@ export type ThreadMessageLike = {
   id?: string | undefined;
   createdAt?: Date | undefined;
   status?: MessageStatus | undefined;
-  attachments?: CompleteAttachment[] | undefined;
+  attachments?: readonly CompleteAttachment[] | undefined;
   metadata?: {
-    steps?: ThreadStep[] | undefined;
+    unstable_data?: readonly Record<string, unknown>[] | undefined;
+    steps?: readonly ThreadStep[] | undefined;
     custom?: Record<string, unknown> | undefined;
   };
 };
@@ -98,6 +99,7 @@ export const fromThreadMessageLike = (
           .filter((c) => !!c),
         status: status ?? fallbackStatus,
         metadata: {
+          unstable_data: metadata?.unstable_data ?? [],
           custom: metadata?.custom ?? {},
           steps: metadata?.steps ?? [],
         },

package/src/runtimes/external-store/external-message-converter.tsx

@@ -32,7 +32,7 @@ type ChunkResult<T> = {
 };
 
 const joinExternalMessages = (
-  messages: useExternalMessageConverter.Message[],
+  messages: readonly useExternalMessageConverter.Message[],
 ): ThreadMessageLike => {
   const assistantMessage: ThreadMessageLike & { content: any[] } = {
     role: "assistant",

package/src/runtimes/local/ChatModelAdapter.tsx

@@ -3,9 +3,11 @@
 import type {
   MessageStatus,
   RunConfig,
+  TextContentPart,
   ThreadAssistantContentPart,
   ThreadMessage,
   ThreadStep,
+  ToolCallContentPart,
 } from "../../types/AssistantTypes";
 import type { ModelConfig } from "../../types/ModelConfigTypes";
 
@@ -18,11 +20,16 @@ export type ChatModelRunResult = {
   content?: ThreadAssistantContentPart[] | undefined;
   status?: MessageStatus | undefined;
   metadata?: {
+    unstable_data?: unknown[] | undefined;
     steps?: ThreadStep[] | undefined;
     custom?: Record<string, unknown> | undefined;
   };
 };
 
+export type CoreChatModelRunResult = Omit<ChatModelRunResult, "content"> & {
+  content: (TextContentPart | ToolCallContentPart)[];
+};
+
 export type ChatModelRunOptions = {
   messages: ThreadMessage[];
   runConfig: RunConfig;

package/src/runtimes/local/LocalThreadRuntimeCore.tsx

@@ -120,7 +120,7 @@ export class LocalThreadRuntimeCore
       role: "assistant",
       status: { type: "running" },
       content: [],
-      metadata: { steps: [], custom: {} },
+      metadata: { unstable_data: [], steps: [], custom: {} },
       createdAt: new Date(),
     };
 

package/src/runtimes/remote-thread-list/RemoteThreadListThreadListRuntimeCore.tsx

@@ -5,7 +5,7 @@ import { RemoteThreadListHookInstanceManager } from "./RemoteThreadListHookInsta
 import { BaseSubscribable } from "./BaseSubscribable";
 import { EMPTY_THREAD_CORE } from "./EMPTY_THREAD_CORE";
 import { OptimisticState } from "./OptimisticState";
-import { FC, Fragment, PropsWithChildren, useEffect, useId } from "react";
+import { FC, Fragment, useEffect, useId } from "react";
 import { create } from "zustand";
 import { CloudInitializeResponse } from "./cloud/CloudContext";
 
@@ -152,8 +152,8 @@ export class RemoteThreadListThreadListRuntimeCore
     this._hookManager = new RemoteThreadListHookInstanceManager(
       adapter.runtimeHook,
     );
-    this.useRenderComponent = create(() => ({
-      RenderComponent: adapter.unstable_Provider ?? Fragment,
+    this.useProvider = create(() => ({
+      Provider: adapter.unstable_Provider ?? Fragment,
     }));
     this.__internal_setAdapter(adapter);
 
@@ -220,7 +220,7 @@ export class RemoteThreadListThreadListRuntimeCore
     this.switchToNewThread();
   }
 
-  private useRenderComponent;
+  private useProvider;
 
   public __internal_setAdapter(adapter: RemoteThreadListAdapter) {
     if (this._adapter === adapter) return;
@@ -229,11 +229,9 @@ export class RemoteThreadListThreadListRuntimeCore
     this._disposeOldAdapter?.();
     this._disposeOldAdapter = this._adapter.onInitialize(this._onInitialize);
 
-    const RenderComponent = adapter.unstable_Provider ?? Fragment;
-    if (
-      RenderComponent !== this.useRenderComponent.getState().RenderComponent
-    ) {
-      this.useRenderComponent.setState({ RenderComponent }, true);
+    const Provider = adapter.unstable_Provider ?? Fragment;
+    if (Provider !== this.useProvider.getState().Provider) {
+      this.useProvider.setState({ Provider }, true);
     }
 
     this._hookManager.setRuntimeHook(adapter.runtimeHook);
@@ -454,7 +452,7 @@ export class RemoteThreadListThreadListRuntimeCore
 
   private useBoundIds = create<string[]>(() => []);
 
-  public __internal_Provider: FC<PropsWithChildren> = ({ children }) => {
+  public __internal_RenderComponent: FC = () => {
     const id = useId();
     useEffect(() => {
       this.useBoundIds.setState((s) => [...s, id], true);
@@ -464,17 +462,15 @@ export class RemoteThreadListThreadListRuntimeCore
     }, []);
 
     const boundIds = this.useBoundIds();
-    const { RenderComponent } = this.useRenderComponent();
+    const { Provider } = this.useProvider();
 
     return (
-      <RenderComponent>
+      <Provider>
         {(boundIds.length === 0 || boundIds[0] === id) && (
           // only render if the component is the first one mounted
           <this._hookManager.__internal_RenderThreadRuntimes />
         )}
-
-        {children}
-      </RenderComponent>
+      </Provider>
     );
   };
 }

package/src/runtimes/remote-thread-list/cloud/useCloudThreadListRuntime.tsx

@@ -1,10 +1,10 @@
 "use client";
 
-import { AssistantRuntime } from "@assistant-ui/react";
 import { PropsWithChildren, useEffect, useMemo, useRef } from "react";
 import { useRemoteThreadListRuntime } from "../useRemoteThreadListRuntime";
 import { AssistantCloud } from "./AssistantCloud";
 import { CloudContext, CloudInitializeResponse } from "./CloudContext";
+import { AssistantRuntime } from "../../../api";
 
 type ThreadData = {
   externalId: string;

package/src/runtimes/remote-thread-list/useRemoteThreadListRuntime.tsx

@@ -3,8 +3,12 @@ import { BaseAssistantRuntimeCore } from "../core/BaseAssistantRuntimeCore";
 import { RemoteThreadListThreadListRuntimeCore } from "./RemoteThreadListThreadListRuntimeCore";
 import { RemoteThreadListAdapter } from "./types";
 import { AssistantRuntimeImpl } from "../../internal";
+import { AssistantRuntimeCore } from "../core/AssistantRuntimeCore";
 
-class RemoteThreadListRuntimeCore extends BaseAssistantRuntimeCore {
+class RemoteThreadListRuntimeCore
+  extends BaseAssistantRuntimeCore
+  implements AssistantRuntimeCore
+{
   public readonly threadList;
 
   constructor(adapter: RemoteThreadListAdapter) {
@@ -12,8 +16,8 @@ class RemoteThreadListRuntimeCore extends BaseAssistantRuntimeCore {
     this.threadList = new RemoteThreadListThreadListRuntimeCore(adapter);
   }
 
-  public get Provider() {
-    return this.threadList.__internal_Provider;
+  public get RenderComponent() {
+    return this.threadList.__internal_RenderComponent;
   }
 }
 

package/src/types/AssistantTypes.ts

@@ -121,7 +121,7 @@ export type MessageStatus =
 
 export type ThreadSystemMessage = MessageCommonProps & {
   readonly role: "system";
-  readonly content: [TextContentPart];
+  readonly content: readonly [TextContentPart];
   readonly metadata: {
     readonly custom: Record<string, unknown>;
   };
@@ -129,7 +129,7 @@ export type ThreadSystemMessage = MessageCommonProps & {
 
 export type ThreadUserMessage = MessageCommonProps & {
   readonly role: "user";
-  readonly content: ThreadUserContentPart[];
+  readonly content: readonly ThreadUserContentPart[];
   readonly attachments: readonly CompleteAttachment[];
   readonly metadata: {
     readonly custom: Record<string, unknown>;
@@ -138,10 +138,11 @@ export type ThreadUserMessage = MessageCommonProps & {
 
 export type ThreadAssistantMessage = MessageCommonProps & {
   readonly role: "assistant";
-  readonly content: ThreadAssistantContentPart[];
+  readonly content: readonly ThreadAssistantContentPart[];
   readonly status: MessageStatus;
   readonly metadata: {
-    readonly steps: ThreadStep[];
+    readonly unstable_data: readonly unknown[];
+    readonly steps: readonly ThreadStep[];
     readonly custom: Record<string, unknown>;
   };
 };
@@ -162,7 +163,8 @@ export type AppendMessage = CoreMessage & {
 type BaseThreadMessage = {
   readonly status?: ThreadAssistantMessage["status"];
   readonly metadata: {
-    readonly steps?: ThreadStep[];
+    readonly unstable_data?: readonly unknown[];
+    readonly steps?: readonly ThreadStep[];
     readonly custom: Record<string, unknown>;
   };
   readonly attachments?: ThreadUserMessage["attachments"];
@@ -183,17 +185,17 @@ export type CoreAssistantContentPart =
 
 export type CoreSystemMessage = {
   role: "system";
-  content: [TextContentPart];
+  content: readonly [TextContentPart];
 };
 
 export type CoreUserMessage = {
   role: "user";
-  content: CoreUserContentPart[];
+  content: readonly CoreUserContentPart[];
 };
 
 export type CoreAssistantMessage = {
   role: "assistant";
-  content: CoreAssistantContentPart[];
+  content: readonly CoreAssistantContentPart[];
 };
 
 export type CoreMessage =