@band-app/server 0.33.0 → 0.34.0

package/dist/openapi.json

@@ -2326,10 +2326,10 @@
                   "range": {
                     "type": "string",
                     "enum": [
+                      "all",
                       "hour",
                       "day",
-                      "week",
-                      "all"
+                      "week"
                     ]
                   }
                 },
@@ -3042,6 +3042,297 @@
         ]
       }
     },
+    "/plugins.list": {
+      "get": {
+        "operationId": "plugins.list",
+        "description": "The bundled plugins and their state. The dashboard hides the UI of disabled ones.",
+        "tags": [
+          "plugins"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "type": "array",
+                          "items": {
+                            "$ref": "#/components/schemas/PluginInfo"
+                          }
+                        }
+                      },
+                      "required": [
+                        "data"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/Error"
+          }
+        }
+      }
+    },
+    "/reviews.forWorkspace": {
+      "get": {
+        "operationId": "reviews.forWorkspace",
+        "description": "The review for the workspace's branch with its checks, or the branch's\nCI jobs when there is no review. Provider failures come back as\n`status: \"error\"` rather than a thrown error, so the panel can show them.",
+        "tags": [
+          "reviews"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "oneOf": [
+                            {
+                              "type": "object",
+                              "properties": {
+                                "status": {
+                                  "type": "string",
+                                  "const": "ok"
+                                },
+                                "provider": {
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string"
+                                    },
+                                    "name": {
+                                      "type": "string"
+                                    }
+                                  },
+                                  "required": [
+                                    "id",
+                                    "name"
+                                  ],
+                                  "additionalProperties": false
+                                },
+                                "repo": {
+                                  "$ref": "#/components/schemas/RepoInfo"
+                                },
+                                "branch": {
+                                  "type": "string"
+                                },
+                                "review": {
+                                  "oneOf": [
+                                    {
+                                      "$ref": "#/components/schemas/ReviewInfo"
+                                    },
+                                    {
+                                      "type": "null"
+                                    }
+                                  ]
+                                },
+                                "checks": {
+                                  "$ref": "#/components/schemas/ChecksReport"
+                                },
+                                "fetchedAt": {
+                                  "type": "string"
+                                }
+                              },
+                              "required": [
+                                "status",
+                                "provider",
+                                "repo",
+                                "branch",
+                                "review",
+                                "checks",
+                                "fetchedAt"
+                              ],
+                              "additionalProperties": false
+                            },
+                            {
+                              "type": "object",
+                              "properties": {
+                                "status": {
+                                  "type": "string",
+                                  "const": "unavailable"
+                                },
+                                "reason": {
+                                  "type": "string",
+                                  "enum": [
+                                    "plain-project",
+                                    "detached-head",
+                                    "no-remote",
+                                    "no-provider"
+                                  ]
+                                },
+                                "message": {
+                                  "type": "string"
+                                }
+                              },
+                              "required": [
+                                "status",
+                                "reason",
+                                "message"
+                              ],
+                              "additionalProperties": false
+                            },
+                            {
+                              "type": "object",
+                              "properties": {
+                                "status": {
+                                  "type": "string",
+                                  "const": "error"
+                                },
+                                "message": {
+                                  "type": "string"
+                                }
+                              },
+                              "required": [
+                                "status",
+                                "message"
+                              ],
+                              "additionalProperties": false
+                            }
+                          ],
+                          "discriminator": {
+                            "propertyName": "status"
+                          },
+                          "description": "What the core returns for a workspace's review panel: the review for the\nworkspace's branch, or when there is none, the checks on the branch."
+                        }
+                      },
+                      "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": {
+                    "workspaceId": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "workspaceId"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    "/reviews.merge": {
+      "post": {
+        "operationId": "reviews.merge",
+        "description": "Merge the workspace branch's open review.",
+        "tags": [
+          "reviews"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "type": "object",
+                          "properties": {
+                            "ok": {
+                              "type": "boolean",
+                              "const": true
+                            }
+                          },
+                          "required": [
+                            "ok"
+                          ],
+                          "additionalProperties": false
+                        }
+                      },
+                      "required": [
+                        "data"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/Error"
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "workspaceId": {
+                    "type": "string"
+                  },
+                  "method": {
+                    "type": "string",
+                    "enum": [
+                      "merge",
+                      "squash",
+                      "rebase"
+                    ]
+                  }
+                },
+                "required": [
+                  "workspaceId",
+                  "method"
+                ],
+                "additionalProperties": false
+              }
+            }
+          }
+        }
+      }
+    },
     "/services.health": {
       "get": {
         "operationId": "services.health",
@@ -10517,11 +10808,11 @@
         }
       }
     },
