@assistant-ui/react 0.12.10 → 0.12.11

package/src/types/AssistantTypes.ts

@@ -1,166 +0,0 @@
-import type { CompleteAttachment } from "./AttachmentTypes";
-import type { ReadonlyJSONValue } from "assistant-stream/utils";
-import type {
-  TextMessagePart,
-  ReasoningMessagePart,
-  SourceMessagePart,
-  ImageMessagePart,
-  FileMessagePart,
-  DataMessagePart,
-  Unstable_AudioMessagePart,
-  ToolCallMessagePart,
-  ThreadUserMessagePart,
-  ThreadAssistantMessagePart,
-} from "./MessagePartTypes";
-
-// Re-export message part types for convenience
-export type {
-  TextMessagePart,
-  ReasoningMessagePart,
-  SourceMessagePart,
-  ImageMessagePart,
-  FileMessagePart,
-  DataMessagePart,
-  Unstable_AudioMessagePart,
-  ToolCallMessagePart,
-  ThreadUserMessagePart,
-  ThreadAssistantMessagePart,
-};
-
-// Alias for the role of a thread message
-export type MessageRole = ThreadMessage["role"];
-
-type MessageCommonProps = {
-  readonly id: string;
-  readonly createdAt: Date;
-};
-
-export type ThreadStep = {
-  readonly messageId?: string;
-  readonly usage?:
-    | {
-        readonly promptTokens: number;
-        readonly completionTokens: number;
-      }
-    | undefined;
-};
-
-export type MessagePartStatus =
-  | {
-      readonly type: "running";
-    }
-  | {
-      readonly type: "complete";
-    }
-  | {
-      readonly type: "incomplete";
-      readonly reason:
-        | "cancelled"
-        | "length"
-        | "content-filter"
-        | "other"
-        | "error";
-      readonly error?: unknown;
-    };
-
-export type ToolCallMessagePartStatus =
-  | {
-      readonly type: "requires-action";
-      readonly reason: "interrupt";
-    }
-  | MessagePartStatus;
-
-export type MessageStatus =
-  | {
-      readonly type: "running";
-    }
-  | {
-      readonly type: "requires-action";
-      readonly reason: "tool-calls" | "interrupt";
-    }
-  | {
-      readonly type: "complete";
-      readonly reason: "stop" | "unknown";
-    }
-  | {
-      readonly type: "incomplete";
-      readonly reason:
-        | "cancelled"
-        | "tool-calls"
-        | "length"
-        | "content-filter"
-        | "other"
-        | "error";
-      readonly error?: ReadonlyJSONValue;
-    };
-
-export type ThreadSystemMessage = MessageCommonProps & {
-  readonly role: "system";
-  readonly content: readonly [TextMessagePart];
-  readonly metadata: {
-    readonly unstable_state?: undefined;
-    readonly unstable_annotations?: undefined;
-    readonly unstable_data?: undefined;
-    readonly steps?: undefined;
-    readonly submittedFeedback?: undefined;
-    readonly custom: Record<string, unknown>;
-  };
-};
-
-export type ThreadUserMessage = MessageCommonProps & {
-  readonly role: "user";
-  readonly content: readonly ThreadUserMessagePart[];
-  readonly attachments: readonly CompleteAttachment[];
-  readonly metadata: {
-    readonly unstable_state?: undefined;
-    readonly unstable_annotations?: undefined;
-    readonly unstable_data?: undefined;
-    readonly steps?: undefined;
-    readonly submittedFeedback?: undefined;
-    readonly custom: Record<string, unknown>;
-  };
-};
-
-export type ThreadAssistantMessage = MessageCommonProps & {
-  readonly role: "assistant";
-  readonly content: readonly ThreadAssistantMessagePart[];
-  readonly status: MessageStatus;
-  readonly metadata: {
-    readonly unstable_state: ReadonlyJSONValue;
-    readonly unstable_annotations: readonly ReadonlyJSONValue[];
-    readonly unstable_data: readonly ReadonlyJSONValue[];
-    readonly steps: readonly ThreadStep[];
-    readonly submittedFeedback?: { readonly type: "positive" | "negative" };
-    readonly custom: Record<string, unknown>;
-  };
-};
-
-export type RunConfig = {
-  // TODO allow user customization via global type overrides
-  readonly custom?: Record<string, unknown>;
-};
-
-export type AppendMessage = Omit<ThreadMessage, "id"> & {
-  parentId: string | null;
-
-  /** The ID of the message that was edited or undefined. */
-  sourceId: string | null;
-  runConfig: RunConfig | undefined;
-  startRun?: boolean | undefined;
-};
-
-type BaseThreadMessage = {
-  readonly status?: ThreadAssistantMessage["status"];
-  readonly metadata: {
-    readonly unstable_state?: ReadonlyJSONValue;
-    readonly unstable_annotations?: readonly ReadonlyJSONValue[];
-    readonly unstable_data?: readonly ReadonlyJSONValue[];
-    readonly steps?: readonly ThreadStep[];
-    readonly submittedFeedback?: { readonly type: "positive" | "negative" };
-    readonly custom: Record<string, unknown>;
-  };
-  readonly attachments?: ThreadUserMessage["attachments"];
-};
-
-export type ThreadMessage = BaseThreadMessage &
-  (ThreadSystemMessage | ThreadUserMessage | ThreadAssistantMessage);

