@checkstack/dashboard-frontend 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,186 @@
 # @checkstack/dashboard-frontend
 
+## 0.7.0
+
+### Minor Changes
+
+- 3547670: Wire the new tips infrastructure across the frontends:
+
+  **Empty-state coaching.** Replace generic "no items" copy with onboarding
+  guidance — short description, three numbered steps and a primary CTA — on
+  every EmptyState that has a meaningful next action. Affects: catalog
+  (systems + groups), dashboard, health-check page, integrations (subscriptions
+
+  - provider connections), GitOps providers + secrets, GitOps provenance,
+    SLO config + overview, maintenance config, satellites, plugin manager,
+    incident config, announcements. Read-only EmptyStates (incident history,
+    maintenance history, plugin events) get clearer descriptions explaining
+    what would populate them.
+
+  **First-run anchored tips.** Add `<Tip>` popovers to the most important
+  "Create" affordances so first-time users see a one-line explanation of
+  what they're about to make and why it matters: catalog “Add System” /
+  “Add Group”, healthcheck “Create Check”, integrations “New Subscription”,
+  GitOps “Add Provider”, SLO “Create SLO”, maintenance “Create Maintenance”,
+  satellite “Create Satellite”, plugin-manager “Install plugin”, incident
+  “Report Incident”, announcement “New Announcement”. Each tip is dismissed
+  per user (server-backed when signed in, localStorage otherwise) and
+  namespaced through `qualifyTipId(plugin, …)` so it cannot escape the
+  plugin's own namespace.
+
+  **Welcome banner on the dashboard.** A `<TipBanner>` at the top of the
+  dashboard introduces Checkstack's main flow ("add a system, then a health
+  check") with a one-click jump into the catalog.
+
+### Patch Changes
+
+- Updated dependencies [42abfff]
+- Updated dependencies [42abfff]
+- Updated dependencies [3547670]
+- Updated dependencies [f6f9a5c]
+- Updated dependencies [1ef2e79]
+- Updated dependencies [aa89bc5]
+- Updated dependencies [3547670]
+- Updated dependencies [3547670]
+- Updated dependencies [950d6ec]
+- Updated dependencies [3547670]
+- Updated dependencies [3547670]
+  - @checkstack/anomaly-common@1.1.0
+  - @checkstack/common@0.9.0
+  - @checkstack/ui@1.8.0
+  - @checkstack/catalog-frontend@0.10.0
+  - @checkstack/incident-common@1.1.0
+  - @checkstack/maintenance-common@1.1.0
+  - @checkstack/catalog-common@2.1.0
+  - @checkstack/frontend-api@0.5.0
+  - @checkstack/queue-frontend@0.4.0
+  - @checkstack/notification-frontend@0.4.0
+  - @checkstack/tips-frontend@0.2.0
+  - @checkstack/auth-frontend@0.6.0
+  - @checkstack/command-common@0.2.11
+  - @checkstack/command-frontend@0.2.35
+  - @checkstack/healthcheck-common@1.0.2
+  - @checkstack/notification-common@1.0.2
+  - @checkstack/signal-frontend@0.1.2
+
+## 0.6.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/catalog-frontend@0.9.1
+  - @checkstack/command-common@0.2.10
+  - @checkstack/common@0.8.0
+  - @checkstack/maintenance-common@1.0.1
+  - @checkstack/notification-frontend@0.3.1
+  - @checkstack/signal-frontend@0.1.1
+  - @checkstack/ui@1.7.1
+  - @checkstack/anomaly-common@1.0.1
+  - @checkstack/auth-frontend@0.5.33
+  - @checkstack/command-frontend@0.2.34
+  - @checkstack/frontend-api@0.4.2
+  - @checkstack/healthcheck-common@1.0.1
+  - @checkstack/incident-common@1.0.1
+  - @checkstack/notification-common@1.0.1
+  - @checkstack/queue-frontend@0.3.3
+
 ## 0.6.0
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@checkstack/dashboard-frontend",
-  "version": "0.6.0",
+  "version": "0.7.0",
+  "license": "Elastic-2.0",
   "type": "module",
   "main": "src/index.tsx",
   "checkstack": {
@@ -8,27 +9,28 @@
   },
   "scripts": {
     "test": "bun test",
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsgo -b",
     "lint": "bun run lint:code",
     "lint:code": "eslint . --max-warnings 0"
   },
   "dependencies": {
-    "@checkstack/anomaly-common": "0.3.0",
-    "@checkstack/auth-frontend": "0.5.31",
-    "@checkstack/catalog-common": "1.5.3",
-    "@checkstack/catalog-frontend": "0.8.7",
-    "@checkstack/command-common": "0.2.9",
-    "@checkstack/command-frontend": "0.2.32",
-    "@checkstack/common": "0.7.0",
-    "@checkstack/frontend-api": "0.4.0",
-    "@checkstack/healthcheck-common": "0.13.0",
-    "@checkstack/incident-common": "0.5.0",
-    "@checkstack/maintenance-common": "0.5.0",
-    "@checkstack/notification-common": "0.3.0",
-    "@checkstack/notification-frontend": "0.2.36",
-    "@checkstack/queue-frontend": "0.3.1",
-    "@checkstack/signal-frontend": "0.1.0",
-    "@checkstack/ui": "1.6.1",
+    "@checkstack/anomaly-common": "1.0.1",
+    "@checkstack/auth-frontend": "0.5.33",
+    "@checkstack/catalog-common": "2.0.1",
+    "@checkstack/catalog-frontend": "0.9.1",
+    "@checkstack/command-common": "0.2.10",
+    "@checkstack/command-frontend": "0.2.34",
+    "@checkstack/common": "0.8.0",
+    "@checkstack/frontend-api": "0.4.2",
+    "@checkstack/healthcheck-common": "1.0.1",
+    "@checkstack/incident-common": "1.0.1",
+    "@checkstack/maintenance-common": "1.0.1",
+    "@checkstack/notification-common": "1.0.1",
+    "@checkstack/notification-frontend": "0.3.1",
+    "@checkstack/queue-frontend": "0.3.3",
+    "@checkstack/signal-frontend": "0.1.1",
+    "@checkstack/tips-frontend": "0.1.0",
+    "@checkstack/ui": "1.7.1",
     "date-fns": "^4.1.0",
     "lucide-react": "^0.344.0",
     "react": "^18.2.0",
@@ -37,7 +39,7 @@
   "devDependencies": {
     "typescript": "^5.0.0",
     "@types/react": "^18.2.0",
-    "@checkstack/tsconfig": "0.0.5",
-    "@checkstack/scripts": "0.1.2"
+    "@checkstack/tsconfig": "0.0.7",
+    "@checkstack/scripts": "0.3.0"
   }
 }

