@assistant-ui/react 0.11.0 → 0.11.2

package/src/api/ThreadRuntime.ts

@@ -1,519 +0,0 @@
-import {
-  ThreadSuggestion,
-  RuntimeCapabilities,
-  ThreadRuntimeCore,
-  SpeechState,
-  ThreadRuntimeEventType,
-  StartRunConfig,
-  ResumeRunConfig,
-} from "../runtimes/core/ThreadRuntimeCore";
-import { ExportedMessageRepository } from "../runtimes/utils/MessageRepository";
-import { AppendMessage, ThreadMessage, Unsubscribe } from "../types";
-import { ThreadMessageLike } from "../runtimes/external-store";
-import {
-  MessageRuntime,
-  MessageRuntimeImpl,
-  MessageState,
-} from "./MessageRuntime";
-import { NestedSubscriptionSubject } from "./subscribable/NestedSubscriptionSubject";
-import { ShallowMemoizeSubject } from "./subscribable/ShallowMemoizeSubject";
-import { SubscribableWithState } from "./subscribable/Subscribable";
-import {
-  ThreadComposerRuntime,
-  ThreadComposerRuntimeImpl,
-} from "./ComposerRuntime";
-import { SKIP_UPDATE } from "./subscribable/SKIP_UPDATE";
-import {
-  MessageRuntimePath,
-  ThreadListItemRuntimePath,
-  ThreadRuntimePath,
-} from "./RuntimePathTypes";
-import type { ThreadListItemState } from "./RuntimeBindings";
-import { RunConfig } from "../types/AssistantTypes";
-import { EventSubscriptionSubject } from "./subscribable/EventSubscriptionSubject";
-import { symbolInnerMessage } from "../runtimes/external-store/getExternalStoreMessage";
-import { ModelContext } from "../model-context";
-import { ChatModelRunOptions, ChatModelRunResult } from "../runtimes";
-import { ReadonlyJSONValue } from "assistant-stream/utils";
-
-export type CreateStartRunConfig = {
-  parentId: string | null;
-  sourceId?: string | null | undefined;
-  runConfig?: RunConfig | undefined;
-};
-
-export type CreateResumeRunConfig = CreateStartRunConfig & {
-  stream: (
-    options: ChatModelRunOptions,
-  ) => AsyncGenerator<ChatModelRunResult, void, unknown>;
-};
-
-const toResumeRunConfig = (message: CreateResumeRunConfig): ResumeRunConfig => {
-  return {
-    parentId: message.parentId ?? null,
-    sourceId: message.sourceId ?? null,
-    runConfig: message.runConfig ?? {},
-    stream: message.stream,
-  };
-};
-
-const toStartRunConfig = (message: CreateStartRunConfig): StartRunConfig => {
-  return {
-    parentId: message.parentId ?? null,
-    sourceId: message.sourceId ?? null,
-    runConfig: message.runConfig ?? {},
-  };
-};
-
-export type CreateAppendMessage =
-  | string
-  | {
-      parentId?: string | null | undefined;
-      sourceId?: string | null | undefined;
-      role?: AppendMessage["role"] | undefined;
-      content: AppendMessage["content"];
-      attachments?: AppendMessage["attachments"] | undefined;
-      metadata?: AppendMessage["metadata"] | undefined;
-      createdAt?: Date | undefined;
-      runConfig?: AppendMessage["runConfig"] | undefined;
-      startRun?: boolean | undefined;
-    };
-
-const toAppendMessage = (
-  messages: readonly ThreadMessage[],
-  message: CreateAppendMessage,
-): AppendMessage => {
-  if (typeof message === "string") {
-    return {
-      createdAt: new Date(),
-      parentId: messages.at(-1)?.id ?? null,
-      sourceId: null,
-      runConfig: {},
-      role: "user",
-      content: [{ type: "text", text: message }],
-      attachments: [],
-      metadata: { custom: {} },
-    };
-  }
-
-  return {
-    createdAt: message.createdAt ?? new Date(),
-    parentId: message.parentId ?? messages.at(-1)?.id ?? null,
-    sourceId: message.sourceId ?? null,
-    role: message.role ?? "user",
-    content: message.content,
-    attachments: message.attachments ?? [],
-    metadata: message.metadata ?? { custom: {} },
-    runConfig: message.runConfig ?? {},
-    startRun: message.startRun,
-  } as AppendMessage;
-};
-
-export type ThreadRuntimeCoreBinding = SubscribableWithState<
-  ThreadRuntimeCore,
-  ThreadRuntimePath
-> & {
-  outerSubscribe(callback: () => void): Unsubscribe;
-};
-
-export type ThreadListItemRuntimeBinding = SubscribableWithState<
-  ThreadListItemState,
-  ThreadListItemRuntimePath
->;
-
-export type ThreadState = {
-  /**
-   * The thread ID.
-   * @deprecated This field is deprecated and will be removed in 0.8.0. Use `useThreadListItem().id` instead.
-   */
-  readonly threadId: string;
-
-  /**
-   * The thread metadata.
-   *
-   * @deprecated Use `useThreadListItem()` instead. This field is deprecated and will be removed in 0.8.0.
-   */
-  readonly metadata: ThreadListItemState;
-
-  /**
-   * Whether the thread is disabled. Disabled threads cannot receive new messages.
-   */
-  readonly isDisabled: boolean;
-
-  /**
-   * Whether the thread is loading its history.
-   */
-  readonly isLoading: boolean;
-
-  /**
-   * Whether the thread is running. A thread is considered running when there is an active stream connection to the backend.
-   */
-  readonly isRunning: boolean;
-
-  /**
-   * The capabilities of the thread, such as whether the thread supports editing, branch switching, etc.
-   */
-  readonly capabilities: RuntimeCapabilities;
-
-  /**
-   * The messages in the currently selected branch of the thread.
-   */
-  readonly messages: readonly ThreadMessage[];
-
-  /**
-   * The thread state.
-   *
-   * @deprecated This feature is experimental
-   */
-  readonly state: ReadonlyJSONValue;
-
-  /**
-   * Follow up message suggestions to show the user.
-   */
-  readonly suggestions: readonly ThreadSuggestion[];
-
-  /**
-   * Custom extra information provided by the runtime.
-   */
-  readonly extras: unknown;
-
-  /**
-   * @deprecated This API is still under active development and might change without notice.
-   */
-  readonly speech: SpeechState | undefined;
-};
-
-export const getThreadState = (
-  runtime: ThreadRuntimeCore,
-  threadListItemState: ThreadListItemState,
-): ThreadState => {
-  const lastMessage = runtime.messages.at(-1);
-  return Object.freeze({
-    threadId: threadListItemState.id,
-    metadata: threadListItemState,
-    capabilities: runtime.capabilities,
-    isDisabled: runtime.isDisabled,
-    isLoading: runtime.isLoading,
-    isRunning:
-      lastMessage?.role !== "assistant"
-        ? false
-        : lastMessage.status.type === "running",
-    messages: runtime.messages,
-    state: runtime.state,
-    suggestions: runtime.suggestions,
-    extras: runtime.extras,
-    speech: runtime.speech,
-  });
-};
-
-export type ThreadRuntime = {
-  /**
-   * The selector for the thread runtime.
-   */
-  readonly path: ThreadRuntimePath;
-
-  /**
-   * The thread composer runtime.
-   */
-  readonly composer: ThreadComposerRuntime;
-
-  /**
-   * Gets a snapshot of the thread state.
-   */
-  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;
-
-  /**
-   * @deprecated pass an object with `parentId` instead. This will be removed in 0.8.0.
-   */
-  startRun(parentId: string | null): void;
-  /**
-   * Start a new run with the given configuration.
-   * @param config The configuration for starting the run
-   */
-  startRun(config: CreateStartRunConfig): void;
-
-  /**
-   * Resume a run with the given configuration.
-   * @param config The configuration for resuming the run
-   **/
-  unstable_resumeRun(config: CreateResumeRunConfig): void;
-
-  subscribe(callback: () => void): Unsubscribe;
-  cancelRun(): void;
-  getModelContext(): ModelContext;
-
-  /**
-   * @deprecated This method was renamed to `getModelContext`.
-   */
-  getModelConfig(): ModelContext;
-
-  export(): ExportedMessageRepository;
-  import(repository: ExportedMessageRepository): void;
-
-  /**
-   * Reset the thread with optional initial messages.
-   *
-   * @param initialMessages - Optional array of initial messages to populate the thread
-   */
-  reset(initialMessages?: readonly ThreadMessageLike[]): void;
-
-  getMessageByIndex(idx: number): MessageRuntime;
-  getMessageById(messageId: string): MessageRuntime;
-
-  /**
-   * @deprecated This API is still under active development and might change without notice.
-   */
-  stopSpeaking(): void;
-
-  unstable_on(event: ThreadRuntimeEventType, callback: () => void): Unsubscribe;
-};
-
-export class ThreadRuntimeImpl implements ThreadRuntime {
-  public get path() {
-    return this._threadBinding.path;
-  }
-
-  public get __internal_threadBinding() {
-    return this._threadBinding;
-  }
-
-  private readonly _threadBinding: ThreadRuntimeCoreBinding & {
-    getStateState(): ThreadState;
-  };
-
-  constructor(
-    threadBinding: ThreadRuntimeCoreBinding,
-    threadListItemBinding: ThreadListItemRuntimeBinding,
-  ) {
-    const stateBinding = new ShallowMemoizeSubject({
-      path: threadBinding.path,
-      getState: () =>
-        getThreadState(
-          threadBinding.getState(),
-          threadListItemBinding.getState(),
-        ),
-      subscribe: (callback) => {
-        const sub1 = threadBinding.subscribe(callback);
-        const sub2 = threadListItemBinding.subscribe(callback);
-        return () => {
-          sub1();
-          sub2();
-        };
-      },
-    });
-
-    this._threadBinding = {
-      path: threadBinding.path,
-      getState: () => threadBinding.getState(),
-      getStateState: () => stateBinding.getState(),
-      outerSubscribe: (callback) => threadBinding.outerSubscribe(callback),
-      subscribe: (callback) => threadBinding.subscribe(callback),
-    };
-
-    this.composer = new ThreadComposerRuntimeImpl(
-      new NestedSubscriptionSubject({
-        path: {
-          ...this.path,
-          ref: this.path.ref + `${this.path.ref}.composer`,
-          composerSource: "thread",
-        },
-        getState: () => this._threadBinding.getState().composer,
-        subscribe: (callback) => this._threadBinding.subscribe(callback),
-      }),
-    );
-
-    this.__internal_bindMethods();
-  }
-
-  protected __internal_bindMethods() {
-    this.append = this.append.bind(this);
-    this.unstable_resumeRun = this.unstable_resumeRun.bind(this);
-    this.startRun = this.startRun.bind(this);
-    this.cancelRun = this.cancelRun.bind(this);
-    this.stopSpeaking = this.stopSpeaking.bind(this);
-    this.export = this.export.bind(this);
-    this.import = this.import.bind(this);
-    this.reset = this.reset.bind(this);
-    this.getMessageByIndex = this.getMessageByIndex.bind(this);
-    this.getMessageById = this.getMessageById.bind(this);
-    this.subscribe = this.subscribe.bind(this);
-    this.unstable_on = this.unstable_on.bind(this);
-    this.getModelContext = this.getModelContext.bind(this);
-    this.getModelConfig = this.getModelConfig.bind(this);
-    this.getState = this.getState.bind(this);
-  }
-
-  public readonly composer;
-
-  public getState() {
-    return this._threadBinding.getStateState();
-  }
-
-  public append(message: CreateAppendMessage) {
-    this._threadBinding
-      .getState()
-      .append(
-        toAppendMessage(this._threadBinding.getState().messages, message),
-      );
-  }
-
-  public subscribe(callback: () => void) {
-    return this._threadBinding.subscribe(callback);
-  }
-
-  public getModelContext() {
-    return this._threadBinding.getState().getModelContext();
-  }
-
-  public getModelConfig() {
-    return this.getModelContext();
-  }
-
-  public startRun(configOrParentId: string | null | CreateStartRunConfig) {
-    const config =
-      configOrParentId === null || typeof configOrParentId === "string"
-        ? { parentId: configOrParentId }
-        : configOrParentId;
-    return this._threadBinding.getState().startRun(toStartRunConfig(config));
-  }
-
-  public unstable_resumeRun(config: CreateResumeRunConfig) {
-    return this._threadBinding.getState().resumeRun(toResumeRunConfig(config));
-  }
-
-  public cancelRun() {
-    this._threadBinding.getState().cancelRun();
-  }
-
-  public stopSpeaking() {
-    return this._threadBinding.getState().stopSpeaking();
-  }
-
-  public export() {
-    return this._threadBinding.getState().export();
-  }
-
-  public import(data: ExportedMessageRepository) {
-    this._threadBinding.getState().import(data);
-  }
-
-  public reset(initialMessages?: readonly ThreadMessageLike[]) {
-    this._threadBinding.getState().reset(initialMessages);
-  }
-
-  public getMessageByIndex(idx: number) {
-    if (idx < 0) throw new Error("Message index must be >= 0");
-
-    return this._getMessageRuntime(
-      {
-        ...this.path,
-        ref: this.path.ref + `${this.path.ref}.messages[${idx}]`,
-        messageSelector: { type: "index", index: idx },
-      },
-      () => {
-        const messages = this._threadBinding.getState().messages;
-        const message = messages[idx];
-        if (!message) return undefined;
-        return {
-          message,
-          parentId: messages[idx - 1]?.id ?? null,
-        };
-      },
-    );
-  }
-
-  public getMessageById(messageId: string) {
-    return this._getMessageRuntime(
-      {
-        ...this.path,
-        ref:
-          this.path.ref +
-          `${this.path.ref}.messages[messageId=${JSON.stringify(messageId)}]`,
-        messageSelector: { type: "messageId", messageId: messageId },
-      },
-      () => this._threadBinding.getState().getMessageById(messageId),
-    );
-  }
-
-  private _getMessageRuntime(
-    path: MessageRuntimePath,
-    callback: () =>
-      | { parentId: string | null; message: ThreadMessage }
-      | undefined,
-  ) {
-    return new MessageRuntimeImpl(
-      new ShallowMemoizeSubject({
-        path,
-        getState: () => {
-          const { message, parentId } = callback() ?? {};
-
-          const { messages, speech: speechState } =
-            this._threadBinding.getState();
-
-          if (!message || parentId === undefined) return SKIP_UPDATE;
-
-          const thread = this._threadBinding.getState();
-
-          const branches = thread.getBranches(message.id);
-          const submittedFeedback = thread.getSubmittedFeedback(message.id);
-
-          return {
-            ...message,
-            ...{ [symbolInnerMessage]: (message as any)[symbolInnerMessage] },
-
-            isLast: messages.at(-1)?.id === message.id,
-            parentId,
-
-            branchNumber: branches.indexOf(message.id) + 1,
-            branchCount: branches.length,
-
-            speech:
-              speechState?.messageId === message.id ? speechState : undefined,
-
-            submittedFeedback,
-          } satisfies MessageState;
-        },
-        subscribe: (callback) => this._threadBinding.subscribe(callback),
-      }),
-      this._threadBinding,
-    );
-  }
-
-  private _eventSubscriptionSubjects = new Map<
-    string,
-    EventSubscriptionSubject<ThreadRuntimeEventType>
-  >();
-
-  public unstable_on(
-    event: ThreadRuntimeEventType,
-    callback: () => void,
-  ): Unsubscribe {
-    let subject = this._eventSubscriptionSubjects.get(event);
-    if (!subject) {
-      subject = new EventSubscriptionSubject({
-        event: event,
-        binding: this._threadBinding,
-      });
-      this._eventSubscriptionSubjects.set(event, subject);
-    }
-    return subject.subscribe(callback);
-  }
-}