package/src/types/AttachmentTypes.ts

@@ -1,45 +0,0 @@
-import type { ThreadUserMessagePart } from "./MessagePartTypes";
-
-export type PendingAttachmentStatus =
-  | {
-      type: "running";
-      reason: "uploading";
-      progress: number;
-    }
-  | {
-      type: "requires-action";
-      reason: "composer-send";
-    }
-  | {
-      type: "incomplete";
-      reason: "error" | "upload-paused";
-    };
-
-export type CompleteAttachmentStatus = {
-  type: "complete";
-};
-
-export type AttachmentStatus =
-  | PendingAttachmentStatus
-  | CompleteAttachmentStatus;
-
-type BaseAttachment = {
-  id: string;
-  type: "image" | "document" | "file";
-  name: string;
-  contentType: string;
-  file?: File;
-  content?: ThreadUserMessagePart[];
-};
-
-export type PendingAttachment = BaseAttachment & {
-  status: PendingAttachmentStatus;
-  file: File;
-};
-
-export type CompleteAttachment = BaseAttachment & {
-  status: CompleteAttachmentStatus;
-  content: ThreadUserMessagePart[];
-};
-
-export type Attachment = PendingAttachment | CompleteAttachment;

package/src/types/MessagePartTypes.ts

@@ -1,82 +0,0 @@
-import { ReadonlyJSONObject } from "assistant-stream/utils";
-import type { ThreadMessage } from "./AssistantTypes";
-
-export type TextMessagePart = {
-  readonly type: "text";
-  readonly text: string;
-  readonly parentId?: string;
-};
-
-export type ReasoningMessagePart = {
-  readonly type: "reasoning";
-  readonly text: string;
-  readonly parentId?: string;
-};
-
-export type SourceMessagePart = {
-  readonly type: "source";
-  readonly sourceType: "url";
-  readonly id: string;
-  readonly url: string;
-  readonly title?: string;
-  readonly parentId?: string;
-};
-
-export type ImageMessagePart = {
-  readonly type: "image";
-  readonly image: string;
-  readonly filename?: string;
-};
-
-export type FileMessagePart = {
-  readonly type: "file";
-  readonly filename?: string;
-  readonly data: string;
-  readonly mimeType: string;
-};
-
-export type Unstable_AudioMessagePart = {
-  readonly type: "audio";
-  readonly audio: {
-    readonly data: string;
-    readonly format: "mp3" | "wav";
-  };
-};
-
-export type DataMessagePart<T = any> = {
-  readonly type: "data";
-  readonly name: string;
-  readonly data: T;
-};
-
-export type ToolCallMessagePart<
-  TArgs = ReadonlyJSONObject,
-  TResult = unknown,
-> = {
-  readonly type: "tool-call";
-  readonly toolCallId: string;
-  readonly toolName: string;
-  readonly args: TArgs;
-  readonly result?: TResult | undefined;
-  readonly isError?: boolean | undefined;
-  readonly argsText: string;
-  readonly artifact?: unknown;
-  readonly interrupt?: { type: "human"; payload: unknown };
-  readonly parentId?: string;
-  readonly messages?: readonly ThreadMessage[];
-};
-
-export type ThreadUserMessagePart =
-  | TextMessagePart
-  | ImageMessagePart
-  | FileMessagePart
-  | Unstable_AudioMessagePart;
-
-export type ThreadAssistantMessagePart =
-  | TextMessagePart
-  | ReasoningMessagePart
-  | ToolCallMessagePart
-  | SourceMessagePart
-  | FileMessagePart
-  | ImageMessagePart
-  | DataMessagePart;

