@neosh/api 0.1.0

package/src/generated/ExtmarkOpts.ts

@@ -0,0 +1,33 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { OnDelete } from "./OnDelete";
+import type { VirtChunk } from "./VirtChunk";
+import type { VirtTextPos } from "./VirtTextPos";
+
+export type ExtmarkOpts = {
+  /**
+   * End column for a ranged highlight, as a UTF-8 byte offset. `None` means a point mark.
+   */
+  end_col?: number | null;
+  hl_group?: string | null;
+  /**
+   * A background for the whole rendered row, not just the bytes the mark covers.
+   *
+   * The distinction is the difference between a diff line that is green and a diff line whose
+   * *text* is green: the band has to reach the right edge of the window to read as one line, and
+   * how wide the window is is not known where the row is written. So the group is carried and
+   * the frontend fills to its own edge — which is also what makes the band survive a resize.
+   *
+   * It sits *under* every ranged `hl_group` on the row rather than competing with them, so a
+   * syntax colour on top keeps its foreground and inherits this background. Nothing else in the
+   * mark vocabulary composes; this one has to, because "which line changed" and "what does this
+   * word mean" are two facts about the same character.
+   */
+  line_hl_group?: string | null;
+  virt_text?: Array<VirtChunk>;
+  virt_text_pos: VirtTextPos;
+  on_delete: OnDelete;
+  /**
+   * Higher priority draws over lower when marks overlap.
+   */
+  priority: number;
+};

package/src/generated/ExtmarkRender.ts

@@ -0,0 +1,44 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ExtmarkId } from "./ExtmarkId";
+import type { NamespaceId } from "./NamespaceId";
+import type { OnDelete } from "./OnDelete";
+import type { VirtChunk } from "./VirtChunk";
+import type { VirtTextPos } from "./VirtTextPos";
+
+/**
+ * A mark as it appears on the wire, already resolved to a column on a specific line.
+ */
+export type ExtmarkRender = {
+  ns: NamespaceId;
+  id: ExtmarkId;
+  /**
+   * UTF-8 byte offset into the line. The frontend converts to a display column.
+   */
+  col: number;
+  /**
+   * End column for a ranged highlight, as a UTF-8 byte offset. `None` means a point mark.
+   */
+  end_col?: number | null;
+  hl_group?: string | null;
+  /**
+   * A background for the whole rendered row, not just the bytes the mark covers.
+   *
+   * The distinction is the difference between a diff line that is green and a diff line whose
+   * *text* is green: the band has to reach the right edge of the window to read as one line, and
+   * how wide the window is is not known where the row is written. So the group is carried and
+   * the frontend fills to its own edge — which is also what makes the band survive a resize.
+   *
+   * It sits *under* every ranged `hl_group` on the row rather than competing with them, so a
+   * syntax colour on top keeps its foreground and inherits this background. Nothing else in the
+   * mark vocabulary composes; this one has to, because "which line changed" and "what does this
+   * word mean" are two facts about the same character.
+   */
+  line_hl_group?: string | null;
+  virt_text?: Array<VirtChunk>;
+  virt_text_pos: VirtTextPos;
+  on_delete: OnDelete;
+  /**
+   * Higher priority draws over lower when marks overlap.
+   */
+  priority: number;
+};

package/src/generated/FileChange.ts

@@ -0,0 +1,18 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { FileState } from "./FileState";
+
+export type FileChange = {
+  path: string;
+  /**
+   * Set only for renames and copies.
+   */
+  from?: string | null;
+  /**
+   * State of the staged copy, if the path is staged at all.
+   */
+  staged?: FileState | null;
+  /**
+   * State of the working-tree copy, if it differs from the index.
+   */
+  unstaged?: FileState | null;
+};

package/src/generated/FileState.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * What happened to one path, as reported by `git status --porcelain=v2`.
+ */
+export type FileState =
+  | "added"
+  | "modified"
+  | "deleted"
+  | "renamed"
+  | "copied"
+  | "type_changed"
+  | "untracked"
+  | "ignored"
+  | "conflicted";

package/src/generated/FloatConfig.ts

