@checkstack/maintenance-common 1.0.0 → 1.1.0

package/CHANGELOG.md

@@ -1,5 +1,156 @@
 # @checkstack/maintenance-common
 
+## 1.1.0
+
+### Minor Changes
+
+- 1ef2e79: feat: hotlinks on incidents/maintenances and additional links on systems
+
+  Users with `manage` access on an incident, maintenance, or system can now
+  attach free-form URL "hotlinks" — Jira tickets, runbooks, dashboards, ticket
+  tools, etc. — alongside the existing fields.
+
+  - **Incidents** & **maintenances**: links live on the entity itself and are
+    surfaced both in the editor dialog and on the public detail page. Two new
+    RPC procedures per plugin (`addLink`, `removeLink`) gated behind the
+    existing `manage` access rule. Links are returned as part of
+    `getIncident` / `getMaintenance` and cache-invalidated on every link
+    mutation.
+  - **Systems**: a parallel `system_links` table with `getSystemLinks`,
+    `addSystemLink`, `removeSystemLink` procedures. Surfaced inside the
+    system editor (next to contacts) and on the read-only system detail
+    sidebar. Cache-scoped per-system so list endpoints remain hot.
+  - **Shared UI**: a `LinksEditor` component in `@checkstack/ui` does the
+    presentation; the three plugins each own their own RPC wiring.
+
+  Database changes ship as additive migrations (new `incident_links`,
+  `maintenance_links`, `system_links` tables, all FK-cascaded on parent
+  delete). No existing columns or rows are touched.
+
+  The system incident and maintenance history pages now sort by relevance:
+  active entries (non-`resolved` incidents, `scheduled` or `in_progress`
+  maintenances) appear at the top, with creation date descending as the
+  tiebreaker.
+
+### Patch Changes
+
+- Updated dependencies [42abfff]
+- Updated dependencies [1ef2e79]
+- Updated dependencies [aa89bc5]
+- Updated dependencies [950d6ec]
+  - @checkstack/common@0.9.0
+  - @checkstack/catalog-common@2.1.0
+  - @checkstack/frontend-api@0.5.0
+  - @checkstack/notification-common@1.0.2
+  - @checkstack/signal-common@0.2.2
+
+## 1.0.1
+
+### Patch Changes
+
+- 50e5f5f: Runtime plugin system: install + uninstall plugins from npm, GitHub releases
+  (including private GitHub Enterprise instances), or tarball uploads at
+  runtime, with multi-package bundles, dependency-derived compatibility checks,
+  multi-instance coordination via a Postgres artifact store, and
+  single-coordinator destructive cleanup.
+
+  Highlights:
+
+  - New `PluginSource` discriminated union and `PluginInstaller` /
+    `PluginInstallerRegistry` interfaces in `@checkstack/backend-api`. The
+    GitHub variant accepts an optional `apiBaseUrl` so deployments backed by
+    GitHub Enterprise can install from `https://ghe.example.com/api/v3`
+    instead of `api.github.com`.
+  - New `installPackageMetadataSchema` (Zod) in `@checkstack/common` validates
+    every plugin's `package.json` at install time. Required fields: `name`,
+    `version`, `description`, `author`, `license`, `checkstack.type`,
+    `checkstack.pluginId`. Optional: `checkstack.bundle`,
+    `checkstack.usageInstructions`, `checkstack.allowInstallScripts`.
+  - New `pluginManagerContract` in `@checkstack/pluginmanager-common` with
+    `list`, `previewInstall`, `install`, `previewUninstall`, `uninstall`, and
+    `events` procedures.
+  - New `@checkstack/pluginmanager-frontend` admin UI: installed-plugins list
+    with per-row uninstall (typed-confirmation modal, schema/configs/cascade
+    toggles), install page with NPM / Tarball Upload / GitHub Release tabs
+    (Catalog tab disabled — coming soon), and an events page surfacing the
+    install/uninstall audit log.
+  - New `bunx @checkstack/scripts plugin-pack` CLI for plugin authors —
+    per-package mode produces an npm-shaped tarball; `--bundle` mode produces
+    an outer tarball containing every sibling declared in
+    `package.json#checkstack.bundle`. Published to npm so external authors
+    can `bunx` it directly without a workspace checkout.
+  - Compatibility derived from `package.json#dependencies` ranges
+    (`semver.satisfies` against the platform's loaded `@checkstack/*`
+    versions) — no separate `compatibility` field.
+  - Multi-instance: originator persists artifacts + `plugins` rows + broadcasts
+    install/uninstall; receiving instances do in-process register/unregister
+    only. Destructive ops (drop schema, delete plugin_configs, delete
+    artifacts, delete `plugins` rows) run exactly once on the originator.
+  - Fresh-instance bootstrap: `loadPlugins()` hydrates any
+    `is_uninstallable=true` plugin missing from `node_modules` from the
+    artifact store before normal Phase 1 register.
+  - New schema: `plugin_artifacts` (tarball storage), `plugin_install_events`
+    (audit/error log). `plugins` extended with `version`, `metadata`,
+    `source`, `bundle_id`, `is_primary`. Local plugin sync now writes
+    `version` from each plugin's `package.json` so the admin UI shows real
+    versions instead of `—`.
+  - Tarball-upload endpoint (`POST /api/pluginmanager/upload-tarball`) for
+    the install UI; access-gated by `pluginmanager.plugin.manage`.
+  - Plugin Manager menu link added to the user menu (main grid, alongside
+    Profile / Notification Settings / etc.).
+
+  Cross-cutting changes:
+
+  - Backend request/response logging now flows through `rootLogger` (winston)
+    instead of `hono/logger`. 5xx responses include the response body inline
+    so swallowed early-return errors are visible in the log.
+  - The `/api/:pluginId/*` dispatcher now logs which core service is missing
+    or which `pluginId` had no metadata when it 500s.
+  - New `registerCorePluginMetadata` on `PluginManager` for core routers
+    (like the plugin manager itself) that need their metadata visible to the
+    RPC dispatcher without going through the full plugin lifecycle.
+  - ESLint: `unicorn/no-null` is now disabled globally. Drizzle distinguishes
+    between `null` (writes a real SQL NULL) and `undefined` (skip the column
+    on insert), so treating them as interchangeable produced latent bugs at
+    the persistence boundary. The bulk of the patch-bumped packages above
+    reflect lint-fix touches that landed when this rule was relaxed.
+  - Workspace-wide license normalization to `Elastic-2.0` (matches
+    `LICENSE.md`). Every `package.json` in the workspace now declares the
+    same SPDX identifier; the patch bumps capture this.
+
+  Plugin packages (every `plugins/*`): added a `pack` npm script
+  (`bunx @checkstack/scripts plugin-pack`), mirrored each plugin's
+  `pluginId` from `plugin-metadata.ts` into `package.json#checkstack.pluginId`
+  so install-time validation passes, stubbed any missing required metadata
+  fields (`description`, `author`, `license`), and added
+  `checkstack.bundle` to multi-package plugin primaries (telegram, rcon, ssh,
+  jira, queue-bullmq, queue-memory, cache-memory).
+
+  Breaking changes:
+
+  - The legacy single-method `PluginInstaller` interface (`install(packageName)`)
+    is removed. Callers must use `coreServices.pluginInstallerRegistry`.
+  - The old `pluginAdminContract` and `createPluginAdminRouter` are removed.
+    Replaced by `pluginManagerContract` in `@checkstack/pluginmanager-common`
+    and `createPluginManagerRouter` in `core/backend`.
+  - `@checkstack/test-utils-backend` no longer exports
+    `createMockPluginInstaller` / `MockPluginInstaller` (the legacy interface
+    it shimmed is gone).
+
+  Note: bumps are limited to `minor` (for packages with new public API
+  surface) and `patch` (for downstream consumers, license normalization,
+  and lint fixes). No `major` bumps despite the `PluginInstaller` removal —
+  the legacy interface had no third-party consumers in the wild before this
+  runtime plugin system landed, and the contract surface is the same shape
+  modulo the rename.
+
+- Updated dependencies [50e5f5f]
+  - @checkstack/catalog-common@2.0.1
+  - @checkstack/common@0.8.0
+  - @checkstack/frontend-api@0.4.2
+  - @checkstack/notification-common@1.0.1
+  - @checkstack/signal-common@0.2.1
+
 ## 1.0.0
 
 ### Major Changes

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@checkstack/maintenance-common",
-  "version": "1.0.0",
+  "version": "1.1.0",
+  "license": "Elastic-2.0",
   "type": "module",
   "exports": {
     ".": {
@@ -8,21 +9,21 @@
     }
   },
   "dependencies": {
-    "@checkstack/common": "0.7.0",
-    "@checkstack/catalog-common": "1.5.3",
-    "@checkstack/frontend-api": "0.4.0",
-    "@checkstack/notification-common": "0.3.0",
-    "@checkstack/signal-common": "0.2.0",
+    "@checkstack/common": "0.8.0",
+    "@checkstack/catalog-common": "2.0.1",
+    "@checkstack/frontend-api": "0.4.2",
+    "@checkstack/notification-common": "1.0.1",
+    "@checkstack/signal-common": "0.2.1",
     "@orpc/contract": "^1.13.14",
     "zod": "^4.2.1"
   },
   "devDependencies": {
     "typescript": "^5.7.2",
-    "@checkstack/tsconfig": "0.0.5",
-    "@checkstack/scripts": "0.1.2"
+    "@checkstack/tsconfig": "0.0.7",
+    "@checkstack/scripts": "0.3.0"
   },
   "scripts": {
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsgo -b",
     "lint": "bun run lint:code",
     "lint:code": "eslint . --max-warnings 0"
   },

