@takazudo/zdtp 0.2.2 → 0.2.3
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,16 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.2.3
|
|
4
|
+
|
|
5
|
+
### Features
|
|
6
|
+
|
|
7
|
+
- Make `ColorScheme.shikiTheme` optional so hosts can pass their color-scheme maps without a dummy `shikiTheme` or an `as unknown as` cast — the runtime already falls back to the cluster's `defaultShikiTheme`. The hydrated `ColorTweakState.shikiTheme` stays required (it is always defaulted, and `TweakState` is re-exported, so keeping it required avoids widening the public `state.color.shikiTheme` type). (e057388, fd87423, [#342](https://github.com/Takazudo/zudo-design-token-panel/issues/342))
|
|
8
|
+
|
|
9
|
+
### Other Changes
|
|
10
|
+
|
|
11
|
+
- docs: document the global (not scheme-scoped) tweak model in README §9 — on a host `color-scheme-changed` event the panel drops its inline overrides and re-seeds the live state from the new scheme, leaving `localStorage` untouched until the next edit. (238b4db, [#343](https://github.com/Takazudo/zudo-design-token-panel/issues/343))
|
|
12
|
+
- ci: drop the stale npm `next` dist-tag on stable releases when it lags `latest`, so `@takazudo/zdtp@next` can no longer silently resolve to an older prerelease. (215ec59, [#345](https://github.com/Takazudo/zudo-design-token-panel/issues/345))
|
|
13
|
+
|
|
3
14
|
## 0.2.2
|
|
4
15
|
|
|
5
16
|
### Other Changes
|
package/README.md
CHANGED
|
@@ -838,6 +838,17 @@ myapp-design-token-panel:visible
|
|
|
838
838
|
|
|
839
839
|
The `visible` key uses a literal `:` separator, not `-`. Every other derived key uses `-`. This is intentional — see [`PORTABLE-CONTRACT.md`](./PORTABLE-CONTRACT.md) §2 for the historical reason. Don't try to "normalize" it; the unit tests assert this specific shape.
|
|
840
840
|
|
|
841
|
+
### Scheme changes and the global tweak model
|
|
842
|
+
|
|
843
|
+
Tweak state is **global**, not scheme-scoped: the keys above are derived only from `storagePrefix` and carry no color-scheme name. A single envelope holds every slice — the `color` slice stores **absolute** colors (palette + role/semantic indices resolved against that palette), while the `spacing` / `typography` / `size` slices store token overrides that are independent of the active scheme.
|
|
844
|
+
|
|
845
|
+
Because the stored palette is absolute, it cannot simply be re-applied on top of a different scheme. So when the host dispatches a `color-scheme-changed` event (e.g. a light/dark toggle), the panel **re-seeds its live state from the newly active scheme**: it removes the inline `:root` overrides it had applied (`clearAppliedStyles`) and re-initializes the live envelope from that scheme (`freshTweakState`). Palette tweaks are therefore intentionally **not** carried across a scheme switch — the panel adopts the new scheme's palette rather than layering the previous absolute colors on top of it. This is the panel's deliberate global model; it does **not** persist a separate color slice per scheme.
|
|
846
|
+
|
|
847
|
+
Two consequences worth knowing as a host integrator:
|
|
848
|
+
|
|
849
|
+
- The event handler does not rewrite the `localStorage` envelope — it only re-seeds the live (in-memory) state and clears the inline overrides. The persisted envelope remains until the next in-panel edit re-persists the (re-seeded) state, or a full reload re-applies it via `loadPersistedState`.
|
|
850
|
+
- Do **not** manually delete the tweak keys on a scheme toggle. The panel already re-seeds on the event, and a manual envelope delete would also discard the scheme-independent `spacing` / `typography` / `size` overrides.
|
|
851
|
+
|
|
841
852
|
---
|
|
842
853
|
|
|
843
854
|
## 10. Console API contract
|
|
@@ -42,8 +42,13 @@ export interface ColorScheme {
|
|
|
42
42
|
* in the Astro types (this package isn't an Astro app — this field is
|
|
43
43
|
* preserved for symmetry with upstream presets and for any future
|
|
44
44
|
* code-block tooling).
|
|
45
|
+
*
|
|
46
|
+
* Optional: this package only uses it for the (no-op) code-block preview,
|
|
47
|
+
* and `initColorFromSchemeData` falls back to `colorExtras.defaultShikiTheme`
|
|
48
|
+
* when a scheme omits it. Hosts whose schemes carry no Shiki theme can pass
|
|
49
|
+
* their scheme maps directly, without a dummy value or an `as unknown as` cast.
|
|
45
50
|
*/
|
|
46
|
-
shikiTheme
|
|
51
|
+
shikiTheme?: string;
|
|
47
52
|
/**
|
|
48
53
|
* Optional semantic overrides — when omitted, defaults from
|
|
49
54
|
* `SEMANTIC_DEFAULTS_ZD` (in `color-scheme-utils.ts`) are used.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"color-schemes.d.ts","sourceRoot":"","sources":["../../src/config/color-schemes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,+EAA+E;AAC/E,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvC,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,MAAM,EAAE,QAAQ,CAAC;IACjB,WAAW,EAAE,QAAQ,CAAC;IACtB,WAAW,EAAE,QAAQ,CAAC;IACtB,OAAO,EAAE;QACP,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;KACP,CAAC;IACF
|
|
1
|
+
{"version":3,"file":"color-schemes.d.ts","sourceRoot":"","sources":["../../src/config/color-schemes.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,+EAA+E;AAC/E,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;AAEvC,MAAM,WAAW,WAAW;IAC1B,UAAU,EAAE,QAAQ,CAAC;IACrB,UAAU,EAAE,QAAQ,CAAC;IACrB,MAAM,EAAE,QAAQ,CAAC;IACjB,WAAW,EAAE,QAAQ,CAAC;IACtB,WAAW,EAAE,QAAQ,CAAC;IACtB,OAAO,EAAE;QACP,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;QACN,MAAM;KACP,CAAC;IACF;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;;;OAMG;IACH,QAAQ,CAAC,EAAE;QACT,EAAE,CAAC,EAAE,QAAQ,CAAC;QACd,EAAE,CAAC,EAAE,QAAQ,CAAC;QACd,OAAO,CAAC,EAAE,QAAQ,CAAC;QACnB,KAAK,CAAC,EAAE,QAAQ,CAAC;QACjB,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,WAAW,CAAC,EAAE,QAAQ,CAAC;QACvB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,OAAO,CAAC,EAAE,QAAQ,CAAC;QACnB,MAAM,CAAC,EAAE,QAAQ,CAAC;QAClB,OAAO,CAAC,EAAE,QAAQ,CAAC;QACnB,IAAI,CAAC,EAAE,QAAQ,CAAC;QAChB,KAAK,CAAC,EAAE,QAAQ,CAAC;QACjB,IAAI,CAAC,EAAE,QAAQ,CAAC;KACjB,CAAC;CACH;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAiFpD,CAAC"}
|
package/dist/panel.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"panel.d.ts","sourceRoot":"","sources":["../src/panel.tsx"],"names":[],"mappings":"AA2GA,MAAM,CAAC,OAAO,UAAU,qBAAqB,
|
|
1
|
+
{"version":3,"file":"panel.d.ts","sourceRoot":"","sources":["../src/panel.tsx"],"names":[],"mappings":"AA2GA,MAAM,CAAC,OAAO,UAAU,qBAAqB,iCA6qB5C;AAED,YAAY,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC"}
|
|
@@ -32,7 +32,12 @@
|
|
|
32
32
|
* The `shikiTheme` field stays on the state + persist envelope so JSON
|
|
33
33
|
* round-tripping with external exports is seamless; the UI hides it and
|
|
34
34
|
* `applyShikiTheme` is a no-op. Removing the field would churn the serde
|
|
35
|
-
* format for no real benefit.
|
|
35
|
+
* format for no real benefit. It stays *required* on the hydrated state —
|
|
36
|
+
* constructors and hydrators always default it (from the scheme / cluster
|
|
37
|
+
* default, or backfilled from defaults), and `TweakState` is re-exported, so
|
|
38
|
+
* keeping it required avoids widening the public `state.color.shikiTheme` type.
|
|
39
|
+
* Only the input `ColorScheme.shikiTheme` is optional (#342), so hosts may omit
|
|
40
|
+
* it on their scheme maps.
|
|
36
41
|
*/
|
|
37
42
|
import type { ColorRef, ColorScheme } from '../config/color-schemes';
|
|
38
43
|
import type { TokenDef } from '../tokens/manifest';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"tweak-state.d.ts","sourceRoot":"","sources":["../../src/state/tweak-state.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"tweak-state.d.ts","sourceRoot":"","sources":["../../src/state/tweak-state.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAEL,KAAK,sBAAsB,EAE5B,MAAM,0BAA0B,CAAC;AAclC,OAAO,EACL,KAAK,YAAY,EAGlB,MAAM,wBAAwB,CAAC;AAMhC,YAAY,EAAE,WAAW,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,MAAM,MAAM,kBAAkB,GAAG,sBAAsB,CAAC;AAKxD,YAAY,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAM3D;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,IAAI,MAAM,CAExC;AAED,wBAAgB,eAAe,IAAI,MAAM,CAExC;AAED,wBAAgB,eAAe,IAAI,MAAM,CAExC;AAED,wBAAgB,UAAU,IAAI,MAAM,CAEnC;AAED,wBAAgB,cAAc,IAAI,MAAM,CAEvC;AAED,wBAAgB,UAAU,IAAI,MAAM,CAEnC;AAED,wBAAgB,aAAa,IAAI,MAAM,CAEtC;AAMD,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAAqC,CAAC;AAErE;;;;;;;;;;GAUG;AACH,wBAAgB,eAAe,IAAI,aAAa,CAO/C;AAED,wBAAgB,YAAY,IAAI,aAAa,CAa5C;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,aAAa,QAM9C;AAED,wFAAwF;AACxF,eAAO,MAAM,WAAW,KAAK,CAAC;AAM9B,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,yGAAyG;AACzG,eAAO,MAAM,eAAe,MAAM,CAAC;AACnC,eAAO,MAAM,gBAAgB,MAAM,CAAC;AAEpC,mGAAmG;AACnG,eAAO,MAAM,eAAe,OAAO,CAAC;AACpC,eAAO,MAAM,gBAAgB,OAAO,CAAC;AAErC;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,SAAoD,CAAC;AAEhF;;;;GAIG;AACH,wBAAgB,WAAW,IAAI,SAAS,CAMvC;AAKD;;;;GAIG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CASlE;AAED,wBAAgB,QAAQ,IAAI,SAAS,CAkBpC;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,SAAS,QAMvC;AAMD;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,YAAY,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAErC,eAAO,MAAM,eAAe,EAAE,YAAgB,CAAC;AAE/C,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,YAAY,GAAG,MAAM,CAI9D;AAED,wBAAgB,WAAW,IAAI,YAAY,CAU1C;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,YAAY,QAMhD;AAOD,wBAAgB,aAAa,CAC3B,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,UAAU,EAAE,MAAM,EAClB,YAAY,EAAE,MAAM,GACnB,aAAa,CAwCf;AAMD;;;;GAIG;AACH,wBAAsB,eAAe,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAGvE;AAED,oFAAoF;AACpF,eAAO,MAAM,YAAY,UAmCxB,CAAC;AAMF;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;IACvD,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAEpD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,eAAe,CAAC;IACvB,OAAO,EAAE,cAAc,CAAC;IACxB,UAAU,EAAE,cAAc,CAAC;IAC3B,IAAI,EAAE,cAAc,CAAC;IACrB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,mEAAmE;IACnE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;CACrC;AAED,0EAA0E;AAC1E,wBAAgB,cAAc,IAAI,cAAc,CAE/C;AAqCD;;;GAGG;AACH,wBAAgB,uBAAuB,CACrC,GAAG,2BAAmB,GACrB,sBAAsB,CAExB;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,sBAAsB,GAAG,eAAe,CAqBtF;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,IAAI,eAAe,GAAG,SAAS,CAGrE;AAqDD,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAwCnD;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEpD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,GAAG,EAAE,QAAQ,GAAG,SAAS,EACzB,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,MAAM,GACf,MAAM,CAiCR;AAmBD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,sBAAkD,GAC1D,MAAM,CAQR;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,GAAE,sBAAkD,GAC1D,eAAe,CAYjB;AAED,wBAAgB,uBAAuB,CACrC,MAAM,EAAE,WAAW,EACnB,OAAO,GAAE,sBAAkD,GAC1D,eAAe,CAyCjB;AAMD,sEAAsE;AACtE,wBAAgB,cAAc,CAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,EAC7B,OAAO,EAAE,MAAM,EAAE,EACjB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,MAAM,GACd,MAAM,CAKR;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED,kFAAkF;AAClF,wBAAgB,eAAe,CAC7B,KAAK,EAAE,eAAe,EACtB,OAAO,GAAE,sBAAkD,QAqB5D;AAED;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,SAAS,QAAQ,EAAE,EAAE,SAAS,EAAE,cAAc,QAUzF;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,QAc/C;AA+DD;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAChC,QAAQ,GAAE,SAAS,sBAAsB,EAOrC,QA0BL;AAqED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACpC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,iCAAiC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,CASrF,CAAC;AA0KF,wBAAgB,kBAAkB,CAChC,OAAO,GAAE,WAA0B,EACnC,aAAa,CAAC,EAAE,eAAe,EAC/B,OAAO,GAAE,sBAAkD,GAC1D,UAAU,GAAG,IAAI,CAgHnB;AAED,2CAA2C;AAC3C,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,GAAE,WAA0B,QAMxF;AAED,4CAA4C;AAC5C,wBAAgB,mBAAmB,CAAC,OAAO,GAAE,WAA0B,QAgBtE"}
|