package/src/api/index.ts

@@ -1,34 +0,0 @@
-export type { AssistantRuntime } from "./AssistantRuntime";
-export type {
-  ThreadRuntime,
-  ThreadState,
-  CreateAppendMessage,
-  CreateStartRunConfig,
-} from "./ThreadRuntime";
-export type { MessageRuntime, MessageState } from "./MessageRuntime";
-
-export type {
-  MessagePartRuntime,
-  MessagePartState,
-} from "./MessagePartRuntime";
-
-// TODO remove in v0.11
-export type {
-  MessagePartRuntime as MessageContentRuntime,
-  MessagePartState as MessageContentState,
-} from "./MessagePartRuntime";
-
-export type {
-  ComposerRuntime,
-  ThreadComposerRuntime,
-  EditComposerRuntime,
-  EditComposerState,
-  ThreadComposerState,
-  ComposerState,
-} from "./ComposerRuntime";
-export type { AttachmentRuntime, AttachmentState } from "./AttachmentRuntime";
-export type { ThreadListRuntime, ThreadListState } from "./ThreadListRuntime";
-export type {
-  ThreadListItemRuntime,
-  ThreadListItemState,
-} from "./ThreadListItemRuntime";

package/src/api/subscribable/BaseSubject.ts

@@ -1,36 +0,0 @@
-import { Unsubscribe } from "../../types/Unsubscribe";
-
-export abstract class BaseSubject {
-  private _subscriptions = new Set<() => void>();
-  private _connection: Unsubscribe | undefined;
-
-  protected get isConnected() {
-    return !!this._connection;
-  }
-
-  protected abstract _connect(): Unsubscribe;
-
-  protected notifySubscribers() {
-    for (const callback of this._subscriptions) callback();
-  }
-
-  private _updateConnection() {
-    if (this._subscriptions.size > 0) {
-      if (this._connection) return;
-      this._connection = this._connect();
-    } else {
-      this._connection?.();
-      this._connection = undefined;
-    }
-  }
-
-  public subscribe(callback: () => void) {
-    this._subscriptions.add(callback);
-    this._updateConnection();
-
-    return () => {
-      this._subscriptions.delete(callback);
-      this._updateConnection();
-    };
-  }
-}