@@ -0,0 +1,63 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Anchor } from "./Anchor";
+import type { BorderStyle } from "./BorderStyle";
+import type { Extent } from "./Extent";
+import type { Offset } from "./Offset";
+
+/**
+ * The highest-leverage primitive in the system. Pickers, completion, hover, permission prompts and
+ * keybinding hints are all this one type with different fields set.
+ */
+export type FloatConfig = {
+  anchor: Anchor;
+  offset: Offset;
+  width: Extent;
+  height: Extent;
+  /**
+   * Higher draws on top. Ties break by open order.
+   */
+  z: number;
+  border: BorderStyle;
+  /**
+   * Semantic highlight group for the border, e.g. `"MyPlugin.Border"`.
+   */
+  border_hl?: string | null;
+  title?: string | null;
+  /**
+   * Close automatically when focus moves elsewhere. The right default for pickers and hovers.
+   */
+  close_on_blur: boolean;
+  /**
+   * Whether the float can take focus at all. `false` for passive hints and hover cards.
+   */
+  focusable: boolean;
+  /**
+   * While this float has focus, global bindings stop resolving.
+   *
+   * # Why this is not "bind over the keys you care about"
+   *
+   * That is what every panel here did, and it only ever worked for the keys the panel itself
+   * used. A widget shadows `<C-n>` because *it* wants `<C-n>` for "next" — so `<C-t>`, `<C-g>`,
+   * `<C-l>` and the rest still fell through to the workspace, and pressing one over an open
+   * picker opened a second panel behind the first and left focus somewhere neither of them
+   * expected. A control that is on screen for two seconds cannot be asked to enumerate every
+   * key the program will ever bind; the question it can answer is "does anything else reach me",
+   * and the answer for a panel you are answering a question with is no.
+   *
+   * Window, buffer and kind scopes still resolve, so a modal is exactly as extensible as any
+   * other panel: a third party binds against its **kind** and that binding is nearer than a
+   * global one, which is the ordering [`KeymapScope`](crate::KeymapScope) already promises.
+   *
+   * # The escape hatches survive
+   *
+   * `ui.modal_escape_keys` — `<C-q>` and `<C-r>` by default — resolve globally anyway. A modal
+   * that failed to bind a way out would otherwise be a terminal you have to kill, and "the
+   * panel is buggy" must never be the same event as "the program is gone". It is an option
+   * rather than a constant because which keys those are is the user's, like every other key
+   * here.
+   *
+   * A key nothing claimed is *swallowed* rather than reported unhandled: a modal that let
+   * characters through to the composer would be typing into a field you cannot see.
+   */
+  modal: boolean;
+};

package/src/generated/FrameSet.ts

@@ -0,0 +1,9 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * The glyphs a [`Animation::Frames`] cycles through.
+ *
+ * Named rather than carried, so the frontend can answer the two questions a plugin cannot: what
+ * this terminal can draw, and how wide it comes out. Adding one here is adding it for everybody.
+ */
+export type FrameSet = "braille" | "dots" | "bars" | "arc" | "corners";

package/src/generated/Gravity.ts

@@ -0,0 +1,11 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Which end of a window short content settles against.
+ *
+ * A layout property rather than a rendering trick, so it survives the trip through the protocol and
+ * a different frontend resolves it the same way. `End` is what makes a transcript read as a
+ * conversation: three exchanges should sit just above the field you are typing into, not stranded
+ * at the top of an empty screen with the composer a long way below them.
+ */
+export type Gravity = "start" | "end";

package/src/generated/HighlightDef.ts

@@ -0,0 +1,13 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { HighlightSpec } from "./HighlightSpec";
+
+/**
+ * Plugins declare semantic names, never colors directly.
+ *
+ * [`HighlightDef::Link`] is what makes a plugin look correct under a theme its author never saw:
+ * `MyPlugin.Border -> Float.Border` inherits whatever the active theme decided borders look like.
+ */
+export type HighlightDef = { "kind": "link"; to: string } | {
+  "kind": "spec";
+  spec: HighlightSpec;
+};

package/src/generated/HighlightEntry.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { HighlightDef } from "./HighlightDef";
+
+/**
+ * One highlight group as [`ApiCall::HlList`] reports it.
+ */
+export type HighlightEntry = {
+  name: string;
+  def: HighlightDef;
+  /**
+   * The plugin that defined it, or `None` for the theme's own.
+   */
+  owner?: string | null;
+};

package/src/generated/HighlightSpec.ts

@@ -0,0 +1,19 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Animation } from "./Animation";
+import type { Color } from "./Color";
+
+export type HighlightSpec = {
+  fg?: Color | null;
+  bg?: Color | null;
+  /**
+   * Motion. Ignored when `ui.motion` is off, which is why it is a hint on the group rather than
+   * a promise to the plugin that set it.
+   */
+  animate?: Animation | null;
+  bold: boolean;
+  italic: boolean;
+  underline: boolean;
+  reverse: boolean;
+  dim: boolean;
+  strikethrough: boolean;
+};

