@checkstack/api-docs-frontend 0.1.34 → 0.1.36

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,154 @@
1
1
  # @checkstack/api-docs-frontend
2
2
 
3
+ ## 0.1.36
4
+
5
+ ### Patch Changes
6
+
7
+ - 950d6ec: Fix mobile UserMenu items rendering at zero height, group menu items by
8
+ section, and unstack cramped card headers on small viewports.
9
+
10
+ - **UserMenu mobile bug**: On mobile, the user-menu Sheet rendered every
11
+ menu item as a grid row, which combined with `flex-shrink: 1` on each
12
+ item collapsed the buttons whose internal layout uses `display: flex`
13
+ (the items registered with `useNavigate` rather than `<Link>`) to zero
14
+ content height. Switched the mobile container to a flex column with
15
+ `[&>*]:shrink-0` and added `min-h-0` so the sheet scrolls correctly
16
+ when the list overflows.
17
+
18
+ - **UserMenu grouping**: Slot extensions now accept an optional `group`
19
+ field. The user menu buckets `UserMenuItemsSlot` extensions by `group`
20
+ and renders each group under a labeled header (`Workspace`,
21
+ `Reliability`, `Configuration`, `Documentation`, `Account`). Existing
22
+ core plugins are tagged with the appropriate group; third-party plugins
23
+ can pick any of these or supply their own label. Untagged extensions
24
+ render last with no header. `UserMenuItemsBottomSlot` is unaffected.
25
+
26
+ - **Card header responsiveness**: `CardHeaderRow` (the primitive shared by
27
+ Incident, Maintenance, Auth, Catalog, GitOps and other config cards) now
28
+ stacks vertically on narrow viewports and only switches to a single row
29
+ at the `sm` breakpoint, so titles and adjacent filter controls (e.g.
30
+ status `Select`, "Show resolved" checkbox) no longer cram together on
31
+ mobile. Refactored the Incident and Maintenance config pages to use the
32
+ primitive instead of a hand-rolled `flex items-center justify-between`
33
+ row, and made their `Select` triggers full-width on mobile.
34
+
35
+ - Updated dependencies [42abfff]
36
+ - Updated dependencies [3547670]
37
+ - Updated dependencies [1ef2e79]
38
+ - Updated dependencies [aa89bc5]
39
+ - Updated dependencies [950d6ec]
40
+ - Updated dependencies [3547670]
41
+ - @checkstack/common@0.9.0
42
+ - @checkstack/ui@1.8.0
43
+ - @checkstack/frontend-api@0.5.0
44
+ - @checkstack/api-docs-common@0.1.12
45
+
46
+ ## 0.1.35
47
+
48
+ ### Patch Changes
49
+
50
+ - 50e5f5f: Runtime plugin system: install + uninstall plugins from npm, GitHub releases
51
+ (including private GitHub Enterprise instances), or tarball uploads at
52
+ runtime, with multi-package bundles, dependency-derived compatibility checks,
53
+ multi-instance coordination via a Postgres artifact store, and
54
+ single-coordinator destructive cleanup.
55
+
56
+ Highlights:
57
+
58
+ - New `PluginSource` discriminated union and `PluginInstaller` /
59
+ `PluginInstallerRegistry` interfaces in `@checkstack/backend-api`. The
60
+ GitHub variant accepts an optional `apiBaseUrl` so deployments backed by
61
+ GitHub Enterprise can install from `https://ghe.example.com/api/v3`
62
+ instead of `api.github.com`.
63
+ - New `installPackageMetadataSchema` (Zod) in `@checkstack/common` validates
64
+ every plugin's `package.json` at install time. Required fields: `name`,
65
+ `version`, `description`, `author`, `license`, `checkstack.type`,
66
+ `checkstack.pluginId`. Optional: `checkstack.bundle`,
67
+ `checkstack.usageInstructions`, `checkstack.allowInstallScripts`.
68
+ - New `pluginManagerContract` in `@checkstack/pluginmanager-common` with
69
+ `list`, `previewInstall`, `install`, `previewUninstall`, `uninstall`, and
70
+ `events` procedures.
71
+ - New `@checkstack/pluginmanager-frontend` admin UI: installed-plugins list
72
+ with per-row uninstall (typed-confirmation modal, schema/configs/cascade
73
+ toggles), install page with NPM / Tarball Upload / GitHub Release tabs
74
+ (Catalog tab disabled — coming soon), and an events page surfacing the
75
+ install/uninstall audit log.
76
+ - New `bunx @checkstack/scripts plugin-pack` CLI for plugin authors —
77
+ per-package mode produces an npm-shaped tarball; `--bundle` mode produces
78
+ an outer tarball containing every sibling declared in
79
+ `package.json#checkstack.bundle`. Published to npm so external authors
80
+ can `bunx` it directly without a workspace checkout.
81
+ - Compatibility derived from `package.json#dependencies` ranges
82
+ (`semver.satisfies` against the platform's loaded `@checkstack/*`
83
+ versions) — no separate `compatibility` field.
84
+ - Multi-instance: originator persists artifacts + `plugins` rows + broadcasts
85
+ install/uninstall; receiving instances do in-process register/unregister
86
+ only. Destructive ops (drop schema, delete plugin_configs, delete
87
+ artifacts, delete `plugins` rows) run exactly once on the originator.
88
+ - Fresh-instance bootstrap: `loadPlugins()` hydrates any
89
+ `is_uninstallable=true` plugin missing from `node_modules` from the
90
+ artifact store before normal Phase 1 register.
91
+ - New schema: `plugin_artifacts` (tarball storage), `plugin_install_events`
92
+ (audit/error log). `plugins` extended with `version`, `metadata`,
93
+ `source`, `bundle_id`, `is_primary`. Local plugin sync now writes
94
+ `version` from each plugin's `package.json` so the admin UI shows real
95
+ versions instead of `—`.
96
+ - Tarball-upload endpoint (`POST /api/pluginmanager/upload-tarball`) for
97
+ the install UI; access-gated by `pluginmanager.plugin.manage`.
98
+ - Plugin Manager menu link added to the user menu (main grid, alongside
99
+ Profile / Notification Settings / etc.).
100
+
101
+ Cross-cutting changes:
102
+
103
+ - Backend request/response logging now flows through `rootLogger` (winston)
104
+ instead of `hono/logger`. 5xx responses include the response body inline
105
+ so swallowed early-return errors are visible in the log.
106
+ - The `/api/:pluginId/*` dispatcher now logs which core service is missing
107
+ or which `pluginId` had no metadata when it 500s.
108
+ - New `registerCorePluginMetadata` on `PluginManager` for core routers
109
+ (like the plugin manager itself) that need their metadata visible to the
110
+ RPC dispatcher without going through the full plugin lifecycle.
111
+ - ESLint: `unicorn/no-null` is now disabled globally. Drizzle distinguishes
112
+ between `null` (writes a real SQL NULL) and `undefined` (skip the column
113
+ on insert), so treating them as interchangeable produced latent bugs at
114
+ the persistence boundary. The bulk of the patch-bumped packages above
115
+ reflect lint-fix touches that landed when this rule was relaxed.
116
+ - Workspace-wide license normalization to `Elastic-2.0` (matches
117
+ `LICENSE.md`). Every `package.json` in the workspace now declares the
118
+ same SPDX identifier; the patch bumps capture this.
119
+
120
+ Plugin packages (every `plugins/*`): added a `pack` npm script
121
+ (`bunx @checkstack/scripts plugin-pack`), mirrored each plugin's
122
+ `pluginId` from `plugin-metadata.ts` into `package.json#checkstack.pluginId`
123
+ so install-time validation passes, stubbed any missing required metadata
124
+ fields (`description`, `author`, `license`), and added
125
+ `checkstack.bundle` to multi-package plugin primaries (telegram, rcon, ssh,
126
+ jira, queue-bullmq, queue-memory, cache-memory).
127
+
128
+ Breaking changes:
129
+
130
+ - The legacy single-method `PluginInstaller` interface (`install(packageName)`)
131
+ is removed. Callers must use `coreServices.pluginInstallerRegistry`.
132
+ - The old `pluginAdminContract` and `createPluginAdminRouter` are removed.
133
+ Replaced by `pluginManagerContract` in `@checkstack/pluginmanager-common`
134
+ and `createPluginManagerRouter` in `core/backend`.
135
+ - `@checkstack/test-utils-backend` no longer exports
136
+ `createMockPluginInstaller` / `MockPluginInstaller` (the legacy interface
137
+ it shimmed is gone).
138
+
139
+ Note: bumps are limited to `minor` (for packages with new public API
140
+ surface) and `patch` (for downstream consumers, license normalization,
141
+ and lint fixes). No `major` bumps despite the `PluginInstaller` removal —
142
+ the legacy interface had no third-party consumers in the wild before this
143
+ runtime plugin system landed, and the contract surface is the same shape
144
+ modulo the rename.
145
+
146
+ - Updated dependencies [50e5f5f]
147
+ - @checkstack/common@0.8.0
148
+ - @checkstack/ui@1.7.1
149
+ - @checkstack/api-docs-common@0.1.11
150
+ - @checkstack/frontend-api@0.4.2
151
+
3
152
  ## 0.1.34