package/src/api/subscribable/EventSubscriptionSubject.ts

@@ -1,44 +0,0 @@
-import { Unsubscribe } from "../../types";
-import { BaseSubject } from "./BaseSubject";
-import { EventSubscribable } from "./Subscribable";
-
-export class EventSubscriptionSubject<
-  TEvent extends string,
-> extends BaseSubject {
-  constructor(private config: EventSubscribable<TEvent>) {
-    super();
-  }
-
-  public getState() {
-    return this.config.binding.getState();
-  }
-
-  public outerSubscribe(callback: () => void) {
-    return this.config.binding.subscribe(callback);
-  }
-
-  protected _connect(): Unsubscribe {
-    const callback = () => {
-      this.notifySubscribers();
-    };
-
-    let lastState = this.config.binding.getState();
-    let innerUnsubscribe = lastState?.unstable_on(this.config.event, callback);
-    const onRuntimeUpdate = () => {
-      const newState = this.config.binding.getState();
-      if (newState === lastState) return;
-      lastState = newState;
-
-      innerUnsubscribe?.();
-      innerUnsubscribe = this.config.binding
-        .getState()
-        ?.unstable_on(this.config.event, callback);
-    };
-
-    const outerUnsubscribe = this.outerSubscribe(onRuntimeUpdate);
-    return () => {
-      outerUnsubscribe?.();
-      innerUnsubscribe?.();
-    };
-  }
-}