package/src/Dashboard.tsx

@@ -14,6 +14,8 @@ import {
   catalogGroupTarget,
 } from "@checkstack/catalog-common";
 import { resolveRoute } from "@checkstack/common";
+import { TipBanner } from "@checkstack/tips-frontend";
+import { pluginMetadata as dashboardTipMetadata } from "./pluginMetadata";
 import { NotificationSubscriptionsManager } from "@checkstack/notification-frontend";
 import { IncidentApi } from "@checkstack/incident-common";
 import { MaintenanceApi } from "@checkstack/maintenance-common";
@@ -28,6 +30,7 @@ import {
   SectionHeader,
   StatusCard,
   EmptyState,
+  Button,
   LoadingSpinner,
   AnimatedCounter,
   TerminalFeed,
@@ -44,6 +47,7 @@ import {
   Wrench,
   Terminal,
   ActivitySquare,
+  Lightbulb,
 } from "lucide-react";
 import { authApiRef } from "@checkstack/auth-frontend/api";
 import { QueueLagAlert } from "@checkstack/queue-frontend";
@@ -215,9 +219,20 @@ export const Dashboard: React.FC = () => {
     if (groupsWithSystems.length === 0) {
       return (
         <EmptyState
-          title="No system groups found"
-          description="Visit the Catalog to create your first group."
           icon={<Server className="w-12 h-12" />}
+          title="Nothing to show on the dashboard yet"
+          description="Once you have systems organised into groups, this is where you'll see their rolled-up health, on a per-team or per-product basis."
+          steps={[
+            "Open the Catalog and add the systems you want to monitor.",
+            "Group related systems together (e.g. one group per team).",
+            "Attach health checks to each system so the dashboard turns green when things are working — and red when they aren't.",
+          ]}
+          actions={
+            <Button onClick={() => navigate(resolveRoute(catalogRoutes.routes.config))}>
+              <LayoutGrid className="w-4 h-4 mr-2" />
+              Open Catalog
+            </Button>
+          }
         />
       );
     }
@@ -307,6 +322,35 @@ export const Dashboard: React.FC = () => {
         {/* Queue Lag Warning */}
         <QueueLagAlert />
 
+        {/* First-run welcome */}
+        <TipBanner
+          plugin={dashboardTipMetadata}
+          id="welcome"
+          title="Welcome to Checkstack"
+          description={
+            <>
+              This is your dashboard — overall health, recent activity, and
+              ongoing maintenances at a glance. To bring it to life, start
+              by adding a system in the <strong>Catalog</strong>, then
+              attach a health check to it.
+            </>
+          }
+          action={{
+            label: "Open Catalog",
+            onClick: () => navigate(resolveRoute(catalogRoutes.routes.config)),
+          }}
+          actionHint={
+            <span className="inline-flex items-center gap-1.5">
+              <Lightbulb
+                className="size-3.5 shrink-0 text-amber-500"
+                aria-hidden="true"
+              />
+              See a small lightbulb next to a button or control? Click it
+              for a short explanation of what that feature does.
+            </span>
+          }
+        />
+
         {/* Overview Section */}
         <section>
           <SectionHeader

package/src/index.tsx

@@ -1,10 +1,6 @@
 import { FrontendPlugin, DashboardSlot } from "@checkstack/frontend-api";
-import { definePluginMetadata } from "@checkstack/common";
 import { Dashboard } from "./Dashboard";
-
-const pluginMetadata = definePluginMetadata({
-  pluginId: "dashboard",
-});
+import { pluginMetadata } from "./pluginMetadata";
 
 export const dashboardPlugin: FrontendPlugin = {
   metadata: pluginMetadata,

package/src/pluginMetadata.ts

@@ -0,0 +1,5 @@
+import { definePluginMetadata } from "@checkstack/common";
+
+export const pluginMetadata = definePluginMetadata({
+  pluginId: "dashboard",
+});

package/tsconfig.json

@@ -2,5 +2,58 @@
   "extends": "@checkstack/tsconfig/frontend.json",
   "include": [
     "src"
+  ],
+  "references": [
+    {
+      "path": "../anomaly-common"
+    },
+    {
+      "path": "../auth-frontend"
+    },
+    {
+      "path": "../catalog-common"
+    },
+    {
+      "path": "../catalog-frontend"
+    },
+    {
+      "path": "../command-common"
+    },
+    {
+      "path": "../command-frontend"
+    },
+    {
+      "path": "../common"
+    },
+    {
+      "path": "../frontend-api"
+    },
+    {
+      "path": "../healthcheck-common"
+    },
+    {
+      "path": "../incident-common"
+    },
+    {
+      "path": "../maintenance-common"
+    },
+    {
+      "path": "../notification-common"
+    },
+    {
+      "path": "../notification-frontend"
+    },
+    {
+      "path": "../queue-frontend"
+    },
+    {
+      "path": "../signal-frontend"
+    },
+    {
+      "path": "../tips-frontend"
+    },
+    {
+      "path": "../ui"
+    }
   ]
-}
+}