@assistant-ui/react 0.5.92 → 0.5.94

package/src/api/AttachmentRuntime.ts

@@ -0,0 +1,123 @@
+import { SubscribableWithState } from "./subscribable/Subscribable";
+
+import { ComposerRuntimeCoreBinding } from "./ComposerRuntime";
+import {
+  Attachment,
+  CompleteAttachment,
+  PendingAttachment,
+  Unsubscribe,
+} from "../types";
+import { AttachmentRuntimePath } from "./RuntimePathTypes";
+
+type MessageAttachmentState = CompleteAttachment & {
+  source: "message";
+  /**
+   * @deprecated You can directly access content part fields in the state. Replace `.attachment.type` with `.type` etc. This will be removed in 0.6.0.
+   */
+  attachment: CompleteAttachment;
+};
+
+type ThreadComposerAttachmentState = PendingAttachment & {
+  source: "thread-composer";
+  /**
+   * @deprecated You can directly access content part fields in the state. Replace `.attachment.type` with `.type` etc. This will be removed in 0.6.0.
+   */
+  attachment: PendingAttachment;
+};
+
+type EditComposerAttachmentState = Attachment & {
+  source: "edit-composer";
+  /**
+   * @deprecated You can directly access content part fields in the state. Replace `.attachment.type` with `.type` etc. This will be removed in 0.6.0.
+   */
+  attachment: Attachment;
+};
+
+export type AttachmentState =
+  | ThreadComposerAttachmentState
+  | EditComposerAttachmentState
+  | MessageAttachmentState;
+
+type AttachmentSnapshotBinding<Source extends AttachmentRuntimeSource> =
+  SubscribableWithState<
+    AttachmentState & { source: Source },
+    AttachmentRuntimePath & { attachmentSource: Source }
+  >;
+
+type AttachmentRuntimeSource = AttachmentState["source"];
+
+export type AttachmentRuntime<
+  TSource extends AttachmentRuntimeSource = AttachmentRuntimeSource,
+> = {
+  path: AttachmentRuntimePath & { attachmentSource: TSource };
+  readonly source: TSource;
+  getState(): AttachmentState & { source: TSource };
+  remove(): Promise<void>;
+  subscribe(callback: () => void): Unsubscribe;
+};
+
+export abstract class AttachmentRuntimeImpl<
+  Source extends AttachmentRuntimeSource = AttachmentRuntimeSource,
+> implements AttachmentRuntime
+{
+  public get path() {
+    return this._core.path;
+  }
+
+  public abstract get source(): Source;
+
+  constructor(private _core: AttachmentSnapshotBinding<Source>) {}
+
+  public getState(): AttachmentState & { source: Source } {
+    return this._core.getState();
+  }
+
+  public abstract remove(): Promise<void>;
+
+  public subscribe(callback: () => void) {
+    return this._core.subscribe(callback);
+  }
+}
+
+abstract class ComposerAttachmentRuntime<
+  Source extends "thread-composer" | "edit-composer",
+> extends AttachmentRuntimeImpl<Source> {
+  constructor(
+    core: AttachmentSnapshotBinding<Source>,
+    private _composerApi: ComposerRuntimeCoreBinding,
+  ) {
+    super(core);
+  }
+
+  public remove() {
+    const core = this._composerApi.getState();
+    if (!core) throw new Error("Composer is not available");
+    return core.removeAttachment(this.getState().id);
+  }
+}
+
+export class ThreadComposerAttachmentRuntimeImpl extends ComposerAttachmentRuntime<"thread-composer"> {
+  public get source(): "thread-composer" {
+    return "thread-composer";
+  }
+}
+
+export class EditComposerAttachmentRuntimeImpl extends ComposerAttachmentRuntime<"edit-composer"> {
+  public get source(): "edit-composer" {
+    return "edit-composer";
+  }
+}
+
+export class MessageAttachmentRuntimeImpl extends AttachmentRuntimeImpl<"message"> {
+  public get source(): "message" {
+    return "message";
+  }
+
+  constructor(core: AttachmentSnapshotBinding<"message">) {
+    super(core);
+  }
+
+  public remove(): never {
+    throw new Error("Message attachments cannot be removed");
+  }
+}

package/src/api/ComposerRuntime.ts

