@ai-matrx/desktop-protocol 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog
 
+## 0.2.0
+
+The phone console (lane E) needs a client that comes back the instant the person does.
+
+- `client.wake({ probeMs })` — reconnecting: dial now instead of waiting out the backoff; open:
+  send a ping and, if nothing is heard within `probeMs` (default 4000), treat the socket as dead
+  and redial at once. A phone resumed from sleep often holds a socket the OS already killed.
+- `bindDesktopWake(client)` (`./client`) and `useDesktopWake()` (`./react`) call `wake()` on
+  `visibilitychange` → visible, `pageshow`, `online` and `focus`.
+- A caller-started `session.attach` (a page reload reattaching by the resource id it kept in the
+  URL) is now a resource stream from its first byte: `resourceId` is set from the params,
+  `lastSeq` starts at `since_seq` (no false `seq_gap` on the first replayed frame), and the stream
+  reattaches after a later drop like the stream that created the resource.
+
+Consumer action: none required. Phone and browser consoles should call `useDesktopWake()` (or
+`bindDesktopWake`) once per client.
+
+## 0.1.1
+
+Automatic changed-only republish (docs/metadata drift since the last tag — see
+`git diff npm/desktop-protocol/v0.1.0..npm/desktop-protocol/v0.1.1 -- apps/shared/desktop-protocol`).
+No source changes intended and no consumer action required.
+
 ## 0.1.0
 
 First release — the Matrx 2 phone slice, lane A.
@@ -14,6 +37,13 @@ First release — the Matrx 2 phone slice, lane A.
   `@ai-matrx/realtime`'s `createBackoff`.
 - `./react` — `DesktopClientProvider`, `useDesktopConnection`, `useDesktopRequest`,
   `useDesktopEvent`.
