@neosh/api 0.1.0

package/src/generated/PluginProvides.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.
+
+/**
+ * The names a plugin publishes for other plugins to use. See [`PluginManifest::provides`].
+ */
+export type PluginProvides = {
+  /**
+   * Contribution points this plugin reads (`sidebar.section`).
+   */
+  points?: Array<string>;
+  /**
+   * Buffer kinds it creates (`neosh.sidebar`).
+   */
+  kinds?: Array<string>;
+  /**
+   * Shared vars it writes (`sidebar.favorite`).
+   */
+  vars?: Array<string>;
+};

package/src/generated/PluginRequest.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 { HookName } from "./HookName";
+import type { HookPayload } from "./HookPayload";
+import type { StreamId } from "./StreamId";
+import type { TurnRequest } from "./TurnRequest";
+
+export type PluginRequest =
+  | { "type": "run_tool"; name: string; input: unknown }
+  | { "type": "hook"; hook: HookName; payload: HookPayload }
+  | { "type": "command"; name: string; args?: Array<string> }
+  | { "type": "provider_stream"; stream: StreamId; request: TurnRequest };

package/src/generated/PluginResponse.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 { HookOutcome } from "./HookOutcome";
+import type { ToolResult } from "./ToolResult";
+
+export type PluginResponse =
+  | { "type": "tool"; result: ToolResult }
+  | { "type": "hook"; outcome: HookOutcome }
+  | { "type": "command"; value: unknown }
+  | { "type": "provider_accepted" }
+  | { "type": "error"; message: string };

package/src/generated/PointInfo.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.
+
+/**
+ * A contribution point as [`ApiCall::ExtPoints`] reports it.
+ */
+export type PointInfo = {
+  point: string;
+  /**
+   * Plugins whose manifest says they read it.
+   */
+  readers: Array<string>;
+  /**
+   * Plugins with something on it now.
+   */
+  contributors: Array<string>;
+};

package/src/generated/Pricing.ts

@@ -0,0 +1,12 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Cost per million tokens, for budget display. `None` where unknown (local models, unlisted
+ * endpoints) — the UI must render "unknown" rather than guessing zero.
+ */
+export type Pricing = {
+  input_per_mtok: number;
+  output_per_mtok: number;
+  cache_read_per_mtok: number;
+  cache_write_per_mtok: number;
+};

package/src/generated/ProjectKey.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.
+
+/**
+ * How two machines recognise the same project.
+ *
+ * The hard part of showing "this project is on three computers" is that the path is not the same
+ * on any of them: `/Users/me/dev/neosh`, `/home/me/src/neosh`, `C:\code\neosh`. Comparing paths
+ * answers the wrong question, and comparing directory names says two unrelated `api` directories
+ * are one project.
+ *
+ * So the key is the repository's origin URL, normalised — `git:github.com/neoswarm/neosh` — which
+ * is the same string on every machine that cloned it, including through different protocols
+ * (`git@github.com:…`, `https://github.com/…`). A directory that is not a checkout falls back to
+ * `dir:<basename>`, which is weak on purpose: it is a guess, and a guess about identity should be
+ * visibly a guess rather than quietly wrong.
+ *
+ * Worktrees of one repository share a key. That is deliberate — they are the same project, checked
+ * out twice — and it is what lets a board say "neosh: on mac-studio and on linux-box" rather than
+ * listing four rows that are all really one thing.
+ */
+export type ProjectKey = string;

package/src/generated/ProviderEmit.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 { ProviderEvent } from "./ProviderEvent";
+import type { StreamId } from "./StreamId";
+
+/**
+ * Emitted by a *plugin-implemented* provider, pushed rather than returned.
+ *
+ * A plugin cannot return a stream across the RPC boundary, so it answers the stream request
+ * immediately and then pushes events tagged with the [`StreamId`] until it sends `MessageStop`.
+ */
+export type ProviderEmit = { stream: StreamId; event: ProviderEvent };

package/src/generated/ProviderEvent.ts

