@assistant-ui/react 0.5.100 → 0.7.1

package/src/api/ThreadRuntime.ts

@@ -1,12 +1,10 @@
 import {
-  AddToolResultOptions,
   ThreadSuggestion,
   RuntimeCapabilities,
-  SubmitFeedbackOptions,
   ThreadRuntimeCore,
   SpeechState,
-  SubmittedFeedback,
   ThreadRuntimeEventType,
+  ThreadMetadata,
 } from "../runtimes/core/ThreadRuntimeCore";
 import { ExportedMessageRepository } from "../runtimes/utils/MessageRepository";
 import {
@@ -32,7 +30,6 @@ import {
 } from "./ComposerRuntime";
 import { LazyMemoizeSubject } from "./subscribable/LazyMemoizeSubject";
 import { SKIP_UPDATE } from "./subscribable/SKIP_UPDATE";
-import { ComposerRuntimeCore } from "../runtimes/core/ComposerRuntimeCore";
 import { MessageRuntimePath, ThreadRuntimePath } from "./RuntimePathTypes";
 
 export type CreateAppendMessage =
@@ -77,51 +74,59 @@ export type ThreadRuntimeCoreBinding = SubscribableWithState<
   outerSubscribe(callback: () => void): Unsubscribe;
 };
 
-export type ThreadState = Readonly<{
+export type ThreadState = {
   /**
    * The thread ID.
+   * @deprecated This field is deprecated and will be removed in 0.8.0. Use `metadata.threadId` instead.
    */
-  threadId: string;
+  readonly threadId: string;
+
+  /**
+   * The thread metadata.
+   */
+  readonly metadata: ThreadMetadata;
+
   /**
    * Whether the thread is disabled. Disabled threads cannot receive new messages.
    */
-  isDisabled: boolean;
+  readonly isDisabled: boolean;
 
   /**
    * Whether the thread is running. A thread is considered running when there is an active stream connection to the backend.
    */
-  isRunning: boolean;
+  readonly isRunning: boolean;
 
   /**
    * The capabilities of the thread, such as whether the thread supports editing, branch switching, etc.
    */
-  capabilities: RuntimeCapabilities;
+  readonly capabilities: RuntimeCapabilities;
 
   /**
    * The messages in the currently selected branch of the thread.
    */
-  messages: readonly ThreadMessage[];
+  readonly messages: readonly ThreadMessage[];
 
   /**
    * Follow up message suggestions to show the user.
    */
-  suggestions: readonly ThreadSuggestion[];
+  readonly suggestions: readonly ThreadSuggestion[];
 
   /**
    * Custom extra information provided by the runtime.
    */
-  extras: unknown;
+  readonly extras: unknown;
 
   /**
    * @deprecated This API is still under active development and might change without notice.
    */
-  speech: SpeechState | undefined;
-}>;
+  readonly speech: SpeechState | undefined;
+};
 
 export const getThreadState = (runtime: ThreadRuntimeCore): ThreadState => {
   const lastMessage = runtime.messages.at(-1);
   return Object.freeze({
-    threadId: runtime.threadId,
+    threadId: runtime.metadata.threadId,
+    metadata: runtime.metadata,
     capabilities: runtime.capabilities,
     isDisabled: runtime.isDisabled,
     isRunning:
@@ -135,18 +140,44 @@ export const getThreadState = (runtime: ThreadRuntimeCore): ThreadState => {
   });
 };
 
-export type ThreadRuntime = Readonly<{
+export type ThreadRuntime = {
+  /**
+   * The selector for the thread runtime.
+   */
   readonly path: ThreadRuntimePath;
 
+  /**
+   * The thread composer runtime.
+   */
   readonly composer: ThreadComposerRuntime;
-  getState(): ThreadState;
 
   /**
-   * @deprecated This method will be removed in 0.6.0. Submit feedback if you need this functionality.
+   * Gets a snapshot of the thread state.
    */
-  unstable_getCore(): ThreadRuntimeCore;
+  getState(): ThreadState;
 
+  /**
+   * Append a new message to the thread.
+   *
+   * @example ```ts
+   * // append a new user message with the text "Hello, world!"
+   * threadRuntime.append("Hello, world!");
+   * ```
+   *
+   * @example ```ts
+   * // append a new assistant message with the text "Hello, world!"
+   * threadRuntime.append({
+   *   role: "assistant",
+   *   content: [{ type: "text", text: "Hello, world!" }],
+   * });
+   * ```
+   */
   append(message: CreateAppendMessage): void;
+
+  /**
+   *
+   * @param parentId
+   */
   startRun(parentId: string | null): void;
   subscribe(callback: () => void): Unsubscribe;
   cancelRun(): void;
@@ -162,153 +193,13 @@ export type ThreadRuntime = Readonly<{
   stopSpeaking: () => void;
 
   unstable_on(event: ThreadRuntimeEventType, callback: () => void): Unsubscribe;
+};
 
-  // Legacy methods with deprecations
-
-  /**
-   * @deprecated Use `getState().capabilities` instead. This will be removed in 0.6.0.
-   */
-  capabilities: Readonly<RuntimeCapabilities>;
-
-  /**
-   * @deprecated Use `getState().threadId` instead. This will be removed in 0.6.0.
-   */
-  threadId: string;
-
-  /**
-   * @deprecated Use `getState().isDisabled` instead. This will be removed in 0.6.0.
-   */
-  isDisabled: boolean;
-
-  /**
-   * @deprecated Use `getState().isRunning` instead. This will be removed in 0.6.0.
-   */
-  isRunning: boolean;
-
-  /**
-   * @deprecated Use `getState().messages` instead. This will be removed in 0.6.0.
-   */
-  messages: readonly ThreadMessage[];
-
-  /**
-   * @deprecated Use `getState().followupSuggestions` instead. This will be removed in 0.6.0.
-   */
-  suggestions: readonly ThreadSuggestion[];
-
-  /**
-   * @deprecated Use `getState().speechState` instead. This will be removed in 0.6.0.
-   */
-  speech: SpeechState | undefined;
-
-  /**
-   * @deprecated Use `getState().extras` instead. This will be removed in 0.6.0.
-   */
-  extras: unknown;
-
-  /**
-   * @deprecated Use `getMesssageById(id).getState().branchNumber` / `getMesssageById(id).getState().branchCount` instead. This will be removed in 0.6.0.
-   */
-  getBranches: (messageId: string) => readonly string[];
-
-  /**
-   * @deprecated Use `getMesssageById(id).switchToBranch({ options })` instead. This will be removed in 0.6.0.
-   */
-  switchToBranch: (branchId: string) => void;
-
-  /**
-   * @deprecated Use `getMesssageById(id).getContentPartByToolCallId(toolCallId).addToolResult({ result })` instead. This will be removed in 0.6.0.
-   */
-  addToolResult: (options: AddToolResultOptions) => void;
-
-  /**
-   * @deprecated Use `getMesssageById(id).speak()` instead. This will be removed in 0.6.0.
-   */
-  speak: (messageId: string) => void;
-
-  /**
-   * @deprecated Use `getMesssageById(id).getState().submittedFeedback` instead. This will be removed in 0.6.0.
-   */
-  getSubmittedFeedback: (messageId: string) => SubmittedFeedback | undefined;
-
-  /**
-   * @deprecated Use `getMesssageById(id).submitFeedback({ type })` instead. This will be removed in 0.6.0.
-   */
-  submitFeedback: (feedback: SubmitFeedbackOptions) => void;
-
-  /**
-   * @deprecated Use `getMesssageById(id).composer` instead. This will be removed in 0.6.0.
-   */
-  getEditComposer: (messageId: string) => ComposerRuntimeCore | undefined;
-
-  /**
-   * @deprecated Use `getMesssageById(id).composer.beginEdit()` instead. This will be removed in 0.6.0.
-   */
-  beginEdit: (messageId: string) => void;
-}>;
-
-export class ThreadRuntimeImpl
-  implements Omit<ThreadRuntimeCore, "getMessageById">, ThreadRuntime
-{
+export class ThreadRuntimeImpl implements ThreadRuntime {
   public get path() {
     return this._threadBinding.path;
   }
 
-  /**
-   * @deprecated Use `getState().threadId` instead. This will be removed in 0.6.0.
-   */
-  public get threadId() {
-    return this.getState().threadId;
-  }
-
-  /**
-   * @deprecated Use `getState().isDisabled` instead. This will be removed in 0.6.0.
-   */
-  public get isDisabled() {
-    return this.getState().isDisabled;
-  }
-
-  /**
-   * @deprecated Use `getState().isRunning` instead. This will be removed in 0.6.0.
-   */
-  public get isRunning() {
-    return this.getState().isRunning;
-  }
-
-  /**
-   * @deprecated Use `getState().capabilities` instead. This will be removed in 0.6.0.
-   */
-  public get capabilities() {
-    return this.getState().capabilities;
-  }
-
-  /**
-   * @deprecated Use `getState().extras` instead. This will be removed in 0.6.0.
-   */
-  public get extras() {
-    return this._threadBinding.getState().extras;
-  }
-
-  /**
-   * @deprecated Use `getState().followupSuggestions` instead. This will be removed in 0.6.0.
-   */
-  public get suggestions() {
-    return this._threadBinding.getState().suggestions;
-  }
-
-  /**
-   * @deprecated Use `getState().messages` instead. This will be removed in 0.6.0.
-   */
-  public get messages() {
-    return this._threadBinding.getState().messages;
-  }
-
-  /**
-   * @deprecated Use `getState().speechState` instead. This will be removed in 0.6.0.
-   */
-  public get speech() {
-    return this._threadBinding.getState().speech;
-  }
-
   public unstable_getCore() {
     return this._threadBinding.getState();
   }
@@ -363,18 +254,10 @@ export class ThreadRuntimeImpl
     return this._threadBinding.subscribe(callback);
   }
 
-  /**
-   * @derprecated Use `getMesssageById(id).getState().branchNumber` / `getMesssageById(id).getState().branchCount` instead. This will be removed in 0.6.0.
-   */
-  public getBranches(messageId: string) {
-    return this._threadBinding.getState().getBranches(messageId);
-  }
-
   public getModelConfig() {
     return this._threadBinding.getState().getModelConfig();
   }
 
-  // TODO sometimes you want to continue when there is no child message
   public startRun(parentId: string | null) {
     return this._threadBinding.getState().startRun(parentId);
   }
@@ -383,27 +266,6 @@ export class ThreadRuntimeImpl
     this._threadBinding.getState().cancelRun();
   }
 
-  /**
-   * @deprecated Use `getMesssageById(id).getContentPartByToolCallId(toolCallId).addToolResult({ result })` instead. This will be removed in 0.6.0.
-   */
-  public addToolResult(options: AddToolResultOptions) {
-    this._threadBinding.getState().addToolResult(options);
-  }
-
-  /**
-   * @deprecated Use `getMesssageById(id).switchToBranch({ options })` instead. This will be removed in 0.6.0.
-   */
-  public switchToBranch(branchId: string) {
-    return this._threadBinding.getState().switchToBranch(branchId);
-  }
-
-  /**
-   * @deprecated Use `getMesssageById(id).speak()` instead. This will be removed in 0.6.0.
-   */
-  public speak(messageId: string) {
-    return this._threadBinding.getState().speak(messageId);
-  }
-
   public stopSpeaking() {
     return this._threadBinding.getState().stopSpeaking();
   }
@@ -412,27 +274,6 @@ export class ThreadRuntimeImpl
     return this._threadBinding.getState().getSubmittedFeedback(messageId);
   }
 
-  /**
-   * @deprecated Use `getMesssageById(id).submitFeedback({ type })` instead. This will be removed in 0.6.0.
-   */
-  public submitFeedback(options: SubmitFeedbackOptions) {
-    return this._threadBinding.getState().submitFeedback(options);
-  }
-
-  /**
-   * @deprecated Use `getMesssageById(id).getMessageByIndex(idx).composer` instead. This will be removed in 0.6.0.
-   */
-  public getEditComposer(messageId: string) {
-    return this._threadBinding.getState().getEditComposer(messageId);
-  }
-
-  /**
-   * @deprecated Use `getMesssageById(id).getMessageByIndex(idx).composer.beginEdit()` instead. This will be removed in 0.6.0.
-   */
-  public beginEdit(messageId: string) {
-    return this._threadBinding.getState().beginEdit(messageId);
-  }
-
   public export() {
     return this._threadBinding.getState().export();
   }
@@ -500,11 +341,9 @@ export class ThreadRuntimeImpl
           return {
             ...message,
 
-            message,
             isLast: messages.at(-1)?.id === message.id,
             parentId,
 
-            branches,
             branchNumber: branches.indexOf(message.id) + 1,
             branchCount: branches.length,
 

package/src/api/index.ts

@@ -15,3 +15,7 @@ export type {
 } from "./ComposerRuntime";
 export type { AttachmentRuntime, AttachmentState } from "./AttachmentRuntime";
 export type { ThreadListRuntime, ThreadListState } from "./ThreadListRuntime";
+export type {
+  ThreadListItemRuntime,
+  ThreadListItemState,
+} from "./ThreadListItemRuntime";

package/src/context/providers/AssistantRuntimeProvider.tsx

@@ -55,7 +55,6 @@ export const AssistantRuntimeProviderImpl: FC<
     return {
       useToolUIs,
       useAssistantRuntime,
-      useAssistantActions: useAssistantRuntime,
       useThreadList,
     };
   }, [useAssistantRuntime, useToolUIs, useThreadList]);