package/src/generated/Hint.ts

@@ -0,0 +1,18 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * One shortcut, as it reads on the row under the composer.
+ *
+ * Split into the key and what it does rather than one pre-formatted string, because the row has to
+ * survive a narrow terminal: labels are dropped before keys are, and that decision cannot be made
+ * once the two have been glued together. The key is written the way the user would press it —
+ * `^P`, `⏎`, `esc` — which is the frontend's spelling of a binding, not the core's `<C-p>`.
+ */
+export type Hint = {
+  keys: string;
+  label: string;
+  /**
+   * Lower sorts first. Ties break by key, so the row does not reshuffle when a plugin reloads.
+   */
+  priority: number;
+};

package/src/generated/HlTarget.ts

@@ -0,0 +1,10 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { WindowId } from "./WindowId";
+
+/**
+ * What a highlight remap applies to. See [`ApiCall::WinSetHighlights`].
+ */
+export type HlTarget = { "kind": "window"; win: WindowId } | {
+  "kind": "kind";
+  name: string;
+};

package/src/generated/HookInvocation.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { HookName } from "./HookName";
+import type { HookPayload } from "./HookPayload";
+import type { RequestId } from "./RequestId";
+
+/**
+ * Identifies which hook payload a plugin is being asked about, paired with a request id so the
+ * host can match the answer.
+ */
+export type HookInvocation = {
+  request: RequestId;
+  hook: HookName;
+  payload: HookPayload;
+};

package/src/generated/HookName.ts

@@ -0,0 +1,17 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Pre/post hook points. Every meaningful action has one.
+ *
+ * This is how policy, audit and permission plugins are written without the core knowing they
+ * exist.
+ */
+export type HookName =
+  | "tool_pre"
+  | "tool_post"
+  | "turn_pre"
+  | "turn_route"
+  | "turn_post"
+  | "buf_pre_change"
+  | "permission_pre"
+  | "ask_user";

package/src/generated/HookOutcome.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * What a hook decided.
+ *
+ * A hook registered as non-blocking is a pure observer and its outcome is ignored — that is
+ * deliberate, so an audit plugin can never wedge the agent loop. A *blocking* hook is awaited with
+ * a timeout, and **a timeout is treated as [`HookOutcome::Veto`]**: a permission plugin that hangs
+ * must fail closed, not open.
+ */
+export type HookOutcome = { "action": "continue" } | {
+  "action": "modify";
+  payload: unknown;
+} | { "action": "veto"; reason: string };

package/src/generated/HookPayload.ts

