@av-pi-studio/protocol 0.0.117 → 0.0.118

package/fixtures/external-clients/create_terminal_response.json

@@ -0,0 +1,31 @@
+{
+  "type": "create_terminal_response",
+  "direction": "server_to_client",
+  "description": "The new terminal's inventory entry (the PTY's real grid size). `service` appears only for script-backed terminals.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": [
+    "/message/requestId",
+    "/message/terminal/slot",
+    "/message/terminal/name",
+    "/message/terminal/cwd"
+  ],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "create_terminal_response",
+      "terminal": {
+        "slot": 1,
+        "workspaceId": "workspace-1",
+        "name": "terminal-1",
+        "cwd": "/tmp/pi-studio-fixture",
+        "shell": "/bin/sh",
+        "cols": 80,
+        "rows": 24,
+        "closed": false
+      },
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/file_download_request.json

@@ -0,0 +1,18 @@
+{
+  "type": "file_download_request",
+  "direction": "client_to_server",
+  "description": "Redeem the token: the daemon streams Begin/Chunk*/End binary file-transfer frames on `stream` (omit `stream` to let the daemon pick), then answers.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/token", "/message/stream"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "file_download_request",
+      "requestId": "req-1",
+      "token": "FAKE",
+      "stream": 1
+    }
+  }
+}

package/fixtures/external-clients/file_download_response.json

@@ -0,0 +1,19 @@
+{
+  "type": "file_download_response",
+  "direction": "server_to_client",
+  "description": "Sent after the End frame. On failure `ok:false` with `error` (invalid_or_expired_token, invalid_stream, read_failed, connection_closed).",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/stream", "/message/transferId"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "file_download_response",
+      "stream": 1,
+      "ok": true,
+      "transferId": "dl-1-1767225600000",
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/file_download_token_request.json

@@ -0,0 +1,17 @@
+{
+  "type": "file_download_token_request",
+  "direction": "client_to_server",
+  "description": "Ask for a single-use download token for a file path on the daemon host.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/path"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "file_download_token_request",
+      "requestId": "req-1",
+      "path": "/tmp/pi-studio-fixture/download.txt"
+    }
+  }
+}

package/fixtures/external-clients/file_download_token_response.json

@@ -0,0 +1,19 @@
+{
+  "type": "file_download_token_response",
+  "direction": "server_to_client",
+  "description": "Token plus its expiry (epoch ms). Failure is `{ok:false,error:\"not_found\"}` with no token.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/token", "/message/expiresAt"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "file_download_token_response",
+      "ok": true,
+      "token": "FAKE",
+      "expiresAt": 1767225600000,
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/file_upload_complete.json

@@ -0,0 +1,19 @@
+{
+  "type": "file_upload_complete",
+  "direction": "server_to_client",
+  "description": "Push after an upload stream ends, only when the request carried `ack:true`. `error` is present only when `ok` is false.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": "fileTransferAck",
+  "volatile": ["/message/transferId", "/message/stream", "/message/bytesWritten"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "file_upload_complete",
+      "transferId": "transfer-1",
+      "stream": 1,
+      "ok": true,
+      "bytesWritten": 30
+    }
+  }
+}

package/fixtures/external-clients/file_upload_request.json

@@ -0,0 +1,19 @@
+{
+  "type": "file_upload_request",
+  "direction": "client_to_server",
+  "description": "Open an upload: the daemon assigns a stream; the client then sends Begin/Chunk*/End binary frames on it. `ack:true` asks for a `file_upload_complete` push when the stream ends.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": "fileTransferAck",
+  "volatile": ["/message/requestId", "/message/path", "/message/transferId"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "file_upload_request",
+      "requestId": "req-1",
+      "path": "/tmp/pi-studio-fixture/upload.txt",
+      "transferId": "transfer-1",
+      "ack": true
+    }
+  }
+}

package/fixtures/external-clients/file_upload_response.json

@@ -0,0 +1,18 @@
+{
+  "type": "file_upload_response",
+  "direction": "server_to_client",
+  "description": "The stream the client must use. Failure: `ok:false` with `error` (missing_fields, no_free_stream).",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/stream"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "file_upload_response",
+      "ok": true,
+      "stream": 1,
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/hello.platform.json

@@ -0,0 +1,20 @@
+{
+  "type": "hello",
+  "direction": "client_to_server",
+  "description": "Handshake from the desktop app: clientType stays \"browser\" (the enum is closed; a daemon up to 0.0.117 rejects unknown values), and the optional platform string says what kind of client it is. Daemons that predate the field ignore it.",
+  "since": "0.0.118",
+  "stage": 1,
+  "requiresFeature": null,
+  "volatile": ["/clientId"],
+  "frame": {
+    "type": "hello",
+    "clientId": "client-1",
+    "clientType": "browser",
+    "platform": "desktop",
+    "protocolVersion": 1,
+    "appVersion": "pistudiodesktop/0.1.0",
+    "capabilities": {
+      "reasoning_merge_enum": true
+    }
+  }
+}

package/fixtures/external-clients/kill_terminal_request.json

@@ -0,0 +1,17 @@
+{
+  "type": "kill_terminal_request",
+  "direction": "client_to_server",
+  "description": "Kill a terminal's PTY.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/slot"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "kill_terminal_request",
+      "requestId": "req-1",
+      "slot": 1
+    }
+  }
+}