package/src/types/QuoteTypes.ts

@@ -1,4 +0,0 @@
-export type QuoteInfo = {
-  readonly text: string;
-  readonly messageId: string;
-};

package/src/types/Unsubscribe.tsx

@@ -1 +0,0 @@
-export type Unsubscribe = () => void;

package/src/types/scopes/attachment.ts

@@ -1,22 +0,0 @@
-import type { Attachment } from "../AttachmentTypes";
-import type { AttachmentRuntime } from "../../legacy-runtime/runtime";
-
-export type AttachmentState = Attachment;
-
-export type AttachmentMethods = {
-  getState(): AttachmentState;
-  remove(): Promise<void>;
-  /** @internal */
-  __internal_getRuntime?(): AttachmentRuntime;
-};
-
-export type AttachmentMeta = {
-  source: "message" | "composer";
-  query: { type: "index"; index: number } | { type: "id"; id: string };
-};
-
-export type AttachmentClientSchema = {
-  state: AttachmentState;
-  methods: AttachmentMethods;
-  meta: AttachmentMeta;
-};

package/src/types/scopes/chainOfThought.ts

@@ -1,42 +0,0 @@
-import type {
-  MessagePartStatus,
-  ToolCallMessagePartStatus,
-} from "../AssistantTypes";
-import type { PartMethods, PartState } from "./part";
-
-export type ChainOfThoughtPart = Extract<
-  PartState,
-  { type: "tool-call" } | { type: "reasoning" }
->;
-
-export type ChainOfThoughtState = {
-  readonly parts: readonly ChainOfThoughtPart[];
-  readonly collapsed: boolean;
-  readonly status: MessagePartStatus | ToolCallMessagePartStatus;
-};
-
-export type ChainOfThoughtMethods = {
-  /**
-   * Get the current state of the chain of thought.
-   */
-  getState(): ChainOfThoughtState;
-  /**
-   * Set the collapsed state of the chain of thought accordion.
-   */
-  setCollapsed(collapsed: boolean): void;
-  /**
-   * Get the part methods for a specific part within this chain of thought.
-   */
-  part(selector: { index: number }): PartMethods;
-};
-
-export type ChainOfThoughtMeta = {
-  source: "message";
-  query: { type: "chainOfThought" };
-};
-
-export type ChainOfThoughtClientSchema = {
-  state: ChainOfThoughtState;
-  methods: ChainOfThoughtMethods;
-  meta: ChainOfThoughtMeta;
-};

package/src/types/scopes/composer.ts