@@ -0,0 +1,95 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { BufferId } from "./BufferId";
+import type { Capability } from "./Capability";
+import type { ModelSelection } from "./ModelSelection";
+import type { PermissionOption } from "./PermissionOption";
+import type { QuestionAnswer } from "./QuestionAnswer";
+import type { SessionId } from "./SessionId";
+import type { StopReason } from "./StopReason";
+import type { ToolCall } from "./ToolCall";
+import type { ToolResult } from "./ToolResult";
+import type { TurnId } from "./TurnId";
+import type { Usage } from "./Usage";
+import type { UserQuestion } from "./UserQuestion";
+
+export type HookPayload =
+  | { "hook": "tool_pre"; call: ToolCall }
+  | { "hook": "tool_post"; call: ToolCall; result: ToolResult }
+  | { "hook": "turn_pre"; turn: TurnId; text: string }
+  | {
+    "hook": "turn_route";
+    turn: TurnId;
+    /**
+     * What is about to be asked, so the decision can be about the work rather than only about
+     * the conversation.
+     */
+    text: string;
+    /**
+     * Which conversation it belongs to. A workspace runs several turns at once, and a router
+     * that assumed the one on screen would send another's work to the wrong place.
+     */
+    session?: SessionId;
+    selection?: ModelSelection;
+  }
+  | { "hook": "turn_post"; turn: TurnId; stop_reason: StopReason; usage: Usage }
+  | {
+    "hook": "buf_pre_change";
+    buf: BufferId;
+    start: number;
+    old_end: number;
+    new_len: number;
+  }
+  | {
+    "hook": "permission_pre";
+    capability: Capability;
+    turn: TurnId | null;
+    /**
+     * Which conversation is blocked on this.
+     *
+     * What [`HookPayload::AskUser`] already carries, and for the same reason: a workspace
+     * runs several turns at once, only one of them is on screen, and a prompt drawn over
+     * whichever conversation you happen to be reading is a prompt about somebody else's work.
+     * `None` when a plugin asked outside any turn.
+     */
+    session?: SessionId;
+    /**
+     * What the asker said it was about to do, in its own words, when that is more than the
+     * capability can carry. An agent driver's `Run cargo test --workspace` is one line the
+     * user can act on; `Exec` plus a truncated command is not.
+     */
+    title?: string;
+    /**
+     * The answers the asker offers. Empty when the only answers are yes and no, which is the
+     * case for every built-in tool.
+     */
+    options: Array<PermissionOption>;
+    /**
+     * Which of `options` was taken, by `id`. Set by the hook, in a [`HookOutcome::Modify`]
+     * carrying this payload back — that is how an answer richer than yes-or-no gets home.
+     */
+    chosen?: string;
+  }
+  | {
+    "hook": "ask_user";
+    /**
+     * Which conversation is asking. A workspace runs several turns at once and only one of
+     * them is on screen, so a panel that assumed "the one in front of you" would put another
+     * conversation's question over the one you are reading.
+     */
+    session?: SessionId;
+    turn?: TurnId;
+    /**
+     * Where the turn is running, so a question about a file can be read against the right
+     * tree.
+     */
+    cwd: string;
+    questions: Array<UserQuestion>;
+    /**
+     * The answers. Set by the hook, in a [`HookOutcome::Modify`] carrying this payload back —
+     * the same way [`Self::PermissionPre::chosen`] comes home.
+     *
+     * `None` means nobody has answered yet. An empty list is not the same thing and is read as
+     * a refusal: it is what a hook that ran and declined to ask anybody returns.
+     */
+    answers?: Array<QuestionAnswer>;
+  };

package/src/generated/InputEvent.ts

@@ -0,0 +1,31 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { KeyPress } from "./KeyPress";
+import type { WindowId } from "./WindowId";
+
+export type InputEvent =
+  | { "type": "ready"; width: number; height: number }
+  | { "type": "attached"; width: number; height: number }
+  | { "type": "detached" }
+  | { "type": "key"; key: KeyPress }
+  | { "type": "paste"; text: string }
+  | { "type": "resize"; width: number; height: number }
+  | {
+    "type": "viewport_changed";
+    win: WindowId;
+    width: number;
+    height: number;
+    top_line: number;
+    /**
+     * How many *buffer* rows are on the screen, which on a wrapping window is not the height.
+     *
+     * The frontend is the only thing that can answer it, and everything that pages by a
+     * screenful needs it: a transcript of paragraphs draws six buffer rows in thirty cells of
+     * height, so half a screen counted as `height / 2` is four screens of scrolling and a
+     * cursor that lands somewhere nobody asked for.
+     */
+    rows: number;
+  }
+  | { "type": "command"; name: string; args: Array<string> }
+  | { "type": "repaint" }
+  | { "type": "focus"; on: boolean }
+  | { "type": "disconnected" };

package/src/generated/InstanceConfig.ts

@@ -0,0 +1,26 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { AuthRef } from "./AuthRef";
+import type { Brand } from "./Brand";
+import type { DriverKind } from "./DriverKind";
+import type { InstanceId } from "./InstanceId";
+import type { ModelInfo } from "./ModelInfo";
+
+/**
+ * A configured driver.
+ */
+export type InstanceConfig = {
+  id: InstanceId;
+  driver: DriverKind;
+  display_name: string;
+  base_url?: string | null;
+  auth: AuthRef;
+  /**
+   * How to draw it. `None` falls back to a generic mark.
+   */
+  brand?: Brand | null;
+  /**
+   * Models this instance serves. Empty means "ask the endpoint at runtime".
+   */
+  models?: Array<ModelInfo>;
+  extra_headers?: Array<[string, string]>;
+};

package/src/generated/InstanceId.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Names a *configured* driver: credentials, base URL, model list.
+ */
+export type InstanceId = string;

package/src/generated/KeyCode.ts

@@ -0,0 +1,20 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type KeyCode =
+  | { "kind": "char"; c: string }
+  | { "kind": "enter" }
+  | { "kind": "tab" }
+  | { "kind": "back_tab" }
+  | { "kind": "backspace" }
+  | { "kind": "delete" }
+  | { "kind": "insert" }
+  | { "kind": "esc" }
+  | { "kind": "left" }
+  | { "kind": "right" }
+  | { "kind": "up" }
+  | { "kind": "down" }
+  | { "kind": "home" }
+  | { "kind": "end" }
+  | { "kind": "page_up" }
+  | { "kind": "page_down" }
+  | { "kind": "f"; n: number };

