@assistant-ui/react 0.11.0 → 0.11.1

package/src/runtimes/adapters/feedback/FeedbackAdapter.ts

@@ -1,43 +0,0 @@
-import { ThreadMessage } from "../../../types/AssistantTypes";
-
-/**
- * Feedback data structure for rating messages.
- */
-type FeedbackAdapterFeedback = {
-  /** The message being rated */
-  message: ThreadMessage;
-  /** The type of feedback being provided */
-  type: "positive" | "negative";
-};
-
-/**
- * Interface for handling user feedback on assistant messages.
- *
- * FeedbackAdapter allows users to provide positive or negative feedback
- * on assistant responses, which can be used for analytics, model improvement,
- * or user experience tracking.
- *
- * @example
- * ```tsx
- * const feedbackAdapter: FeedbackAdapter = {
- *   submit: (feedback) => {
- *     console.log(`User gave ${feedback.type} feedback on message:`, feedback.message.id);
- *
- *     // Send to analytics service
- *     analytics.track('message_feedback', {
- *       messageId: feedback.message.id,
- *       feedbackType: feedback.type,
- *       messageContent: feedback.message.content
- *     });
- *   }
- * };
- * ```
- */
-export type FeedbackAdapter = {
-  /**
-   * Submits user feedback for a message.
-   *
-   * @param feedback - The feedback data containing message and rating type
-   */
-  submit: (feedback: FeedbackAdapterFeedback) => void;
-};

package/src/runtimes/adapters/speech/SpeechAdapterTypes.ts

@@ -1,98 +0,0 @@
-import { Unsubscribe } from "../../../types";
-
-/**
- * Types and interfaces for speech synthesis (text-to-speech) functionality.
- */
-export namespace SpeechSynthesisAdapter {
-  /**
-   * Status of a speech synthesis operation.
-   */
-  export type Status =
-    | {
-        /** Speech is starting or currently running */
-        type: "starting" | "running";
-      }
-    | {
-        /** Speech has ended */
-        type: "ended";
-        /** Reason why speech ended */
-        reason: "finished" | "cancelled" | "error";
-        /** Error details if speech ended due to error */
-        error?: unknown;
-      };
-
-  /**
-   * Represents a single speech utterance with control and status tracking.
-   */
-  export type Utterance = {
-    /** Current status of the utterance */
-    status: Status;
-    /** Cancel the current speech */
-    cancel: () => void;
-    /** Subscribe to status changes */
-    subscribe: (callback: () => void) => Unsubscribe;
-  };
-}
-
-/**
- * Interface for text-to-speech functionality.
- *
- * SpeechSynthesisAdapter provides the ability to convert text content
- * into spoken audio, with status tracking and cancellation support.
- *
- * @example
- * ```tsx
- * const speechAdapter: SpeechSynthesisAdapter = {
- *   speak: (text) => {
- *     const utterance = new SpeechSynthesisUtterance(text);
- *     speechSynthesis.speak(utterance);
- *
- *     return {
- *       status: { type: "starting" },
- *       cancel: () => speechSynthesis.cancel(),
- *       subscribe: (callback) => {
- *         utterance.addEventListener('end', callback);
- *         return () => utterance.removeEventListener('end', callback);
- *       }
- *     };
- *   }
- * };
- * ```
- */
-export type SpeechSynthesisAdapter = {
-  /**
-   * Converts text to speech and returns an utterance object for control.
-   *
-   * @param text - The text content to speak
-   * @returns An utterance object with status and control methods
-   */
-  speak: (text: string) => SpeechSynthesisAdapter.Utterance;
-};
-
-export namespace SpeechRecognitionAdapter {
-  export type Status =
-    | {
-        type: "starting" | "running";
-      }
-    | {
-        type: "ended";
-        reason: "stopped" | "cancelled" | "error";
-      };
-
-  export type Result = {
-    transcript: string;
-  };
-
-  export type Session = {
-    status: Status;
-    stop: () => Promise<void>;
-    cancel: () => void;
-    onSpeechStart: (callback: () => void) => Unsubscribe;
-    onSpeechEnd: (callback: (result: Result) => void) => Unsubscribe;
-    onSpeech: (callback: (result: Result) => void) => Unsubscribe;
-  };
-}
-
-export type SpeechRecognitionAdapter = {
-  listen: () => SpeechRecognitionAdapter.Session;
-};

package/src/runtimes/adapters/suggestion/SuggestionAdapter.ts

