@band-app/server 0.57.0 → 0.59.0

package/dist/openapi.json

@@ -248,6 +248,108 @@
         ]
       }
     },
+    "/resources.snapshot": {
+      "get": {
+        "operationId": "resources.snapshot",
+        "tags": [
+          "resources"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "$ref": "#/components/schemas/ResourcesReport"
+                        }
+                      },
+                      "required": [
+                        "data"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
+      }
+    },
+    "/resources.storage": {
+      "get": {
+        "operationId": "resources.storage",
+        "tags": [
+          "resources"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "$ref": "#/components/schemas/ResourceStorageView"
+                        }
+                      },
+                      "required": [
+                        "data"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/Error"
+          }
+        },
+        "parameters": [
+          {
+            "name": "input",
+            "in": "query",
+            "required": true,
+            "style": "deepObject",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "hostId": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "hostId"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
     "/hooks.check": {
       "get": {
         "operationId": "hooks.check",
@@ -24467,6 +24569,401 @@
         ],
         "additionalProperties": false
       },
+      "ResourcesReport": {
+        "type": "object",
+        "properties": {
+          "takenAt": {
+            "type": "number"
+          },
+          "machines": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ResourceMachine"
+            }
+          }
+        },
+        "required": [
+          "takenAt",
+          "machines"
+        ],
+        "additionalProperties": false
+      },
+      "ResourceMachine": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "`local` for the hub's own machine, else the worker id."
+          },
+          "role": {
+            "type": "string",
+            "enum": [
+              "hub",
+              "worker"
+            ],
+            "description": "`hub` for the hub's machine (its built-in worker included), `worker` for any other."
+          },
+          "name": {
+            "type": "string"
+          },
+          "version": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "builtInWorker": {
+            "type": "boolean",
+            "description": "Whether the hub's machine also runs the built-in `local` worker."
+          },
+          "onBattery": {
+            "type": [
+              "boolean",
+              "null"
+            ]
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "ok",
+              "unavailable"
+            ]
+          },
+          "reason": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "enum": [
+              "offline",
+              "no-answer"
+            ],
+            "description": "Why a machine shows no numbers."
+          },
+          "snapshot": {
+            "oneOf": [
+              {
+                "allOf": [
+                  {
+                    "$ref": "#/components/schemas/Omit"
+                  },
+                  {
+                    "type": "object",
+                    "properties": {
+                      "processes": {
+                        "type": "array",
+                        "items": {
+                          "$ref": "#/components/schemas/ResourceProcessView"
+                        }
+                      }
+                    },
+                    "required": [
+                      "processes"
+                    ],
+                    "additionalProperties": false
+                  }
+                ]
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "role",
+          "name",
+          "version",
+          "builtInWorker",
+          "onBattery",
+          "status",
+          "reason",
+          "snapshot"
+        ],
+        "additionalProperties": false
+      },
+      "Omit": {
+        "type": "object",
+        "properties": {
+          "hostname": {
+            "type": "string"
+          },
+          "os": {
+            "type": "string"
+          },
+          "cores": {
+            "type": "number"
+          },
+          "memTotalBytes": {
+            "type": "number",
+            "description": "RAM of the machine and what is in use, in bytes."
+          },
+          "memUsedBytes": {
+            "type": "number"
+          },
+          "machineCpuPercent": {
+            "type": [
+              "number",
+              "null"
+            ],
+            "description": "Machine CPU over the sampling window, 0 to 100. Null when it could not be read."
+          },
+          "loadAverage": {
+            "type": "number"
+          },
+          "windowMs": {
+            "type": "number",
+            "description": "How long the sampling window was, in milliseconds."
+          },
+          "takenAt": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "hostname",
+          "os",
+          "cores",
+          "memTotalBytes",
+          "memUsedBytes",
+          "machineCpuPercent",
+          "loadAverage",
+          "windowMs",
+          "takenAt"
+        ],
+        "additionalProperties": false
+      },
+      "ResourceProcessView": {
+        "type": "object",
+        "properties": {
+          "worktree": {
+            "$ref": "#/components/schemas/ResourceWorktreeRef"
+          },
+          "chat": {
+            "$ref": "#/components/schemas/ResourceChatRef"
+          },
+          "kind": {
+            "type": "string",
+            "enum": [
+              "terminal",
+              "agent",
+              "browser",
+              "hub",
+              "worker",
+              "mcp",
+              "terminal-daemon",
+              "agent-daemon",
+              "lsp",
+              "simulator",
+              "other"
+            ],
+            "description": "What a Band process on a machine is for."
+          },
+          "chatId": {
+            "type": "string"
+          },
+          "worktreeId": {
+            "type": "string",
+            "description": "Ids from the process environment (`BAND_WORKTREE_ID`, `BAND_CHAT_ID`, `BAND_TERMINAL_ID`)."
+          },
+          "terminalId": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string",
+            "description": "Short name: the shell, the agent adapter, the language server."
+          },
+          "pid": {
+            "type": "number"
+          },
+          "rssBytes": {
+            "type": "number",
+            "description": "Resident memory of the process and its children, in bytes."
+          },
+          "cpuPercent": {
+            "type": "number",
+            "description": "CPU of the process and its children over the sampling window, in percent of one core."
+          },
+          "processCount": {
+            "type": "number",
+            "description": "How many processes the numbers cover (the process and its descendants)."
+          }
+        },
+        "required": [
+          "kind",
+          "name",
+          "pid",
+          "rssBytes",
+          "cpuPercent",
+          "processCount"
+        ],
+        "additionalProperties": false
+      },
+      "ResourceWorktreeRef": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "repo": {
+            "type": "string"
+          },
+          "branch": {
+            "type": "string"
+          },
+          "title": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "repo",
+          "branch",
+          "title"
+        ],
+        "additionalProperties": false
+      },
+      "ResourceChatRef": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "agent": {
+            "type": "string"
+          },
+          "running": {
+            "type": "boolean"
+          },
+          "idleMs": {
+            "type": [
+              "number",
+              "null"
+            ],
+            "description": "Milliseconds since the agent last sent anything. Null when unknown."
+          },
+          "idle": {
+            "type": "boolean",
+            "description": "True when the agent has been quiet for an hour and runs no turn."
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "agent",
+          "running",
+          "idleMs",
+          "idle"
+        ],
+        "additionalProperties": false
+      },
+      "ResourceStorageView": {
+        "type": "object",
+        "properties": {
+          "worktrees": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ResourceStorageWorktree"
+            }
+          },
+          "state": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "sizeBytes": {
+                  "type": "number"
+                }
+              },
+              "required": [
+                "name",
+                "sizeBytes"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "disk": {
+            "oneOf": [
+              {
+                "$ref": "#/components/schemas/ResourceDisk"
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "worktrees",
+          "state",
+          "disk"
+        ],
+        "additionalProperties": false
+      },
+      "ResourceStorageWorktree": {
+        "type": "object",
+        "properties": {
+          "sizeBytes": {
+            "type": "number"
+          },
+          "error": {
+            "type": "string"
+          },
+          "id": {
+            "type": "string"
+          },
+          "repo": {
+            "type": "string"
+          },
+          "branch": {
+            "type": "string"
+          },
+          "title": {
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        },
+        "required": [
+          "sizeBytes",
+          "id",
+          "repo",
+          "branch",
+          "title"
+        ],
+        "additionalProperties": false
+      },
+      "ResourceDisk": {
+        "type": "object",
+        "properties": {
+          "path": {
+            "type": "string",
+            "description": "The folder the numbers describe."
+          },
+          "totalBytes": {
+            "type": "number"
+          },
+          "freeBytes": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "path",
+          "totalBytes",
+          "freeBytes"
+        ],
+        "additionalProperties": false
+      },
       "HooksStatus": {
         "type": "object",
         "properties": {
@@ -24961,6 +25458,24 @@
                   "install": {
                     "type": "string"
                   },
+                  "resources": {
+                    "type": "object",
+                    "properties": {
+                      "cpu": {
+                        "type": "number"
+                      },
+                      "memory": {
+                        "type": "string"
+                      },
+                      "disk": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "cpu"
+                    ],
+                    "additionalProperties": false
+                  },
                   "build": {
                     "type": "object",
                     "properties": {
@@ -24996,24 +25511,6 @@
                     "items": {
                       "type": "string"
                     }
-                  },
-                  "resources": {
-                    "type": "object",
-                    "properties": {
-                      "cpu": {
-                        "type": "number"
-                      },
-                      "memory": {
-                        "type": "string"
-                      },
-                      "disk": {
-                        "type": "string"
-                      }
-                    },
-                    "required": [
-                      "cpu"
-                    ],
-                    "additionalProperties": false
                   }
                 },
                 "additionalProperties": false
@@ -25329,6 +25826,24 @@
                   "install": {
                     "type": "string"
                   },
+                  "resources": {
+                    "type": "object",
+                    "properties": {
+                      "cpu": {
+                        "type": "number"
+                      },
+                      "memory": {
+                        "type": "string"
+                      },
+                      "disk": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "cpu"
+                    ],
+                    "additionalProperties": false
+                  },
                   "build": {
                     "type": "object",
                     "properties": {
@@ -25364,24 +25879,6 @@
                     "items": {
                       "type": "string"
                     }
-                  },
-                  "resources": {
-                    "type": "object",
-                    "properties": {
-                      "cpu": {
-                        "type": "number"
-                      },
-                      "memory": {
-                        "type": "string"
-                      },
-                      "disk": {
-                        "type": "string"
-                      }
-                    },
-                    "required": [
-                      "cpu"
-                    ],
-                    "additionalProperties": false
                   }
                 },
                 "additionalProperties": false