package/fixtures/external-clients/kill_terminal_response.json

@@ -0,0 +1,18 @@
+{
+  "type": "kill_terminal_response",
+  "direction": "server_to_client",
+  "description": "`ok:false` when the slot does not exist. A kill also broadcasts `terminals_update`.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/slot"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "kill_terminal_response",
+      "slot": 1,
+      "ok": true,
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/list_terminals_request.json

@@ -0,0 +1,16 @@
+{
+  "type": "list_terminals_request",
+  "direction": "client_to_server",
+  "description": "List every live terminal.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "list_terminals_request",
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/list_terminals_response.json

@@ -0,0 +1,33 @@
+{
+  "type": "list_terminals_response",
+  "direction": "server_to_client",
+  "description": "The terminal inventory (one representative element).",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": [
+    "/message/requestId",
+    "/message/terminals/0/slot",
+    "/message/terminals/0/name",
+    "/message/terminals/0/cwd"
+  ],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "list_terminals_response",
+      "terminals": [
+        {
+          "slot": 1,
+          "workspaceId": "workspace-1",
+          "name": "terminal-1",
+          "cwd": "/tmp/pi-studio-fixture",
+          "shell": "/bin/sh",
+          "cols": 80,
+          "rows": 24,
+          "closed": false
+        }
+      ],
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/manifest.json

@@ -187,6 +187,28 @@
       "type": "agent_update",
       "direction": "server_to_client"
     },
+    {
+      "file": "capture_terminal_request.json",
+      "type": "capture_terminal_request",
+      "direction": "client_to_server",
+      "response": "capture_terminal_response.json"
+    },
+    {
+      "file": "capture_terminal_response.json",
+      "type": "capture_terminal_response",
+      "direction": "server_to_client"
+    },
+    {
+      "file": "create_terminal_request.json",
+      "type": "create_terminal_request",
+      "direction": "client_to_server",
+      "response": "create_terminal_response.json"
+    },
+    {
+      "file": "create_terminal_response.json",
+      "type": "create_terminal_response",
+      "direction": "server_to_client"
+    },
     {
       "file": "daemon_log_lines.json",
       "type": "daemon_log_lines",
@@ -263,6 +285,44 @@
       "type": "fetch_agent_timeline_response",
       "direction": "server_to_client"
     },
+    {
+      "file": "file_download_request.json",
+      "type": "file_download_request",
+      "direction": "client_to_server",
+      "response": "file_download_response.json"
+    },
+    {
+      "file": "file_download_response.json",
+      "type": "file_download_response",
+      "direction": "server_to_client"
+    },
+    {
+      "file": "file_download_token_request.json",
+      "type": "file_download_token_request",
+      "direction": "client_to_server",
+      "response": "file_download_token_response.json"
+    },
+    {
+      "file": "file_download_token_response.json",
+      "type": "file_download_token_response",
+      "direction": "server_to_client"
+    },
+    {
+      "file": "file_upload_complete.json",
+      "type": "file_upload_complete",
+      "direction": "server_to_client"
+    },
+    {
+      "file": "file_upload_request.json",
+      "type": "file_upload_request",
+      "direction": "client_to_server",
+      "response": "file_upload_response.json"
+    },
+    {
+      "file": "file_upload_response.json",
+      "type": "file_upload_response",
+      "direction": "server_to_client"
+    },
     {
       "file": "health.json",
       "type": "health",
@@ -274,6 +334,12 @@
       "direction": "client_to_server",
       "response": "status.server_info.json"
     },
+    {
+      "file": "hello.platform.json",
+      "type": "hello",
+      "direction": "client_to_server",
+      "response": "status.server_info.json"
+    },
     {
       "file": "interrupt_agent.json",
       "type": "interrupt_agent",
@@ -285,6 +351,17 @@
       "type": "interrupt_response",
       "direction": "server_to_client"
     },
+    {
+      "file": "kill_terminal_request.json",
+      "type": "kill_terminal_request",
+      "direction": "client_to_server",
+      "response": "kill_terminal_response.json"
+    },
+    {
+      "file": "kill_terminal_response.json",
+      "type": "kill_terminal_response",
+      "direction": "server_to_client"
+    },
     {
       "file": "list_agents_request.json",
       "type": "list_agents_request",
@@ -296,6 +373,17 @@
       "type": "list_agents_response",
       "direction": "server_to_client"
     },
+    {
+      "file": "list_terminals_request.json",
+      "type": "list_terminals_request",
+      "direction": "client_to_server",
+      "response": "list_terminals_response.json"
+    },
+    {
+      "file": "list_terminals_response.json",
+      "type": "list_terminals_response",
+      "direction": "server_to_client"
+    },
     {
       "file": "ping.json",
       "type": "ping",
@@ -307,6 +395,17 @@
       "type": "pong",
       "direction": "server_to_client"
     },
+    {
+      "file": "rename_terminal_request.json",
+      "type": "rename_terminal_request",
+      "direction": "client_to_server",
+      "response": "rename_terminal_response.json"
+    },
+    {
+      "file": "rename_terminal_response.json",
+      "type": "rename_terminal_response",
+      "direction": "server_to_client"
+    },
     {
       "file": "rpc_error.json",
       "type": "rpc_error",
@@ -316,6 +415,22 @@
       "file": "status.server_info.json",
       "type": "status",
       "direction": "server_to_client"
+    },
+    {
+      "file": "subscribe_terminal_request.json",
+      "type": "subscribe_terminal_request",
+      "direction": "client_to_server",
+      "response": "subscribe_terminal_response.json"
+    },
+    {
+      "file": "subscribe_terminal_response.json",
+      "type": "subscribe_terminal_response",
+      "direction": "server_to_client"
+    },
+    {
+      "file": "terminals_update.json",
+      "type": "terminals_update",
+      "direction": "server_to_client"
     }
   ]
 }

