@fungi.computer/whistle 0.0.0-stage → 0.0.1

package/docs/api/interaction.md

@@ -0,0 +1,124 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/whistle**](README.md)
+
+---
+
+[@fungi.computer/whistle](README.md) / interaction
+
+# interaction
+
+## Type Aliases
+
+### WhistleInteractionStatus
+
+```ts
+type WhistleInteractionStatus =
+  "working" | "prompting" | "failed" | "done" | "cancelled";
+```
+
+Where one interaction is in its life.
+
+---
+
+### WhistlePendingPrompt
+
+```ts
+type WhistlePendingPrompt = Readonly<{
+  sequence: number;
+  request: WhistlePrompt;
+}>;
+```
+
+The one pending question, with the sequence its answer must name.
+
+---
+
+### WhistleMessageNotice
+
+```ts
+type WhistleMessageNotice = Extract<
+  WhistleNotice,
+  Readonly<{
+    type: "info" | "progress" | "success";
+  }>
+>;
+```
+
+A notice that carries a message line.
+
+---
+
+### WhistleHandoffNotice
+
+```ts
+type WhistleHandoffNotice = Extract<
+  WhistleNotice,
+  Readonly<{
+    type: "handoff";
+  }>
+>;
+```
+
+A "continue elsewhere" notice.
+
+---
+
+### WhistleInteractionSnapshot
+
+```ts
+type WhistleInteractionSnapshot = Readonly<{
+  title: string;
+  status: WhistleInteractionStatus;
+  message?: WhistleMessageNotice;
+  handoff?: WhistleHandoffNotice;
+  links: readonly WhistleNoticeLink[];
+  prompt?: WhistlePendingPrompt;
+  failure?: string;
+}>;
+```
+
+Everything a renderer needs to draw one interaction.
+
+---
+
+### WhistleInteractionHost
+
+```ts
+type WhistleInteractionHost = Readonly<{
+  snapshot: () => WhistleInteractionSnapshot;
+  subscribe: (listener) => () => void;
+  begin: () => WhistleInteractionSession;
+  answer: (sequence, value) => boolean;
+  cancel: () => void;
+}>;
+```
+
+A renderer-neutral store behind one interaction dialog or panel.
+
+## Functions
+
+### createWhistleInteractionHost()
+
+```ts
+function createWhistleInteractionHost(options): WhistleInteractionHost;
+```
+
+Own one interaction's state for any renderer. Prompts and notices are parsed
+here, at the boundary where command-supplied data becomes UI.
+
+#### Parameters
+
+| Parameter | Type                                                                |
+| --------- | ------------------------------------------------------------------- |
+| `options` | `Readonly`\<\{ `title`: `string`; `onEnd?`: (`end`) => `void`; \}\> |
+
+#### Returns
+
+[`WhistleInteractionHost`](#whistleinteractionhost)
+
+## References
+
+### interactionTextLimit
+
+Re-exports [interactionTextLimit](wire.md#interactiontextlimit)