@checkstack/healthcheck-frontend 0.18.1 → 0.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,204 @@
1
1
  # @checkstack/healthcheck-frontend
2
2
 
3
+ ## 0.19.0
4
+
5
+ ### Minor Changes
6
+
7
+ - 3547670: Wire the new tips infrastructure across the frontends:
8
+
9
+ **Empty-state coaching.** Replace generic "no items" copy with onboarding
10
+ guidance — short description, three numbered steps and a primary CTA — on
11
+ every EmptyState that has a meaningful next action. Affects: catalog
12
+ (systems + groups), dashboard, health-check page, integrations (subscriptions
13
+
14
+ - provider connections), GitOps providers + secrets, GitOps provenance,
15
+ SLO config + overview, maintenance config, satellites, plugin manager,
16
+ incident config, announcements. Read-only EmptyStates (incident history,
17
+ maintenance history, plugin events) get clearer descriptions explaining
18
+ what would populate them.
19
+
20
+ **First-run anchored tips.** Add `<Tip>` popovers to the most important
21
+ "Create" affordances so first-time users see a one-line explanation of
22
+ what they're about to make and why it matters: catalog “Add System” /
23
+ “Add Group”, healthcheck “Create Check”, integrations “New Subscription”,
24
+ GitOps “Add Provider”, SLO “Create SLO”, maintenance “Create Maintenance”,
25
+ satellite “Create Satellite”, plugin-manager “Install plugin”, incident
26
+ “Report Incident”, announcement “New Announcement”. Each tip is dismissed
27
+ per user (server-backed when signed in, localStorage otherwise) and
28
+ namespaced through `qualifyTipId(plugin, …)` so it cannot escape the
29
+ plugin's own namespace.
30
+
31
+ **Welcome banner on the dashboard.** A `<TipBanner>` at the top of the
32
+ dashboard introduces Checkstack's main flow ("add a system, then a health
33
+ check") with a one-click jump into the catalog.
34
+
35
+ ### Patch Changes
36
+
37
+ - 950d6ec: Fix mobile UserMenu items rendering at zero height, group menu items by
38
+ section, and unstack cramped card headers on small viewports.
39
+
40
+ - **UserMenu mobile bug**: On mobile, the user-menu Sheet rendered every
41
+ menu item as a grid row, which combined with `flex-shrink: 1` on each
42
+ item collapsed the buttons whose internal layout uses `display: flex`
43
+ (the items registered with `useNavigate` rather than `<Link>`) to zero
44
+ content height. Switched the mobile container to a flex column with
45
+ `[&>*]:shrink-0` and added `min-h-0` so the sheet scrolls correctly
46
+ when the list overflows.
47
+
48
+ - **UserMenu grouping**: Slot extensions now accept an optional `group`
49
+ field. The user menu buckets `UserMenuItemsSlot` extensions by `group`
50
+ and renders each group under a labeled header (`Workspace`,
51
+ `Reliability`, `Configuration`, `Documentation`, `Account`). Existing
52
+ core plugins are tagged with the appropriate group; third-party plugins
53
+ can pick any of these or supply their own label. Untagged extensions
54
+ render last with no header. `UserMenuItemsBottomSlot` is unaffected.
55
+
56
+ - **Card header responsiveness**: `CardHeaderRow` (the primitive shared by
57
+ Incident, Maintenance, Auth, Catalog, GitOps and other config cards) now
58
+ stacks vertically on narrow viewports and only switches to a single row
59
+ at the `sm` breakpoint, so titles and adjacent filter controls (e.g.
60
+ status `Select`, "Show resolved" checkbox) no longer cram together on
61
+ mobile. Refactored the Incident and Maintenance config pages to use the
62
+ primitive instead of a hand-rolled `flex items-center justify-between`
63
+ row, and made their `Select` triggers full-width on mobile.
64
+
65
+ - Updated dependencies [42abfff]
66
+ - Updated dependencies [42abfff]
67
+ - Updated dependencies [3547670]
68
+ - Updated dependencies [f6f9a5c]
69
+ - Updated dependencies [f6f9a5c]
70
+ - Updated dependencies [1ef2e79]
71
+ - Updated dependencies [aa89bc5]
72
+ - Updated dependencies [3547670]
73
+ - Updated dependencies [950d6ec]
74
+ - Updated dependencies [3547670]
75
+ - Updated dependencies [3547670]
76
+ - @checkstack/anomaly-common@1.1.0
77
+ - @checkstack/common@0.9.0
78
+ - @checkstack/ui@1.8.0
79
+ - @checkstack/satellite-common@0.4.0
80
+ - @checkstack/gitops-frontend@0.4.0
81
+ - @checkstack/catalog-common@2.1.0
82
+ - @checkstack/frontend-api@0.5.0
83
+ - @checkstack/tips-frontend@0.2.0
84
+ - @checkstack/auth-frontend@0.6.0
85
+ - @checkstack/dashboard-frontend@0.7.0
86
+ - @checkstack/healthcheck-common@1.0.2
87
+ - @checkstack/signal-frontend@0.1.2
88
+
89
+ ## 0.18.2
90
+
91
+ ### Patch Changes
92
+
93
+ - 50e5f5f: Runtime plugin system: install + uninstall plugins from npm, GitHub releases
94
+ (including private GitHub Enterprise instances), or tarball uploads at
95
+ runtime, with multi-package bundles, dependency-derived compatibility checks,
96
+ multi-instance coordination via a Postgres artifact store, and
97
+ single-coordinator destructive cleanup.
98
+
99
+ Highlights:
100
+
101
+ - New `PluginSource` discriminated union and `PluginInstaller` /
102
+ `PluginInstallerRegistry` interfaces in `@checkstack/backend-api`. The
103
+ GitHub variant accepts an optional `apiBaseUrl` so deployments backed by
104
+ GitHub Enterprise can install from `https://ghe.example.com/api/v3`
105
+ instead of `api.github.com`.
106
+ - New `installPackageMetadataSchema` (Zod) in `@checkstack/common` validates
107
+ every plugin's `package.json` at install time. Required fields: `name`,
108
+ `version`, `description`, `author`, `license`, `checkstack.type`,
109
+ `checkstack.pluginId`. Optional: `checkstack.bundle`,
110
+ `checkstack.usageInstructions`, `checkstack.allowInstallScripts`.
111
+ - New `pluginManagerContract` in `@checkstack/pluginmanager-common` with
112
+ `list`, `previewInstall`, `install`, `previewUninstall`, `uninstall`, and
113
+ `events` procedures.
114
+ - New `@checkstack/pluginmanager-frontend` admin UI: installed-plugins list
115
+ with per-row uninstall (typed-confirmation modal, schema/configs/cascade
116
+ toggles), install page with NPM / Tarball Upload / GitHub Release tabs
117
+ (Catalog tab disabled — coming soon), and an events page surfacing the
118
+ install/uninstall audit log.
119
+ - New `bunx @checkstack/scripts plugin-pack` CLI for plugin authors —
120
+ per-package mode produces an npm-shaped tarball; `--bundle` mode produces
121
+ an outer tarball containing every sibling declared in
122
+ `package.json#checkstack.bundle`. Published to npm so external authors
123
+ can `bunx` it directly without a workspace checkout.
124
+ - Compatibility derived from `package.json#dependencies` ranges
125
+ (`semver.satisfies` against the platform's loaded `@checkstack/*`
126
+ versions) — no separate `compatibility` field.
127
+ - Multi-instance: originator persists artifacts + `plugins` rows + broadcasts
128
+ install/uninstall; receiving instances do in-process register/unregister
129
+ only. Destructive ops (drop schema, delete plugin_configs, delete
130
+ artifacts, delete `plugins` rows) run exactly once on the originator.
131
+ - Fresh-instance bootstrap: `loadPlugins()` hydrates any
132
+ `is_uninstallable=true` plugin missing from `node_modules` from the
133
+ artifact store before normal Phase 1 register.
134
+ - New schema: `plugin_artifacts` (tarball storage), `plugin_install_events`
135
+ (audit/error log). `plugins` extended with `version`, `metadata`,
136
+ `source`, `bundle_id`, `is_primary`. Local plugin sync now writes
137
+ `version` from each plugin's `package.json` so the admin UI shows real
138
+ versions instead of `—`.
139
+ - Tarball-upload endpoint (`POST /api/pluginmanager/upload-tarball`) for
140
+ the install UI; access-gated by `pluginmanager.plugin.manage`.
141
+ - Plugin Manager menu link added to the user menu (main grid, alongside
142
+ Profile / Notification Settings / etc.).
143
+
144
+ Cross-cutting changes:
145
+
146
+ - Backend request/response logging now flows through `rootLogger` (winston)
147
+ instead of `hono/logger`. 5xx responses include the response body inline
148
+ so swallowed early-return errors are visible in the log.
149
+ - The `/api/:pluginId/*` dispatcher now logs which core service is missing
150
+ or which `pluginId` had no metadata when it 500s.
151
+ - New `registerCorePluginMetadata` on `PluginManager` for core routers
152
+ (like the plugin manager itself) that need their metadata visible to the
153
+ RPC dispatcher without going through the full plugin lifecycle.
154
+ - ESLint: `unicorn/no-null` is now disabled globally. Drizzle distinguishes
155
+ between `null` (writes a real SQL NULL) and `undefined` (skip the column
156
+ on insert), so treating them as interchangeable produced latent bugs at
157
+ the persistence boundary. The bulk of the patch-bumped packages above
158
+ reflect lint-fix touches that landed when this rule was relaxed.
159
+ - Workspace-wide license normalization to `Elastic-2.0` (matches
160
+ `LICENSE.md`). Every `package.json` in the workspace now declares the
161
+ same SPDX identifier; the patch bumps capture this.
162
+
163
+ Plugin packages (every `plugins/*`): added a `pack` npm script
164
+ (`bunx @checkstack/scripts plugin-pack`), mirrored each plugin's
165
+ `pluginId` from `plugin-metadata.ts` into `package.json#checkstack.pluginId`
166
+ so install-time validation passes, stubbed any missing required metadata
167
+ fields (`description`, `author`, `license`), and added
168
+ `checkstack.bundle` to multi-package plugin primaries (telegram, rcon, ssh,
169
+ jira, queue-bullmq, queue-memory, cache-memory).
170
+
171
+ Breaking changes:
172
+
173
+ - The legacy single-method `PluginInstaller` interface (`install(packageName)`)
174
+ is removed. Callers must use `coreServices.pluginInstallerRegistry`.
175
+ - The old `pluginAdminContract` and `createPluginAdminRouter` are removed.
176
+ Replaced by `pluginManagerContract` in `@checkstack/pluginmanager-common`
177
+ and `createPluginManagerRouter` in `core/backend`.
178
+ - `@checkstack/test-utils-backend` no longer exports
179
+ `createMockPluginInstaller` / `MockPluginInstaller` (the legacy interface
180
+ it shimmed is gone).
181
+
182
+ Note: bumps are limited to `minor` (for packages with new public API
183
+ surface) and `patch` (for downstream consumers, license normalization,
184
+ and lint fixes). No `major` bumps despite the `PluginInstaller` removal —
185
+ the legacy interface had no third-party consumers in the wild before this
186
+ runtime plugin system landed, and the contract surface is the same shape
187
+ modulo the rename.
188
+
189
+ - Updated dependencies [50e5f5f]
190
+ - @checkstack/catalog-common@2.0.1
191
+ - @checkstack/common@0.8.0
192
+ - @checkstack/dashboard-frontend@0.6.1
193
+ - @checkstack/gitops-frontend@0.3.8
194
+ - @checkstack/signal-frontend@0.1.1
195
+ - @checkstack/ui@1.7.1
196
+ - @checkstack/anomaly-common@1.0.1
197
+ - @checkstack/auth-frontend@0.5.33
198
+ - @checkstack/frontend-api@0.4.2
199
+ - @checkstack/healthcheck-common@1.0.1
200
+ - @checkstack/satellite-common@0.3.2
201
+
3
202
  ## 0.18.1
