@neosh/api 0.2.0 → 0.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neosh/api",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "The neosh plugin API. Types are generated from the Rust side and drift-checked in CI.",
   "license": "MIT",
   "type": "module",

package/src/generated/ApiCall.ts

@@ -366,6 +366,7 @@ export type ApiCall =
   | { "call": "swarm_probe"; addr: string }
   | { "call": "swarm_pair"; node: NodeId; name: string; addr?: string | null }
   | { "call": "swarm_unpair"; node: NodeId }
+  | { "call": "swarm_rename"; node: NodeId; name?: string | null }
   | { "call": "swarm_reconnect"; node: NodeId }
   | { "call": "swarm_disconnect"; node: NodeId }
   | { "call": "swarm_strangers" }

package/src/generated/ClientMessage.ts

@@ -1,6 +1,8 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ApiCall } from "./ApiCall";
 import type { BuildId } from "./BuildId";
 import type { KeyPress } from "./KeyPress";
+import type { SessionId } from "./SessionId";
 import type { WindowId } from "./WindowId";
 
 /**
@@ -32,11 +34,33 @@ export type ClientMessage =
      * from the workspace anyway, and refusing it would be a worse answer than saying nothing.
      */
     build: BuildId;
+    /**
+     * Open in this conversation. See [`InputEvent::Attached::session`].
+     */
+    session?: SessionId | null;
   }
   | { "kind": "input" }
     & (
       | { "type": "ready"; width: number; height: number }
-      | { "type": "attached"; width: number; height: number }
+      | {
+        "type": "attached";
+        width: number;
+        height: number;
+        /**
+         * Which conversation this terminal would like to open in.
+         *
+         * `None` — every attach until `neosh "a prompt"` existed — is the ordinary placement: the
+         * most recent conversation nobody else is reading, or the screen a workspace nobody was
+         * watching kept for whoever came back. That second case is why this cannot be left to
+         * "the newest conversation wins": a terminal starting one and then attaching would be
+         * handed the abandoned screen instead, and the conversation it had just started would be
+         * running somewhere nothing on that screen mentions.
+         *
+         * A request rather than an instruction: a conversation deleted between the ask and the
+         * arrival gets the ordinary placement rather than an error nobody can act on.
+         */
+        session?: SessionId | null;
+      }
       | { "type": "detached" }
       | { "type": "key"; key: KeyPress }
       | { "type": "paste"; text: string }
@@ -65,4 +89,14 @@ export type ClientMessage =
     )
   | { "kind": "detach" }
   | { "kind": "stop" }
-  | { "kind": "status" };
+  | { "kind": "status" }
+  | {
+    "kind": "call";
+    /**
+     * Echoed on [`ServerMessage::Called`]. Any string the caller likes — several may be in
+     * flight at once, which is the point of it being here rather than implied by order.
+     */
+    id: string;
+    call: ApiCall;
+  }
+  | { "kind": "subscribe" };

package/src/generated/InputEvent.ts

@@ -1,10 +1,29 @@
 // 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 { SessionId } from "./SessionId";
 import type { WindowId } from "./WindowId";
 
 export type InputEvent =
   | { "type": "ready"; width: number; height: number }
-  | { "type": "attached"; width: number; height: number }
+  | {
+    "type": "attached";
+    width: number;
+    height: number;
+    /**
+     * Which conversation this terminal would like to open in.
+     *
+     * `None` — every attach until `neosh "a prompt"` existed — is the ordinary placement: the
+     * most recent conversation nobody else is reading, or the screen a workspace nobody was
+     * watching kept for whoever came back. That second case is why this cannot be left to
+     * "the newest conversation wins": a terminal starting one and then attaching would be
+     * handed the abandoned screen instead, and the conversation it had just started would be
+     * running somewhere nothing on that screen mentions.
+     *
+     * A request rather than an instruction: a conversation deleted between the ask and the
+     * arrival gets the ordinary placement rather than an error nobody can act on.
+     */
+    session?: SessionId | null;
+  }
   | { "type": "detached" }
   | { "type": "key"; key: KeyPress }
   | { "type": "paste"; text: string }

package/src/generated/LinkState.ts

@@ -3,14 +3,15 @@
 /**
  * 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
+ * `up` is the summary and this is the story, because "not connected" is four 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.
+ * again, one nothing is dialling at all — it reached us last time, or it was told to stop — and
+ * one that answered and is waiting on a person. `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": "waiting" }
   | { "state": "retrying"; attempt: number }
   | { "state": "down" };

package/src/generated/ServerMessage.ts

@@ -1,6 +1,8 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ApiResponse } from "./ApiResponse";
 import type { BuildId } from "./BuildId";
 import type { DetachReason } from "./DetachReason";
+import type { PluginEvent } from "./PluginEvent";
 import type { UiEvent } from "./UiEvent";
 import type { WorkspaceStatus } from "./WorkspaceStatus";
 
@@ -12,4 +14,6 @@ export type ServerMessage =
   | { "kind": "refused"; reason: string; protocol_version: number }
   | { "kind": "events"; batch: Array<UiEvent> }
   | { "kind": "detached"; reason: DetachReason }
-  | { "kind": "status"; status: WorkspaceStatus };
+  | { "kind": "status"; status: WorkspaceStatus }
+  | { "kind": "called"; id: string; response: ApiResponse }
+  | { "kind": "event"; event: PluginEvent };

package/src/index.ts

@@ -1641,6 +1641,17 @@ export interface SwarmApi {
   pair(node: NodeId, opts?: { name?: string; addr?: string }): Promise<void>;
   /** Withdraw authorisation and stop connecting. Refuses for a machine your config declared. */
   unpair(node: NodeId): Promise<void>;
+  /**
+   * Call a machine something else — an SSH `Host` alias, and for the same reasons.
+   *
+   * A hostname is chosen by whoever set the machine up, is often `Mac` or `ubuntu` on every box
+   * somebody owns, and is not what its owner calls it. This wins over the announced name
+   * everywhere a `SwarmNode` is read, so every panel agrees; `null` gives the announced name back.
+   *
+   * Refuses for a machine your `config.toml` declared, naming the `name` field to change instead —
+   * an alias stored beside a config peer would be reverted by the next reload.
+   */
+  rename(node: NodeId, name: string | null): Promise<void>;
   /**
    * Dial a down peer again now, rather than waiting out its retry delay.
    *
@@ -2053,6 +2064,9 @@ function build(
       async unpair(node) {
         await c({ call: "swarm_unpair", node });
       },
+      async rename(node, name) {
+        await c({ call: "swarm_rename", node, name });
+      },
       async reconnect(node) {
         await c({ call: "swarm_reconnect", node });
       },