package/src/index.ts

@@ -10,6 +10,8 @@ export {
   MaintenanceWithSystemsSchema,
   MaintenanceUpdateSchema,
   MaintenanceDetailSchema,
+  MaintenanceLinkSchema,
+  AddMaintenanceLinkInputSchema,
   CreateMaintenanceInputSchema,
   UpdateMaintenanceInputSchema,
   AddMaintenanceUpdateInputSchema,
@@ -18,6 +20,8 @@ export {
   type MaintenanceWithSystems,
   type MaintenanceUpdate,
   type MaintenanceDetail,
+  type MaintenanceLink,
+  type AddMaintenanceLinkInput,
   type CreateMaintenanceInput,
   type UpdateMaintenanceInput,
   type AddMaintenanceUpdateInput,

package/src/rpc-contract.ts

@@ -6,6 +6,8 @@ import {
   MaintenanceWithSystemsSchema,
   MaintenanceDetailSchema,
   MaintenanceUpdateSchema,
+  MaintenanceLinkSchema,
+  AddMaintenanceLinkInputSchema,
   CreateMaintenanceInputSchema,
   UpdateMaintenanceInputSchema,
   AddMaintenanceUpdateInputSchema,
@@ -102,6 +104,24 @@ export const maintenanceContract = {
     .input(z.object({ id: z.string(), message: z.string().optional() }))
     .output(MaintenanceWithSystemsSchema),
 
+  /** Add a hotlink (e.g. change ticket, runbook) to a maintenance */
+  addLink: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [maintenanceAccess.maintenance.manage],
+  })
+    .input(AddMaintenanceLinkInputSchema)
+    .output(MaintenanceLinkSchema),
+
+  /** Remove a hotlink from a maintenance */
+  removeLink: proc({
+    operationType: "mutation",
+    userType: "authenticated",
+    access: [maintenanceAccess.maintenance.manage],
+  })
+    .input(z.object({ id: z.string() }))
+    .output(z.object({ success: z.boolean() })),
+
   /** Delete a maintenance */
   deleteMaintenance: proc({
     operationType: "mutation",

package/src/schemas.ts

@@ -52,10 +52,32 @@ export const MaintenanceUpdateSchema = z.object({
 export type MaintenanceUpdate = z.infer<typeof MaintenanceUpdateSchema>;
 
 /**
- * Full maintenance detail with systems and updates
+ * Free-form hotlink attached to a maintenance (e.g. change ticket, runbook).
+ */
+export const MaintenanceLinkSchema = z.object({
+  id: z.string(),
+  maintenanceId: z.string(),
+  label: z.string().nullable(),
+  url: z.string(),
+  createdAt: z.date(),
+});
+export type MaintenanceLink = z.infer<typeof MaintenanceLinkSchema>;
+
+export const AddMaintenanceLinkInputSchema = z.object({
+  maintenanceId: z.string(),
+  label: z.string().max(120).optional(),
+  url: z.string().url("Must be a valid URL"),
+});
+export type AddMaintenanceLinkInput = z.infer<
+  typeof AddMaintenanceLinkInputSchema
+>;
+
+/**
+ * Full maintenance detail with systems, updates, and hotlinks
  */
 export const MaintenanceDetailSchema = MaintenanceWithSystemsSchema.extend({
   updates: z.array(MaintenanceUpdateSchema),
+  links: z.array(MaintenanceLinkSchema),
 });
 export type MaintenanceDetail = z.infer<typeof MaintenanceDetailSchema>;
 

package/tsconfig.json

@@ -2,5 +2,22 @@
   "extends": "@checkstack/tsconfig/common.json",
   "include": [
     "src"
+  ],
+  "references": [
+    {
+      "path": "../catalog-common"
+    },
+    {
+      "path": "../common"
+    },
+    {
+      "path": "../frontend-api"
+    },
+    {
+      "path": "../notification-common"
+    },
+    {
+      "path": "../signal-common"
+    }
   ]
-}
+}