4
203
 
5
204
  ### Patch Changes
package/package.json CHANGED
@@ -1,27 +1,30 @@
1
1
  {
2
2
  "name": "@checkstack/healthcheck-frontend",
3
- "version": "0.18.1",
3
+ "version": "0.19.0",
4
+ "license": "Elastic-2.0",
4
5
  "type": "module",
5
6
  "main": "src/index.tsx",
6
7
  "checkstack": {
7
8
  "type": "frontend"
8
9
  },
9
10
  "scripts": {
10
- "typecheck": "tsc --noEmit",
11
+ "typecheck": "tsgo -b",
11
12
  "lint": "bun run lint:code",
12
13
  "lint:code": "eslint . --max-warnings 0"
13
14
  },
14
15
  "dependencies": {
15
- "@checkstack/anomaly-common": "0.3.0",
16
- "@checkstack/auth-frontend": "0.5.31",
17
- "@checkstack/catalog-common": "1.5.3",
18
- "@checkstack/common": "0.7.0",
19
- "@checkstack/dashboard-frontend": "0.5.1",
20
- "@checkstack/frontend-api": "0.4.0",
21
- "@checkstack/gitops-frontend": "0.3.6",
22
- "@checkstack/healthcheck-common": "0.13.0",
23
- "@checkstack/signal-frontend": "0.1.0",
24
- "@checkstack/ui": "1.6.1",
16
+ "@checkstack/anomaly-common": "1.0.1",
17
+ "@checkstack/auth-frontend": "0.5.33",
18
+ "@checkstack/catalog-common": "2.0.1",
19
+ "@checkstack/common": "0.8.0",
20
+ "@checkstack/dashboard-frontend": "0.6.1",
21
+ "@checkstack/frontend-api": "0.4.2",
22
+ "@checkstack/gitops-frontend": "0.3.8",
23
+ "@checkstack/healthcheck-common": "1.0.1",
24
+ "@checkstack/satellite-common": "0.3.2",
25
+ "@checkstack/signal-frontend": "0.1.1",
26
+ "@checkstack/tips-frontend": "0.1.0",
27
+ "@checkstack/ui": "1.7.1",
25
28
  "ajv": "^8.18.0",
26
29
  "ajv-formats": "^3.0.1",
27
30
  "date-fns": "^4.1.0",
@@ -30,12 +33,11 @@
30
33
  "react-router-dom": "^6.20.0",
31
34
  "recharts": "^3.6.0",
32
35
  "uuid": "^13.0.0",
33
- "zod": "^4.2.1",
34
- "@checkstack/satellite-common": "0.3.0"
36
+ "zod": "^4.2.1"
35
37
  },
36
38
  "devDependencies": {
37
- "@checkstack/scripts": "0.1.2",
38
- "@checkstack/tsconfig": "0.0.5",
39
+ "@checkstack/scripts": "0.3.0",
40
+ "@checkstack/tsconfig": "0.0.7",
39
41
  "@types/react": "^18.2.0",
40
42
  "typescript": "^5.0.0"
41
43
  }
@@ -131,7 +131,7 @@ export const HealthCheckLatencyChart: React.FC<
131
131
  />
132
132
  <Tooltip
133
133
  content={({ active, payload }) => {
134
- // eslint-disable-next-line unicorn/no-null -- recharts requires null return, not undefined
134
+
135
135
  if (!active || !payload?.length) return null;
136
136
  const data = payload[0].payload as (typeof chartData)[number];
137
137
  const startTime = format(new Date(data.timestamp), "MMM d, HH:mm");
package/src/index.tsx CHANGED
@@ -96,6 +96,7 @@ export default createFrontendPlugin({
96
96
  createSlotExtension(UserMenuItemsSlot, {
97
97
  id: "healthcheck.user-menu.items",
98
98
  component: HealthCheckMenuItems,
99
+ metadata: { group: "Reliability" },
99
100
  }),
100
101
  createSlotExtension(SystemStateBadgesSlot, {
101
102
  id: "healthcheck.system-health-badge",
@@ -315,7 +315,7 @@ const AssignmentIDEPageContent = () => {
315
315
  {
316
316
  systemId,
317
317
  configurationId: configId,
318
- // eslint-disable-next-line unicorn/no-null -- RPC contract uses nullable()
318
+
319
319
  retentionConfig: null,
320
320
  },
321
321
  {
@@ -11,7 +11,9 @@ import {
11
11
  type HealthCheckConfiguration,
12
12
  healthcheckRoutes,
13
13
  healthCheckAccess,
14
+ pluginMetadata as healthcheckPluginMetadata,
14
15
  } from "@checkstack/healthcheck-common";
16
+ import { Tip } from "@checkstack/tips-frontend";
15
17
  import { HealthCheckList } from "../components/HealthCheckList";
16
18
  import {
17
19
  Button,
@@ -128,9 +130,18 @@ const HealthCheckConfigPageContent = () => {
128
130
  </Link>
129
131
  </Button>
130
132
  )}
131
- <Button onClick={handleCreate}>
132
- <Plus className="mr-2 h-4 w-4" /> Create Check
133
- </Button>
133
+ <Tip
134
+ plugin={healthcheckPluginMetadata}
135
+ id="create"
136
+ title="Health checks bring systems to life"
137
+ description="Each check decides what 'healthy' means for one of your systems — an HTTP endpoint returning 200, a TCP port being open, a Postgres query succeeding, anything you can express. Failed checks flip the system's health status, notify subscribers, and burn SLO error budget. They do NOT auto-open incidents — those are reported by hand when there's a real outage."
138
+ side="bottom"
139
+ align="end"
140
+ >
141
+ <Button onClick={handleCreate}>
142
+ <Plus className="mr-2 h-4 w-4" /> Create Check
143
+ </Button>
144
+ </Tip>
134
145
  </div>
135
146
  }
136
147
  >
package/tsconfig.json CHANGED
@@ -2,5 +2,43 @@
2
2
  "extends": "@checkstack/tsconfig/frontend.json",
3
3
  "include": [
4
4
  "src"
5
+ ],
6
+ "references": [
7
+ {
8
+ "path": "../anomaly-common"
9
+ },
10
+ {
11
+ "path": "../auth-frontend"
12
+ },
13
+ {
14
+ "path": "../catalog-common"
15
+ },
16
+ {
17
+ "path": "../common"
18
+ },
19
+ {
20
+ "path": "../dashboard-frontend"
21
+ },
22
+ {
23
+ "path": "../frontend-api"
24
+ },
25
+ {
26
+ "path": "../gitops-frontend"
27
+ },
28
+ {
29
+ "path": "../healthcheck-common"
30
+ },
31
+ {
32
+ "path": "../satellite-common"
33
+ },
34
+ {
35
+ "path": "../signal-frontend"
36
+ },
37
+ {
38
+ "path": "../tips-frontend"
39
+ },
40
+ {
41
+ "path": "../ui"
42
+ }
5
43
  ]
6
- }
44
+ }