@@ -1,14 +0,0 @@
-import { ThreadMessage } from "../../../types/AssistantTypes";
-import { ThreadSuggestion } from "../../core";
-
-type SuggestionAdapterGenerateOptions = {
-  messages: readonly ThreadMessage[];
-};
-
-export type SuggestionAdapter = {
-  generate: (
-    options: SuggestionAdapterGenerateOptions,
-  ) =>
-    | Promise<readonly ThreadSuggestion[]>
-    | AsyncGenerator<readonly ThreadSuggestion[], void>;
-};

package/src/runtimes/composer/BaseComposerRuntimeCore.tsx

@@ -1,239 +0,0 @@
-import {
-  Attachment,
-  CompleteAttachment,
-  PendingAttachment,
-} from "../../types/AttachmentTypes";
-import { AppendMessage } from "../../types";
-import { AttachmentAdapter } from "../adapters/attachment";
-import {
-  ComposerRuntimeCore,
-  ComposerRuntimeEventType,
-} from "../core/ComposerRuntimeCore";
-import { MessageRole, RunConfig } from "../../types/AssistantTypes";
-import { BaseSubscribable } from "../remote-thread-list/BaseSubscribable";
-
-const isAttachmentComplete = (a: Attachment): a is CompleteAttachment =>
-  a.status.type === "complete";
-
-export abstract class BaseComposerRuntimeCore
-  extends BaseSubscribable
-  implements ComposerRuntimeCore
-{
-  public readonly isEditing = true;
-
-  protected abstract getAttachmentAdapter(): AttachmentAdapter | undefined;
-
-  public get attachmentAccept(): string {
-    return this.getAttachmentAdapter()?.accept ?? "*";
-  }
-
-  private _attachments: readonly Attachment[] = [];
-  public get attachments() {
-    return this._attachments;
-  }
-
-  protected setAttachments(value: readonly Attachment[]) {
-    this._attachments = value;
-    this._notifySubscribers();
-  }
-
-  public abstract get canCancel(): boolean;
-
-  public get isEmpty() {
-    return !this.text.trim() && !this.attachments.length;
-  }
-
-  private _text = "";
-
-  get text() {
-    return this._text;
-  }
-
-  private _role: MessageRole = "user";
-
-  get role() {
-    return this._role;
-  }
-
-  private _runConfig: RunConfig = {};
-
-  get runConfig() {
-    return this._runConfig;
-  }
-
-  public setText(value: string) {
-    if (this._text === value) return;
-
-    this._text = value;
-    this._notifySubscribers();
-  }
-
-  public setRole(role: MessageRole) {
-    if (this._role === role) return;
-
-    this._role = role;
-    this._notifySubscribers();
-  }
-
-  public setRunConfig(runConfig: RunConfig) {
-    if (this._runConfig === runConfig) return;
-
-    this._runConfig = runConfig;
-    this._notifySubscribers();
-  }
-
-  private _emptyTextAndAttachments() {
-    this._attachments = [];
-    this._text = "";
-    this._notifySubscribers();
-  }
-
-  private async _onClearAttachments() {
-    const adapter = this.getAttachmentAdapter();
-    if (adapter) {
-      await Promise.all(this._attachments.map((a) => adapter.remove(a)));
-    }
-  }
-
-  public async reset() {
-    if (
-      this._attachments.length === 0 &&
-      this._text === "" &&
-      this._role === "user" &&
-      Object.keys(this._runConfig).length === 0
-    ) {
-      return;
-    }
-
-    this._role = "user";
-    this._runConfig = {};
-
-    const task = this._onClearAttachments();
-    this._emptyTextAndAttachments();
-    await task;
-  }
-
-  public async clearAttachments() {
-    const task = this._onClearAttachments();
-    this.setAttachments([]);
-
-    await task;
-  }
-
-  public async send() {
-    const adapter = this.getAttachmentAdapter();
-    const attachments =
-      adapter && this.attachments.length > 0
-        ? Promise.all(
-            this.attachments.map(async (a) => {
-              if (isAttachmentComplete(a)) return a;
-              const result = await adapter.send(a);
-              return result as CompleteAttachment;
-            }),
-          )
-        : [];
-
-    const text = this.text;
-    this._emptyTextAndAttachments();
-    const message: Omit<AppendMessage, "parentId" | "sourceId"> = {
-      createdAt: new Date(),
-      role: this.role,
-      content: text ? [{ type: "text", text }] : [],
-      attachments: await attachments,
-      runConfig: this.runConfig,
-      metadata: { custom: {} },
-    };
-
-    this.handleSend(message);
-    this._notifyEventSubscribers("send");
-  }
-
-  public cancel() {
-    this.handleCancel();
-  }
-
-  protected abstract handleSend(
-    message: Omit<AppendMessage, "parentId" | "sourceId">,
-  ): void;
-  protected abstract handleCancel(): void;
-
-  async addAttachment(file: File) {
-    const adapter = this.getAttachmentAdapter();
-    if (!adapter) throw new Error("Attachments are not supported");
-
-    const upsertAttachment = (a: PendingAttachment) => {
-      const idx = this._attachments.findIndex(
-        (attachment) => attachment.id === a.id,
-      );
-      if (idx !== -1)
-        this._attachments = [
-          ...this._attachments.slice(0, idx),
-          a,
-          ...this._attachments.slice(idx + 1),
-        ];
-      else {
-        this._attachments = [...this._attachments, a];
-        this._notifyEventSubscribers("attachment-add");
-      }
-
-      this._notifySubscribers();
-    };
-
-    const promiseOrGenerator = adapter.add({ file });
-    if (Symbol.asyncIterator in promiseOrGenerator) {
-      for await (const r of promiseOrGenerator) {
-        upsertAttachment(r);
-      }
-    } else {
-      upsertAttachment(await promiseOrGenerator);
-    }
-
-    this._notifyEventSubscribers("attachment-add");
-    this._notifySubscribers();
-  }
-
-  async removeAttachment(attachmentId: string) {
-    const adapter = this.getAttachmentAdapter();
-    if (!adapter) throw new Error("Attachments are not supported");
-
-    const index = this._attachments.findIndex((a) => a.id === attachmentId);
-    if (index === -1) throw new Error("Attachment not found");
-    const attachment = this._attachments[index]!;
-
-    await adapter.remove(attachment);
-
-    // this._attachments.toSpliced(index, 1); - not yet widely supported
-    this._attachments = [
-      ...this._attachments.slice(0, index),
-      ...this._attachments.slice(index + 1),
-    ];
-    this._notifySubscribers();
-  }
-
-  private _eventSubscribers = new Map<
-    ComposerRuntimeEventType,
-    Set<() => void>
-  >();
-
-  protected _notifyEventSubscribers(event: ComposerRuntimeEventType) {
-    const subscribers = this._eventSubscribers.get(event);
-    if (!subscribers) return;
-
-    for (const callback of subscribers) callback();
-  }
-
-  public unstable_on(event: ComposerRuntimeEventType, callback: () => void) {
-    const subscribers = this._eventSubscribers.get(event);
-    if (!subscribers) {
-      this._eventSubscribers.set(event, new Set([callback]));
-    } else {
-      subscribers.add(callback);
-    }
-
-    return () => {
-      const subscribers = this._eventSubscribers.get(event);
-      if (!subscribers) return;
-      subscribers.delete(callback);
-    };
-  }
-}