4
153
 
5
154
  ### Patch Changes
package/package.json CHANGED
@@ -1,21 +1,22 @@
1
1
  {
2
2
  "name": "@checkstack/api-docs-frontend",
3
- "version": "0.1.34",
3
+ "version": "0.1.36",
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/frontend-api": "0.4.0",
16
- "@checkstack/common": "0.7.0",
17
- "@checkstack/api-docs-common": "0.1.10",
18
- "@checkstack/ui": "1.6.1",
16
+ "@checkstack/frontend-api": "0.4.2",
17
+ "@checkstack/common": "0.8.0",
18
+ "@checkstack/api-docs-common": "0.1.11",
19
+ "@checkstack/ui": "1.7.1",
19
20
  "react": "^18.2.0",
20
21
  "react-router-dom": "^6.22.0",
21
22
  "lucide-react": "^0.344.0"
@@ -23,7 +24,7 @@
23
24
  "devDependencies": {
24
25
  "typescript": "^5.0.0",
25
26
  "@types/react": "^18.2.0",
26
- "@checkstack/tsconfig": "0.0.5",
27
- "@checkstack/scripts": "0.1.2"
27
+ "@checkstack/tsconfig": "0.0.7",
28
+ "@checkstack/scripts": "0.3.0"
28
29
  }
29
30
  }
package/src/index.tsx CHANGED
@@ -25,6 +25,7 @@ export const apiDocsPlugin = createFrontendPlugin({
25
25
  createSlotExtension(UserMenuItemsSlot, {
26
26
  id: "api-docs.user-menu.link",
27
27
  component: ApiDocsMenuItem,
28
+ metadata: { group: "Documentation" },
28
29
  }),
29
30
  ],
30
31
  });
package/tsconfig.json CHANGED
@@ -2,5 +2,19 @@
2
2
  "extends": "@checkstack/tsconfig/frontend.json",
3
3
  "include": [
4
4
  "src"
5
+ ],
6
+ "references": [
7
+ {
8
+ "path": "../api-docs-common"
9
+ },
10
+ {
11
+ "path": "../common"
12
+ },
13
+ {
14
+ "path": "../frontend-api"
15
+ },
16
+ {
17
+ "path": "../ui"
18
+ }
5
19
  ]
6
- }
20
+ }