@neosh/api 0.1.0

package/src/generated/AscpMessage.ts

@@ -0,0 +1,73 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { AgentCommand } from "./AgentCommand";
+import type { AgentSummary } from "./AgentSummary";
+import type { NodeCapabilities } from "./NodeCapabilities";
+import type { NodeInfo } from "./NodeInfo";
+import type { Refusal } from "./Refusal";
+import type { SessionId } from "./SessionId";
+import type { StreamEvent } from "./StreamEvent";
+
+/**
+ * Everything that goes over the wire.
+ *
+ * One enum rather than a request and a response type, because the connection is symmetric: after
+ * the handshake either side may send any of these, and a node is a peer rather than a client or a
+ * server. Which side dialled is an accident of who booted first.
+ */
+export type AscpMessage =
+  | {
+    "type": "hello";
+    version: number;
+    node: NodeInfo;
+    capabilities: NodeCapabilities;
+    /**
+     * Hex, 32 bytes.
+     */
+    nonce: string;
+  }
+  | {
+    "type": "welcome";
+    version: number;
+    node: NodeInfo;
+    capabilities: NodeCapabilities;
+    /**
+     * Hex ed25519 signature over the dialler's `nonce`.
+     */
+    signature: string;
+    nonce: string;
+  }
+  | { "type": "proof"; signature: string }
+  | {
+    "type": "presence";
+    node: NodeInfo;
+    capabilities: NodeCapabilities;
+    /**
+     * Monotonic per node, so a board can drop a message that overtook another.
+     *
+     * Not a timestamp: clocks on different machines disagree by more than the interval
+     * between two of these, and "the newer one wins" decided by wall clock is how a stale
+     * inventory permanently wins over a fresh one.
+     */
+    seq: bigint;
+  }
+  | {
+    "type": "inventory";
+    seq: bigint;
+    full: boolean;
+    agents: Array<AgentSummary>;
+    gone: Array<SessionId>;
+  }
+  | { "type": "subscribe"; session: SessionId }
+  | { "type": "unsubscribe"; session: SessionId }
+  | { "type": "stream"; session: SessionId; event: StreamEvent }
+  | { "type": "command"; id: string; session: SessionId; command: AgentCommand }
+  | {
+    "type": "ack";
+    id: string;
+    /**
+     * The conversation a [`AgentCommand::NewSession`] created, when that is what was asked.
+     */
+    session?: SessionId | null;
+  }
+  | { "type": "refused"; id: string; refusal: Refusal }
+  | { "type": "goodbye"; message?: string | null };

package/src/generated/AttachmentInfo.ts

@@ -0,0 +1,25 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * An image the composer is holding, as far as anything outside the host is concerned.
+ *
+ * The size is in here because it is the part you cannot see for yourself: an attachment is a row
+ * that says "png", and whether that row is forty kilobytes or four megabytes is the whole of what
+ * you would want to know before sending it.
+ */
+export type AttachmentInfo = {
+  /**
+   * Where the bytes are, in the workspace's directory.
+   */
+  path: string;
+  /**
+   * `image/png`, `image/jpeg`, `image/gif` or `image/webp`, read off the bytes.
+   */
+  media_type: string;
+  width: number;
+  height: number;
+  /**
+   * On disk, after any shrinking.
+   */
+  bytes: number;
+};

package/src/generated/Attrs.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.
+
+export type Attrs = {
+  bold: boolean;
+  italic: boolean;
+  underline: boolean;
+  reverse: boolean;
+  dim: boolean;
+  strikethrough: boolean;
+};

package/src/generated/AuthRef.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.
+
+/**
+ * How a driver authenticates. Never carries a secret value — only where to find one.
+ *
+ * Secrets are resolved at request time from the environment or an OS keychain and are structurally
+ * excluded from every type that crosses a process boundary.
+ */
+export type AuthRef =
+  | { "kind": "env"; var: string }
+  | { "kind": "command"; argv: Array<string> }
+  | { "kind": "cli"; program: string; login?: string | null }
+  | { "kind": "inherited" }
+  | { "kind": "none" };

package/src/generated/BackgroundTask.ts

@@ -0,0 +1,23 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { TaskId } from "./TaskId";
+
+/**
+ * One thing still running that no turn is waiting for.
+ *
+ * A *shell that was backgrounded*, a sub-agent that was let go of, a monitor left watching
+ * something — whatever the driver started and no longer holds the turn open for. What it is
+ * doing is the driver's business; that it is still doing it is the reader's.
+ */
+export type BackgroundTask = {
+  id: TaskId;
+  /**
+   * One line, in the driver's own words. Empty when it would not say.
+   */
+  title: string;
+  /**
+   * Which sort of thing it is, verbatim from the driver — `claude` says `local_bash`,
+   * `local_agent`, `local_workflow`, `monitor_ws`. Not translated: a name we invented for a
+   * kind we have never seen is a name that is wrong on the install that has one.
+   */
+  kind?: string | null;
+};