@@ -0,0 +1,505 @@
+import { Attachment, PendingAttachment } from "../types/AttachmentTypes";
+import {
+  ComposerRuntimeCore,
+  ThreadComposerRuntimeCore,
+} from "../runtimes/core/ComposerRuntimeCore";
+import { Unsubscribe } from "../types";
+import { SubscribableWithState } from "./subscribable/Subscribable";
+import { LazyMemoizeSubject } from "./subscribable/LazyMemoizeSubject";
+import {
+  AttachmentRuntime,
+  AttachmentState,
+  EditComposerAttachmentRuntimeImpl,
+  ThreadComposerAttachmentRuntimeImpl,
+} from "./AttachmentRuntime";
+import { ShallowMemoizeSubject } from "./subscribable/ShallowMemoizeSubject";
+import { SKIP_UPDATE } from "./subscribable/SKIP_UPDATE";
+import { ComposerRuntimePath } from "./RuntimePathTypes";
+
+export type ThreadComposerRuntimeCoreBinding = SubscribableWithState<
+  ThreadComposerRuntimeCore | undefined,
+  ComposerRuntimePath & { composerSource: "thread" }
+>;
+
+export type EditComposerRuntimeCoreBinding = SubscribableWithState<
+  ComposerRuntimeCore | undefined,
+  ComposerRuntimePath & { composerSource: "edit" }
+>;
+
+export type ComposerRuntimeCoreBinding = SubscribableWithState<
+  ComposerRuntimeCore | undefined,
+  ComposerRuntimePath
+>;
+
+type LegacyEditComposerState = Readonly<{
+  type: "edit";
+
+  /** @deprecated Use `text` instead. This will be removed in 0.6.0. */
+  value: string;
+  /** @deprecated Use `useComposerRuntime().setText()` instead. This will be removed in 0.6.0. */
+  setValue: (value: string) => void;
+
+  text: string;
+  /**
+   * @deprecated Use `useComposerRuntime().setText()` instead. This will be removed in 0.6.0.
+   */
+  setText: (value: string) => void;
+
+  canCancel: boolean;
+  isEditing: boolean;
+  isEmpty: boolean;
+
+  /**
+   * @deprecated Use useComposerRuntime().beginEdit() instead. This will be removed in 0.6.0.
+   */
+  edit: () => void;
+  /**
+   * @deprecated Use `useComposerRuntime().send()` instead. This will be removed in 0.6.0.
+   */
+  send: () => void;
+  /**
+   * @deprecated Use `useComposerRuntime().cancel()` instead. This will be removed in 0.6.0.
+   */
+  cancel: () => void;
+}>;
+
+type LegacyThreadComposerState = Readonly<{
+  type: "thread";
+
+  /** @deprecated Use `text` instead. This will be removed in 0.6.0. */
+  value: string;
+  /** @deprecated Use `useComposerRuntime().setText` instead. This will be removed in 0.6.0. */
+  setValue: (value: string) => void;
+
+  attachments: readonly Attachment[];
+
+  /** @deprecated Use `useComposerRuntime().addAttachment` instead. This will be removed in 0.6.0. */
+  addAttachment: (file: File) => Promise<void>;
+  /** @deprecated Use `useComposerRuntime().removeAttachment` instead. This will be removed in 0.6.0. */
+  removeAttachment: (attachmentId: string) => Promise<void>;
+
+  text: string;
+  /** @deprecated Use `useComposerRuntime().setText` instead. This will be removed in 0.6.0. */
+  setText: (value: string) => void;
+
+  /** @deprecated Use `useComposerRuntime().reset` instead. This will be removed in 0.6.0. */
+  reset: () => void;
+
+  canCancel: boolean;
+  isEditing: boolean;
+  isEmpty: boolean;
+
+  /**
+   * @deprecated Use `useComposerRuntime().send` instead. This will be removed in 0.6.0.
+   **/
+  send: () => void;
+  /** @deprecated Use `useComposerRuntime().cancel` instead. This will be removed in 0.6.0. */
+  cancel: () => void;
+}>;
+
+type BaseComposerState = {
+  text: string;
+  attachments: readonly Attachment[];
+
+  canCancel: boolean;
+  isEditing: boolean;
+  isEmpty: boolean;
+};
+
+export type ThreadComposerState = LegacyThreadComposerState &
+  BaseComposerState & {
+    type: "thread";
+
+    attachments: readonly PendingAttachment[];
+  };
+
+export type EditComposerState = LegacyEditComposerState &
+  BaseComposerState & {
+    type: "edit";
+  };
+
+export type ComposerState = ThreadComposerState | EditComposerState;
+
+const METHOD_NOT_SUPPORTED = () => {
+  throw new Error("Composer is not available");
+};
+const EMPTY_ARRAY = Object.freeze([]);
+const getThreadComposerState = (
+  runtime: ThreadComposerRuntimeCore | undefined,
+): ThreadComposerState => {
+  return Object.freeze({
+    type: "thread",
+
+    isEditing: runtime?.isEditing ?? false,
+    canCancel: runtime?.canCancel ?? false,
+    isEmpty: runtime?.isEmpty ?? true,
+    text: runtime?.text ?? "",
+    attachments: runtime?.attachments ?? EMPTY_ARRAY,
+
+    value: runtime?.text ?? "",
+    setValue: runtime?.setText.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    setText: runtime?.setText.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    // edit: beginEdit,
+    send: runtime?.send.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    cancel: runtime?.cancel.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    reset: runtime?.reset.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+
+    addAttachment: runtime?.addAttachment.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    removeAttachment:
+      runtime?.removeAttachment.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+  });
+};
+
+const getEditComposerState = (
+  runtime: ComposerRuntimeCore | undefined,
+  beginEdit: () => void,
+): EditComposerState => {
+  return Object.freeze({
+    type: "edit",
+
+    isEditing: runtime?.isEditing ?? false,
+    canCancel: runtime?.canCancel ?? false,
+    isEmpty: runtime?.isEmpty ?? true,
+    text: runtime?.text ?? "",
+    attachments: runtime?.attachments ?? EMPTY_ARRAY,
+
+    value: runtime?.text ?? "",
+    setValue: runtime?.setText.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    setText: runtime?.setText.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    edit: beginEdit,
+    send: runtime?.send.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+    cancel: runtime?.cancel.bind(runtime) ?? METHOD_NOT_SUPPORTED,
+  });
+};
+
+export type ComposerRuntime = {
+  path: ComposerRuntimePath;
+  readonly type: "edit" | "thread";
+  getState(): ComposerState;
+
+  /** @deprecated Use `getState().isEditing` instead. This will be removed in 0.6.0. */
+  readonly isEditing: boolean;
+
+  /** @deprecated Use `getState().isEmpty` instead. This will be removed in 0.6.0. */
+  readonly isEmpty: boolean;
+
+  /** @deprecated Use `getState().canCancel` instead. This will be removed in 0.6.0. */
+  readonly canCancel: boolean;
+
+  /** @deprecated Use `getState().text` instead. This will be removed in 0.6.0. */
+  readonly text: string;
+
+  /** @deprecated Use `getState().attachments` instead. This will be removed in 0.6.0. */
+  readonly attachments: readonly Attachment[];
+
+  /** @deprecated Use `getState().text` instead. This will be removed in 0.6.0. */
+  readonly value: string;
+
+  setText(text: string): void;
+  setValue(text: string): void;
+
+  getAttachmentAccept(): string;
+  addAttachment(file: File): Promise<void>;
+
+  /** @deprecated Use `getAttachmentById(id).removeAttachment()` instead. This will be removed in 0.6.0. */
+  removeAttachment(attachmentId: string): Promise<void>;
+
+  /** @deprecated This method will be removed in 0.6.0. Submit feedback if you need this functionality. */
+  reset(): void;
+
+  send(): void;
+  cancel(): void;
+  subscribe(callback: () => void): Unsubscribe;
+  getAttachmentByIndex(idx: number): AttachmentRuntime;
+};
+
+export abstract class ComposerRuntimeImpl
+  implements ComposerRuntimeCore, ComposerRuntime
+{
+  public get path() {
+    return this._core.path;
+  }
+
+  public abstract get type(): "edit" | "thread";
+
+  constructor(protected _core: ComposerRuntimeCoreBinding) {}
+
+  /**
+   * @deprecated Use `getState().isEditing` instead. This will be removed in 0.6.0.
+   */
+  public get isEditing() {
+    return this.getState().isEditing;
+  }
+
+  /**
+   * @deprecated Use `getState().isEmpty` instead. This will be removed in 0.6.0.
+   */
+  public get isEmpty() {
+    return this.getState().isEmpty;
+  }
+
+  /**
+   * @deprecated Use `getState().canCancel` instead. This will be removed in 0.6.0.
+   */
+  public get canCancel() {
+    return this.getState().canCancel;
+  }
+
+  /**
+   * @deprecated Use `getState().text` instead. This will be removed in 0.6.0.
+   */
+  public get text() {
+    return this.getState().text;
+  }
+
+  /**
+   * @deprecated Use `getState().attachments` instead. This will be removed in 0.6.0.
+   */
+  public get attachments() {
+    return this.getState().attachments;
+  }
+
+  /**
+   * @deprecated Use `getState().text` instead. This will be removed in 0.6.0.
+   */
+  public get value() {
+    return this.text;
+  }
+
+  public abstract getState(): ComposerState;
+
+  public setText(text: string) {
+    const core = this._core.getState();
+    if (!core) throw new Error("Composer is not available");
+    core.setText(text);
+  }
+
+  public setValue(text: string) {
+    this.setText(text);
+  }
+
+  public addAttachment(file: File) {
+    const core = this._core.getState();
+    if (!core) throw new Error("Composer is not available");
+    return core.addAttachment(file);
+  }
+
+  /**
+   * @deprecated Use `getAttachmentById(id).removeAttachment()` instead. This will be removed in 0.6.0.
+   */
+  public removeAttachment(attachmentId: string) {
+    const core = this._core.getState();
+    if (!core) throw new Error("Composer is not available");
+    return core.removeAttachment(attachmentId);
+  }
+
+  /**
+   * @deprecated This method will be removed in 0.6.0. Submit feedback if you need this functionality.
+   */
+  public reset() {
+    const core = this._core.getState();
+    if (!core) throw new Error("Composer is not available");
+    core.reset();
+  }
+
+  public send() {
+    const core = this._core.getState();
+    if (!core) throw new Error("Composer is not available");
+    core.send();
+  }
+
+  public cancel() {
+    const core = this._core.getState();
+    if (!core) throw new Error("Composer is not available");
+    core.cancel();
+  }
+
+  public subscribe(callback: () => void) {
+    return this._core.subscribe(callback);
+  }
+
+  public getAttachmentAccept(): string {
+    const core = this._core.getState();
+    if (!core) throw new Error("Composer is not available");
+    return core.getAttachmentAccept();
+  }
+
+  public abstract getAttachmentByIndex(idx: number): AttachmentRuntime;
+}
+
+export type ThreadComposerRuntime = Omit<
+  ComposerRuntime,
+  "getState" | "getAttachmentByIndex"
+> & {
+  readonly path: ComposerRuntimePath & { composerSource: "thread" };
+  readonly type: "thread";
+  getState(): ThreadComposerState;
+
+  /**
+   * @deprecated Use `getState().attachments` instead. This will be removed in 0.6.0.
+   */
+  attachments: readonly PendingAttachment[];
+
+  getAttachmentByIndex(
+    idx: number,
+  ): AttachmentRuntime & { source: "thread-composer" };
+};
+
+export class ThreadComposerRuntimeImpl
+  extends ComposerRuntimeImpl
+  implements ThreadComposerRuntime, ThreadComposerState
+{
+  public override get path() {
+    return this._core.path as ComposerRuntimePath & {
+      composerSource: "thread";
+    };
+  }
+
+  public get type() {
+    return "thread" as const;
+  }
+
+  private _getState;
+
+  constructor(core: ThreadComposerRuntimeCoreBinding) {
+    const stateBinding = new LazyMemoizeSubject({
+      path: core.path,
+      getState: () => getThreadComposerState(core.getState()),
+      subscribe: (callback) => core.subscribe(callback),
+    });
+    super({
+      path: core.path,
+      getState: () => core.getState(),
+      subscribe: (callback) => stateBinding.subscribe(callback),
+    });
+    this._getState = stateBinding.getState.bind(stateBinding);
+  }
+
+  public override get attachments() {
+    return this.getState()?.attachments ?? EMPTY_ARRAY;
+  }
+
+  public override getState(): ThreadComposerState {
+    return this._getState();
+  }
+
+  public getAttachmentByIndex(idx: number) {
+    return new ThreadComposerAttachmentRuntimeImpl(
+      new ShallowMemoizeSubject({
+        path: {
+          ...this.path,
+          attachmentSource: "thread-composer",
+          attachmentSelector: { type: "index", index: idx },
+          ref: this.path.ref + `${this.path.ref}.attachments[${idx}]`,
+        },
+        getState: () => {
+          const attachments = this.getState().attachments;
+          const attachment = attachments[idx];
+          if (!attachment) return SKIP_UPDATE;
+
+          return {
+            ...attachment,
+            attachment: attachment,
+            source: "thread-composer",
+          } satisfies AttachmentState & { source: "thread-composer" };
+        },
+        subscribe: (callback) => this._core.subscribe(callback),
+      }),
+      this._core,
+    );
+  }
+}
+
+export type EditComposerRuntime = Omit<
+  ComposerRuntime,
+  "getState" | "getAttachmentByIndex"
+> & {
+  readonly path: ComposerRuntimePath & { composerSource: "edit" };
+  readonly type: "edit";
+
+  getState(): EditComposerState;
+  beginEdit(): void;
+
+  /**
+   * @deprecated Use `beginEdit()` instead. This will be removed in 0.6.0.
+   */
+  edit(): void;
+
+  getAttachmentByIndex(
+    idx: number,
+  ): AttachmentRuntime & { source: "edit-composer" };
+};
+
+export class EditComposerRuntimeImpl
+  extends ComposerRuntimeImpl
+  implements EditComposerRuntime, EditComposerState
+{
+  public override get path() {
+    return this._core.path as ComposerRuntimePath & { composerSource: "edit" };
+  }
+
+  public get type() {
+    return "edit" as const;
+  }
+
+  private _getState;
+  constructor(
+    core: EditComposerRuntimeCoreBinding,
+    private _beginEdit: () => void,
+  ) {
+    const stateBinding = new LazyMemoizeSubject({
+      path: core.path,
+      getState: () => getEditComposerState(core.getState(), this._beginEdit),
+      subscribe: (callback) => core.subscribe(callback),
+    });
+
+    super({
+      path: core.path,
+      getState: () => core.getState(),
+      subscribe: (callback) => stateBinding.subscribe(callback),
+    });
+
+    this._getState = stateBinding.getState.bind(stateBinding);
+  }
+
+  public override getState(): EditComposerState {
+    return this._getState();
+  }
+
+  public beginEdit() {
+    this._beginEdit();
+  }
+
+  /**
+   * @deprecated Use `beginEdit()` instead. This will be removed in 0.6.0.
+   */
+  public edit() {
+    this.beginEdit();
+  }
+
+  public getAttachmentByIndex(idx: number) {
+    return new EditComposerAttachmentRuntimeImpl(
+      new ShallowMemoizeSubject({
+        path: {
+          ...this.path,
+          attachmentSource: "edit-composer",
+          attachmentSelector: { type: "index", index: idx },
+          ref: this.path.ref + `${this.path.ref}.attachments[${idx}]`,
+        },
+        getState: () => {
+          const attachments = this.getState().attachments;
+          const attachment = attachments[idx];
+          if (!attachment) return SKIP_UPDATE;
+
+          return {
+            ...attachment,
+            attachment: attachment,
+            source: "edit-composer",
+          } satisfies AttachmentState & { source: "edit-composer" };
+        },
+        subscribe: (callback) => this._core.subscribe(callback),
+      }),
+      this._core,
+    );
+  }
+}