+- Relay ↔ device hop, as built by the relay (lane D): `BROADCAST_CID` (an ENVELOPE frame with
+  cid 0 from the device reaches every client), `connectionEndFrame` / `isConnectionEnd` (an
+  ENVELOPE frame with FIN and no payload: relay → device "client gone", device → relay "close this
+  client"), with zod twins `RelayHopEnvelopeHeader` and `RelayHopConnectionEnd`; the `/call` hop
+  shapes `RelayCallHello` (id `hello`) and `RelayCallEnvelope` (id `call`); close codes
+  `ABNORMAL` 1006 (how a relay deploy arrives), `DEVICE_RECONNECTED` 1012, `TRY_AGAIN_LATER` 1013,
+  and `CloseCodeValue` so Python sees the same table. Corpus cases 40–55.
 - Generated twins: `generated/desktop-protocol.schema.json` and
   `aidream/_generated/desktop_protocol.py` (Pydantic, `StrictModel` base, `OPS`/`EVENTS`,
   `validate_wire`), held identical by `pnpm generate --check`.
@@ -33,3 +63,4 @@ Defects found in the draft and fixed here (not preserved):
 ### Consumer action
 
 None — new package.
+

package/README.md

@@ -14,7 +14,7 @@ pnpm add @ai-matrx/desktop-protocol
 | `@ai-matrx/desktop-protocol` | Schemas for the envelope and every `cap.op`, `OPS` / `EVENTS` registries, `ErrorCode`, close codes, `DesktopProtocolError`. Every schema name is also its inferred type. |
 | `@ai-matrx/desktop-protocol/frame` | The 16-byte binary frame codec. Zod-free (the relay Worker's hot path). |
 | `@ai-matrx/desktop-protocol/client` | `createDesktopClient` — reconnecting client with typed requests, credit-gated streams, transparent terminal reattach, heartbeat and relay reauth. |
-| `@ai-matrx/desktop-protocol/react` | `DesktopClientProvider`, `useDesktopConnection`, `useDesktopRequest`, `useDesktopEvent`. |
+| `@ai-matrx/desktop-protocol/react` | `DesktopClientProvider`, `useDesktopConnection`, `useDesktopRequest`, `useDesktopEvent`, `useDesktopWake`. |
 
 ## Client
 
@@ -51,7 +51,15 @@ term.write("ls\n");
   those, never on messages. A dropped socket rejects unary work with `DEVICE_OFFLINE` (retryable).
 - **Terminal closes** (`4010` revoked, `4003` forbidden, `4004` not found, `4009` replaced, `4426`
   upgrade) end the client for good; everything else reconnects with the shared
-  `@ai-matrx/realtime` backoff (stability reset + jitter).
+  `@ai-matrx/realtime` backoff (stability reset + jitter) — including `1006` (a relay deploy drops
+  every socket without a close frame) and `1012` (the relay's "the device reconnected": hello and
+  reattach against the new core session).
+- **Coming back:** `client.wake()` (or `bindDesktopWake(client)` / `useDesktopWake()`, which call it
+  on `visibilitychange`, `pageshow`, `online` and `focus`) dials at once while reconnecting and
+  probes an open socket with a ping, redialing if nothing answers within 4 s.
+- **Reload reattach:** keep `stream.resourceId` and `stream.lastSeq` (e.g. in the URL); after a reload
+  `client.stream("session.attach", { resource_id, since_seq })` replays the gap and then behaves
+  exactly like the original stream, including surviving later drops.
 - Background problems (malformed messages, sequence gaps, heartbeat death, reconnect alarm) go to
   `onDiagnostic` — loud by default (`console.warn`).
 

package/dist/client.cjs

@@ -22,6 +22,7 @@ var client_exports = {};
 __export(client_exports, {
   DesktopProtocolError: () => DesktopProtocolError,
   RECONNECT_ALARM_ATTEMPTS: () => import_realtime.RECONNECT_ALARM_ATTEMPTS,
+  bindDesktopWake: () => bindDesktopWake,
   createDesktopClient: () => createDesktopClient,
   isDesktopProtocolError: () => isDesktopProtocolError
 });
@@ -283,7 +284,15 @@ var CoreToClientMsg = import_zod3.z.discriminatedUnion("type", [ResponseMsg, Err
 var CloseCode = {
   NORMAL: 1e3,
   GOING_AWAY: 1001,
-  // relay deploy / app quit — reconnect immediately
+  // app quit; relay: the device was silent for 75 s — reconnect
+  /** Never sent by anyone: what a socket reports when it drops without a close frame. A relay
+   *  deploy (every Durable Object restarts) arrives as this — reconnect immediately. */
+  ABNORMAL: 1006,
+  /** Relay → clients: the device (re)connected, so the core session they spoke to is gone —
+   *  reconnect, hello, and reattach with since_seq. */
+  DEVICE_RECONNECTED: 1012,
+  TRY_AGAIN_LATER: 1013,
+  // relay: signing keys or the device registry unreachable — retry
   AUTH_INVALID: 4001,
   AUTH_FORBIDDEN: 4003,
   DEVICE_NOT_FOUND: 4004,
@@ -296,6 +305,7 @@ var CloseCode = {
   PROTOCOL_ERROR: 4400,
   UPGRADE_REQUIRED: 4426
 };
+var CloseCodeValue = import_zod3.z.literal([1e3, 1001, 1006, 1012, 1013, 4001, 4003, 4004, 4008, 4009, 4010, 4400, 4426]);
 
 // src/schema/frame.ts
 var import_zod4 = require("zod");
@@ -307,6 +317,22 @@ var FrameHeader = import_zod4.z.strictObject({
   sid: u32,
   seq: u32
 });
+var RelayHopEnvelopeHeader = import_zod4.z.strictObject({
+  version: import_zod4.z.literal(FRAME_VERSION),
+  flags: import_zod4.z.literal(0),
+  channel: import_zod4.z.literal(255),
+  cid: u32,
+  sid: import_zod4.z.literal(0),
+  seq: import_zod4.z.literal(0)
+});
+var RelayHopConnectionEnd = import_zod4.z.strictObject({
+  version: import_zod4.z.literal(FRAME_VERSION),
+  flags: import_zod4.z.literal(1),
+  channel: import_zod4.z.literal(255),
+  cid: import_zod4.z.int().min(1).max(4294967295),
+  sid: import_zod4.z.literal(0),
+  seq: import_zod4.z.literal(0)
+});
 var DEFAULT_WINDOW_BYTES = 262144;
 var DEFAULT_MAX_FRAME_PAYLOAD_BYTES = 65536;
 
@@ -616,6 +642,22 @@ var RelayCallResponse = import_zod9.z.discriminatedUnion("ok", [
   import_zod9.z.strictObject({ ok: import_zod9.z.literal(true), result: import_zod9.z.unknown() }),
   import_zod9.z.strictObject({ ok: import_zod9.z.literal(false), error: ProtocolErrorBody })
 ]);
+var RELAY_CALL_HELLO_ID = "hello";
+var RELAY_CALL_REQUEST_ID = "call";
+var RelayCallHello = import_zod9.z.strictObject({
+  type: import_zod9.z.literal("hello"),
+  id: import_zod9.z.literal(RELAY_CALL_HELLO_ID),
+  protocolVersion: ProtocolVersion,
+  clientType: import_zod9.z.literal("server"),
+  clientVersion: import_zod9.z.string().min(1).max(32)
+});
+var RelayCallEnvelope = import_zod9.z.strictObject({
+  id: import_zod9.z.literal(RELAY_CALL_REQUEST_ID),
+  type: import_zod9.z.literal("request"),
+  cap: import_zod9.z.string().min(1).max(32),
+  op: import_zod9.z.string().min(1).max(64),
+  params: import_zod9.z.unknown()
+});
 
 // src/schema/registry.ts
 var FS_ERR = ["NOT_FOUND", "PERMISSION_DENIED_OS", "INVALID_PARAMS", "RESOURCE_BUSY", "INTERNAL"];
@@ -720,7 +762,9 @@ function createDesktopClient(options) {
   let helloId = null;
   let reconnectTimer = null;
   let heartbeatTimer = null;
+  let probeTimer = null;
   let lastHeardAt = 0;
+  let heardCount = 0;
   let closedByUser = false;
   const newId = (prefix) => `${prefix}${(++nextId).toString(36)}`;
   function setState(patch) {
@@ -775,6 +819,7 @@ function createDesktopClient(options) {
     ws.onmessage = (event) => {
       if (generation !== socketGeneration) return;
       lastHeardAt = timers.now();
+      heardCount++;
       onMessage(event.data);
     };
     ws.onerror = () => {
@@ -816,6 +861,10 @@ function createDesktopClient(options) {
       timers.clearTimeout(heartbeatTimer);
       heartbeatTimer = null;
     }
+    if (probeTimer !== null) {
+      timers.clearTimeout(probeTimer);
+      probeTimer = null;
+    }
     const terminal = code === null ? void 0 : TERMINAL_CLOSE.get(code);
     const lost = error ?? (terminal ? new DesktopProtocolError(terminal[0], terminal[1]) : new DesktopProtocolError("DEVICE_OFFLINE", "Connection lost", { retryable: true }));
     for (const [id, p] of pending) {
@@ -1192,15 +1241,16 @@ function createDesktopClient(options) {
     });
     result.catch(() => void 0);
     done.catch(() => void 0);
+    const attach = op === "session.attach" ? params : null;
     const s = {
       op,
       handlers,
       options: opts,
       id: newId("s"),
       sid: null,
-      resourceId: null,
-      lastSeq: 0,
-      expectSeq: 1,
+      resourceId: attach ? attach.resource_id : null,
+      lastSeq: attach?.since_seq ?? 0,
+      expectSeq: attach ? attach.since_seq === void 0 ? null : attach.since_seq + 1 : 1,
       windowBytes: opts.windowBytes ?? DEFAULT_WINDOW_BYTES,
       consumedUncredited: 0,
       sendWindow: DEFAULT_WINDOW_BYTES,
@@ -1289,6 +1339,34 @@ function createDesktopClient(options) {
   function reauth(token) {
     sendJson({ type: "relay", op: "reauth", token });
   }
+  function wake(opts = {}) {
+    if (closedByUser || state.status === "closed") return;
+    if (state.status === "idle" || state.status === "reconnecting") {
+      connect();
+      return;
+    }
+    if (state.status === "connecting" || !socket || probeTimer !== null) return;
+    const generation = socketGeneration;
+    const heardBefore = heardCount;
+    try {
+      socket.send(PING_TEXT);
+    } catch {
+    }
+    probeTimer = timers.setTimeout(() => {
+      probeTimer = null;
+      if (generation !== socketGeneration || !socket) return;
+      if (heardCount > heardBefore) return;
+      const silentMs = timers.now() - lastHeardAt;
+      diagnose({ kind: "heartbeat_timeout", silentMs });
+      const dead = socket;
+      onSocketGone(generation, null, new DesktopProtocolError("TIMEOUT", "Connection went silent", { retryable: true }));
+      try {
+        dead.close(CloseCode.NORMAL, "wake probe timeout");
+      } catch {
+      }
+      if (state.status === "reconnecting") connect();
+    }, opts.probeMs ?? 4e3);
+  }
   return {
     connect,
     close,
@@ -1303,7 +1381,29 @@ function createDesktopClient(options) {
     request,
     stream,
     on,
-    reauth
+    reauth,
+    wake
+  };
+}
+
+// src/client/wake.ts
+function bindDesktopWake(client, options = {}) {
+  const targets = options.targets ?? (typeof window !== "undefined" && typeof document !== "undefined" ? { window, document } : null);
+  if (!targets) return () => void 0;
+  const wakeOptions = options.probeMs === void 0 ? {} : { probeMs: options.probeMs };
+  const onVisibility = () => {
+    if (targets.document.visibilityState === "visible") client.wake(wakeOptions);
+  };
+  const onWake = () => client.wake(wakeOptions);
+  targets.document.addEventListener("visibilitychange", onVisibility);
+  targets.window.addEventListener("pageshow", onWake);
+  targets.window.addEventListener("online", onWake);
+  targets.window.addEventListener("focus", onWake);
+  return () => {
+    targets.document.removeEventListener("visibilitychange", onVisibility);
+    targets.window.removeEventListener("pageshow", onWake);
+    targets.window.removeEventListener("online", onWake);
+    targets.window.removeEventListener("focus", onWake);
   };
 }
 //# sourceMappingURL=client.cjs.map