Utilities

API Reference

AssistantCloud

AuiConfig

Builds a config for AuiProvider; the config prop only accepts configs built with this helper.

A config is plain data: it can be hoisted to module scope, created inline per render, or memoized — the provider never relies on config identity.

const aui = useAui();
const config = AuiConfig({
  message: Derived({
    source: "thread",
    query: { index: 0 },
    get: (aui) => aui.thread.message({ index: 0 }),
  }),
});

<AuiProvider extends={aui} config={config}>{children}</AuiProvider>;

ChainOfThoughtClient

CloudRendererHost

createMessageQueue

const createMessageQueue: (driver: MessageQueueDriver) => MessageQueueController;

createSimpleTitleAdapter

const createSimpleTitleAdapter: () => TitleGenerationAdapter;

createThreadRowsSelector

Creates a selector for useAuiState that flattens the current thread into rows (see ThreadRow). The selector returns the same array for the same thread state, and keeps returning the previous array and row objects while a streamed token leaves the rows unchanged, so a list keyed by row.key re-renders only when rows appear, disappear, regroup or a turn completes. Create one selector per list, at module scope or with useState.

const selectRows = createThreadRowsSelector({
  groupBy: groupPartByType({ reasoning: ["group-reasoning"] }),
});

function VirtualThread() {
  const rows = useAuiState(selectRows);
  // feed rows to a virtualizer and render each with ThreadPrimitive.Row
}

const createThreadRowsSelector: (options?: ThreadRowsOptions) => (state: AssistantState) => readonly ThreadRow[];

defaultDirectiveFormatter

Default directive formatter using the :type[label]{name=id} syntax.

When id equals label, the {name=…} attribute is omitted for brevity. Labels containing ] or distinct IDs containing } use :type{label="..." name="..."} with JSON-quoted values instead. The name field is omitted when it equals the label. Existing bracket syntax stays literal.

const defaultDirectiveFormatter: DirectiveFormatter;

DevToolsHooks

InMemoryThreadList

isMessageNotSentError

const isMessageNotSentError: (error: unknown) => error is MessageNotSentError;

MessageNotSentError

Rejection reason for a send that never reached the backend, so nothing ran and nothing is recoverable from the thread. A runtime adapter throws it from onNew to hand the message back to the thread composer, which restores the draft it cleared at dispatch time when nothing has claimed the composer since. Throwing it from onEdit reopens the unsent edit if the source message is unchanged, no newer edit has started, and the thread is still current.

readAnonymousRefreshToken

The refresh token of the anonymous identity this browser holds for baseUrl, or null when it has none.

const readAnonymousRefreshToken: (baseUrl: string) => string | null;

RemoteThreadList

AuiConfig threads entry backed by a RemoteThreadListAdapter. Thread bodies are born from the thread factory inside the client tree, so any AssistantClient host can run a remote or cloud list. Per-thread history and attachments come from unstable_useAdapters. useRemoteThreadListRuntime uses the same hook except while it renders unstable_Provider, which it does only when the adapter it mounts with has one. Key the factory with withKey so history reloads when the visible thread changes. With backgroundThreads, every visited thread stays mounted: runs continue across switches, per-item isRunning is live, and freshly initialized threads title themselves.

SingleThreadList

Suggestions

useSmooth

Animates streamed message part text with a typewriter-style reveal.

Takes the current part state and a smooth argument: false disables, true uses the default rate, and a SmoothOptions object tunes the reveal. Returns the part state with text replaced by the revealed prefix and status reporting running until the reveal catches up. If the source settles before any character has been revealed, the text is committed immediately so a missed animation frame cannot leave an empty bubble.

The reveal auto-disables under prefers-reduced-motion: reduce, committing the full text immediately; this takes precedence over an explicit smooth={true}.

const { text, status } = useSmooth(useMessagePartText(), {
  drainMs: 500,
  maxCharsPerFrame: 30,
});

fromThreadMessageLike

const fromThreadMessageLike: (like: ThreadMessageLike, fallbackId: string, fallbackStatus: MessageStatus) => ThreadMessage;

generateId

const generateId: (size?: number) => string;

unstable_defaultWebMcpFilter

The predicate the WebMCP provider uses when no filter is passed: an enabled frontend tool with a client-side execute. A tool authored without a type is included, because execute is what distinguishes the deprecated type-less form from a backend or human tool. A filter replaces this, so pass it through to narrow the default set rather than widen it.

const unstable_defaultWebMcpFilter: (_name: string, tool: Tool<any, any>) => boolean;

unstable_useWebMcpProvider

Publishes the frontend tools in the model context to a WebMCP-capable browser, so the user's own browser agent can call them.

Returns status: "unsupported" when the page exposes no document.modelContext (or navigator.modelContext), and the sorted names of the tools currently registered with the host.

unstable_defaultDirectiveFormatter

const unstable_defaultDirectiveFormatter: DirectiveFormatter;