package/src/runtimes/composer/DefaultEditComposerRuntimeCore.tsx

@@ -1,62 +0,0 @@
-import { AppendMessage, ThreadMessage } from "../../types";
-import { getThreadMessageText } from "../../utils/getThreadMessageText";
-import { AttachmentAdapter } from "../adapters/attachment";
-import { ThreadRuntimeCore } from "../core/ThreadRuntimeCore";
-import { BaseComposerRuntimeCore } from "./BaseComposerRuntimeCore";
-
-export class DefaultEditComposerRuntimeCore extends BaseComposerRuntimeCore {
-  public get canCancel() {
-    return true;
-  }
-
-  protected getAttachmentAdapter() {
-    return this.runtime.adapters?.attachments;
-  }
-
-  private _nonTextParts;
-  private _previousText;
-  private _parentId;
-  private _sourceId;
-  constructor(
-    private runtime: ThreadRuntimeCore & {
-      adapters?: { attachments?: AttachmentAdapter | undefined } | undefined;
-    },
-    private endEditCallback: () => void,
-    { parentId, message }: { parentId: string | null; message: ThreadMessage },
-  ) {
-    super();
-    this._parentId = parentId;
-    this._sourceId = message.id;
-    this._previousText = getThreadMessageText(message);
-    this.setText(this._previousText);
-
-    this.setRole(message.role);
-    this.setAttachments(message.attachments ?? []);
-
-    this._nonTextParts = message.content.filter((part) => part.type !== "text");
-
-    // Use the runConfig from the regular (non-edit) composer as the initial runConfig for the edit composer
-    this.setRunConfig({ ...runtime.composer.runConfig });
-  }
-
-  public async handleSend(
-    message: Omit<AppendMessage, "parentId" | "sourceId">,
-  ) {
-    const text = getThreadMessageText(message as AppendMessage);
-    if (text !== this._previousText) {
-      this.runtime.append({
-        ...message,
-        content: [...message.content, ...this._nonTextParts] as any,
-        parentId: this._parentId,
-        sourceId: this._sourceId,
-      });
-    }
-
-    this.handleCancel();
-  }
-
-  public handleCancel() {
-    this.endEditCallback();
-    this._notifySubscribers();
-  }
-}