-    "/tasks.list": {
+    "/clientState.list": {
       "get": {
-        "operationId": "tasks.list",
+        "operationId": "clientState.list",
         "tags": [
-          "tasks"
+          "clientState"
         ],
         "responses": {
           "200": {
@@ -10537,38 +10828,351 @@
                         "data": {
                           "type": "object",
                           "properties": {
-                            "tasks": {
+                            "entries": {
                               "type": "array",
                               "items": {
-                                "type": "object",
-                                "properties": {
-                                  "workspaceExists": {
-                                    "type": "boolean"
-                                  },
-                                  "id": {
-                                    "type": "string"
-                                  },
-                                  "workspaceId": {
-                                    "type": "string"
-                                  },
-                                  "project": {
-                                    "type": "string"
-                                  },
-                                  "branch": {
-                                    "type": "string"
-                                  },
-                                  "prompt": {
-                                    "type": "string"
-                                  },
-                                  "status": {
-                                    "type": "string",
-                                    "enum": [
-                                      "running",
-                                      "completed",
-                                      "failed"
-                                    ],
-                                    "description": "Persisted-task status. Mirrors the `tasks.status` enum in `schema.ts`.\n\nKept distinct from the in-memory `TaskInfo.status` (declared in the\nservice tier) because the service tier may add transient states (e.g.\n`pending` for queued tasks) without touching the persisted column."
-                                  },
+                                "$ref": "#/components/schemas/ClientStateEntry"
+                              }
+                            }
+                          },
+                          "required": [
+                            "entries"
+                          ],
+                          "additionalProperties": false
+                        }
+                      },
+                      "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": {
+                    "workspaceId": {
+                      "type": [
+                        "string",
+                        "null"
+                      ]
+                    },
+                    "deviceType": {
+                      "type": "string",
+                      "enum": [
+                        "desktop",
+                        "mobile"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "workspaceId",
+                    "deviceType"
+                  ],
+                  "additionalProperties": false
+                }
+              }
+            }
+          }
+        ]
+      }
+    },
+    "/clientState.set": {
+      "post": {
+        "operationId": "clientState.set",
+        "tags": [
+          "clientState"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "oneOf": [
+                            {
+                              "type": "object",
+                              "properties": {
+                                "ok": {
+                                  "type": "boolean",
+                                  "const": true
+                                },
+                                "entry": {
+                                  "$ref": "#/components/schemas/ClientStateEntry"
+                                }
+                              },
+                              "required": [
+                                "ok",
+                                "entry"
+                              ],
+                              "additionalProperties": false
+                            },
+                            {
+                              "type": "object",
+                              "properties": {
+                                "ok": {
+                                  "type": "boolean",
+                                  "const": false
+                                },
+                                "entry": {
+                                  "$ref": "#/components/schemas/ClientStateEntry"
+                                }
+                              },
+                              "required": [
+                                "ok",
+                                "entry"
+                              ],
+                              "additionalProperties": false
+                            }
+                          ],
+                          "discriminator": {
+                            "propertyName": "ok"
+                          }
+                        }
+                      },
+                      "required": [
+                        "data"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/Error"
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "key": {
+                    "type": "string"
+                  },
+                  "scope": {
+                    "type": "string",
+                    "enum": [
+                      "desktop",
+                      "mobile",
+                      "all"
+                    ]
+                  },
+                  "baseVersion": {
+                    "type": "number"
+                  },
+                  "clientId": {
+                    "type": "string"
+                  },
+                  "value": {}
+                },
+                "required": [
+                  "key",
+                  "scope",
+                  "baseVersion",
+                  "clientId"
+                ],
+                "additionalProperties": false
+              }
+            }
+          }
+        }
+      }
+    },
+    "/clientState.delete": {
+      "post": {
+        "operationId": "clientState.delete",
+        "tags": [
+          "clientState"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "oneOf": [
+                            {
+                              "type": "object",
+                              "properties": {
+                                "ok": {
+                                  "type": "boolean",
+                                  "const": true
+                                },
+                                "entry": {
+                                  "$ref": "#/components/schemas/ClientStateEntry"
+                                }
+                              },
+                              "required": [
+                                "ok",
+                                "entry"
+                              ],
+                              "additionalProperties": false
+                            },
+                            {
+                              "type": "object",
+                              "properties": {
+                                "ok": {
+                                  "type": "boolean",
+                                  "const": false
+                                },
+                                "entry": {
+                                  "$ref": "#/components/schemas/ClientStateEntry"
+                                }
+                              },
+                              "required": [
+                                "ok",
+                                "entry"
+                              ],
+                              "additionalProperties": false
+                            }
+                          ],
+                          "discriminator": {
+                            "propertyName": "ok"
+                          }
+                        }
+                      },
+                      "required": [
+                        "data"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "result"
+                  ]
+                }
+              }
+            }
+          },
+          "default": {
+            "$ref": "#/components/responses/Error"
+          }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "key": {
+                    "type": "string"
+                  },
+                  "scope": {
+                    "type": "string",
+                    "enum": [
+                      "desktop",
+                      "mobile",
+                      "all"
+                    ]
+                  },
+                  "baseVersion": {
+                    "type": "number"
+                  },
+                  "clientId": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "key",
+                  "scope",
+                  "baseVersion",
+                  "clientId"
+                ],
+                "additionalProperties": false
+              }
+            }
+          }
+        }
+      }
+    },
+    "/tasks.list": {
+      "get": {
+        "operationId": "tasks.list",
+        "tags": [
+          "tasks"
+        ],
+        "responses": {
+          "200": {
+            "description": "Successful response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "result": {
+                      "type": "object",
+                      "properties": {
+                        "data": {
+                          "type": "object",
+                          "properties": {
+                            "tasks": {
+                              "type": "array",
+                              "items": {
+                                "type": "object",
+                                "properties": {
+                                  "workspaceExists": {
+                                    "type": "boolean"
+                                  },
+                                  "id": {
+                                    "type": "string"
+                                  },
+                                  "workspaceId": {
+                                    "type": "string"
+                                  },
+                                  "project": {
+                                    "type": "string"
+                                  },
+                                  "branch": {
+                                    "type": "string"
+                                  },
+                                  "prompt": {
+                                    "type": "string"
+                                  },
+                                  "status": {
+                                    "type": "string",
+                                    "enum": [
+                                      "running",
+                                      "completed",
+                                      "failed"
+                                    ],
+                                    "description": "Persisted-task status. Mirrors the `tasks.status` enum in `schema.ts`.\n\nKept distinct from the in-memory `TaskInfo.status` (declared in the\nservice tier) because the service tier may add transient states (e.g.\n`pending` for queued tasks) without touching the persisted column."
+                                  },
                                   "sessionId": {
                                     "type": "string"
                                   },
@@ -11518,6 +12122,242 @@
         ],
         "additionalProperties": false
       },
+      "PluginInfo": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "version": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "active",
+              "inactive",
+              "disabled",
+              "errored"
+            ]
+          },
+          "error": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The last activation error, when `status` is `errored`."
+          },
+          "slots": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "const": "workspace.sideTabs"
+            }
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "version",
+          "status",
+          "error",
+          "slots"
+        ],
+        "additionalProperties": false
+      },
+      "RepoInfo": {
+        "type": "object",
+        "properties": {
+          "host": {
+            "type": "string"
+          },
+          "owner": {
+            "type": "string"
+          },
+          "repo": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "host",
+          "owner",
+          "repo"
+        ],
+        "additionalProperties": false
+      },
+      "ReviewInfo": {
+        "type": "object",
+        "properties": {
+          "number": {
+            "type": "number"
+          },
+          "url": {
+            "type": "string"
+          },
+          "title": {
+            "type": "string"
+          },
+          "state": {
+            "type": "string",
+            "enum": [
+              "open",
+              "draft",
+              "merged",
+              "closed"
+            ]
+          },
+          "updatedAt": {
+            "type": "string"
+          },
+          "reviewDecision": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "enum": [
+              "approved",
+              "changes_requested",
+              "review_required"
+            ]
+          },
+          "mergeState": {
+            "type": "string",
+            "enum": [
+              "dirty",
+              "unknown",
+              "draft",
+              "clean",
+              "unstable",
+              "has_hooks",
+              "blocked",
+              "behind"
+            ],
+            "description": "Whether the review can merge now, and if not, why."
+          },
+          "checks": {
+            "$ref": "#/components/schemas/ChecksReport"
+          }
+        },
+        "required": [
+          "number",
+          "url",
+          "title",
+          "state",
+          "updatedAt",
+          "reviewDecision",
+          "mergeState",
+          "checks"
+        ],
+        "additionalProperties": false
+      },
+      "ChecksReport": {
+        "type": "object",
+        "properties": {
+          "state": {
+            "type": "string",
+            "enum": [
+              "running",
+              "cancelled",
+              "success",
+              "failure",
+              "pending",
+              "none"
+            ],
+            "description": "The overall state of a set of checks. `none` means there are no checks."
+          },
+          "headSha": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The commit the checks ran on."
+          },
+          "checks": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CheckRun"
+            }
+          }
+        },
+        "required": [
+          "state",
+          "headSha",
+          "checks"
+        ],
+        "additionalProperties": false
+      },
+      "CheckRun": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Stable within one report, for list keys."
+          },
+          "name": {
+            "type": "string"
+          },
+          "workflowName": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The CI workflow that ran the job, when the check came from one."
+          },
+          "state": {
+            "type": "string",
+            "enum": [
+              "running",
+              "cancelled",
+              "success",
+              "failure",
+              "pending",
+              "skipped",
+              "neutral"
+            ],
+            "description": "The state of one check or CI job."
+          },
+          "url": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The job's page on the forge."
+          },
+          "startedAt": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "completedAt": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "description": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "A one-line result, e.g. a check run's title or a commit status description."
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "workflowName",
+          "state",
+          "url",
+          "startedAt",
+          "completedAt",
+          "description"
+        ],
+        "additionalProperties": false
+      },
       "TerminalListEntry": {
         "type": "object",
         "properties": {
@@ -11652,6 +12492,19 @@
             },
             "additionalProperties": {},
             "description": "Agent preferences (issue #682). `defaultMode` is how an agent session\nstarts when the caller sends no mode: `gui` in a chat pane, `tui` as the\nagent's CLI in a terminal. Browsers keep their own per-device mode and\nalways send it, so this applies to the CLI, cronjobs and MCP. Replaces\n`cli.defaultVia`, which boot migrates once."
+          },
+          "plugins": {
+            "type": "object",
+            "properties": {
+              "disabled": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            "additionalProperties": {},
+            "description": "Bundled plugins (`plugins/<id>/`). A plugin whose id is in `disabled`\nnever activates and its UI is hidden. Read once at boot."
           }
         },
         "additionalProperties": {}
