@checkstack/backend-api 0.11.1 → 0.12.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @checkstack/backend-api
 
+## 0.12.0
+
+### Minor Changes
+
+- 26d8bae: Distributed satellite health checks and Assignment IDE page
+
+  **Satellite System**
+
+  - New `satellite-backend`, `satellite-common`, `satellite-frontend`, and `satellite` agent packages for distributed health check execution
+  - WebSocket-based satellite connectivity with authentication, heartbeats, and live configuration push
+  - Satellite management UI with create dialog, status badges, and list page
+
+  **Live Configuration Updates**
+
+  - Added `assignmentChanged` hook to `healthcheck-backend` for cross-plugin communication
+  - `satellite-backend` subscribes to assignment changes and pushes config updates to connected satellites in real-time
+
+  **Assignment IDE Page**
+
+  - Replaced the 1028-line modal-based `SystemHealthCheckAssignment` component with a full-page IDE layout
+  - New modular components: `AssignmentTree`, `GeneralPanel`, `ThresholdsPanel`, `RetentionPanel`, `ExecutionPanel`
+  - Added unassign capability and sorted assignment lists for stable ordering
+
+  **Shared IDE Primitives**
+
+  - Extracted `IDETreeNode`, `IDETreeSection`, `IDEStatusBar`, `IDELayout` to `@checkstack/ui` for cross-plugin reuse
+  - Migrated existing health check IDE editor to use shared primitives
+
+  **Infrastructure**
+
+  - Added `Dockerfile.satellite` for containerized satellite deployment
+  - WebSocket route registry in `@checkstack/backend` and `@checkstack/backend-api`
+
+### Patch Changes
+
+- Updated dependencies [26d8bae]
+- Updated dependencies [26d8bae]
+  - @checkstack/healthcheck-common@0.11.0
+  - @checkstack/queue-api@0.2.13
+
 ## 0.11.1
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/backend-api",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "type": "module",
   "main": "./src/index.ts",
   "scripts": {
@@ -9,10 +9,10 @@
     "lint:code": "eslint . --max-warnings 0"
   },
   "dependencies": {
-    "@checkstack/common": "0.6.4",
-    "@checkstack/healthcheck-common": "0.10.0",
-    "@checkstack/queue-api": "0.2.11",
-    "@checkstack/signal-common": "0.1.8",
+    "@checkstack/common": "0.6.5",
+    "@checkstack/healthcheck-common": "0.10.1",
+    "@checkstack/queue-api": "0.2.12",
+    "@checkstack/signal-common": "0.1.9",
     "@orpc/client": "^1.13.14",
     "@orpc/contract": "^1.13.14",
     "@orpc/openapi": "^1.13.2",

package/src/core-services.ts

@@ -14,6 +14,7 @@ import {
   RpcClient,
 } from "./types";
 import type { EventBus } from "./event-bus-types";
+import type { WebSocketRouteRegistry } from "./ws-registry";
 
 export * from "./types";
 
@@ -43,4 +44,5 @@ export const coreServices = {
   config: createServiceRef<ConfigService>("core.config"),
   eventBus: createServiceRef<EventBus>("core.eventBus"),
   signalService: createServiceRef<SignalService>("core.signalService"),
+  wsRegistry: createServiceRef<WebSocketRouteRegistry>("core.wsRegistry"),
 };

package/src/index.ts

@@ -27,3 +27,4 @@ export * from "./collector-strategy";
 export * from "./collector-registry";
 export * from "./incremental-aggregation";
 export * from "./aggregated-result";
+export * from "./ws-registry";

package/src/ws-registry.ts

@@ -0,0 +1,70 @@
+/**
+ * A generic interface for a WebSocket connection managed by the core server.
+ * Plugins interact with WebSocket clients through this adapter, insulating
+ * them from the underlying Bun WebSocket API.
+ */
+export interface WsConnection {
+  /** Send a string message to the client */
+  send(data: string): void;
+  /** Close the connection */
+  close(): void;
+}
+
+/**
+ * Per-connection handlers returned by a route handler's `onConnection` callback.
+ * These closures capture the connection's state (e.g., auth state, session data).
+ */
+export interface WsConnectionHandlers {
+  onMessage: (message: string) => void | Promise<void>;
+  onClose: () => void;
+}
+
+/**
+ * A WebSocket route handler registered by a plugin.
+ * The core server calls `onConnection` when a new WebSocket is opened on
+ * the handler's registered path, and the handler returns per-connection
+ * event callbacks.
+ */
+export interface WebSocketRouteHandler {
+  /**
+   * Called when a new WebSocket connection opens on this route.
+   * Return per-connection message/close handlers.
+   */
+  onConnection(ws: WsConnection): WsConnectionHandlers;
+}
+
+/**
+ * Scoped registry for plugin WebSocket route handlers.
+ * Each plugin receives a scoped instance (via factory) that auto-prefixes
+ * the pluginId — just like the RPC service.
+ *
+ * Plugins register handlers with a local path segment, and the core server
+ * makes them available under `/api/ws/{pluginId}{path}`.
+ *
+ * @example
+ * ```ts
+ * // In satellite-backend init (pluginId "satellite" is auto-prefixed):
+ * wsRegistry.register("/", handler);
+ * // → Available at /api/ws/satellite
+ *
+ * wsRegistry.register("/connect", handler);
+ * // → Available at /api/ws/satellite/connect
+ * ```
+ */
+export interface WebSocketRouteRegistry {
+  /**
+   * Register a WebSocket route handler at the given path.
+   * The pluginId prefix is applied automatically by the scoped factory.
+   */
+  register(path: string, handler: WebSocketRouteHandler): void;
+}
+
+/**
+ * Core-level store for all registered WS routes.
+ * The backend server uses this to look up handlers during WebSocket upgrade.
+ * Not exposed to plugins — they interact via the scoped `WebSocketRouteRegistry`.
+ */
+export interface WebSocketRouteStore {
+  /** Look up a handler by full path (e.g., "satellite" or "satellite/connect"). */
+  getHandler(fullPath: string): WebSocketRouteHandler | undefined;
+}