package/src/generated/BlockStartKind.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.
+import type { ToolCallId } from "./ToolCallId";
+
+export type BlockStartKind = { "kind": "text" } | { "kind": "thinking" } | {
+  "kind": "tool_use";
+  id: ToolCallId;
+  name: string;
+};

package/src/generated/BorderStyle.ts

@@ -0,0 +1,3 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type BorderStyle = "none" | "single" | "rounded" | "double" | "thick";

package/src/generated/BranchInfo.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.
+
+export type BranchInfo = {
+  name: string;
+  is_head: boolean;
+  is_remote: boolean;
+  upstream?: string | null;
+  ahead: number;
+  behind: number;
+  /**
+   * Subject of the tip commit, for a picker that wants a second line.
+   */
+  subject?: string | null;
+  /**
+   * Committer date of the tip, seconds since the epoch. Sorting a branch list by anything else
+   * puts the branch you were just on somewhere in the middle.
+   */
+  committed_at: number;
+};

package/src/generated/Brand.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.
+
+/**
+ * How a provider is drawn: a mark, and a highlight group carrying its colour.
+ *
+ * Three marks rather than one because a terminal is not one thing. A Nerd Font has a real brand
+ * glyph; a bare Unicode terminal has geometry; `ui.ascii_only` has a letter. Choosing between them
+ * is the frontend's job, like every other display decision — this type only says what the choices
+ * are.
+ *
+ * The colour is a **highlight group name**, never a colour value, so a theme can restyle every
+ * provider mark without anything here changing and a 16-colour terminal still gets something.
+ */
+export type Brand = {
+  /**
+   * Nerd Font glyph, used when `ui.nerd_font` is on.
+   */
+  nerd?: string | null;
+  /**
+   * Plain Unicode mark. Works in any terminal with a modern font.
+   */
+  mark: string;
+  /**
+   * One or two ASCII characters, for `ui.ascii_only`.
+   */
+  ascii: string;
+  /**
+   * Highlight group carrying the brand colour, e.g. `Brand.Anthropic`.
+   */
+  hl: string;
+};

package/src/generated/BufferId.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.
+
+/**
+ * A text buffer. Buffers are the only place text lives.
+ */
+export type BufferId = number;

package/src/generated/BuildId.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.
+
+/**
+ * Which build of neosh a process is running.
+ *
+ * [`PROTOCOL_VERSION`] answers "can these two talk at all", and a mismatch there is refused. This
+ * answers the question underneath it, which has no wrong answer and therefore cannot be refused:
+ * *are they the same program*. A workspace outlives the terminals that look at it and outlives
+ * the file it was loaded from, so the ordinary way to develop neosh — change a plugin, rebuild,
+ * run it — produces two processes speaking one protocol, where the older one is the only one
+ * whose code is actually doing anything. Nothing about that is visible on screen without this.
+ */
+export type BuildId = {
+  /**
+   * What this build calls itself. Equal across every build of one release, so never enough on
+   * its own — during development it is the same string for months.
+   */
+  version: string;
+  /**
+   * When the executable was written, in seconds since the epoch. Zero when it could not be
+   * read, which is *unknown* rather than old — see [`BuildId::behind`].
+   */
+  written: number;
+};

package/src/generated/Capability.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.
+
+/**
+ * What an action wants to do. Checked before any filesystem, network or exec effect.
+ */
+export type Capability =
+  | { "kind": "read_file"; path: string }
+  | { "kind": "write_file"; path: string }
+  | { "kind": "exec"; command: string }
+  | { "kind": "network"; host: string };

package/src/generated/ClientMessage.ts

