@checkstack/satellite-common 0.3.2 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,101 @@
 # @checkstack/satellite-common
 
+## 0.5.0
+
+### Minor Changes
+
+- 9016526: Add a `/rest/:pluginId/*` HTTP mount that serves every plugin's oRPC contract
+  through the REST/OpenAPI shape described by `/api/openapi.json`. Queries are
+  `GET` with query parameters, mutations are `POST` with the input as the raw
+  JSON body. The existing `/api/:pluginId/*` mount continues to serve oRPC's
+  native wire protocol unchanged, so existing clients are not affected.
+
+  The OpenAPI spec at `/api/openapi.json` now reflects the real mount: every
+  `paths` entry is prefixed with `/rest` instead of `/api`.
+
+  Also fixes a SPA-fallback bug: the backend's `/api-docs` route previously
+  returned 404 on production deployments because the static-file middleware
+  skipped any path starting with `/api`, capturing `/api-docs` along with real
+  API routes. The skip now requires a trailing slash (`/api/`, `/rest/`).
+
+  Required access rules are now visible in the API Docs UI. The OpenAPI spec
+  generator was reading a non-existent `accessRules` field on procedure
+  metadata; the real field is `access: AccessRule[]`. Each procedure's access
+  rules are now flattened to fully-qualified IDs (e.g. `catalog.system.read`)
+  and emitted under `x-orpc-meta.accessRules`, which the existing
+  `Required Access Rules` section in the docs UI already knew how to render.
+
+  The API Docs schema renderer now handles record types (zod `z.record`),
+  `$ref`s into `components.schemas`, `oneOf`/`anyOf`/`allOf`, nullable union
+  types (`type: ["string", "null"]`), and `format` qualifiers. Previously
+  record outputs like `{ statuses: object }` masked the actual value type;
+  they now render as `{ [key]: <ResolvedType> { ... } }` with the inner
+  schema expanded, capped at 12 levels with cycle detection.
+
+  **REST method conventions.** `proc()` now defaults to `GET` for queries and
+  `POST` for mutations on the `/rest` mount, using bracket-notation query
+  params (`?filter[status]=active&ids[0]=a`) for GET inputs. Existing
+  procedures were updated to follow REST semantics:
+
+  - `update*` mutations → `PATCH`
+  - `delete*` / `remove*` mutations → `DELETE`
+  - `getBulk*` queries and any query taking a large array input → `POST`
+    (because `@orpc/openapi@1.13.x` has no GET→POST URL-length fallback)
+
+  GET endpoints require an `object` input — bare scalars like
+  `.input(z.string())` are not valid on GET. `getSystemConfigurations` was
+  refactored from `.input(z.string())` to `.input(z.object({ systemId: ... }))`
+  to fit the GET shape; the only call-site update was the in-process router
+  unpacking `input.systemId` instead of passing `input` directly.
+
+  The API Docs UI now renders query parameters (path/query/header/cookie) in a
+  dedicated table for GET endpoints, and the fetch example shows them in the
+  URL with `<required>` / `<optional>` placeholders.
+
+### Patch Changes
+
+- Updated dependencies [9016526]
+  - @checkstack/common@0.10.0
+  - @checkstack/healthcheck-common@1.1.0
+  - @checkstack/signal-common@0.2.3
+
+## 0.4.0
+
+### Minor Changes
+
+- f6f9a5c: Add a GitOps `Satellite` kind plus a UI affordance for resetting tokens.
+
+  GitOps owns satellite **metadata only** — `metadata.name`,
+  `spec.region`, and `metadata.labels` (used as the satellite's runtime
+  tags). The bcrypt token is intentionally never expressed in YAML; on
+  first reconcile a satellite is created with a random token that is
+  discarded, and operators must use the Satellites page to retrieve a
+  working credential.
+
+  To support that flow:
+
+  - New service methods: `updateSatelliteMetadata`, `rotateSatelliteToken`,
+    `getSatelliteByName`.
+  - New RPC procs: `updateSatellite`, `rotateSatelliteToken`.
+  - New `RotateSatelliteTokenDialog` and a "Reset token" key icon on the
+    Satellites list. The dialog reuses the one-time-reveal layout from
+    `CreateSatelliteDialog`.
+  - The Satellites list shows a `GitOpsSourceBadge` next to managed
+    satellites and disables the delete button while leaving the
+    token-reset button enabled (so operators can always re-issue a
+    credential without touching YAML).
+
+  The satellite kind reconciler adopts pre-existing satellites by name on
+  first sync, so this is safe to roll out against installations that
+  already have manually-created satellites.
+
+### Patch Changes
+
+- Updated dependencies [42abfff]
+  - @checkstack/common@0.9.0
+  - @checkstack/healthcheck-common@1.0.2
+  - @checkstack/signal-common@0.2.2
+
 ## 0.3.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/satellite-common",
-  "version": "0.3.2",
+  "version": "0.5.0",
   "license": "Elastic-2.0",
   "type": "module",
   "exports": {
@@ -9,16 +9,16 @@
     }
   },
   "dependencies": {
-    "@checkstack/common": "0.7.0",
-    "@checkstack/healthcheck-common": "1.0.0",
-    "@checkstack/signal-common": "0.2.0",
+    "@checkstack/common": "0.9.0",
+    "@checkstack/healthcheck-common": "1.0.2",
+    "@checkstack/signal-common": "0.2.2",
     "@orpc/contract": "^1.13.14",
     "zod": "^4.2.1"
   },
   "devDependencies": {
     "typescript": "^5.7.2",
-    "@checkstack/tsconfig": "0.0.6",
-    "@checkstack/scripts": "0.1.2"
+    "@checkstack/tsconfig": "0.0.7",
+    "@checkstack/scripts": "0.3.1"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/rpc-contract.ts

@@ -52,9 +52,47 @@ export const satelliteContract = {
     userType: "authenticated",
     access: [satelliteAccess.satellite.manage],
   })
+    .route({ method: "DELETE" })
     .input(z.object({ id: z.string() }))
     .output(z.void()),
 
+  /**
+   * Update a satellite's metadata. Token is unaffected — use
+   * `rotateSatelliteToken` to issue a new token.
+   */
+  updateSatellite: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [satelliteAccess.satellite.manage],
+  })
+    .route({ method: "PATCH" })
+    .input(
+      z.object({
+        id: z.string(),
+        name: z.string().min(1).optional(),
+        region: z.string().min(1).optional(),
+        tags: z.record(z.string(), z.string()).optional(),
+      }),
+    )
+    .output(SatelliteWithStatusSchema),
+
+  /**
+   * Rotate (reset) a satellite's token. Returns the new plaintext token,
+   * shown once. The previous token is invalidated immediately.
+   */
+  rotateSatelliteToken: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [satelliteAccess.satellite.manage],
+  })
+    .input(z.object({ id: z.string() }))
+    .output(
+      z.object({
+        satellite: SatelliteWithStatusSchema,
+        token: z.string(),
+      }),
+    ),
+
   /**
    * Get the list of online satellite IDs.
    * Used internally by healthcheck-backend for stale source exclusion