@datalabz_/dashboard-kit 4.0.4 → 5.0.1

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.
Files changed (4) hide show
  1. package/README.md +27 -20
  2. package/package.json +2 -1
  3. package/v4.js +1 -1
  4. package/v5.js +1820 -0
package/README.md CHANGED
@@ -30,20 +30,24 @@ API reference. The SQL gateway the kit calls is
30
30
 
31
31
  ## Versions
32
32
 
33
- Each major is a separate, self-contained `vN.js`/`vN.css` pair, **pinned by
34
- URL from every dashboard generated against it** — those dashboards keep
35
- loading it indefinitely, so a shipped `vN` is a live dependency that is only
36
- ever added to, never altered (see Rules).
37
-
38
- - **`v4` is the current and only live major** — what the authoring guide
39
- links, what `catalog.html` demos, and the only kit that is published.
33
+ Each major is a separate, self-contained bundle, **pinned by URL from every
34
+ dashboard generated against it** — those dashboards keep loading it
35
+ indefinitely, so a shipped `vN` is a live dependency that is only ever added
36
+ to, never altered (see Rules). Up to `v4` a major is a `vN.js`/`vN.css` pair;
37
+ from `v5` on it is `vN.js` alone, carrying its own CSS, because Claude artifacts
38
+ can load scripts from jsDelivr but not stylesheets.
39
+
40
+ - **`v5` is the current major** — what the authoring guide links and what
41
+ `catalog.html` demos.
42
+ - **`v4` stays live** and in every release: every dashboard made before `v5`
43
+ loads it.
40
44
  - **`v1`, `v2` and `v3` are deprecated — treat them as gone.** They are not in
41
45
  this repo and are not published. Don't bring them back, don't publish them,
42
46
  don't cite them in docs or `catalog.html`, and don't copy from them when
43
- cutting a new major — start from `v4`. Whatever is live at their old
44
- 888drafts URLs is frozen at its last published state.
47
+ cutting a new major — start from the current one. Whatever is live at their
48
+ old 888drafts URLs is frozen at its last published state.
45
49
 
46
- A `vN.js`/`vN.css` pair is one served bundle; the repo's per-file line budget
50
+ A major's files are one served bundle; the repo's per-file line budget
47
51
  (AGENTS.md #2) does not apply to it — it cannot be split without changing the
48
52
  URLs already pinned by live dashboards.
49
53
 
@@ -98,13 +102,15 @@ URLs already pinned by live dashboards.
98
102
 
99
103
  ## Cutting a new version (`v{N+1}`)
100
104
 
101
- 1. Copy `v{N}.js`/`v{N}.css` → `v{N+1}.js`/`v{N+1}.css`.
105
+ 1. Copy `v{N}.js` → `v{N+1}.js`. From `v5` on there is no CSS file to copy: it
106
+ lives in the `DK_KIT_V{N}_CSS` string inside the JS, renamed for the new
107
+ major.
102
108
  2. Fix the header comment to `/* DashboardKit v{N+1}.js */`.
103
- 3. In [bitbucket-pipelines.yml](../bitbucket-pipelines.yml), add
104
- `v{N+1}.js v{N+1}.css` to the `cp` line and stamp `__BUILD__` in
105
- `v{N+1}.js` too — **in addition to** `v{N}`, never instead of it. A
106
- Cloudflare Pages deploy replaces the whole site, so a major left out of a
107
- deploy stops loading for every dashboard pinned to it.
109
+ 3. In [bitbucket-pipelines.yml](../bitbucket-pipelines.yml), add `v{N+1}.js`
110
+ to the `cp` line and stamp `__BUILD__` in it too, and add it to `files` in
111
+ [package.json](package.json) — **in addition to** every live major, never
112
+ instead of one. A Cloudflare Pages deploy replaces the whole site, so a
113
+ major left out of a deploy stops loading for every dashboard pinned to it.
108
114
  4. Make the actual change in the new file only.
109
115
  5. Update `catalog.html` and the authoring guide's kit links — only once the
110
116
  user has accepted the new `vN`.
@@ -117,12 +123,13 @@ URLs already pinned by live dashboards.
117
123
 
118
124
  Pushing a `kit-v*` tag (`kit-v4.0.3`, …) runs
119
125
  [bitbucket-pipelines.yml](../bitbucket-pipelines.yml). It publishes `v4.js`,
120
- `v4.css`, `wrapper.js`, `wrapper.css` and `catalog.html` as they are in this
121
- directory, with `v4.js`'s `__BUILD__` marker replaced by the commit hash so
122
- System Info can say which build is live, to two places:
126
+ `v4.css`, `v5.js`, `wrapper.js`, `wrapper.css` and `catalog.html` as they are
127
+ in this directory, with the `__BUILD__` marker in each kit's JS replaced by the
128
+ commit hash so System Info can say which build is live, to two places:
123
129
 
124
130
  - **Cloudflare Pages**, project `dashboard-kit` — for BackOffice dashboards,
125
- which load `https://dashboard-kit-2n2.pages.dev/vN.{css,js}`. That is a test
131
+ which load `https://dashboard-kit-2n2.pages.dev/v5.js` (older ones
132
+ `v4.js` and `v4.css`). That is a test
126
133
  address on a test account until the company account serves
127
134
  `https://kit.<domain>/`; dashboards made before then keep the test address,
128
135
  so the test project must stay until they are rewritten. Every file is
package/package.json CHANGED
@@ -1,11 +1,12 @@
1
1
  {
2
2
  "name": "@datalabz_/dashboard-kit",
3
- "version": "4.0.4",
3
+ "version": "5.0.1",
4
4
  "description": "DashboardKit runtime + styles, served from jsDelivr",
5
5
  "license": "UNLICENSED",
6
6
  "files": [
7
7
  "v4.js",
8
8
  "v4.css",
9
+ "v5.js",
9
10
  "wrapper.js",
10
11
  "wrapper.css"
11
12
  ],
package/v4.js CHANGED
@@ -20,7 +20,7 @@
20
20
  let _activeTabId = '';
21
21
  let _sections = []; // { id, label, load, loaded, errors }
22
22
  let _title = '';
23
- let _gitVer = 'ded6e67'; // replaced at deploy: sed -i "s/ded6e67/$(git rev-parse --short HEAD)/g" v4.js
23
+ let _gitVer = 'ec73754'; // replaced at deploy: sed -i "s/ec73754/$(git rev-parse --short HEAD)/g" v4.js
24
24
  let _calls = []; // System Info call log
25
25
  let _sectionErrors = {}; // sectionId → error count
26
26
  let _generation = 0;