package/src/generated/KeyContext.ts

@@ -0,0 +1,24 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { KeyPress } from "./KeyPress";
+import type { Mode } from "./Mode";
+import type { ViewId } from "./ViewId";
+import type { WindowId } from "./WindowId";
+
+/**
+ * A key the host has already routed to this plugin's command. Included so a plugin can implement
+ * modal behaviour without re-deriving routing.
+ */
+export type KeyContext = {
+  key: KeyPress;
+  mode: Mode;
+  /**
+   * Which terminal it was pressed in.
+   *
+   * A workspace can have several and they are not copies of each other, so a plugin that puts
+   * something on screen in answer to a key has to be able to put it on *that* screen. This is
+   * where the answer comes from, and the ergonomic layer hands it back as a namespace already
+   * bound to it, so the ordinary plugin never has to name a view at all.
+   */
+  view: ViewId;
+  win?: WindowId | null;
+};

package/src/generated/KeyMods.ts

@@ -0,0 +1,8 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type KeyMods = {
+  ctrl: boolean;
+  alt: boolean;
+  shift: boolean;
+  meta: boolean;
+};

package/src/generated/KeyPress.ts

@@ -0,0 +1,5 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { KeyCode } from "./KeyCode";
+import type { KeyMods } from "./KeyMods";
+
+export type KeyPress = { code: KeyCode; mods: KeyMods };

package/src/generated/KeymapEntry.ts

@@ -0,0 +1,11 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { KeymapScope } from "./KeymapScope";
+import type { Mode } from "./Mode";
+
+export type KeymapEntry = {
+  mode: Mode;
+  lhs: string;
+  command: string;
+  scope: KeymapScope;
+  desc?: string | null;
+};

package/src/generated/KeymapScope.ts

@@ -0,0 +1,20 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { BufferId } from "./BufferId";
+import type { WindowId } from "./WindowId";
+
+/**
+ * Scope a keymap applies at. Resolution order is window -> buffer -> kind -> global; the first
+ * binding found wins, which is what stops every plugin fighting over `<Esc>`.
+ */
+export type KeymapScope =
+  | { "kind": "global" }
+  | { "kind": "buffer"; buf: BufferId }
+  | { "kind": "window"; win: WindowId }
+  | {
+    "kind": "buf_kind";
+    /**
+     * The kind, not the discriminant — `name` because `kind` is already the tag this enum is
+     * serialized under.
+     */
+    name: string;
+  };

package/src/generated/LineDraw.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { MarkDraw } from "./MarkDraw";
+
+/**
+ * One line of a repaint on the way *in*: text, and the marks to put on it.
+ *
+ * The inbound twin of [`LineRender`], and deliberately the same shape. A panel that draws itself
+ * hands over rows, not a script of mutations — see [`ApiCall::BufRender`](crate::ApiCall::BufRender)
+ * for why the script was the bug.
+ *
+ * No `ns` or `id` per mark: the namespace is the call's, and an id is a handle for deleting one
+ * mark later, which is not a thing a wholesale repaint ever does — it clears by namespace and
+ * writes the lot again.
+ */
+export type LineDraw = { text: string; marks?: Array<MarkDraw> };

package/src/generated/LineRender.ts

@@ -0,0 +1,9 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ExtmarkRender } from "./ExtmarkRender";
+
+/**
+ * One line of a buffer, with its annotations attached.
+ *
+ * Text and marks are never sent separately. See the module docs.
+ */
+export type LineRender = { text: string; marks?: Array<ExtmarkRender> };

package/src/generated/LinkState.ts

@@ -0,0 +1,16 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * How the connection to a peer stands, beyond the fact of it being up or not.
+ *
+ * `up` is the summary and this is the story, because "not connected" is three different rows on a
+ * board: a machine being dialled that has never answered, one that was here and is being dialled
+ * again, and one nothing is dialling at all — it reached us last time, or it was told to stop.
+ * `attempt` counts dials since the last success, so a panel can say `try 4` instead of drawing a
+ * spinner that has been spinning since Tuesday.
+ */
+export type LinkState =
+  | { "state": "connecting"; attempt: number }
+  | { "state": "up" }
+  | { "state": "retrying"; attempt: number }
+  | { "state": "down" };