@@ -0,0 +1,32 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Activity } from "./Activity";
+import type { BlockStartKind } from "./BlockStartKind";
+import type { StopReason } from "./StopReason";
+import type { ToolCallId } from "./ToolCallId";
+import type { Usage } from "./Usage";
+
+/**
+ * Normalized streaming events.
+ *
+ * These mirror the Anthropic Messages SSE shape because it is the most expressive of the wire
+ * formats we target (separate thinking blocks, incremental tool-input JSON). Every other driver
+ * adapts *into* this, so the agent loop has exactly one stream shape to handle.
+ */
+export type ProviderEvent =
+  | { "type": "message_start"; model?: string | null; usage: Usage }
+  | { "type": "block_start"; index: number; block: BlockStartKind }
+  | { "type": "text_delta"; index: number; text: string }
+  | { "type": "thinking_delta"; index: number; text: string }
+  | { "type": "signature_delta"; index: number; signature: string }
+  | { "type": "tool_input_delta"; index: number; partial_json: string }
+  | { "type": "block_stop"; index: number }
+  | { "type": "message_delta"; stop_reason?: StopReason | null; usage: Usage }
+  | { "type": "message_stop" }
+  | {
+    "type": "tool_result";
+    id: ToolCallId;
+    content: string;
+    is_error: boolean;
+  }
+  | { "type": "activity"; activity: Activity }
+  | { "type": "error"; message: string; retryable: boolean };

package/src/generated/ProviderOptionDescriptor.ts

@@ -0,0 +1,38 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { OptionChoice } from "./OptionChoice";
+
+/**
+ * One knob a model exposes.
+ *
+ * The UI renders these without knowing what any of them mean, so a driver can add
+ * `{"id":"fast_mode"}` and have it appear in the model picker with no host change.
+ */
+export type ProviderOptionDescriptor = {
+  "type": "select";
+  id: string;
+  label: string;
+  description?: string | null;
+  options: Array<OptionChoice>;
+  current_value?: string | null;
+  /**
+   * Values that are applied by prefixing the *prompt* rather than by sending a request
+   * parameter. Some vendors gate reasoning depth on magic words in the user message.
+   */
+  prompt_injected_values?: Array<string>;
+} | {
+  "type": "boolean";
+  id: string;
+  label: string;
+  description?: string | null;
+  current_value: boolean;
+  /**
+   * A word to put in the message while this is on, for a switch a vendor reads out of the
+   * prompt rather than off a parameter.
+   *
+   * The switch is then *nothing but* that word: with it on, the word is written into the
+   * turn and no option value is sent at all. The same idea as
+   * [`Self::Select::prompt_injected_values`], for the knobs that are a yes/no rather than a
+   * rung — orchestration modes, personas, anything a harness gates on what you said.
+   */
+  prompt_injected_word?: string | null;
+};

package/src/generated/ProviderOptionValue.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 ProviderOptionValue = string | boolean;

package/src/generated/QuestionAnswer.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.
+
+/**
+ * What somebody said, for one question.
+ */
+export type QuestionAnswer = {
+  /**
+   * Which question this answers, by its [`UserQuestion::question`] text.
+   */
+  question: string;
+  /**
+   * The labels taken, in the order they were taken. Exactly one for a single-select question.
+   *
+   * An answer somebody *typed* is one entry that is not any of the offered labels, and that is
+   * not a special case on the wire: to the agent, "Postgres" and "neither, use what is already
+   * there" are the same kind of thing — what the user said.
+   */
+  answers: Array<string>;
+  /**
+   * Whether [`Self::answers`] was typed rather than chosen. Carried so a transcript can draw it
+   * differently; nothing sent to the agent depends on it.
+   */
+  custom: boolean;
+};

package/src/generated/QuestionOption.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.
+
+/**
+ * One answer on offer.
+ */
+export type QuestionOption = {
+  /**
+   * What the option is called. **This is what is sent back** — the agent matches on the label
+   * it wrote, not on a position in a list, so a client that reorders the rows still answers the
+   * question it was asked.
+   */
+  label: string;
+  /**
+   * What taking it would mean. Shown under the label, dimmed; often the part that decides it.
+   */
+  description: string;
+};