package/src/runtimes/composer/DefaultThreadComposerRuntimeCore.tsx

@@ -1,55 +0,0 @@
-import { AppendMessage, PendingAttachment } from "../../types";
-import { AttachmentAdapter } from "../adapters/attachment";
-import { ThreadComposerRuntimeCore } from "../core/ComposerRuntimeCore";
-import { ThreadRuntimeCore } from "../core/ThreadRuntimeCore";
-import { BaseComposerRuntimeCore } from "./BaseComposerRuntimeCore";
-
-export class DefaultThreadComposerRuntimeCore
-  extends BaseComposerRuntimeCore
-  implements ThreadComposerRuntimeCore
-{
-  private _canCancel = false;
-  public get canCancel() {
-    return this._canCancel;
-  }
-
-  public override get attachments(): readonly PendingAttachment[] {
-    return super.attachments as readonly PendingAttachment[];
-  }
-
-  protected getAttachmentAdapter() {
-    return this.runtime.adapters?.attachments;
-  }
-
-  constructor(
-    private runtime: Omit<ThreadRuntimeCore, "composer"> & {
-      adapters?: { attachments?: AttachmentAdapter | undefined } | undefined;
-    },
-  ) {
-    super();
-    this.connect();
-  }
-
-  public connect() {
-    return this.runtime.subscribe(() => {
-      if (this.canCancel !== this.runtime.capabilities.cancel) {
-        this._canCancel = this.runtime.capabilities.cancel;
-        this._notifySubscribers();
-      }
-    });
-  }
-
-  public async handleSend(
-    message: Omit<AppendMessage, "parentId" | "sourceId">,
-  ) {
-    this.runtime.append({
-      ...(message as AppendMessage),
-      parentId: this.runtime.messages.at(-1)?.id ?? null,
-      sourceId: null,
-    });
-  }
-
-  public async handleCancel() {
-    this.runtime.cancelRun();
-  }
-}

package/src/runtimes/core/AssistantRuntimeCore.tsx

@@ -1,18 +0,0 @@
-import { ComponentType } from "react";
-import type { ModelContextProvider } from "../../model-context/ModelContextTypes";
-import type { Unsubscribe } from "../../types/Unsubscribe";
-import { ThreadListRuntimeCore } from "./ThreadListRuntimeCore";
-
-export type AssistantRuntimeCore = {
-  readonly threads: ThreadListRuntimeCore;
-
-  registerModelContextProvider: (provider: ModelContextProvider) => Unsubscribe;
-
-  /**
-   * EXPERIMENTAL: A component that is rendered inside the AssistantRuntimeProvider.
-   *
-   * Note: This field is expected to never change.
-   * To update the component, use a zustand store.
-   */
-  readonly RenderComponent?: ComponentType | undefined;
-};

package/src/runtimes/core/BaseAssistantRuntimeCore.tsx

@@ -1,16 +0,0 @@
-import { type ModelContextProvider } from "../../model-context/ModelContextTypes";
-import type { Unsubscribe } from "../../types/Unsubscribe";
-import type { AssistantRuntimeCore } from "./AssistantRuntimeCore";
-import { CompositeContextProvider } from "../../utils/CompositeContextProvider";
-import { ThreadListRuntimeCore } from "./ThreadListRuntimeCore";
-
-export abstract class BaseAssistantRuntimeCore implements AssistantRuntimeCore {
-  protected readonly _contextProvider = new CompositeContextProvider();
-  public abstract get threads(): ThreadListRuntimeCore;
-
-  public registerModelContextProvider(
-    provider: ModelContextProvider,
-  ): Unsubscribe {
-    return this._contextProvider.registerModelContextProvider(provider);
-  }
-}