package/fixtures/external-clients/rename_terminal_request.json

@@ -0,0 +1,18 @@
+{
+  "type": "rename_terminal_request",
+  "direction": "client_to_server",
+  "description": "Rename a terminal.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/slot"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "rename_terminal_request",
+      "requestId": "req-1",
+      "slot": 1,
+      "name": "renamed"
+    }
+  }
+}

package/fixtures/external-clients/rename_terminal_response.json

@@ -0,0 +1,18 @@
+{
+  "type": "rename_terminal_response",
+  "direction": "server_to_client",
+  "description": "`ok:false` when the slot does not exist. A successful rename also broadcasts `terminals_update`.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/slot"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "rename_terminal_response",
+      "slot": 1,
+      "ok": true,
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/subscribe_terminal_request.json

@@ -0,0 +1,19 @@
+{
+  "type": "subscribe_terminal_request",
+  "direction": "client_to_server",
+  "description": "Attach to one terminal's binary stream; `cols`/`rows` (optional) resize the PTY before the snapshot. `restoreMode` is optional.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/slot"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "subscribe_terminal_request",
+      "requestId": "req-1",
+      "slot": 1,
+      "cols": 80,
+      "rows": 24
+    }
+  }
+}

package/fixtures/external-clients/subscribe_terminal_response.json

@@ -0,0 +1,21 @@
+{
+  "type": "subscribe_terminal_response",
+  "direction": "server_to_client",
+  "description": "Subscription result; `cols`/`rows` echo the PTY's real size. Failure: `ok:false`, `error:\"no_such_terminal\"`.",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": ["/message/requestId", "/message/slot"],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "subscribe_terminal_response",
+      "slot": 1,
+      "ok": true,
+      "restoreMode": "basic",
+      "cols": 80,
+      "rows": 24,
+      "requestId": "req-1"
+    }
+  }
+}

package/fixtures/external-clients/terminals_update.json

@@ -0,0 +1,31 @@
+{
+  "type": "terminals_update",
+  "direction": "server_to_client",
+  "description": "Broadcast to every session when the terminal inventory changes (create, rename, resize, exit/kill).",
+  "since": "0.0.118",
+  "stage": 3,
+  "requiresFeature": null,
+  "volatile": [
+    "/message/terminals/0/slot",
+    "/message/terminals/0/name",
+    "/message/terminals/0/cwd"
+  ],
+  "frame": {
+    "type": "session",
+    "message": {
+      "type": "terminals_update",
+      "terminals": [
+        {
+          "slot": 1,
+          "workspaceId": "workspace-1",
+          "name": "terminal-1",
+          "cwd": "/tmp/pi-studio-fixture",
+          "shell": "/bin/sh",
+          "cols": 80,
+          "rows": 24,
+          "closed": false
+        }
+      ]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@av-pi-studio/protocol",
-  "version": "0.0.117",
+  "version": "0.0.118",
   "files": [
     "dist",
     "!dist/**/*.map",