package/src/context/providers/TextContentPartProvider.tsx

@@ -41,7 +41,6 @@ export const TextContentPartProvider: FC<TextContentPartProvider.Props> = ({
     );
     const useContentPart = create<ContentPartState>(() => ({
       status: isRunning ? RUNNING_STATUS : COMPLETE_STATUS,
-      part: { type: "text", text },
       type: "text",
       text,
     }));
@@ -64,7 +63,6 @@ export const TextContentPartProvider: FC<TextContentPartProvider.Props> = ({
       {
         type: "text",
         text,
-        part: { type: "text", text },
         status: targetStatus,
       } satisfies ContentPartState,
       true,

package/src/context/providers/ThreadRuntimeProvider.tsx

@@ -34,19 +34,6 @@ const useThreadStore = (runtime: ThreadRuntime) => {
   return store;
 };
 
-const useThreadMessagesStore = (runtime: ThreadRuntime) => {
-  const [store] = useState(() => create(() => runtime.messages));
-
-  useEffect(() => {
-    const updateState = () =>
-      writableStore(store).setState(runtime.messages, true);
-    updateState();
-    return runtime.subscribe(updateState);
-  }, [runtime, store]);
-
-  return store;
-};
-
 const useThreadComposerStore = (runtime: ThreadComposerRuntime) => {
   const [store] = useState(() => create(() => runtime.getState()));
 
@@ -65,7 +52,6 @@ export const ThreadRuntimeProvider: FC<
 > = ({ children, runtime }) => {
   const useThreadRuntime = useThreadRuntimeStore(runtime);
   const useThread = useThreadStore(runtime);
-  const useThreadMessages = useThreadMessagesStore(runtime);
   const useThreadComposer = useThreadComposerStore(runtime.composer);
 
   const context = useMemo<ThreadContextValue>(() => {
@@ -74,12 +60,10 @@ export const ThreadRuntimeProvider: FC<
     return {
       useThread,
       useThreadRuntime,
-      useThreadMessages,
-      useThreadActions: useThreadRuntime,
       useComposer: useThreadComposer,
       useViewport,
     };
-  }, [useThread, useThreadRuntime, useThreadMessages, useThreadComposer]);
+  }, [useThread, useThreadRuntime, useThreadComposer]);
 
   return (
     <ThreadContext.Provider value={context}>{children}</ThreadContext.Provider>

package/src/context/react/AssistantContext.ts

@@ -13,11 +13,6 @@ export type AssistantContextValue = {
   useToolUIs: UseBoundStore<ReadonlyStore<AssistantToolUIsState>>;
   useAssistantRuntime: UseBoundStore<ReadonlyStore<AssistantRuntime>>;
   useThreadList: UseBoundStore<ReadonlyStore<ThreadListState>>;
-
-  /**
-   * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
-   */
-  useAssistantActions: UseBoundStore<ReadonlyStore<AssistantRuntime>>;
 };
 
 export const AssistantContext = createContext<AssistantContextValue | null>(
@@ -43,26 +38,6 @@ export function useAssistantRuntime(options?: {
   return context.useAssistantRuntime();
 }
 
-export const actions = createContextStoreHook(
-  useAssistantContext,
-  "useAssistantActions",
-);
-
-/**
- * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
- */
-export const useAssistantActionsStore = actions.useAssistantActionsStore;
-
-/**
- * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
- */
-export const useAssistantActions = actions.useAssistantActions;
-
-/**
- * @deprecated Use `useAssistantRuntime` instead. This will be removed in 0.6.0.
- */
-export const useAssistantRuntimeStore = useAssistantActionsStore;
-
 export const { useToolUIs, useToolUIsStore } = createContextStoreHook(
   useAssistantContext,
   "useToolUIs",

package/src/context/react/ComposerContext.ts

@@ -23,7 +23,7 @@ export const useComposerContext = (): ComposerContextValue => {
   );
 };
 
-export const { useComposer, useComposerStore } = createContextStoreHook(
+export const { useComposer } = createContextStoreHook(
   useComposerContext,
   "useComposer",
 );

package/src/context/react/ContentPartContext.ts

@@ -36,7 +36,7 @@ export function useContentPartRuntime(options?: {
   return context.useContentPartRuntime();
 }
 
-export const { useContentPart, useContentPartStore } = createContextStoreHook(
+export const { useContentPart } = createContextStoreHook(
   useContentPartContext,
   "useContentPart",
 );

package/src/context/react/MessageContext.ts

@@ -38,7 +38,7 @@ export function useMessageRuntime(options?: {
   return context.useMessageRuntime();
 }
 
-export const { useMessage, useMessageStore } = createContextStoreHook(
+export const { useMessage } = createContextStoreHook(
   useMessageContext,
   "useMessage",
 );
@@ -48,7 +48,7 @@ export const { useMessageUtils, useMessageUtilsStore } = createContextStoreHook(
   "useMessageUtils",
 );
 
-export const { useEditComposer, useEditComposerStore } = createContextStoreHook(
+export const { useEditComposer } = createContextStoreHook(
   useMessageContext,
   "useEditComposer",
 );

package/src/context/react/ThreadContext.ts

@@ -8,17 +8,12 @@ import { createContextHook } from "./utils/createContextHook";
 import { createContextStoreHook } from "./utils/createContextStoreHook";
 import { ThreadRuntime } from "../../api/ThreadRuntime";
 import { ThreadState } from "../../api/ThreadRuntime";
-import { ModelConfig, ThreadMessage } from "../../types";
+import { ModelConfig } from "../../types";
 import { ThreadComposerState } from "../../api/ComposerRuntime";
 
 export type ThreadContextValue = {
   useThread: UseBoundStore<ReadonlyStore<ThreadState>>;
-  /**
-   * @deprecated Use `useThreadRuntime` instead. This will be removed in 0.6.0.
-   */
-  useThreadActions: UseBoundStore<ReadonlyStore<ThreadRuntime>>;
   useThreadRuntime: UseBoundStore<ReadonlyStore<ThreadRuntime>>;
-  useThreadMessages: UseBoundStore<ReadonlyStore<readonly ThreadMessage[]>>;
   useComposer: UseBoundStore<ReadonlyStore<ThreadComposerState>>;
   useViewport: UseBoundStore<ReadonlyStore<ThreadViewportState>>;
 };
@@ -42,48 +37,16 @@ export function useThreadRuntime(options?: { optional?: boolean | undefined }) {
   return context.useThreadRuntime();
 }
 
-export const actions = createContextStoreHook(
+export const { useThread } = createContextStoreHook(
   useThreadContext,
-  "useThreadActions",
+  "useThread",
 );
 
-/**
- * @deprecated Use `useThreadRuntime` instead. This will be removed in 0.6.0.
- */
-export const useThreadActionsStore = actions.useThreadActionsStore;
-
-/**
- * @deprecated Use `useThreadRuntime` instead. This will be removed in 0.6.0.
- */
-export const useThreadActions = actions.useThreadActions;
-
-/**
- * @deprecated Use `useThreadRuntime` instead. This will be removed in 0.6.0.
- */
-export const useThreadRuntimeStore = useThreadActionsStore;
-
-export const { useThread, useThreadStore } = createContextStoreHook(
+export const { useComposer: useThreadComposer } = createContextStoreHook(
   useThreadContext,
-  "useThread",
+  "useComposer",
 );
 
-const messages = createContextStoreHook(useThreadContext, "useThreadMessages");
-
-/**
- * @deprecated Use `useThread().messages` instead. This will be removed in 0.6.0.
- */
-export const useThreadMessages = messages.useThreadMessages;
-
-/**
- * @deprecated Use `useThreadRuntime().getState().messages` instead. This will be removed in 0.6.0.
- */
-export const useThreadMessagesStore = messages.useThreadMessagesStore;
-
-export const {
-  useComposer: useThreadComposer,
-  useComposerStore: useThreadComposerStore,
-} = createContextStoreHook(useThreadContext, "useComposer");
-
 export const {
   useViewport: useThreadViewport,
   useViewportStore: useThreadViewportStore,