@@ -1,80 +0,0 @@
-import type { Attachment } from "../AttachmentTypes";
-import type { MessageRole, RunConfig } from "../AssistantTypes";
-import type { QuoteInfo } from "../QuoteTypes";
-import type { ComposerRuntime } from "../../legacy-runtime/runtime";
-import type { AttachmentMethods } from "./attachment";
-import { DictationState } from "../../legacy-runtime/runtime-cores";
-
-export type ComposerState = {
-  readonly text: string;
-  readonly role: MessageRole;
-  readonly attachments: readonly Attachment[];
-  readonly runConfig: RunConfig;
-  readonly isEditing: boolean;
-  readonly canCancel: boolean;
-  readonly attachmentAccept: string;
-  readonly isEmpty: boolean;
-  readonly type: "thread" | "edit";
-
-  /**
-   * The current state of dictation.
-   * Undefined when dictation is not active.
-   */
-  readonly dictation: DictationState | undefined;
-
-  /**
-   * The currently quoted text, if any.
-   * Undefined when no quote is set.
-   */
-  readonly quote: QuoteInfo | undefined;
-};
-
-export type ComposerMethods = {
-  getState(): ComposerState;
-  setText(text: string): void;
-  setRole(role: MessageRole): void;
-  setRunConfig(runConfig: RunConfig): void;
-  addAttachment(file: File): Promise<void>;
-  clearAttachments(): Promise<void>;
-  attachment(selector: { index: number } | { id: string }): AttachmentMethods;
-  reset(): Promise<void>;
-  send(): void;
-  cancel(): void;
-  beginEdit(): void;
-
-  /**
-   * Start dictation to convert voice to text input.
-   * Requires a DictationAdapter to be configured.
-   */
-  startDictation(): void;
-
-  /**
-   * Stop the current dictation session.
-   */
-  stopDictation(): void;
-
-  /**
-   * Set a quote for the next message. Pass undefined to clear.
-   */
-  setQuote(quote: QuoteInfo | undefined): void;
-
-  /** @internal */
-  __internal_getRuntime?(): ComposerRuntime;
-};
-
-export type ComposerMeta = {
-  source: "thread" | "message";
-  query: Record<string, never>;
-};
-
-export type ComposerEvents = {
-  "composer.send": { threadId: string; messageId?: string };
-  "composer.attachmentAdd": { threadId: string; messageId?: string };
-};
-
-export type ComposerClientSchema = {
-  state: ComposerState;
-  methods: ComposerMethods;
-  meta: ComposerMeta;
-  events: ComposerEvents;
-};

package/src/types/scopes/message.ts

@@ -1,78 +0,0 @@
-import type { ThreadMessage } from "../AssistantTypes";
-import type {
-  SpeechState,
-  SubmittedFeedback,
-} from "../../legacy-runtime/runtime-cores/core/ThreadRuntimeCore";
-import type { RunConfig } from "../AssistantTypes";
-import type { MessageRuntime } from "../../legacy-runtime/runtime";
-import type { ComposerMethods, ComposerState } from "./composer";
-import type { PartMethods, PartState } from "./part";
-import type { AttachmentMethods } from "./attachment";
-
-export type MessageState = ThreadMessage & {
-  readonly parentId: string | null;
-  readonly isLast: boolean;
-  readonly branchNumber: number;
-  readonly branchCount: number;
-  /**
-   * @deprecated This API is still under active development and might change without notice.
-   *
-   * To enable text-to-speech, provide a `SpeechSynthesisAdapter` to the runtime.
-   *
-   * @example
-   * ```ts
-   * import { WebSpeechSynthesisAdapter } from "@assistant-ui/react";
-   * import { useChatRuntime } from "@assistant-ui/react-ai-sdk";
-   *
-   * const runtime = useChatRuntime({
-   *   adapters: {
-   *     speech: new WebSpeechSynthesisAdapter(),
-   *   },
-   * });
-   */
-  readonly speech: SpeechState | undefined;
-  /** @deprecated Use `message.metadata.submittedFeedback` instead. This will be removed in 0.12.0. */
-  readonly submittedFeedback: SubmittedFeedback | undefined;
-  readonly composer: ComposerState;
-  readonly parts: readonly PartState[];
-  readonly isCopied: boolean;
-  readonly isHovering: boolean;
-  /** The position of this message in the thread (0 for first message) */
-  readonly index: number;
-};
-
-export type MessageMethods = {
-  /**
-   * Get the current state of the message.
-   */
-  getState(): MessageState;
-  composer: ComposerMethods;
-  reload(config?: { runConfig?: RunConfig }): void;
-  /** @deprecated This API is still under active development and might change without notice. */
-  speak(): void;
-  /** @deprecated This API is still under active development and might change without notice. */
-  stopSpeaking(): void;
-  submitFeedback(feedback: { type: "positive" | "negative" }): void;
-  switchToBranch(options: {
-    position?: "previous" | "next";
-    branchId?: string;
-  }): void;
-  getCopyText(): string;
-  part(selector: { index: number } | { toolCallId: string }): PartMethods;
-  attachment(selector: { index: number } | { id: string }): AttachmentMethods;
-  setIsCopied(value: boolean): void;
-  setIsHovering(value: boolean): void;
-  /** @internal */
-  __internal_getRuntime?(): MessageRuntime;
-};
-
-export type MessageMeta = {
-  source: "thread";
-  query: { type: "id"; id: string } | { type: "index"; index: number };
-};
-
-export type MessageClientSchema = {
-  state: MessageState;
-  methods: MessageMethods;
-  meta: MessageMeta;
-};