package/src/generated/QuotaCredits.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.
+
+/**
+ * Paid-for headroom past the plan, where the vendor sells it.
+ */
+export type QuotaCredits = {
+  /**
+   * Whether the account can actually spend past its plan. `false` is the interesting case: it is
+   * why hitting a limit stops work rather than costing money.
+   */
+  enabled: boolean;
+  used_percent?: number | null;
+  /**
+   * Already formatted by whoever knew the currency. A balance rendered from a minor-unit integer
+   * by a client that guessed `USD` is a number that is wrong twice a year.
+   */
+  balance?: string | null;
+  limit?: string | null;
+  /**
+   * Why it is off, in the vendor's words, when it is off for a reason worth repeating.
+   */
+  disabled_reason?: string | null;
+};

package/src/generated/QuotaSample.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 { InstanceId } from "./InstanceId";
+
+/**
+ * One window's percentage at one instant, kept so a gauge can be a line rather than a number.
+ *
+ * Sampled rather than derived. Nothing on disk records what a plan percentage was an hour ago —
+ * the vendor reports only *now* — so a history exists at all only because something wrote each
+ * answer down as it arrived.
+ */
+export type QuotaSample = {
+  at: number;
+  instance: InstanceId;
+  /**
+   * [`QuotaWindow::id`], so a sample can be matched back to the window it belongs to.
+   */
+  window: string;
+  used_percent: number;
+};

package/src/generated/QuotaSeverity.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.
+
+/**
+ * How worried to be, as the vendor grades it.
+ *
+ * Graded at the source rather than by a threshold here, because the thresholds are not ours to
+ * pick: Anthropic calls 94% of a weekly window `critical` and 55% of a session window `normal`,
+ * and a client that decided at 80% for both would be shouting about the wrong one. A source that
+ * reports no grade gets one from [`QuotaSeverity::of`], which is the fallback and says so.
+ */
+export type QuotaSeverity = "normal" | "warn" | "critical" | "exhausted";

package/src/generated/QuotaSnapshot.ts

@@ -0,0 +1,34 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { InstanceId } from "./InstanceId";
+import type { QuotaCredits } from "./QuotaCredits";
+import type { QuotaSource } from "./QuotaSource";
+import type { QuotaWindow } from "./QuotaWindow";
+
+/**
+ * Everything known about one account's allowance, as of one instant.
+ *
+ * Whole rather than patched, for the reason [`crate::Activity::Plan`] is whole: a patch is only
+ * correct if the previous state was, and every source of these reports the complete set anyway.
+ */
+export type QuotaSnapshot = {
+  /**
+   * Which configured provider instance this is the account of. Two instances may share one
+   * account and two accounts may share one vendor, so this is keyed by instance and never by
+   * vendor.
+   */
+  instance: InstanceId;
+  /**
+   * The plan's own name, when the vendor says it: `max`, `pro`, `plus`. Drawn as context for the
+   * percentages, never used to infer what the limits are.
+   */
+  plan?: string | null;
+  windows: Array<QuotaWindow>;
+  credits?: QuotaCredits | null;
+  /**
+   * Unix seconds. The reason this is on the wire rather than stamped on arrival: a snapshot
+   * travels — over ASCP from another computer, out of a store on reattach — and "when it was
+   * received here" is a different fact from "when it was true".
+   */
+  observed_at: number;
+  source: QuotaSource;
+};

package/src/generated/QuotaSource.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.
+
+/**
+ * Where a snapshot came from, which is the same thing as how much to trust its age.
+ */
+export type QuotaSource = "turn" | "poll" | "plugin";

package/src/generated/QuotaWindow.ts