@@ -0,0 +1,67 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { BuildId } from "./BuildId";
+import type { KeyPress } from "./KeyPress";
+import type { WindowId } from "./WindowId";
+
+/**
+ * What a client says to the workspace it has connected to.
+ *
+ * # Why this is a second envelope rather than raw [`InputEvent`]s
+ *
+ * [`InputEvent`] is what a *view* does — a key, a resize, a command. It has nothing to say about
+ * the connection carrying it, and it should not: the same events come from a terminal that owns
+ * the process, where there is no connection to talk about. Attaching, detaching and being told
+ * somebody else took over are facts about the wire, so they live on the wire's own type and the
+ * view protocol stays exactly what it was.
+ */
+export type ClientMessage =
+  | {
+    "kind": "attach";
+    /**
+     * Refused rather than negotiated. A client built against a different protocol is almost
+     * always a neosh that was upgraded while its workspace kept running, and rendering a
+     * partial UI is a worse answer than saying so.
+     */
+    protocol_version: number;
+    width: number;
+    height: number;
+    /**
+     * Which build the terminal is, so the workspace's answer can be compared against it.
+     *
+     * Defaulted, because a client older than this field is one that cannot be told apart
+     * from the workspace anyway, and refusing it would be a worse answer than saying nothing.
+     */
+    build: BuildId;
+  }
+  | { "kind": "input" }
+    & (
+      | { "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" }
+    )
+  | { "kind": "detach" }
+  | { "kind": "stop" }
+  | { "kind": "status" };

package/src/generated/Color.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.
+
+/**
+ * A color as *declared*. Down-conversion to 256 or 16 colors happens at the terminal boundary, so
+ * plugins never think about terminal capability.
+ */
+export type Color = { "kind": "rgb"; r: number; g: number; b: number } | {
+  "kind": "indexed";
+  i: number;
+} | { "kind": "default" };

package/src/generated/CommandEntry.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.
+
+/**
+ * A registered command, as listed for a palette or `:help`-style listing.
+ */
+export type CommandEntry = {
+  name: string;
+  desc?: string | null;
+  /**
+   * Which plugin owns it, so a palette can group or attribute entries.
+   */
+  plugin: string;
+};

package/src/generated/CommitInfo.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.
+
+export type CommitInfo = {
+  hash: string;
+  short: string;
+  subject: string;
+  body: string;
+  author: string;
+  committed_at: number;
+};

package/src/generated/ContentBlock.ts

@@ -0,0 +1,39 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ToolCallId } from "./ToolCallId";
+
+/**
+ * A piece of a message.
+ *
+ * `Thinking` is a first-class variant rather than something folded into `Text`, because a UI must
+ * be able to render or collapse reasoning independently, and because thinking blocks have to be
+ * replayed back to the provider unchanged on the next turn.
+ */
+export type ContentBlock =
+  | { "type": "text"; text: string }
+  | {
+    "type": "thinking";
+    text: string;
+    /**
+     * Opaque provider signature. Must be echoed back verbatim or the provider rejects the turn.
+     */
+    signature?: string | null;
+  }
+  | { "type": "tool_use"; id: ToolCallId; name: string; input: unknown }
+  | {
+    "type": "tool_result";
+    tool_use_id: ToolCallId;
+    content: string;
+    is_error: boolean;
+  }
+  | {
+    "type": "image";
+    /**
+     * Where the bytes are, absolute. Written by the workspace, read by a driver.
+     */
+    path: string;
+    /**
+     * `image/png`, `image/jpeg`, `image/gif` or `image/webp` — the four every provider we
+     * target accepts. Read off the bytes rather than off the file name, which is a claim.
+     */
+    media_type: string;
+  };

package/src/generated/Contribution.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.
+
+/**
+ * One item somebody put on a contribution point.
+ */
+export type Contribution = {
+  point: string;
+  id: string;
+  /**
+   * Which plugin contributed it. Stamped by the host, so a row in a panel can always be traced
+   * to the thing that put it there — and so `plugins.disabled` takes its rows with it.
+   */
+  plugin: string;
+  item: unknown;
+  priority: number;
+};

package/src/generated/CostBasis.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.
+
+/**
+ * Why a bucket's cost is what it is, so a client can be honest about it.
+ */
+export type CostBasis = "priced" | "unpriced";

package/src/generated/CredentialInfo.ts

@@ -0,0 +1,30 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { AccountKind } from "./AccountKind";
+import type { Brand } from "./Brand";
+import type { CredentialSource } from "./CredentialSource";
+import type { DriverKind } from "./DriverKind";
+import type { InstanceId } from "./InstanceId";
+
+/**
+ * An instance and the state of its credential. **Never carries the secret itself.**
+ */
+export type CredentialInfo = {
+  instance: InstanceId;
+  display_name: string;
+  driver: DriverKind;
+  source: CredentialSource;
+  /**
+   * A plan, a key, or something local. What a picker groups by.
+   */
+  account: AccountKind;
+  brand?: Brand | null;
+  /**
+   * Whether this instance's driver is registered, so the entry is worth offering at all.
+   */
+  driver_available: boolean;
+  /**
+   * Whether a key can be typed in for it. False for a CLI login or a local endpoint, where
+   * asking for one would be asking for something that does nothing.
+   */
+  accepts_key: boolean;
+};

