@fungi.computer/parakeet 0.0.0-stage → 0.1.0

package/docs/api/README.md

@@ -0,0 +1,15 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+**@fungi.computer/parakeet**
+
+---
+
+# @fungi.computer/parakeet
+
+## Modules
+
+| Module                              | Description |
+| ----------------------------------- | ----------- |
+| [commands/slash](commands/slash.md) | -           |
+| [headless](headless.md)             | -           |
+| [index](index.md)                   | -           |

package/docs/api/commands/slash.md

@@ -0,0 +1,321 @@
+<!-- Generated by Botanical API docs (TypeDoc + typedoc-plugin-markdown). Do not edit. -->
+
+[**@fungi.computer/parakeet**](../README.md)
+
+---
+
+[@fungi.computer/parakeet](../README.md) / commands/slash
+
+# commands/slash
+
+## Type Aliases
+
+### SlashCommand
+
+```ts
+type SlashCommand = Readonly<{
+  alias: string;
+  commandId: string;
+  title: string;
+  description?: string;
+  category: string;
+  order: number;
+  grammar?: WhistleSlashArguments;
+  keys: readonly string[];
+  availability: WhistleAvailability;
+}>;
+```
+
+One slash command as every Parakeet renderer lists it.
+
+---
+
+### KeyBindingRow
+
+```ts
+type KeyBindingRow = Readonly<{
+  commandId: string;
+  keys: string;
+  title: string;
+  order: number;
+}>;
+```
+
+One key binding as help and hint surfaces list it.
+
+---
+
+### SlashParse
+
+```ts
+type SlashParse =
+  | Readonly<{
+      kind: "prompt";
+    }>
+  | Readonly<{
+      kind: "command";
+      command: SlashCommand;
+      arguments?: WhistleJsonObject;
+      requestIdField?: string;
+    }>
+  | Readonly<{
+      kind: "invalid";
+      message: string;
+    }>;
+```
+
+How one composer draft maps to a command.
+
+---
+
+### SlashCommandItem
+
+```ts
+type SlashCommandItem = Readonly<{
+  command: SlashCommand;
+  label: string;
+  matches: readonly number[];
+  insert: string;
+}>;
+```
+
+One command offered while the alias is being typed.
+
+---
+
+### SlashWordItem
+
+```ts
+type SlashWordItem = Readonly<{
+  word: WhistleSlashWord;
+  label: string;
+  matches: readonly number[];
+  insert: string;
+}>;
+```
+
+One argument word offered after the alias.
+
+---
+
+### SlashCompletion
+
+```ts
+type SlashCompletion =
+  | Readonly<{
+      kind: "none";
+    }>
+  | Readonly<{
+      kind: "commands";
+      query: string;
+      items: readonly SlashCommandItem[];
+    }>
+  | Readonly<{
+      kind: "arguments";
+      command: SlashCommand;
+      query: string;
+      hint: string;
+      items: readonly SlashWordItem[];
+    }>;
+```
+
+What a composer shows for the current draft.
+
+---
+
+### FuzzyMatch
+
+```ts
+type FuzzyMatch = Readonly<{
+  tier: number;
+  spread: number;
+  indices: number[];
+}>;
+```
+
+How well one candidate matched a query; lower tiers and spreads rank first.
+
+## Functions
+
+### keyLabel()
+
+```ts
+function keyLabel(binding, mac?): string;
+```
+
+Human key labels from Whistle bindings, with the platform's modifier name.
+
+#### Parameters
+
+| Parameter | Type      |
+| --------- | --------- |
+| `binding` | `string`  |
+| `mac`     | `boolean` |
+
+#### Returns
+
+`string`
+
+---
+
+### slashRegistry()
+
+```ts
+function slashRegistry(snapshot): readonly Readonly<{
+  alias: string;
+  commandId: string;
+  title: string;
+  description?: string;
+  category: string;
+  order: number;
+  grammar?: {
+     hint: string;
+     words?: readonly object[];
+     text?: {
+        field: string;
+        arguments: {
+         [key: string]:
+           | string
+           | number
+           | boolean
+           | readonly string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | ... 4 more ... | null)[] | { ...; } | null)[] | { ...; } | null)[] | { ...; } | ...[]
+           | {
+         [key: string]: string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | number | boolean | readonly (string | ... 4 more ... | null)[] | { ...; } | null)[] | { ...; } | null)[] | { ...; } | ...;
+         }
+           | null;
+        };
+        requestIdField?: string;
+     };
+  };
+  keys: readonly string[];
+  availability: WhistleAvailability;
+}>[];
+```
+
+Every slash alias in the live graph, with the keys bound to its command.
+
+#### Parameters
+
+| Parameter  | Type              |
+| ---------- | ----------------- |
+| `snapshot` | `WhistleSnapshot` |
+
+#### Returns
+
+readonly `Readonly`\<\{ `alias`: `string`; `commandId`: `string`; `title`:
+`string`; `description?`: `string`; `category`: `string`; `order`: `number`;
+`grammar?`: \{ `hint`: `string`; `words?`: readonly `object`[]; `text?`: \{
+`field`: `string`; `arguments`: \{ \[`key`: `string`\]: \| `string` \| `number`
+\| `boolean` \| readonly string \| number \| boolean \| readonly (string \|
+number \| boolean \| readonly (string \| number \| boolean \| readonly (string
+\| number \| boolean \| readonly (string \| number \| boolean \| readonly
+(string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\]
+\| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \|
+\{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \|
+number \| boolean \| readonly (string \| number \| boolean \| readonly (string
+\| number \| boolean \| readonly (string \| number \| boolean \| readonly
+(string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\]
+\| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \}
+\| `null`; \}; `requestIdField?`: `string`; \}; \}; `keys`: readonly `string`[];
+`availability`: `WhistleAvailability`; \}\>[]
+
+---
+
+### keyBindings()
+
+```ts
+function keyBindings(snapshot): readonly Readonly<{
+  commandId: string;
+  keys: string;
+  title: string;
+  order: number;
+}>[];
+```
+
+Every bound key in the live graph, grouped by command.
+
+#### Parameters
+
+| Parameter  | Type              |
+| ---------- | ----------------- |
+| `snapshot` | `WhistleSnapshot` |
+
+#### Returns
+
+readonly `Readonly`\<\{ `commandId`: `string`; `keys`: `string`; `title`:
+`string`; `order`: `number`; \}\>[]
+
+---
+
+### parseSlashDraft()
+
+```ts
+function parseSlashDraft(registry, draft): SlashParse;
+```
+
+Parse one draft against the registry; only a leading `/` names a command.
+
+#### Parameters
+
+| Parameter  | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `registry` | readonly `Readonly`\<\{ `alias`: `string`; `commandId`: `string`; `title`: `string`; `description?`: `string`; `category`: `string`; `order`: `number`; `grammar?`: \{ `hint`: `string`; `words?`: readonly `object`[]; `text?`: \{ `field`: `string`; `arguments`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `requestIdField?`: `string`; \}; \}; `keys`: readonly `string`[]; `availability`: `WhistleAvailability`; \}\>[] |
+| `draft`    | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+
+#### Returns
+
+[`SlashParse`](#slashparse)
+
+---
+
+### fuzzyMatch()
+
+```ts
+function fuzzyMatch(
+  candidate,
+  query,
+):
+  | Readonly<{
+      tier: number;
+      spread: number;
+      indices: number[];
+    }>
+  | undefined;
+```
+
+Fuzzy match: a prefix beats a word start beats a substring beats an in-order
+subsequence; tighter subsequences rank first.
+
+#### Parameters
+
+| Parameter   | Type     |
+| ----------- | -------- |
+| `candidate` | `string` |
+| `query`     | `string` |
+
+#### Returns
+
+\| `Readonly`\<\{ `tier`: `number`; `spread`: `number`; `indices`: `number`[];
+\}\> \| `undefined`
+
+---
+
+### completeSlash()
+
+```ts
+function completeSlash(registry, draft, options?): SlashCompletion;
+```
+
+Rank completions for one draft; renderers draw exactly these rows.
+
+#### Parameters
+
+| Parameter  | Type                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
+| ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `registry` | readonly `Readonly`\<\{ `alias`: `string`; `commandId`: `string`; `title`: `string`; `description?`: `string`; `category`: `string`; `order`: `number`; `grammar?`: \{ `hint`: `string`; `words?`: readonly `object`[]; `text?`: \{ `field`: `string`; `arguments`: \{ \[`key`: `string`\]: \| `string` \| `number` \| `boolean` \| readonly string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...[] \| \{ \[`key`: `string`\]: string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| number \| boolean \| readonly (string \| ... 4 more ... \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| null)\[\] \| \{ ...; \} \| ...; \} \| `null`; \}; `requestIdField?`: `string`; \}; \}; `keys`: readonly `string`[]; `availability`: `WhistleAvailability`; \}\>[] |
+| `draft`    | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| `options`  | `Readonly`\<\{ `idleCategory?`: `string`; \}\>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+
+#### Returns
+
+[`SlashCompletion`](#slashcompletion)