@@ -0,0 +1,40 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { QuotaSeverity } from "./QuotaSeverity";
+
+/**
+ * One rolling allowance, as the vendor describes it.
+ */
+export type QuotaWindow = {
+  /**
+   * The vendor's own name for this limit. Stable enough to key a redraw on, opaque by design.
+   */
+  id: string;
+  /**
+   * What to draw. Written for a person: `Session`, `Weekly`, `Weekly · Opus`.
+   */
+  label: string;
+  /**
+   * 0-100. Above 100 is possible and is not clamped — an account in overage really has used more
+   * than its allowance, and rounding that down to "full" loses the only interesting part.
+   */
+  used_percent: number;
+  /**
+   * Unix seconds. `None` for an allowance that does not roll over.
+   */
+  resets_at?: number | null;
+  /**
+   * How long the window is, when the vendor says. Lets a client show how fast it is being spent
+   * rather than only how much is gone.
+   */
+  window_minutes?: number | null;
+  severity: QuotaSeverity;
+  /**
+   * What this limit is *about*, when it is about one thing: a model, a surface. `Fable`, `Opus`.
+   */
+  scope?: string | null;
+  /**
+   * The limit currently doing the limiting. Several windows are usually open at once and only
+   * one of them is the reason a request would be refused.
+   */
+  active: boolean;
+};

package/src/generated/Rect.ts

@@ -0,0 +1,7 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * A resolved rectangle in frontend cell space. Only ever travels frontend -> core (as viewport
+ * feedback) or core -> frontend for raw-cell surfaces, which are opaque blits by definition.
+ */
+export type Rect = { row: number; col: number; width: number; height: number };

package/src/generated/Refusal.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.
+
+/**
+ * Why a command was not carried out.
+ */
+export type Refusal =
+  | { "reason": "no_such_agent" }
+  | { "reason": "not_permitted"; what: string }
+  | { "reason": "busy"; message: string }
+  | { "reason": "failed"; message: string };

package/src/generated/RemoteProject.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 { ProjectKey } from "./ProjectKey";
+
+/**
+ * One checkout a node has, for "start something over there".
+ */
+export type RemoteProject = {
+  key: ProjectKey;
+  name: string;
+  /**
+   * The path on the owning node. Opaque here: it is what you hand back in
+   * [`AgentCommand::NewSession`], not something to look at locally.
+   */
+  cwd: string;
+  /**
+   * Whether this node has a conversation open in it now.
+   */
+  active: boolean;
+};

package/src/generated/RepoInfo.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.
+
+/**
+ * Where a repository is and what state its HEAD is in.
+ */
+export type RepoInfo = {
+  /**
+   * Absolute path to the working tree root.
+   */
+  root: string;
+  /**
+   * `None` on a detached HEAD, which is why `head` is reported separately.
+   */
+  branch?: string | null;
+  detached: boolean;
+  /**
+   * Short hash of HEAD. `None` in a repository with no commits yet.
+   */
+  head?: string | null;
+  upstream?: string | null;
+  ahead: number;
+  behind: number;
+};

package/src/generated/RepoStatus.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 { FileChange } from "./FileChange";
+import type { RepoInfo } from "./RepoInfo";
+
+export type RepoStatus = { repo: RepoInfo; changes: Array<FileChange> };

package/src/generated/RequestId.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.
+
+/**
+ * Correlates a request across the plugin boundary in either direction.
+ */
+export type RequestId = string;

package/src/generated/Role.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 Role = "user" | "assistant";

package/src/generated/RunningTurn.ts

@@ -0,0 +1,12 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { SessionId } from "./SessionId";
+
+export type RunningTurn = {
+  session: SessionId;
+  label: string;
+  /**
+   * The directory the conversation belongs to.
+   */
+  cwd: string;
+  elapsed_secs: number;
+};

package/src/generated/SelectShape.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 two ends of a selection mean. See [`crate::ApiCall::WinSelectShape`].
+ */
+export type SelectShape = "exclusive" | "inclusive" | "line";

package/src/generated/ServerMessage.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 { BuildId } from "./BuildId";
+import type { DetachReason } from "./DetachReason";
+import type { UiEvent } from "./UiEvent";
+import type { WorkspaceStatus } from "./WorkspaceStatus";
+
+/**
+ * What the workspace says back.
+ */
+export type ServerMessage =
+  | { "kind": "attached"; protocol_version: number; build: BuildId }
+  | { "kind": "refused"; reason: string; protocol_version: number }
+  | { "kind": "events"; batch: Array<UiEvent> }
+  | { "kind": "detached"; reason: DetachReason }
+  | { "kind": "status"; status: WorkspaceStatus };

package/src/generated/SessionId.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.
+
+/**
+ * One conversation, persistent across restarts.
+ */
+export type SessionId = string;