package/src/generated/CredentialSource.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.
+
+/**
+ * Where the key for an instance is coming from.
+ *
+ * Reported so a settings list can say *why* something works, which is the difference between "it
+ * is signed in" and "it is signed in and will still be tomorrow".
+ */
+export type CredentialSource =
+  | { "kind": "plan"; via: string }
+  | { "kind": "plan_missing"; program: string; hint?: string | null }
+  | { "kind": "env"; var: string }
+  | { "kind": "keychain" }
+  | { "kind": "session" }
+  | { "kind": "command" }
+  | { "kind": "inherited" }
+  | { "kind": "not_needed" }
+  | { "kind": "missing" };

package/src/generated/CursorMotion.ts

@@ -0,0 +1,21 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Where the cursor goes.
+ *
+ * Resolved against the *buffer*, never the screen: the core does not know how wide a pane is or
+ * how many columns a character occupies. `Up` and `Down` therefore remember a grapheme-cluster
+ * index rather than a display column, which is the closest thing to "the same place" that can be
+ * computed without measuring anything.
+ */
+export type CursorMotion =
+  | "left"
+  | "right"
+  | "up"
+  | "down"
+  | "line_start"
+  | "line_end"
+  | "word_left"
+  | "word_right"
+  | "buf_start"
+  | "buf_end";

package/src/generated/CursorShape.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.
+
+/**
+ * What the caret looks like. See [`crate::ApiCall::WinCursorShape`].
+ */
+export type CursorShape = "bar" | "block" | "underline";

package/src/generated/DetachReason.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.
+
+export type DetachReason = { "kind": "asked" } | { "kind": "taken_over" } | {
+  "kind": "stopping";
+};

package/src/generated/DiffTarget.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.
+
+/**
+ * What to run `git diff` against.
+ */
+export type DiffTarget = { "kind": "unstaged" } | { "kind": "staged" } | {
+  "kind": "range";
+  base: string;
+  head: string;
+};

package/src/generated/Dock.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.
+
+/**
+ * Where a non-floating window sits.
+ *
+ * Deliberately *not* an arbitrary split tree: agent UIs do not need one, and a split tree creates
+ * layout ambiguity that every plugin then has to reason about.
+ */
+export type Dock = "left" | "right" | "bottom" | "main";

package/src/generated/DriverCommand.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.
+
+/**
+ * A command the driver itself accepts, as opposed to one neosh implements.
+ *
+ * Reported rather than configured. Which commands exist depends on the install — `claude` counts
+ * project `.claude/commands/`, plugins and MCP prompts among them — so any list written here
+ * would be wrong on the first machine that had one of its own.
+ */
+export type DriverCommand = {
+  /**
+   * Without the leading slash.
+   */
+  name: string;
+  description?: string | null;
+  /**
+   * What to type after it, when the driver says — `"[message]"`, `"<branch>"`.
+   */
+  argument_hint?: string | null;
+};

package/src/generated/DriverKind.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.
+
+/**
+ * Names a driver implementation, e.g. `anthropic`, `openai-compat`, `claude-cli`.
+ *
+ * Intentionally open. See the module docs.
+ */
+export type DriverKind = string;

package/src/generated/Extent.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.
+
+/**
+ * A size request along one axis. Resolved by the frontend against the real viewport.
+ *
+ * # An extent measures content, not the box drawn around it
+ *
+ * Every variant here answers the same question — *how much room does what I am putting in it
+ * need* — and the border is chrome the frontend adds afterwards. `Auto` could not mean anything
+ * else, since the content is all it has to measure; the others follow it so that swapping one for
+ * another does not silently resize what you can see.
+ *
+ * The alternative, where `Fixed` names the outer box, means every caller subtracts two from every
+ * number it computes, and the day one of them forgets, the last line of a list is simply not
+ * drawn — with no error, because a rectangle that small is perfectly valid.
+ */
+export type Extent = { "kind": "fixed"; n: number } | { "kind": "auto" } | {
+  "kind": "max";
+  n: number;
+} | { "kind": "fill" };

package/src/generated/ExtmarkId.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.
+
+/**
+ * An annotation within a namespace.
+ */
+export type ExtmarkId = number;

package/src/generated/ExtmarkInfo.ts

@@ -0,0 +1,43 @@
+// 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's current position, for `get`.
+ */
+export type ExtmarkInfo = {
+  id: ExtmarkId;
+  ns: NamespaceId;
+  row: number;
+  col: number;
+  invalid: boolean;
+  /**
+   * 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;
+};