package/src/api/ContentPartRuntime.ts

@@ -0,0 +1,76 @@
+import {
+  ThreadAssistantContentPart,
+  ThreadUserContentPart,
+  ContentPartStatus,
+  ToolCallContentPartStatus,
+} from "../types/AssistantTypes";
+import { ThreadRuntimeCoreBinding } from "./ThreadRuntime";
+import { MessageStateBinding } from "./MessageRuntime";
+import { SubscribableWithState } from "./subscribable/Subscribable";
+import { Unsubscribe } from "../types";
+import { ContentPartRuntimePath } from "./RuntimePathTypes";
+
+export type ContentPartState = (
+  | ThreadUserContentPart
+  | ThreadAssistantContentPart
+) & {
+  /**
+   * @deprecated You can directly access content part fields in the state. Replace `.part.type` with `.type` etc. This will be removed in 0.6.0.
+   */
+  part: ThreadUserContentPart | ThreadAssistantContentPart;
+  status: ContentPartStatus | ToolCallContentPartStatus;
+};
+
+type ContentPartSnapshotBinding = SubscribableWithState<
+  ContentPartState,
+  ContentPartRuntimePath
+>;
+
+export type ContentPartRuntime = {
+  path: ContentPartRuntimePath;
+
+  getState(): ContentPartState;
+  addToolResult(result: any): void;
+  subscribe(callback: () => void): Unsubscribe;
+};
+
+export class ContentPartRuntimeImpl implements ContentPartRuntime {
+  public get path() {
+    return this.contentBinding.path;
+  }
+
+  constructor(
+    private contentBinding: ContentPartSnapshotBinding,
+    private messageApi: MessageStateBinding,
+    private threadApi: ThreadRuntimeCoreBinding,
+  ) {}
+
+  public getState() {
+    return this.contentBinding.getState();
+  }
+
+  public addToolResult(result: any) {
+    const message = this.messageApi.getState();
+    if (!message) throw new Error("Message is not available");
+
+    const state = this.contentBinding.getState();
+    if (!state) throw new Error("Content part is not available");
+
+    if (state.type !== "tool-call")
+      throw new Error("Tried to add tool result to non-tool content part");
+
+    const toolName = state.toolName;
+    const toolCallId = state.toolCallId;
+
+    this.threadApi.getState().addToolResult({
+      messageId: message.id,
+      toolName,
+      toolCallId,
+      result,
+    });
+  }
+
+  public subscribe(callback: () => void) {
+    return this.contentBinding.subscribe(callback);
+  }
+}