@fungi.computer/parakeet 0.0.0-stage → 0.1.0

package/docs/api/index.md

@@ -0,0 +1,1249 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/parakeet**](README.md)
+
+---
+
+[@fungi.computer/parakeet](README.md) / index
+
+# index
+
+## Type Aliases
+
+### AgentHeadActivity
+
+```ts
+type AgentHeadActivity = "idle" | "thinking" | "speaking";
+```
+
+What the head is doing: at rest, working something out, or talking.
+
+---
+
+### InteractionPanelProps
+
+```ts
+type InteractionPanelProps = Readonly<{
+  host: WhistleInteractionHost;
+  onClose?: () => void;
+  onRetry?: () => void;
+}>;
+```
+
+The interaction to draw and the page's close and retry callbacks.
+
+---
+
+### AvatarState
+
+```ts
+type AvatarState = Readonly<
+  Pick<AvatarPresentation, "activity" | "expression">
+>;
+```
+
+The current activity and expression supplied to a live avatar.
+
+---
+
+### ParakeetModel
+
+```ts
+type ParakeetModel = Readonly<{
+  model: string;
+  provider: string;
+}>;
+```
+
+Stable model identity presented by the current Session.
+
+---
+
+### ParakeetUsage
+
+```ts
+type ParakeetUsage = Readonly<{
+  cost: number;
+  tokens: number;
+}>;
+```
+
+Aggregate usage presented by the current Session timeline.
+
+---
+
+### ParakeetStatus
+
+```ts
+type ParakeetStatus =
+  | "connecting"
+  | "cancelling"
+  | "error"
+  | "idle"
+  | "queued"
+  | "retrying"
+  | "sending"
+  | "streaming"
+  | "thinking"
+  | "disconnected";
+```
+
+Conversation activity presented by Parakeet.
+
+---
+
+### TimelineController
+
+```ts
+type TimelineController = Readonly<{
+  settled: readonly ParakeetTimelineItem[];
+  tail: readonly ParakeetTimelineItem[];
+  commandAnchors: ReadonlyMap<string, string>;
+  queued: SessionPendingPrompts;
+  pendingHasMore: boolean;
+  hasMoreHistory: boolean;
+  loadingOlderHistory: boolean;
+  loadOlderHistory: () => void;
+  hasNewerHistory: boolean;
+  loadNewerHistory: () => void;
+  pinVisibleHistory: () => void;
+  jumpToLatest: () => void;
+  model?: ParakeetModel;
+  usage?: ParakeetUsage;
+}>;
+```
+
+Stable history and replaceable work rendered by a conversation client.
+
+---
+
+### ComposerController
+
+```ts
+type ComposerController = Readonly<{
+  cancel: () => Promise<void>;
+  draft: string;
+  failure: "admission" | "failed" | "cancelled" | "interrupted" | undefined;
+  admissionError: "queue_full" | undefined;
+  retry: () => void;
+  dismissFailed: (requestId) => void;
+  send: (delivery?) => void;
+  submitCommand: (run) => Promise<WhistleExecutionOutcome | undefined>;
+  setDraft: (value) => void;
+}>;
+```
+
+Draft and prompt operations for the current conversation.
+
+---
+
+### StatusController
+
+```ts
+type StatusController = Readonly<{
+  commandId: string | undefined;
+  observation: ParakeetObservation;
+  reconnect: () => Promise<ParakeetReconnectOutcome>;
+  status: ParakeetStatus;
+  viewState: ParakeetSessionViewState;
+  context: SessionContext | undefined;
+}>;
+```
+
+Session activity, observation, and Agent-lifetime controls.
+
+---
+
+### ParakeetAuthor
+
+```ts
+type ParakeetAuthor = Readonly<{
+  id: string;
+  name: string;
+}>;
+```
+
+Who wrote a timeline line, as the host chose to show them.
+
+---
+
+### ParakeetAuthorOf
+
+```ts
+type ParakeetAuthorOf = (meta) => ParakeetAuthor | undefined;
+```
+
+The host's reading of a message's opaque metadata: the author to show, or none.
+Parakeet never interprets metadata itself.
+
+#### Parameters
+
+| Parameter | Type                         |
+| --------- | ---------------------------- |
+| `meta`    | `SessionMessage`\[`"meta"`\] |
+
+#### Returns
+
+[`ParakeetAuthor`](#parakeetauthor) \| `undefined`
+
+---
+
+### ParakeetToolArguments
+
+```ts
+type ParakeetToolArguments = JsonObject;
+```
+
+Pi's JSON argument object after the maintained Zod boundary parser.
+
+---
+
+### ToolDisclosureState
+
+```ts
+type ToolDisclosureState = Readonly<{
+  mode: "collapsed" | "default" | "expanded";
+  overrides: ReadonlyMap<string, boolean>;
+}>;
+```
+
+View-only open/closed state shared by the browser and terminal renderers.
+
+---
+
+### ParakeetToolKind
+
+```ts
+type ParakeetToolKind =
+  "code" | "command" | "edit" | "other" | "read" | "search";
+```
+
+Closed presentation vocabulary for one tool call. It is chosen from the typed
+tool name, never inferred from arguments or result text.
+
+---
+
+### ParakeetToolDiffLine
+
+```ts
+type ParakeetToolDiffLine = Readonly<{
+  kind: "add" | "context" | "remove";
+  text: string;
+}>;
+```
+
+One changed or context line of a diff hunk.
+
+---
+
+### ParakeetToolDiffHunk
+
+```ts
+type ParakeetToolDiffHunk = Readonly<{
+  header?: string;
+  lines: readonly ParakeetToolDiffLine[];
+}>;
+```
+
+One hunk: a jsdiff hunk, or one `@@` block of a Codex patch.
+
+---
+
+### ParakeetToolDiffFile
+
+```ts
+type ParakeetToolDiffFile = Readonly<{
+  operation: "add" | "delete" | "update";
+  path?: string;
+  moveTo?: string;
+  hunks: readonly ParakeetToolDiffHunk[];
+  unified: string;
+  lineNumbers: boolean;
+}>;
+```
+
+The hunks for one file.
+
+---
+
+### ParakeetToolDiffRow
+
+```ts
+type ParakeetToolDiffRow = Readonly<{
+  kind: "add" | "context" | "file" | "hunk" | "remove";
+  text: string;
+}>;
+```
+
+One display row of a diff, flattened once here so every renderer draws the same
+rows. File rows appear only when a call touches several files.
+
+---
+
+### ParakeetToolExcerptLine
+
+```ts
+type ParakeetToolExcerptLine = Readonly<{
+  number?: number;
+  text: string;
+}>;
+```
+
+One file excerpt line; the number is present only when it is known.
+
+---
+
+### ParakeetToolMatch
+
+```ts
+type ParakeetToolMatch = Readonly<{
+  location: string;
+  text: string;
+}>;
+```
+
+One search hit.
+
+---
+
+### ParakeetToolOutputLine
+
+```ts
+type ParakeetToolOutputLine = Readonly<{
+  stream: "stderr" | "stdout";
+  text: string;
+}>;
+```
+
+One line of command output, marked by the stream that produced it.
+
+---
+
+### ParakeetToolCallSection
+
+```ts
+type ParakeetToolCallSection = Readonly<
+  | {
+      kind: "excerpt";
+      lines: readonly ParakeetToolExcerptLine[];
+      preview: number;
+    }
+  | {
+      kind: "matches";
+      matches: readonly ParakeetToolMatch[];
+      preview: number;
+    }
+  | {
+      kind: "diff";
+      files: readonly ParakeetToolDiffFile[];
+      lines: readonly ParakeetToolDiffRow[];
+      preview: number;
+    }
+  | {
+      kind: "command";
+      lines: readonly string[];
+      preview: number;
+    }
+  | {
+      kind: "script";
+      lines: readonly string[];
+      preview: number;
+    }
+  | {
+      kind: "output";
+      lines: readonly ParakeetToolOutputLine[];
+      preview: number;
+    }
+  | {
+      kind: "text";
+      label?: string;
+      language?: "json";
+      lines: readonly string[];
+      preview: number;
+    }
+>;
+```
+
+One typed section of an expanded call body. Sections hold complete bounded
+content; renderers show `preview` items and offer the rest.
+
+---
+
+### ParakeetToolCallView
+
+```ts
+type ParakeetToolCallView = Readonly<{
+  id: string;
+  kind: ParakeetToolKind;
+  name: string;
+  verb: string;
+  activeVerb: string;
+  label: string;
+  paths: readonly string[];
+  status: ParakeetToolItem["status"];
+  durationMs?: number;
+  exitCode?: number;
+  error?: string;
+  sections: readonly ParakeetToolCallSection[];
+}>;
+```
+
+Renderer-neutral presentation of one tool call and its joined result.
+
+---
+
+### ParakeetVisitor
+
+```ts
+type ParakeetVisitor = Readonly<{
+  agentName: string;
+}>;
+```
+
+Public composer options for an anonymous visitor conversation.
+
+---
+
+### ParakeetProps
+
+```ts
+type ParakeetProps = Readonly<{
+  disambiguateAuthors?: boolean;
+  authorOf?: ParakeetAuthorOf;
+  visitor?: ParakeetVisitor;
+  markdownPolicy?: "session" | "visitor";
+  session: ParakeetSession;
+  clients?: readonly ClientEntryV1[];
+  composerActionVariant?: "primary" | "outline";
+  renderToolActions?: (item) => ReactNode;
+  renderAssistantAttachment?: (text) => ReactNode;
+  formatAssistantText?: (text) => string;
+  onLink?: (href) => boolean;
+  onOpen?: (target) => void;
+  empty?: ReactNode;
+  commands?: ParakeetCommandRuntime;
+}>;
+```
+
+Props for the standalone retained conversation surface.
+
+---
+
+### ParakeetViewProps
+
+```ts
+type ParakeetViewProps = Readonly<{
+  disambiguateAuthors?: boolean;
+  visitor?: ParakeetVisitor;
+  composerActionVariant?: "primary" | "outline";
+  renderToolActions?: (item) => ReactNode;
+  renderAssistantAttachment?: (text) => ReactNode;
+  formatAssistantText?: (text) => string;
+  onLink?: (href) => boolean;
+  onOpen?: (target) => void;
+  empty?: ReactNode;
+  commands?: ParakeetCommandRuntime;
+}>;
+```
+
+Props for the reusable retained conversation view.
+
+---
+
+### ParakeetPromptResult
+
+```ts
+type ParakeetPromptResult =
+  | Accepted
+  | Readonly<{
+      status: "recorded";
+    }>;
+```
+
+A prompt may be recorded for a human without admitting Agent work.
+
+---
+
+### ParakeetSessionCommand
+
+```ts
+type ParakeetSessionCommand = {
+  (input): Promise<ParakeetPromptResult>;
+  (input): Promise<CancelResult>;
+  (input): Promise<undefined>;
+  (input): Promise<
+    Readonly<{
+      sessionId: string;
+    }>
+  >;
+  (input): Promise<
+    | Readonly<{
+        status: "accepted";
+        commandId: string;
+      }>
+    | Readonly<{
+        status: "too_late";
+        commandId: string;
+      }>
+    | Readonly<{
+        sessionId: string;
+      }>
+    | Readonly<{
+        status: "recorded";
+      }>
+    | undefined
+  >;
+};
+```
+
+Session commands preserve their owner results, including held visitor lines.
+
+#### Call Signature
+
+```ts
+(input): Promise<ParakeetPromptResult>;
+```
+
+Admit Agent work or record a prompt held for a human reply.
+
+##### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                         |
+| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`   | \| \{ `delivery`: `"followUp"` \| `"steer"`; `requestId`: `string`; `type`: `"prompt"`; `text`: `string`; `images?`: readonly `object`[]; \} \| \{ `type`: `"compact"`; `requestId`: `string`; `instructions?`: `string`; \} |
+
+##### Returns
+
+`Promise`\<[`ParakeetPromptResult`](#parakeetpromptresult)\>
+
+#### Call Signature
+
+```ts
+(input): Promise<CancelResult>;
+```
+
+Cancel the named queued or running command.
+
+##### Parameters
+
+| Parameter              | Type                                                                          |
+| ---------------------- | ----------------------------------------------------------------------------- |
+| `input`                | \{ `commandId`: `string`; `onlyIfPending?`: `boolean`; `type`: `"cancel"`; \} |
+| `input.commandId`      | `string`                                                                      |
+| `input.onlyIfPending?` | `boolean`                                                                     |
+| `input.type`           | `"cancel"`                                                                    |
+
+##### Returns
+
+`Promise`\<`CancelResult`\>
+
+#### Call Signature
+
+```ts
+(input): Promise<undefined>;
+```
+
+Forward an owner-supported Session control command.
+
+##### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                |
+| --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`   | \| \{ `type`: `"abort"`; \} \| \{ `type`: `"branch"`; `entryId`: `string`; \} \| \{ `type`: `"operator"`; `requestId`: `string`; `author`: `"operator"` \| `"party"`; `text`: `string`; \} \| \{ `type`: `"title"`; `title`: `string` \| `null`; \} |
+
+##### Returns
+
+`Promise`\<`undefined`\>
+
+#### Call Signature
+
+```ts
+(input): Promise<Readonly<{
+  sessionId: string;
+}>>;
+```
+
+Return the owner-issued address of a forked Session.
+
+##### Parameters
+
+| Parameter       | Type                                         |
+| --------------- | -------------------------------------------- |
+| `input`         | \{ `type`: `"fork"`; `entryId`: `string`; \} |
+| `input.type`    | `"fork"`                                     |
+| `input.entryId` | `string`                                     |
+
+##### Returns
+
+`Promise`\<`Readonly`\<\{ `sessionId`: `string`; \}\>\>
+
+#### Call Signature
+
+```ts
+(input): Promise<
+  | Readonly<{
+  status: "accepted";
+  commandId: string;
+}>
+  | Readonly<{
+  status: "too_late";
+  commandId: string;
+}>
+  | Readonly<{
+  sessionId: string;
+}>
+  | Readonly<{
+  status: "recorded";
+}>
+| undefined>;
+```
+
+Dispatch a typed command without inventing an admission result.
+
+##### Parameters
+
+| Parameter | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
+| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `input`   | \| \{ `delivery`: `"followUp"` \| `"steer"`; `requestId`: `string`; `type`: `"prompt"`; `text`: `string`; `images?`: readonly `object`[]; \} \| \{ `type`: `"abort"`; \} \| \{ `commandId`: `string`; `onlyIfPending?`: `boolean`; `type`: `"cancel"`; \} \| \{ `type`: `"branch"`; `entryId`: `string`; \} \| \{ `type`: `"fork"`; `entryId`: `string`; \} \| \{ `type`: `"operator"`; `requestId`: `string`; `author`: `"operator"` \| `"party"`; `text`: `string`; \} \| \{ `type`: `"compact"`; `requestId`: `string`; `instructions?`: `string`; \} \| \{ `type`: `"title"`; `title`: `string` \| `null`; \} |
+
+##### Returns
+
+`Promise`\< \| `Readonly`\<\{ `status`: `"accepted"`; `commandId`: `string`;
+\}\> \| `Readonly`\<\{ `status`: `"too_late"`; `commandId`: `string`; \}\> \|
+`Readonly`\<\{ `sessionId`: `string`; \}\> \| `Readonly`\<\{ `status`:
+`"recorded"`; \}\> \| `undefined`\>
+
+---
+
+### ParakeetSession
+
+```ts
+type ParakeetSession = Readonly<
+  Pick<ShiitakeSession, "address" | "extension" | "read" | "watch"> & object
+>;
+```
+
+The exact Shiitake operations consumed by the retained conversation UI.
+
+---
+
+### ParakeetUserMessageItem
+
+```ts
+type ParakeetUserMessageItem = Readonly<{
+  author?: ParakeetAuthor;
+  origin?: SessionMessage["origin"];
+  id: string;
+  kind: "user_message";
+  requestId?: string;
+  commandId?: string;
+  status: "pending" | "accepted" | "queued" | "failed" | "confirmed";
+  delivery?: PromptDelivery;
+  error?: string;
+  at?: number;
+  text: string;
+}>;
+```
+
+One user prompt projected into the conversation timeline.
+
+---
+
+### ParakeetAssistantMessageItem
+
+```ts
+type ParakeetAssistantMessageItem = Readonly<{
+  author?: ParakeetAuthor;
+  id: string;
+  kind: "assistant_message";
+  isError?: boolean;
+  pending: boolean;
+  at?: number;
+  text: string;
+  thinking?: string;
+  usage?: Readonly<{
+    cost: number;
+    tokens: number;
+  }>;
+}>;
+```
+
+One assistant message projected from exact stored Pi content.
+
+---
+
+### ParakeetToolItem
+
+```ts
+type ParakeetToolItem = Readonly<{
+  args: Readonly<ParakeetToolArguments>;
+  id: string;
+  kind: "tool";
+  name: string;
+  result?: ToolResultMessage;
+  startedAt?: number;
+  status: "completed" | "error" | "running" | "unknown";
+}>;
+```
+
+One Pi tool call joined with its corresponding tool result.
+
+---
+
+### ParakeetToolGroupItem
+
+```ts
+type ParakeetToolGroupItem = Readonly<{
+  active?: ParakeetToolCallView;
+  calls: readonly ParakeetToolCallView[];
+  durationMs?: number;
+  failedCount: number;
+  id: string;
+  kind: "tool_group";
+  status: "completed" | "error" | "running" | "unknown";
+  summary: string;
+  tools: readonly ParakeetToolItem[];
+}>;
+```
+
+One maximal run of consecutive tool calls between conversation rows. A lone call
+is a group of one. Grouping is computed once by the headless projection.
+
+---
+
+### ParakeetTimelineItem
+
+```ts
+type ParakeetTimelineItem =
+  | ParakeetAssistantMessageItem
+  | {
+      id: string;
+      kind: "compaction_divider";
+      at: number;
+      tokensBefore: number;
+      tokensAfter: number | null;
+    }
+  | {
+      id: string;
+      kind: "compaction_notice";
+      at: number;
+      trigger: SessionCompactionTrigger;
+      result: "failed" | "nothing_to_compact";
+      diagnostic: string | null;
+    }
+  | ParakeetToolGroupItem
+  | ParakeetUserMessageItem;
+```
+
+Stable row grammar rendered by Parakeet's timeline.
+
+#### Union Members
+
+[`ParakeetAssistantMessageItem`](#parakeetassistantmessageitem)
+
+---
+
+##### Type Literal
+
+```ts
+{
+  id: string;
+  kind: "compaction_divider";
+  at: number;
+  tokensBefore: number;
+  tokensAfter: number | null;
+}
+```
+
+| Name           | Type                   | Description                                                          |
+| -------------- | ---------------------- | -------------------------------------------------------------------- |
+| `id`           | `string`               | Stable rendered-item identity, from the durable compaction entry.    |
+| `kind`         | `"compaction_divider"` | Compaction-divider timeline discriminator.                           |
+| `at`           | `number`               | When the compaction ran, in milliseconds since the epoch.            |
+| `tokensBefore` | `number`               | Estimated context tokens the compaction started from.                |
+| `tokensAfter`  | `number` \| `null`     | Estimated context tokens right after it; null for older compactions. |
+
+---
+
+##### Type Literal
+
+```ts
+{
+  id: string;
+  kind: "compaction_notice";
+  at: number;
+  trigger: SessionCompactionTrigger;
+  result: "failed" | "nothing_to_compact";
+  diagnostic: string | null;
+}
+```
+
+| Name         | Type                                 | Description                                                       |
+| ------------ | ------------------------------------ | ----------------------------------------------------------------- |
+| `id`         | `string`                             | Stable rendered-item identity, from the durable notice entry.     |
+| `kind`       | `"compaction_notice"`                | Compaction-notice timeline discriminator.                         |
+| `at`         | `number`                             | When it was recorded, in milliseconds since the epoch.            |
+| `trigger`    | `SessionCompactionTrigger`           | What started it: the user, the context threshold, or an overflow. |
+| `result`     | `"failed"` \| `"nothing_to_compact"` | What the compaction did: nothing to summarize, or a failure.      |
+| `diagnostic` | `string` \| `null`                   | A failure's bounded reason; null for "nothing to compact".        |
+
+---
+
+[`ParakeetToolGroupItem`](#parakeettoolgroupitem)
+
+---
+
+[`ParakeetUserMessageItem`](#parakeetusermessageitem)
+
+## Variables
+
+### AgentHead
+
+```ts
+const AgentHead: NamedExoticComponent<{
+  activity?: AgentHeadActivity;
+  avatar: {
+    v: 1;
+    character: "mushroom" | "cat" | "burger";
+    appearance: z.ZodRecord<
+      z.ZodString,
+      z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>
+    >;
+    expression: string;
+    renderStyle:
+      | "plain"
+      | "pencil"
+      | "manga"
+      | "riso"
+      | "halftone"
+      | "blueprint"
+      | "crt"
+      | "watercolor";
+  };
+  className?: string;
+  name: string;
+  size?: number;
+}>;
+```
+
+An Agent's head at avatar size, drawn from the Agent's own avatar (a property of
+the Agent record, never of a conversation). The letter shows until a frame is
+ready. The live canvas stays mounted and is paused unless `thinking` or
+`speaking`, so an idle head shows its real look without animating.
+
+---
+
+### ShiitakeAvatar
+
+```ts
+const ShiitakeAvatar: NamedExoticComponent<{
+  avatar?: {
+    v: 1;
+    character: "mushroom" | "cat" | "burger";
+    appearance: z.ZodRecord<
+      z.ZodString,
+      z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>
+    >;
+    expression: string;
+    renderStyle:
+      | "plain"
+      | "pencil"
+      | "manga"
+      | "riso"
+      | "halftone"
+      | "blueprint"
+      | "crt"
+      | "watercolor";
+  } | null;
+  className?: string;
+  service?: SpriteService;
+  state: AvatarState;
+}>;
+```
+
+A sprite head drawn in the live activity and expression it is given. With an
+`avatar` it draws that look (a member's own, in their settings); with none it is
+Shiitake, the product mascot, in the character's own defaults. Conversations
+have no avatar: an Agent's head is `AgentHead`, drawn from the Agent record.
+
+---
+
+### initialToolDisclosure
+
+```ts
+const initialToolDisclosure: ToolDisclosureState;
+```
+
+Defaults only, with no reader choices.
+
+## Functions
+
+### InteractionPanel()
+
+```ts
+function InteractionPanel(__namedParameters): Element;
+```
+
+Browser renderer for one Whistle interaction. It draws the same host snapshot
+the terminal draws; the command, not the page, defines the steps.
+
+#### Parameters
+
+| Parameter           | Type                                              |
+| ------------------- | ------------------------------------------------- |
+| `__namedParameters` | [`InteractionPanelProps`](#interactionpanelprops) |
+
+#### Returns
+
+`Element`
+
+---
+
+### ParakeetProvider()
+
+```ts
+function ParakeetProvider(__namedParameters): Element;
+```
+
+Own one renderer-neutral conversation scope over the existing query cache.
+
+#### Parameters
+
+| Parameter           | Type                                                                                                                                                                                                                                                                          |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `__namedParameters` | `Readonly`\<\{ `children`: `ReactNode`; `session`: [`ParakeetSession`](#parakeetsession); `clients?`: readonly `ClientEntryV1`[]; `interactionStore?`: [`ParakeetInteractions`](headless.md#parakeetinteractions); `authorOf?`: [`ParakeetAuthorOf`](#parakeetauthorof); \}\> |
+
+#### Returns
+
+`Element`
+
+---
+
+### useTimeline()
+
+```ts
+function useTimeline(): TimelineController;
+```
+
+Read stable history and replaceable live work.
+
+#### Returns
+
+[`TimelineController`](#timelinecontroller)
+
+---
+
+### useComposer()
+
+```ts
+function useComposer(): ComposerController;
+```
+
+Read and mutate the current conversation draft and prompt.
+
+#### Returns
+
+[`ComposerController`](#composercontroller)
+
+---
+
+### useStatus()
+
+```ts
+function useStatus(): StatusController;
+```
+
+Read Session activity and operate its observation.
+
+#### Returns
+
+[`StatusController`](#statuscontroller)
+
+---
+
+### formatTokenCount()
+
+```ts
+function formatTokenCount(tokens): string;
+```
+
+One token count, compacted for a narrow readout, e.g. `182000` to `182K`. Shared
+by the context footer and the compaction divider and notices.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `tokens`  | `number` |
+
+#### Returns
+
+`string`
+
+---
+
+### formatContextUsage()
+
+```ts
+function formatContextUsage(context): string;
+```
+
+Context used over the model's window, e.g. `12K/200K`, shared by the browser and
+terminal footers. An unknown window shows the tokens alone.
+
+#### Parameters
+
+| Parameter | Type             |
+| --------- | ---------------- |
+| `context` | `SessionContext` |
+
+#### Returns
+
+`string`
+
+---
+
+### formatModelIdentity()
+
+```ts
+function formatModelIdentity(model): string;
+```
+
+The durable assistant's provider/model ids, shared by browser and terminal.
+
+#### Parameters
+
+| Parameter | Type                              |
+| --------- | --------------------------------- |
+| `model`   | [`ParakeetModel`](#parakeetmodel) |
+
+#### Returns
+
+`string`
+
+---
+
+### toolGroupDefaultOpen()
+
+```ts
+function toolGroupDefaultOpen(group): boolean;
+```
+
+Active and failed groups show every call; clean history retains a visible tail.
+
+#### Parameters
+
+| Parameter | Type                                              |
+| --------- | ------------------------------------------------- |
+| `group`   | [`ParakeetToolGroupItem`](#parakeettoolgroupitem) |
+
+#### Returns
+
+`boolean`
+
+---
+
+### visibleToolCalls()
+
+```ts
+function visibleToolCalls(
+  group,
+  open,
+): readonly Readonly<{
+  id: string;
+  kind: ParakeetToolKind;
+  name: string;
+  verb: string;
+  activeVerb: string;
+  label: string;
+  paths: readonly string[];
+  status: "error" | "unknown" | "completed" | "running";
+  durationMs?: number;
+  exitCode?: number;
+  error?: string;
+  sections: readonly ParakeetToolCallSection[];
+}>[];
+```
+
+Even a folded group shows recent calls, rather than hiding all tool work.
+
+#### Parameters
+
+| Parameter | Type                                              |
+| --------- | ------------------------------------------------- |
+| `group`   | [`ParakeetToolGroupItem`](#parakeettoolgroupitem) |
+| `open`    | `boolean`                                         |
+
+#### Returns
+
+readonly `Readonly`\<\{ `id`: `string`; `kind`:
+[`ParakeetToolKind`](#parakeettoolkind); `name`: `string`; `verb`: `string`;
+`activeVerb`: `string`; `label`: `string`; `paths`: readonly `string`[];
+`status`: `"error"` \| `"unknown"` \| `"completed"` \| `"running"`;
+`durationMs?`: `number`; `exitCode?`: `number`; `error?`: `string`; `sections`:
+readonly [`ParakeetToolCallSection`](#parakeettoolcallsection)[]; \}\>[]
+
+---
+
+### toolCallDefaultOpen()
+
+```ts
+function toolCallDefaultOpen(call): boolean;
+```
+
+A failed call opens by default so its error is visible.
+
+#### Parameters
+
+| Parameter | Type                                            |
+| --------- | ----------------------------------------------- |
+| `call`    | [`ParakeetToolCallView`](#parakeettoolcallview) |
+
+#### Returns
+
+`boolean`
+
+---
+
+### disclosureOpen()
+
+```ts
+function disclosureOpen(state, id, defaultOpen): boolean;
+```
+
+Whether a group or call is currently open.
+
+#### Parameters
+
+| Parameter     | Type                                          |
+| ------------- | --------------------------------------------- |
+| `state`       | [`ToolDisclosureState`](#tooldisclosurestate) |
+| `id`          | `string`                                      |
+| `defaultOpen` | `boolean`                                     |
+
+#### Returns
+
+`boolean`
+
+---
+
+### toggleDisclosure()
+
+```ts
+function toggleDisclosure(state, id, defaultOpen): ToolDisclosureState;
+```
+
+Flip one group or call, recording the reader's explicit choice.
+
+#### Parameters
+
+| Parameter     | Type                                          |
+| ------------- | --------------------------------------------- |
+| `state`       | [`ToolDisclosureState`](#tooldisclosurestate) |
+| `id`          | `string`                                      |
+| `defaultOpen` | `boolean`                                     |
+
+#### Returns
+
+[`ToolDisclosureState`](#tooldisclosurestate)
+
+---
+
+### toggleAllDisclosure()
+
+```ts
+function toggleAllDisclosure(state): ToolDisclosureState;
+```
+
+Expand everything, or collapse everything when the reader has expanded anything.
+Either way individual choices are cleared.
+
+#### Parameters
+
+| Parameter | Type                                          |
+| --------- | --------------------------------------------- |
+| `state`   | [`ToolDisclosureState`](#tooldisclosurestate) |
+
+#### Returns
+
+[`ToolDisclosureState`](#tooldisclosurestate)
+
+---
+
+### formatToolDuration()
+
+```ts
+function formatToolDuration(milliseconds): string;
+```
+
+Compact duration: `340ms`, `1.2s`, `2m 5s`.
+
+#### Parameters
+
+| Parameter      | Type     |
+| -------------- | -------- |
+| `milliseconds` | `number` |
+
+#### Returns
+
+`string`
+
+---
+
+### useMarkdown()
+
+```ts
+function useMarkdown(content): MarkdownDocument;
+```
+
+Parse chat Markdown for headless hosts, including terminal presentation.
+
+#### Parameters
+
+| Parameter | Type     |
+| --------- | -------- |
+| `content` | `string` |
+
+#### Returns
+
+`MarkdownDocument`
+
+---
+
+### ParakeetView()
+
+```ts
+function ParakeetView(__namedParameters): ReactElement;
+```
+
+Render the retained conversation surface within one Parakeet provider.
+
+#### Parameters
+
+| Parameter           | Type                                      |
+| ------------------- | ----------------------------------------- |
+| `__namedParameters` | [`ParakeetViewProps`](#parakeetviewprops) |
+
+#### Returns
+
+`ReactElement`
+
+---
+
+### Parakeet()
+
+```ts
+function Parakeet(__namedParameters): ReactElement;
+```
+
+Standalone typed composer and exact-message timeline.
+
+#### Parameters
+
+| Parameter           | Type                              |
+| ------------------- | --------------------------------- |
+| `__namedParameters` | [`ParakeetProps`](#parakeetprops) |
+
+#### Returns
+
+`ReactElement`