package/src/types/scopes/modelContext.ts

@@ -1,14 +0,0 @@
-import type { Unsubscribe } from "../Unsubscribe";
-import type { ModelContextProvider } from "../../model-context/ModelContextTypes";
-
-export type ModelContextState = Record<string, never>;
-
-export type ModelContextMethods = ModelContextProvider & {
-  getState(): ModelContextState;
-  register: (provider: ModelContextProvider) => Unsubscribe;
-};
-
-export type ModelContextClientSchema = {
-  state: ModelContextState;
-  methods: ModelContextMethods;
-};

package/src/types/scopes/part.ts

@@ -1,49 +0,0 @@
-import type { ToolResponse } from "assistant-stream";
-import type { MessagePartRuntime } from "../../legacy-runtime/runtime";
-import type {
-  ThreadUserMessagePart,
-  ThreadAssistantMessagePart,
-  MessagePartStatus,
-  ToolCallMessagePartStatus,
-} from "../AssistantTypes";
-
-export type PartState = (ThreadUserMessagePart | ThreadAssistantMessagePart) & {
-  readonly status: MessagePartStatus | ToolCallMessagePartStatus;
-};
-
-export type PartMethods = {
-  /**
-   * Get the current state of the message part.
-   */
-  getState(): PartState;
-  /**
-   * Add tool result to a tool call message part that has no tool result yet.
-   * This is useful when you are collecting a tool result via user input ("human tool calls").
-   */
-  addToolResult(result: unknown | ToolResponse<unknown>): void;
-  /**
-   * Resume a tool call that is waiting for human input with a payload.
-   * This is useful when a tool has requested human input and is waiting for a response.
-   */
-  resumeToolCall(payload: unknown): void;
-  /** @internal */
-  __internal_getRuntime?(): MessagePartRuntime;
-};
-
-export type PartMeta =
-  | {
-      source: "message";
-      query:
-        | { type: "index"; index: number }
-        | { type: "toolCallId"; toolCallId: string };
-    }
-  | {
-      source: "chainOfThought";
-      query: { type: "index"; index: number };
-    };
-
-export type PartClientSchema = {
-  state: PartState;
-  methods: PartMethods;
-  meta: PartMeta;
-};

package/src/types/scopes/suggestion.ts

@@ -1,20 +0,0 @@
-export type SuggestionState = {
-  title: string;
-  label: string;
-  prompt: string;
-};
-
-export type SuggestionMethods = {
-  getState(): SuggestionState;
-};
-
-export type SuggestionMeta = {
-  source: "suggestions";
-  query: { index: number };
-};
-
-export type SuggestionClientSchema = {
-  state: SuggestionState;
-  methods: SuggestionMethods;
-  meta: SuggestionMeta;
-};

package/src/types/scopes/suggestions.ts

@@ -1,21 +0,0 @@
-import type { SuggestionMethods } from "./suggestion";
-
-export type Suggestion = {
-  title: string;
-  label: string;
-  prompt: string;
-};
-
-export type SuggestionsState = {
-  suggestions: Suggestion[];
-};
-
-export type SuggestionsMethods = {
-  getState(): SuggestionsState;
-  suggestion(query: { index: number }): SuggestionMethods;
-};
-
-export type SuggestionsClientSchema = {
-  state: SuggestionsState;
-  methods: SuggestionsMethods;
-};