@@ -13201,6 +14054,49 @@
         },
         "additionalProperties": false
       },
+      "ClientStateEntry": {
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          },
+          "scope": {
+            "type": "string",
+            "enum": [
+              "desktop",
+              "mobile",
+              "all"
+            ],
+            "description": "Client-state types shared by the server and the dashboard.\n\nClient state is small UI state (open center tabs, panel widths, drafts, …)\nthat the dashboard keeps on the Band server so every device shows the same\nthing. Each entry has a scope: `all` is one value for every device, and\n`desktop` / `mobile` hold a separate value per device type.\n\nEvery write names the version it was based on. The server refuses a write\nwhose base is not the current version, so a client that missed another\ndevice's change (offline, reconnecting) can never overwrite it."
+          },
+          "workspaceId": {
+            "type": [
+              "string",
+              "null"
+            ],
+            "description": "The workspace the key belongs to, or null for a global key."
+          },
+          "value": {
+            "description": "The stored JSON value, or null once the key has been deleted."
+          },
+          "version": {
+            "type": "number",
+            "description": "Starts at 1 and goes up by one on every write, including a delete."
+          },
+          "updatedAt": {
+            "type": "number"
+          }
+        },
+        "required": [
+          "key",
+          "scope",
+          "workspaceId",
+          "value",
+          "version",
+          "updatedAt"
+        ],
+        "additionalProperties": false
+      },
       "SubmitResult": {
         "type": "object",
         "properties": {