package/src/api/subscribable/NestedSubscriptionSubject.ts

@@ -1,58 +0,0 @@
-import { Unsubscribe } from "../../types";
-import { BaseSubject } from "./BaseSubject";
-import {
-  NestedSubscribable,
-  Subscribable,
-  SubscribableWithState,
-} from "./Subscribable";
-
-export class NestedSubscriptionSubject<
-    TState extends Subscribable | undefined,
-    TPath,
-  >
-  extends BaseSubject
-  implements
-    SubscribableWithState<TState, TPath>,
-    NestedSubscribable<TState, TPath>
-{
-  public get path() {
-    return this.binding.path;
-  }
-
-  constructor(private binding: NestedSubscribable<TState, TPath>) {
-    super();
-  }
-
-  public getState() {
-    return this.binding.getState();
-  }
-
-  public outerSubscribe(callback: () => void) {
-    return this.binding.subscribe(callback);
-  }
-
-  protected _connect(): Unsubscribe {
-    const callback = () => {
-      this.notifySubscribers();
-    };
-
-    let lastState = this.binding.getState();
-    let innerUnsubscribe = lastState?.subscribe(callback);
-    const onRuntimeUpdate = () => {
-      const newState = this.binding.getState();
-      if (newState === lastState) return;
-      lastState = newState;
-
-      innerUnsubscribe?.();
-      innerUnsubscribe = this.binding.getState()?.subscribe(callback);
-
-      callback();
-    };
-
-    const outerUnsubscribe = this.outerSubscribe(onRuntimeUpdate);
-    return () => {
-      outerUnsubscribe?.();
-      innerUnsubscribe?.();
-    };
-  }
-}