@checkstack/notification-common 1.0.2 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,92 @@
 # @checkstack/notification-common
 
+## 1.1.1
+
+### Patch Changes
+
+- a06b899: Dead-code audit cleanup and a small platform of shared notification helpers.
+
+  **Removed (dead code)**
+
+  - `core/backend/src/plugin-manager/deregistration-guard.ts` deleted. The exported `assertCanDeregister()` was never called and was a less-complete version of the dependents+isUninstallable checks already done inline by `previewUninstallOriginator` / `uninstallOriginator` in `plugin-manager-orchestrator.ts`.
+  - `createMockQueueFactory` deprecated alias removed from `@checkstack/test-utils-backend`. Use `createMockQueueManager` directly.
+
+  **New shared helpers**
+
+  - `@checkstack/backend-api` now exports `requestTimeoutMs()` — a Zod field builder for outbound HTTP request timeouts (1s..60s, default 10s). Replaces hand-rolled `configNumber({}).min(1000).max(60_000).default(10_000)` in `integration-webhook-backend`, `integration-script-backend`, and `healthcheck-script-backend`'s inline collector.
+  - `@checkstack/notification-common` now exports `SubjectStatusSchema` / `SubjectStatus`, mirroring the existing `ImportanceSchema`.
+  - `@checkstack/notification-backend` now exports:
+    - `SUBJECT_STATUS_EMOJI` / `IMPORTANCE_EMOJI` — the shared status / importance emoji maps that Discord, Slack, Teams, Webex and Telegram previously each redefined inline.
+    - `postJson(opts)` — a timeout-bounded `fetch` wrapper that handles non-2xx logging and error mapping for webhook-style POSTs. Returns `{ ok: true, response } | { ok: false, error }`.
+
+  **Migrated to shared helpers**
+
+  - Discord, Slack, Gotify, Pushover notification backends now use `postJson`. Outer try/catch + per-plugin error mapping deleted (~140 LOC).
+  - Discord, Slack, Teams, Telegram, Webex notification backends now use `IMPORTANCE_EMOJI`. Discord, Slack, Teams use `SUBJECT_STATUS_EMOJI`.
+  - Teams, Webex, Backstage, Telegram kept their inline fetch/Bot logic: their error strings surface server response bodies to operators, or the transport isn't raw `fetch` (Telegram uses `grammy`'s `Bot`).
+
+  **API surface tightening**
+
+  - Per-plugin test-only re-exports in 6 notification backends (Pushover, Gotify, Backstage, Slack, Discord, Teams) and the `CertificateInfo` interface in `healthcheck-tls-backend/strategy.ts` are now JSDoc-tagged `@internal`. No behaviour change; signals that downstream consumers must not depend on them.
+
+## 1.1.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/signal-common@0.2.3
+
 ## 1.0.2
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@checkstack/notification-common",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "license": "Elastic-2.0",
   "type": "module",
   "exports": {
@@ -10,15 +10,15 @@
     }
   },
   "dependencies": {
-    "@checkstack/common": "0.8.0",
-    "@checkstack/signal-common": "0.2.1",
+    "@checkstack/common": "0.10.0",
+    "@checkstack/signal-common": "0.2.3",
     "@orpc/contract": "^1.13.14",
     "zod": "^4.0.0"
   },
   "devDependencies": {
     "@checkstack/tsconfig": "0.0.7",
     "typescript": "^5.7.2",
-    "@checkstack/scripts": "0.3.0"
+    "@checkstack/scripts": "0.3.2"
   },
   "scripts": {
     "typecheck": "tsgo -b",

package/src/rpc-contract.ts

@@ -112,6 +112,7 @@ export const notificationContract = {
     userType: "user",
     access: [],
   })
+    .route({ method: "DELETE" })
     .input(z.object({ notificationId: z.string().uuid() }))
     .output(z.void()),
 
@@ -164,6 +165,7 @@ export const notificationContract = {
     userType: "user",
     access: [],
   })
+    .route({ method: "POST" })
     .input(z.object({ groupIds: z.array(z.string()) }))
     .output(z.record(z.string(), z.boolean())),
 
@@ -226,6 +228,7 @@ export const notificationContract = {
     userType: "service",
     access: [],
   })
+    .route({ method: "DELETE" })
     .input(
       z.object({
         groupId: z.string().describe("Full namespaced group ID to delete"),
@@ -337,6 +340,7 @@ export const notificationContract = {
     userType: "service",
     access: [],
   })
+    .route({ method: "DELETE" })
     .input(
       z.object({
         targetTypeId: z.string(),
@@ -530,6 +534,7 @@ export const notificationContract = {
     userType: "user",
     access: [notificationAccess.admin],
   })
+    .route({ method: "PATCH" })
     .input(
       z.object({
         strategyId: z.string().describe("Qualified strategy ID"),

package/src/schemas.ts

@@ -4,6 +4,15 @@ import { z } from "zod";
 export const ImportanceSchema = z.enum(["info", "warning", "critical"]);
 export type Importance = z.infer<typeof ImportanceSchema>;
 
+// Optional health/status hint for affected subjects.
+export const SubjectStatusSchema = z.enum([
+  "healthy",
+  "unhealthy",
+  "degraded",
+  "unknown",
+]);
+export type SubjectStatus = z.infer<typeof SubjectStatusSchema>;
+
 // Notification action for CTA buttons
 export const NotificationActionSchema = z.object({
   label: z.string(),
@@ -48,7 +57,7 @@ export const NotificationSubjectSchema = z.object({
    * Optional health/status hint, used to color the chip and add an icon.
    * Strategies that cannot render color simply ignore it.
    */
-  status: z.enum(["healthy", "unhealthy", "degraded", "unknown"]).optional(),
+  status: SubjectStatusSchema.optional(),
 });
 export type NotificationSubject = z.infer<typeof NotificationSubjectSchema>;