@contentstack/studio-registry 2.0.0 → 2.1.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.
Files changed (29) hide show
  1. package/dist/cjs/index.cjs +670 -11
  2. package/dist/cjs/index.cjs.map +1 -1
  3. package/dist/esm/common/global-store.js.map +1 -1
  4. package/dist/esm/component-registry/built-in-components-loader.js +36 -0
  5. package/dist/esm/component-registry/built-in-components-loader.js.map +1 -0
  6. package/dist/esm/component-registry/registry.constant.js +3 -0
  7. package/dist/esm/component-registry/registry.constant.js.map +1 -1
  8. package/dist/esm/component-registry/registry.js +6 -0
  9. package/dist/esm/component-registry/registry.js.map +1 -1
  10. package/dist/esm/data-binder/first-of-type.js +86 -0
  11. package/dist/esm/data-binder/first-of-type.js.map +1 -0
  12. package/dist/esm/data-binder/handle-binding-map.util.js +3 -0
  13. package/dist/esm/data-binder/handle-binding-map.util.js.map +1 -1
  14. package/dist/esm/data-binder/retrieve-data.js +54 -8
  15. package/dist/esm/data-binder/retrieve-data.js.map +1 -1
  16. package/dist/esm/data-binder/retrieve-data.util.js +11 -2
  17. package/dist/esm/data-binder/retrieve-data.util.js.map +1 -1
  18. package/dist/esm/data-binder/section-exposed-bindings.js +98 -0
  19. package/dist/esm/data-binder/section-exposed-bindings.js.map +1 -0
  20. package/dist/esm/data-binder/section-exposed-design-props.js +243 -0
  21. package/dist/esm/data-binder/section-exposed-design-props.js.map +1 -0
  22. package/dist/esm/data-binder/state-binding.util.js +50 -1
  23. package/dist/esm/data-binder/state-binding.util.js.map +1 -1
  24. package/dist/esm/design-registry/design-registry.js +44 -1
  25. package/dist/esm/design-registry/design-registry.js.map +1 -1
  26. package/dist/esm/index.d.ts +313 -9
  27. package/dist/esm/index.js +6 -2
  28. package/dist/esm/index.js.map +1 -1
  29. package/package.json +5 -5
@@ -0,0 +1 @@
1
+ {"version":3,"file":"section-exposed-bindings.js","sources":["../../../src/data-binder/section-exposed-bindings.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;AAmBG;AACG,SAAU,+BAA+B,CAC7C,mBAA4B,EAAA;AAE5B,IAAA,MAAM,IAAI,GAAI,mBAAqD,EAAE,IAAI;IACzE,OAAO,IAAI,KAAK,UAAU;AAC5B;AAEA;;;AAGG;AACG,SAAU,qBAAqB,CAAC,OAAgB,EAAA;IACpD,MAAM,CAAC,GAAG,OAGG;AACb,IAAA,IAAI,CAAC,EAAE,IAAI,KAAK,UAAU;AAAE,QAAA,OAAO,SAAS;AAC5C,IAAA,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,EAAE,WAAW;AAChC,IAAA,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,GAAG,GAAG,GAAG,SAAS;AACzD;AAEA;;;;;;;;;;;;;;;;;;;;;;;;;AAyBG;AACG,SAAU,yBAAyB,CACvC,mBAA4B,EAC5B,eAAmC,EACnC,UAA+B,EAC/B,eAAwB,EAAA;;;;;;AAOxB,IAAA,IAAI,UAAU;AAAE,QAAA,OAAO,IAAI;;;;;;;;;;AAU3B,IAAA,IAAI,CAAC,eAAe;AAAE,QAAA,OAAO,IAAI;;;;;AAKjC,IAAA,IAAI,CAAC,+BAA+B,CAAC,mBAAmB,CAAC;AAAE,QAAA,OAAO,KAAK;IACvE,IAAI,eAAe,KAAK,UAAU;AAAE,QAAA,OAAO,KAAK;;;AAGhD,IAAA,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,mBAAmB,CAAC;AACpE,IAAA,IAAI,CAAC,eAAe,IAAI,CAAC,iBAAiB;AAAE,QAAA,OAAO,IAAI;IACvD,OAAO,eAAe,KAAK,iBAAiB;AAC9C;;;;"}
@@ -0,0 +1,243 @@
1
+ /**
2
+ * Exposed design props (docs/adr/0004). A Section can expose a Design prop
3
+ * (ADR 0003) of one of its inner nodes so each Template placement sets its own
4
+ * per-breakpoint values. The placement stores them in the PLACED node's
5
+ * `styles`, under a group keyed by the exposed prop's uid, with the real CSS
6
+ * property as the declaration key:
7
+ *
8
+ * placed.styles[ep.uid].responsiveStyles[bp][ep.propKey] = <css value>
9
+ *
10
+ * The renderers turn that into a per-inner-node override map carried on
11
+ * `dataSources[SECTION_EXPOSED_STYLE_OVERRIDES_KEY]` (next to
12
+ * `section_exposed_overrides`), and merge it per breakpoint into a CLONE of the
13
+ * inner node's styles right before `handleNodeStyles`. Every helper here is
14
+ * shared by the client renderer, the RSC entry, the editor canvas and SSR style
15
+ * extraction, so they all make the same call.
16
+ */
17
+ /** dataSources key carrying {@link SectionExposedStyleOverrides} into a section subtree. */
18
+ const SECTION_EXPOSED_STYLE_OVERRIDES_KEY = "section_exposed_style_overrides";
19
+ /**
20
+ * Internal prop a renderer hands a placed section's wrapper component: the
21
+ * placed node's resolved style groups other than `default` (the raw material
22
+ * the wrapper builds {@link SectionExposedStyleOverrides} from). Never a DOM
23
+ * attribute.
24
+ */
25
+ const SECTION_EXPOSED_STYLES_PROP = "section_exposed_styles";
26
+ const DEFAULT_STYLE_GROUP = "default";
27
+ const isPlainObject = (v) => !!v && typeof v === "object" && !Array.isArray(v);
28
+ /** Reads `sectionExposedProps` from a section's ui (tolerates a missing/encoded ui). */
29
+ function getSectionExposedPropDefinitions(sectionUi) {
30
+ if (!isPlainObject(sectionUi))
31
+ return [];
32
+ const defs = sectionUi.metadata
33
+ ?.sectionExposedProps;
34
+ return Array.isArray(defs) ? defs : [];
35
+ }
36
+ /** Indexes every node of a section's ui tree (through all slots) by uid. */
37
+ function indexSectionNodes(sectionUi) {
38
+ const byUid = new Map();
39
+ const walk = (node) => {
40
+ if (!isPlainObject(node))
41
+ return;
42
+ if (typeof node.uid === "string")
43
+ byUid.set(node.uid, node);
44
+ const slots = node.slots;
45
+ if (!isPlainObject(slots))
46
+ return;
47
+ for (const children of Object.values(slots)) {
48
+ if (Array.isArray(children))
49
+ children.forEach(walk);
50
+ }
51
+ };
52
+ walk(sectionUi);
53
+ return byUid;
54
+ }
55
+ /**
56
+ * Is this exposed prop a Design prop? The inner component's registration is
57
+ * the truth: `propKey` registered with `design: true` on the component at
58
+ * `nodeUid`. Only when that registration can't be found (no node, no
59
+ * registry, component or prop not registered) does the entry's `design` flag
60
+ * decide — so a legacy entry written without the flag still counts as design.
61
+ */
62
+ function isExposedDesignProp(ep, innerNode, registry) {
63
+ let registered;
64
+ if (innerNode && registry) {
65
+ try {
66
+ registered = registry.getComponentByNode(innerNode, true)?.props?.[ep.propKey];
67
+ }
68
+ catch {
69
+ registered = undefined;
70
+ }
71
+ }
72
+ if (isPlainObject(registered))
73
+ return registered.design === true;
74
+ return ep.design === true;
75
+ }
76
+ /**
77
+ * Splits a section's exposed props into ordinary props (`propDefs`, which ride
78
+ * `section_exposed_overrides`) and design props (`designDefs`, which ride
79
+ * {@link SECTION_EXPOSED_STYLE_OVERRIDES_KEY}). One walk of the section ui.
80
+ */
81
+ function partitionSectionExposedProps(defs, sectionUi, registry) {
82
+ if (!defs.length)
83
+ return { propDefs: defs, designDefs: [] };
84
+ const nodes = indexSectionNodes(sectionUi);
85
+ const propDefs = [];
86
+ const designDefs = [];
87
+ for (const ep of defs) {
88
+ if (isExposedDesignProp(ep, nodes.get(ep.nodeUid), registry)) {
89
+ designDefs.push(ep);
90
+ }
91
+ else {
92
+ propDefs.push(ep);
93
+ }
94
+ }
95
+ return { propDefs, designDefs };
96
+ }
97
+ /** A placed section node (by node type, or by its registration's metadata). */
98
+ function isSectionCompositionNode(node, componentOptions) {
99
+ if (node?.type === "section-composition")
100
+ return true;
101
+ return (componentOptions?.metadata?.type ===
102
+ "section-composition");
103
+ }
104
+ /**
105
+ * A placed section's own styles as they may become classes: the `default`
106
+ * group only. Its other groups are exposed-design-prop values for the inner
107
+ * nodes and must never reach the wrapper as class props or DOM attributes.
108
+ */
109
+ function getSectionCompositionOwnStyles(styles) {
110
+ const own = styles?.[DEFAULT_STYLE_GROUP];
111
+ return own ? { [DEFAULT_STYLE_GROUP]: own } : {};
112
+ }
113
+ /**
114
+ * Snapshot of a placed section's non-`default` style groups' responsive
115
+ * styles (copied per breakpoint, so a later in-place binding resolution on the
116
+ * node can't change a value a memo already compared). `undefined` when none.
117
+ */
118
+ function getSectionExposedStyleGroups(styles) {
119
+ if (!isPlainObject(styles))
120
+ return undefined;
121
+ let out;
122
+ for (const [group, style] of Object.entries(styles)) {
123
+ if (group === DEFAULT_STYLE_GROUP)
124
+ continue;
125
+ const responsive = style
126
+ ?.responsiveStyles;
127
+ if (!isPlainObject(responsive))
128
+ continue;
129
+ const copy = {};
130
+ for (const [bp, decls] of Object.entries(responsive)) {
131
+ if (isPlainObject(decls))
132
+ copy[bp] = { ...decls };
133
+ }
134
+ out = out ?? {};
135
+ out[group] = copy;
136
+ }
137
+ return out;
138
+ }
139
+ const isEmptyCssValue = (v) => v === undefined || v === null || v === "";
140
+ /**
141
+ * Builds `{ [nodeUid]: { [propKey]: { [bp]: { [propKey]: value } } } }` from a
142
+ * placed section's style groups (keyed by exposed uid, as returned by
143
+ * {@link getSectionExposedStyleGroups}). Only design
144
+ * exposures count, and only the declaration under the exposure's real CSS key
145
+ * (`ep.propKey`) — anything else in the group (e.g. the legacy uid-keyed
146
+ * declaration) is ignored. A breakpoint whose value is empty/unresolved is
147
+ * left out, so it keeps the Section's own value.
148
+ */
149
+ function buildSectionExposedStyleOverrides(designDefs, placedGroups) {
150
+ if (!designDefs.length || !isPlainObject(placedGroups))
151
+ return null;
152
+ let overrides = null;
153
+ for (const ep of designDefs) {
154
+ const responsive = placedGroups[ep.uid];
155
+ if (!isPlainObject(responsive))
156
+ continue;
157
+ const perBreakpoint = {};
158
+ for (const [bp, decls] of Object.entries(responsive)) {
159
+ if (!isPlainObject(decls) || !(ep.propKey in decls))
160
+ continue;
161
+ const value = decls[ep.propKey];
162
+ if (isEmptyCssValue(value))
163
+ continue;
164
+ perBreakpoint[bp] = { [ep.propKey]: value };
165
+ }
166
+ if (!Object.keys(perBreakpoint).length)
167
+ continue;
168
+ overrides = overrides ?? {};
169
+ overrides[ep.nodeUid] = overrides[ep.nodeUid] ?? {};
170
+ overrides[ep.nodeUid][ep.propKey] = perBreakpoint;
171
+ }
172
+ return overrides;
173
+ }
174
+ /**
175
+ * Merges one inner node's exposed-design-prop overrides into a CLONE of its
176
+ * styles: per breakpoint, the placement's declarations replace the Section's
177
+ * at that breakpoint id; every other breakpoint keeps the Section's value. A
178
+ * group the Section never set is created. The input is never mutated (inner
179
+ * nodes are shared by every placement of the Section).
180
+ */
181
+ function applyExposedStyleOverrides(styles, overridesForNode) {
182
+ const base = (styles ?? {});
183
+ if (!overridesForNode || !Object.keys(overridesForNode).length)
184
+ return base;
185
+ const merged = { ...base };
186
+ for (const [propKey, perBreakpoint] of Object.entries(overridesForNode)) {
187
+ if (!isPlainObject(perBreakpoint))
188
+ continue;
189
+ const group = base[propKey];
190
+ merged[propKey] = {
191
+ ...(group ?? {}),
192
+ classes: group?.classes ?? [],
193
+ responsiveStyles: {
194
+ ...(group?.responsiveStyles ?? {}),
195
+ ...perBreakpoint,
196
+ },
197
+ };
198
+ }
199
+ return merged;
200
+ }
201
+ /** The style override map in scope, read from a data context's dataSources. */
202
+ function getSectionExposedStyleOverrides(dataSources) {
203
+ if (!isPlainObject(dataSources))
204
+ return undefined;
205
+ const map = dataSources[SECTION_EXPOSED_STYLE_OVERRIDES_KEY];
206
+ return isPlainObject(map) ? map : undefined;
207
+ }
208
+ /**
209
+ * The styles a renderer hands `handleNodeStyles` for a node:
210
+ * - a placed section → its `default` group only;
211
+ * - an inner node with exposed-design-prop overrides in scope → a merged clone;
212
+ * - anything else → its own styles, untouched.
213
+ */
214
+ function getNodeRenderStyles(node, dataSources, isSectionComposition = node.type === "section-composition") {
215
+ if (isSectionComposition)
216
+ return getSectionCompositionOwnStyles(node.styles);
217
+ const forNode = getSectionExposedStyleOverrides(dataSources)?.[node.uid];
218
+ return applyExposedStyleOverrides(node.styles, forNode);
219
+ }
220
+ /**
221
+ * Returns `dataSources` scoped to ONE placement's style overrides: `overrides`
222
+ * replaces whatever map was inherited (an enclosing section's map is never
223
+ * meant for this section's nodes), and `null` removes it. Returns the input
224
+ * unchanged when there is nothing to add or remove.
225
+ */
226
+ function withSectionExposedStyleOverrides(dataSources, overrides) {
227
+ const hasInherited = isPlainObject(dataSources) &&
228
+ SECTION_EXPOSED_STYLE_OVERRIDES_KEY in dataSources;
229
+ if (overrides && Object.keys(overrides).length) {
230
+ if (hasInherited &&
231
+ dataSources[SECTION_EXPOSED_STYLE_OVERRIDES_KEY] === overrides) {
232
+ return dataSources;
233
+ }
234
+ return { ...dataSources, [SECTION_EXPOSED_STYLE_OVERRIDES_KEY]: overrides };
235
+ }
236
+ if (!hasInherited)
237
+ return dataSources;
238
+ const { [SECTION_EXPOSED_STYLE_OVERRIDES_KEY]: _dropped, ...rest } = dataSources;
239
+ return rest;
240
+ }
241
+
242
+ export { SECTION_EXPOSED_STYLES_PROP, SECTION_EXPOSED_STYLE_OVERRIDES_KEY, applyExposedStyleOverrides, buildSectionExposedStyleOverrides, getNodeRenderStyles, getSectionCompositionOwnStyles, getSectionExposedPropDefinitions, getSectionExposedStyleGroups, getSectionExposedStyleOverrides, indexSectionNodes, isExposedDesignProp, isSectionCompositionNode, partitionSectionExposedProps, withSectionExposedStyleOverrides };
243
+ //# sourceMappingURL=section-exposed-design-props.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"section-exposed-design-props.js","sources":["../../../src/data-binder/section-exposed-design-props.ts"],"sourcesContent":[null],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;AAeG;AAEH;AACO,MAAM,mCAAmC,GAC9C;AAEF;;;;;AAKG;AACI,MAAM,2BAA2B,GAAG;AAwC3C,MAAM,mBAAmB,GAAG,SAAS;AAErC,MAAM,aAAa,GAAG,CAAC,CAAU,KAC/B,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;AAEnD;AACM,SAAU,gCAAgC,CAC9C,SAAkB,EAAA;AAElB,IAAA,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC;AAAE,QAAA,OAAO,EAAE;AACxC,IAAA,MAAM,IAAI,GAAI,SAAS,CAAC;AACtB,UAAE,mBAAmB;AACvB,IAAA,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAI,IAAuC,GAAG,EAAE;AAC5E;AAEA;AACM,SAAU,iBAAiB,CAAC,SAAkB,EAAA;AAClD,IAAA,MAAM,KAAK,GAAG,IAAI,GAAG,EAAgB;AACrC,IAAA,MAAM,IAAI,GAAG,CAAC,IAAa,KAAI;AAC7B,QAAA,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;YAAE;AAC1B,QAAA,IAAI,OAAO,IAAI,CAAC,GAAG,KAAK,QAAQ;YAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,IAAa,CAAC;AACpE,QAAA,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK;AACxB,QAAA,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC;YAAE;QAC3B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE;AAC3C,YAAA,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;AAAE,gBAAA,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;QACrD;AACF,IAAA,CAAC;IACD,IAAI,CAAC,SAAS,CAAC;AACf,IAAA,OAAO,KAAK;AACd;AAEA;;;;;;AAMG;SACa,mBAAmB,CACjC,EAAgC,EAChC,SAA2B,EAC3B,QAA6C,EAAA;AAE7C,IAAA,IAAI,UAAmB;AACvB,IAAA,IAAI,SAAS,IAAI,QAAQ,EAAE;AACzB,QAAA,IAAI;AACF,YAAA,UAAU,GAAG,QAAQ,CAAC,kBAAkB,CAAC,SAAS,EAAE,IAAI,CAAC,EAAE,KAAK,GAC9D,EAAE,CAAC,OAAO,CACX;QACH;AAAE,QAAA,MAAM;YACN,UAAU,GAAG,SAAS;QACxB;IACF;IACA,IAAI,aAAa,CAAC,UAAU,CAAC;AAAE,QAAA,OAAO,UAAU,CAAC,MAAM,KAAK,IAAI;AAChE,IAAA,OAAO,EAAE,CAAC,MAAM,KAAK,IAAI;AAC3B;AAEA;;;;AAIG;SACa,4BAA4B,CAG1C,IAAS,EACT,SAAkB,EAClB,QAA6C,EAAA;IAE7C,IAAI,CAAC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE;AAC3D,IAAA,MAAM,KAAK,GAAG,iBAAiB,CAAC,SAAS,CAAC;IAC1C,MAAM,QAAQ,GAAQ,EAAE;IACxB,MAAM,UAAU,GAAQ,EAAE;AAC1B,IAAA,KAAK,MAAM,EAAE,IAAI,IAAI,EAAE;AACrB,QAAA,IAAI,mBAAmB,CAAC,EAAE,EAAE,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,EAAE;AAC5D,YAAA,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACrB;aAAO;AACL,YAAA,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACnB;IACF;AACA,IAAA,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE;AACjC;AAEA;AACM,SAAU,wBAAwB,CACtC,IAAoC,EACpC,gBAA6E,EAAA;AAE7E,IAAA,IAAI,IAAI,EAAE,IAAI,KAAK,qBAAqB;AAAE,QAAA,OAAO,IAAI;AACrD,IAAA,QACG,gBAAgB,EAAE,QAA0C,EAAE,IAAI;AACnE,QAAA,qBAAqB;AAEzB;AAEA;;;;AAIG;AACG,SAAU,8BAA8B,CAC5C,MAA8B,EAAA;AAE9B,IAAA,MAAM,GAAG,GAAG,MAAM,GAAG,mBAAmB,CAAC;AACzC,IAAA,OAAO,GAAG,GAAG,EAAE,CAAC,mBAAmB,GAAG,GAAG,EAAE,GAAG,EAAE;AAClD;AAEA;;;;AAIG;AACG,SAAU,4BAA4B,CAC1C,MAA8B,EAAA;AAE9B,IAAA,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC;AAAE,QAAA,OAAO,SAAS;AAC5C,IAAA,IAAI,GAAwD;AAC5D,IAAA,KAAK,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QACnD,IAAI,KAAK,KAAK,mBAAmB;YAAE;QACnC,MAAM,UAAU,GAAI;AAClB,cAAE,gBAAgB;AACpB,QAAA,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;YAAE;QAChC,MAAM,IAAI,GAA4B,EAAE;AACxC,QAAA,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACpD,IAAI,aAAa,CAAC,KAAK,CAAC;gBAAE,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,EAAE;QACnD;AACA,QAAA,GAAG,GAAG,GAAG,IAAI,EAAE;AACf,QAAA,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI;IACnB;AACA,IAAA,OAAO,GAAG;AACZ;AAEA,MAAM,eAAe,GAAG,CAAC,CAAU,KACjC,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE;AAE3C;;;;;;;;AAQG;AACG,SAAU,iCAAiC,CAC/C,UAA0C,EAC1C,YAAwE,EAAA;IAExE,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC;AAAE,QAAA,OAAO,IAAI;IACnE,IAAI,SAAS,GAAwC,IAAI;AACzD,IAAA,KAAK,MAAM,EAAE,IAAI,UAAU,EAAE;QAC3B,MAAM,UAAU,GAAG,YAAY,CAAC,EAAE,CAAC,GAAG,CAAC;AACvC,QAAA,IAAI,CAAC,aAAa,CAAC,UAAU,CAAC;YAAE;QAChC,MAAM,aAAa,GAA4B,EAAE;AACjD,QAAA,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;AACpD,YAAA,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,CAAC;gBAAE;YACrD,MAAM,KAAK,GAAG,KAAK,CAAC,EAAE,CAAC,OAAO,CAAC;YAC/B,IAAI,eAAe,CAAC,KAAK,CAAC;gBAAE;AAC5B,YAAA,aAAa,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,OAAO,GAAG,KAAK,EAAE;QAC7C;QACA,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,MAAM;YAAE;AACxC,QAAA,SAAS,GAAG,SAAS,IAAI,EAAE;AAC3B,QAAA,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE;AACnD,QAAA,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,GAAG,aAAa;IACnD;AACA,IAAA,OAAO,SAAS;AAClB;AAEA;;;;;;AAMG;AACG,SAAU,0BAA0B,CACxC,MAA8B,EAC9B,gBAAqE,EAAA;AAErE,IAAA,MAAM,IAAI,IAAI,MAAM,IAAI,EAAE,CAAe;IACzC,IAAI,CAAC,gBAAgB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM;AAAE,QAAA,OAAO,IAAI;AAC3E,IAAA,MAAM,MAAM,GAAe,EAAE,GAAG,IAAI,EAAE;AACtC,IAAA,KAAK,MAAM,CAAC,OAAO,EAAE,aAAa,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,EAAE;AACvE,QAAA,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC;YAAE;AACnC,QAAA,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC;QAC3B,MAAM,CAAC,OAAO,CAAC,GAAG;AAChB,YAAA,IAAI,KAAK,IAAI,EAAE,CAAC;AAChB,YAAA,OAAO,EAAE,KAAK,EAAE,OAAO,IAAI,EAAE;AAC7B,YAAA,gBAAgB,EAAE;AAChB,gBAAA,IAAI,KAAK,EAAE,gBAAgB,IAAI,EAAE,CAAC;AAClC,gBAAA,GAAI,aAAwD;AAC7D,aAAA;SACF;IACH;AACA,IAAA,OAAO,MAAM;AACf;AAEA;AACM,SAAU,+BAA+B,CAC7C,WAAoB,EAAA;AAEpB,IAAA,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC;AAAE,QAAA,OAAO,SAAS;AACjD,IAAA,MAAM,GAAG,GAAG,WAAW,CAAC,mCAAmC,CAAC;AAC5D,IAAA,OAAO,aAAa,CAAC,GAAG,CAAC,GAAI,GAAoC,GAAG,SAAS;AAC/E;AAEA;;;;;AAKG;AACG,SAAU,mBAAmB,CACjC,IAA2C,EAC3C,WAAoB,EACpB,oBAAoB,GAAG,IAAI,CAAC,IAAI,KAAK,qBAAqB,EAAA;AAE1D,IAAA,IAAI,oBAAoB;AAAE,QAAA,OAAO,8BAA8B,CAAC,IAAI,CAAC,MAAM,CAAC;AAC5E,IAAA,MAAM,OAAO,GAAG,+BAA+B,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;IACxE,OAAO,0BAA0B,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,CAAC;AACzD;AAEA;;;;;AAKG;AACG,SAAU,gCAAgC,CAC9C,WAAc,EACd,SAA0D,EAAA;AAE1D,IAAA,MAAM,YAAY,GAChB,aAAa,CAAC,WAAW,CAAC;QAC1B,mCAAmC,IAAI,WAAW;IACpD,IAAI,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,EAAE;AAC9C,QAAA,IACE,YAAY;AACX,YAAA,WAAuC,CACtC,mCAAmC,CACpC,KAAK,SAAS,EACf;AACA,YAAA,OAAO,WAAW;QACpB;QACA,OAAO,EAAE,GAAG,WAAW,EAAE,CAAC,mCAAmC,GAAG,SAAS,EAAE;IAC7E;AACA,IAAA,IAAI,CAAC,YAAY;AAAE,QAAA,OAAO,WAAW;AACrC,IAAA,MAAM,EAAE,CAAC,mCAAmC,GAAG,QAAQ,EAAE,GAAG,IAAI,EAAE,GAChE,WAAsC;AACxC,IAAA,OAAO,IAAS;AAClB;;;;"}
@@ -62,6 +62,55 @@ function collectStateBindingKeys(node) {
62
62
  }
63
63
  return [...keys];
64
64
  }
65
+ /**
66
+ * The keys a node binds as Studio state (`source: "state"`, written when the
67
+ * author picks a State Variable) that are not declared in this process yet.
68
+ * Only tagged bindings count: an untagged `component_props` key may as well be
69
+ * a function the app registers later, or plain data.
70
+ */
71
+ function getUndeclaredStateBindingKeys(node) {
72
+ if (!node)
73
+ return [];
74
+ const store = getStateStoreInstance();
75
+ const keys = new Set();
76
+ const consider = (binding) => {
77
+ if (binding?.source !== "state")
78
+ return;
79
+ const key = getComponentPropsBindingKey(binding);
80
+ if (key && !declaredKeyForPath(store, key))
81
+ keys.add(key);
82
+ };
83
+ for (const binding of Object.values(node.metadata?.bindings ?? {})) {
84
+ consider(binding);
85
+ }
86
+ for (const prop of Object.values(node.props ?? {})) {
87
+ consider(prop?.binding);
88
+ }
89
+ return [...keys];
90
+ }
91
+ /** Keys already reported by {@link warnUndeclaredStateBindings}. */
92
+ const reportedUndeclaredStateKeys = new Set();
93
+ /**
94
+ * Development aid, for server renders: warns once per key when a node bound to
95
+ * a Studio state variable renders before the app declared that variable. The
96
+ * server then renders the binding's fallback, and when the browser declares
97
+ * the variable before hydrating, hydration finds the declared default instead
98
+ * and reports a mismatch. Fix: declare state where every render sees it first
99
+ * — `registerGlobalStateVariables` in a module the layout imports.
100
+ */
101
+ function warnUndeclaredStateBindings(node) {
102
+ if (typeof process !== "undefined" && process.env?.NODE_ENV === "production")
103
+ return;
104
+ for (const key of getUndeclaredStateBindingKeys(node)) {
105
+ if (reportedUndeclaredStateKeys.has(key))
106
+ continue;
107
+ reportedUndeclaredStateKeys.add(key);
108
+ console.warn(`[Contentstack Studio] "${key}" is bound as a Studio state variable but ` +
109
+ `was not declared when this page rendered on the server, so it rendered ` +
110
+ `its fallback and hydration may not match. Declare it before rendering, ` +
111
+ `e.g. registerGlobalStateVariables() in a module your layout imports.`);
112
+ }
113
+ }
65
114
  /**
66
115
  * Snapshot of the given declared state keys — `{ key: currentValue }` —
67
116
  * merged by the renderer into `data.component_props` before prop resolution
@@ -154,5 +203,5 @@ function getNodeBoundFunctionName(node) {
154
203
  return undefined;
155
204
  }
156
205
 
157
- export { collectStateBindingKeys, getNodeBoundFunctionName, getStateDefaultsFor, getStateValuesFor };
206
+ export { collectStateBindingKeys, getNodeBoundFunctionName, getStateDefaultsFor, getStateValuesFor, getUndeclaredStateBindingKeys, warnUndeclaredStateBindings };
158
207
  //# sourceMappingURL=state-binding.util.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"state-binding.util.js","sources":["../../../src/data-binder/state-binding.util.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAKA;;;;;;;;;;;AAWG;AACH;;;;;AAKG;AACH,SAAS,kBAAkB,CACzB,KAA+C,EAC/C,IAAY,EAAA;AAEZ,IAAA,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;AAAE,QAAA,OAAO,IAAI;IACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;AAChC,IAAA,KAAK,IAAI,GAAG,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE;AACnD,QAAA,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AAC/C,QAAA,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC;AAAE,YAAA,OAAO,MAAM;IAC7C;AACA,IAAA,OAAO,SAAS;AAClB;AAEM,SAAU,uBAAuB,CACrC,IAKQ,EAAA;AAER,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,OAAO,EAAE;AACpB,IAAA,MAAM,KAAK,GAAG,qBAAqB,EAAE;AACrC,IAAA,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU;AAE9B,IAAA,MAAM,QAAQ,GAAG,CAAC,OAAgB,KAAI;AACpC,QAAA,MAAM,GAAG,GAAG,2BAA2B,CAAC,OAAO,CAAC;AAChD,QAAA,IAAI,CAAC,GAAG;YAAE;;;;;;;QAOV,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,EAAE,GAAG,CAAC;AAC/C,QAAA,IAAI,QAAQ;AAAE,YAAA,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;AAClC,IAAA,CAAC;;;;;AAMD,IAAA,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE;QAClE,QAAQ,CAAC,OAAO,CAAC;IACnB;AACA,IAAA,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE;AAClD,QAAA,QAAQ,CAAE,IAA8B,EAAE,OAAO,CAAC;IACpD;AAEA,IAAA,OAAO,CAAC,GAAG,IAAI,CAAC;AAClB;AAEA;;;;;;;;;AASG;AACG,SAAU,iBAAiB,CAC/B,IAAuB,EAAA;AAEvB,IAAA,MAAM,KAAK,GAAG,qBAAqB,EAAE;IACrC,MAAM,GAAG,GAA4B,EAAE;AACvC,IAAA,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS;AAAE,YAAA,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK;IAC3C;AACA,IAAA,OAAO,GAAG;AACZ;AAEA;;;;;;AAMG;AACG,SAAU,mBAAmB,CACjC,IAAuB,EAAA;AAEvB,IAAA,MAAM,KAAK,GAAG,qBAAqB,EAAE;IACrC,MAAM,GAAG,GAA4B,EAAE;AACvC,IAAA,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,MAAM,KAAK,GAAG,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC;QAC3C,IAAI,KAAK,KAAK,SAAS;AAAE,YAAA,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK;IAC3C;AACA,IAAA,OAAO,GAAG;AACZ;AAEA;;;;;AAKG;AACH,SAAS,2BAA2B,CAAC,OAAgB,EAAA;IACnD,MAAM,CAAC,GAAG,OAAyD;IACnE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,eAAe;AAAE,QAAA,OAAO,SAAS;AACnE,IAAA,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;AAAE,QAAA,OAAO,CAAC,CAAC,KAAK,IAAI,SAAS;AAC5D,IAAA,MAAM,IAAI,GAAI,CAAC,CAAC;AACd,UAAE,IAAI;AACR,IAAA,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACpC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,OAAO,KAAK,IAAI,SAAS;IAC3B;AACA,IAAA,OAAO,SAAS;AAClB;AAEA;;;;;;;;;;;;;;AAcG;AACG,SAAU,wBAAwB,CACtC,IAKQ,EAAA;AAER,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,OAAO,SAAS;AAC3B,IAAA,MAAM,UAAU,GAAG,sBAAsB,EAAE;AAC3C,IAAA,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;AAAE,QAAA,OAAO,SAAS;AAC7C,IAAA,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC;AAEjC,IAAA,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE;AAClE,QAAA,MAAM,GAAG,GAAG,2BAA2B,CAAC,OAAO,CAAC;AAChD,QAAA,IAAI,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AAAE,YAAA,OAAO,GAAG;IACvC;AACA,IAAA,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE;QAClD,MAAM,GAAG,GAAG,2BAA2B,CACpC,IAA8B,EAAE,OAAO,CACzC;AACD,QAAA,IAAI,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AAAE,YAAA,OAAO,GAAG;IACvC;AACA,IAAA,OAAO,SAAS;AAClB;;;;"}
1
+ {"version":3,"file":"state-binding.util.js","sources":["../../../src/data-binder/state-binding.util.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAKA;;;;;;;;;;;AAWG;AACH;;;;;AAKG;AACH,SAAS,kBAAkB,CACzB,KAA+C,EAC/C,IAAY,EAAA;AAEZ,IAAA,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC;AAAE,QAAA,OAAO,IAAI;IACvC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC;AAChC,IAAA,KAAK,IAAI,GAAG,GAAG,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,GAAG,EAAE,EAAE;AACnD,QAAA,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;AAC/C,QAAA,IAAI,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC;AAAE,YAAA,OAAO,MAAM;IAC7C;AACA,IAAA,OAAO,SAAS;AAClB;AAEM,SAAU,uBAAuB,CACrC,IAKQ,EAAA;AAER,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,OAAO,EAAE;AACpB,IAAA,MAAM,KAAK,GAAG,qBAAqB,EAAE;AACrC,IAAA,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU;AAE9B,IAAA,MAAM,QAAQ,GAAG,CAAC,OAAgB,KAAI;AACpC,QAAA,MAAM,GAAG,GAAG,2BAA2B,CAAC,OAAO,CAAC;AAChD,QAAA,IAAI,CAAC,GAAG;YAAE;;;;;;;QAOV,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,EAAE,GAAG,CAAC;AAC/C,QAAA,IAAI,QAAQ;AAAE,YAAA,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC;AAClC,IAAA,CAAC;;;;;AAMD,IAAA,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE;QAClE,QAAQ,CAAC,OAAO,CAAC;IACnB;AACA,IAAA,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE;AAClD,QAAA,QAAQ,CAAE,IAA8B,EAAE,OAAO,CAAC;IACpD;AAEA,IAAA,OAAO,CAAC,GAAG,IAAI,CAAC;AAClB;AAEA;;;;;AAKG;AACG,SAAU,6BAA6B,CAC3C,IAKQ,EAAA;AAER,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,OAAO,EAAE;AACpB,IAAA,MAAM,KAAK,GAAG,qBAAqB,EAAE;AACrC,IAAA,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU;AAC9B,IAAA,MAAM,QAAQ,GAAG,CAAC,OAAgB,KAAI;AACpC,QAAA,IAAK,OAA4C,EAAE,MAAM,KAAK,OAAO;YACnE;AACF,QAAA,MAAM,GAAG,GAAG,2BAA2B,CAAC,OAAO,CAAC;QAChD,IAAI,GAAG,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,GAAG,CAAC;AAAE,YAAA,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;AAC3D,IAAA,CAAC;AACD,IAAA,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE;QAClE,QAAQ,CAAC,OAAO,CAAC;IACnB;AACA,IAAA,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE;AAClD,QAAA,QAAQ,CAAE,IAA8B,EAAE,OAAO,CAAC;IACpD;AACA,IAAA,OAAO,CAAC,GAAG,IAAI,CAAC;AAClB;AAEA;AACA,MAAM,2BAA2B,GAAG,IAAI,GAAG,EAAU;AAErD;;;;;;;AAOG;AACG,SAAU,2BAA2B,CACzC,IAAyD,EAAA;IAEzD,IAAI,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE,QAAQ,KAAK,YAAY;QAC1E;IACF,KAAK,MAAM,GAAG,IAAI,6BAA6B,CAAC,IAAI,CAAC,EAAE;AACrD,QAAA,IAAI,2BAA2B,CAAC,GAAG,CAAC,GAAG,CAAC;YAAE;AAC1C,QAAA,2BAA2B,CAAC,GAAG,CAAC,GAAG,CAAC;AACpC,QAAA,OAAO,CAAC,IAAI,CACV,CAAA,uBAAA,EAA0B,GAAG,CAAA,0CAAA,CAA4C;YACvE,CAAA,uEAAA,CAAyE;YACzE,CAAA,uEAAA,CAAyE;AACzE,YAAA,CAAA,oEAAA,CAAsE,CACzE;IACH;AACF;AAEA;;;;;;;;;AASG;AACG,SAAU,iBAAiB,CAC/B,IAAuB,EAAA;AAEvB,IAAA,MAAM,KAAK,GAAG,qBAAqB,EAAE;IACrC,MAAM,GAAG,GAA4B,EAAE;AACvC,IAAA,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS;AAAE,YAAA,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK;IAC3C;AACA,IAAA,OAAO,GAAG;AACZ;AAEA;;;;;;AAMG;AACG,SAAU,mBAAmB,CACjC,IAAuB,EAAA;AAEvB,IAAA,MAAM,KAAK,GAAG,qBAAqB,EAAE;IACrC,MAAM,GAAG,GAA4B,EAAE;AACvC,IAAA,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACtB,MAAM,KAAK,GAAG,KAAK,CAAC,kBAAkB,CAAC,GAAG,CAAC;QAC3C,IAAI,KAAK,KAAK,SAAS;AAAE,YAAA,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK;IAC3C;AACA,IAAA,OAAO,GAAG;AACZ;AAEA;;;;;AAKG;AACH,SAAS,2BAA2B,CAAC,OAAgB,EAAA;IACnD,MAAM,CAAC,GAAG,OAAyD;IACnE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,eAAe;AAAE,QAAA,OAAO,SAAS;AACnE,IAAA,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ;AAAE,QAAA,OAAO,CAAC,CAAC,KAAK,IAAI,SAAS;AAC5D,IAAA,MAAM,IAAI,GAAI,CAAC,CAAC;AACd,UAAE,IAAI;AACR,IAAA,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QACpC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,OAAO,KAAK,IAAI,SAAS;IAC3B;AACA,IAAA,OAAO,SAAS;AAClB;AAEA;;;;;;;;;;;;;;AAcG;AACG,SAAU,wBAAwB,CACtC,IAKQ,EAAA;AAER,IAAA,IAAI,CAAC,IAAI;AAAE,QAAA,OAAO,SAAS;AAC3B,IAAA,MAAM,UAAU,GAAG,sBAAsB,EAAE;AAC3C,IAAA,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;AAAE,QAAA,OAAO,SAAS;AAC7C,IAAA,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC;AAEjC,IAAA,KAAK,MAAM,OAAO,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,IAAI,EAAE,CAAC,EAAE;AAClE,QAAA,MAAM,GAAG,GAAG,2BAA2B,CAAC,OAAO,CAAC;AAChD,QAAA,IAAI,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AAAE,YAAA,OAAO,GAAG;IACvC;AACA,IAAA,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE;QAClD,MAAM,GAAG,GAAG,2BAA2B,CACpC,IAA8B,EAAE,OAAO,CACzC;AACD,QAAA,IAAI,GAAG,IAAI,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC;AAAE,YAAA,OAAO,GAAG;IACvC;AACA,IAAA,OAAO,SAAS;AAClB;;;;"}
@@ -7,6 +7,7 @@ class DesignRegistry {
7
7
  classes = {};
8
8
  tokens;
9
9
  cssVariables;
10
+ tokenOrigins;
10
11
  options = {
11
12
  tokenOptions: getDefaultDesignTokensOptions(),
12
13
  };
@@ -18,18 +19,25 @@ class DesignRegistry {
18
19
  this.tokens = processedDesignTokens;
19
20
  this.cssVariables = cssVariablesValues;
20
21
  this.cssVariablesToDesignTokens = cssVariablesToDesignTokens;
22
+ this.tokenOrigins = Object.fromEntries(Object.keys(cssVariablesValues).map((cssVariable) => [
23
+ cssVariable,
24
+ "default",
25
+ ]));
21
26
  }
22
27
  registerDesignTokens(tokens, options = {}) {
23
28
  const csDesignTokens = processDesignToken(DEFAULT_DESIGN_TOKENS);
24
29
  const userDesignTokens = processDesignToken(tokens);
25
30
  const config = processDesignTokensOptions(options);
26
31
  this.options.tokenOptions = config;
32
+ // Read before the merge below, which writes into csDesignTokens.
33
+ const origins = tokenOriginSources(config.allowDefaultDesignTokens ? csDesignTokens : undefined, userDesignTokens);
27
34
  const { processedDesignTokens, cssVariablesValues, cssVariablesToDesignTokens, } = designTokensToCssVariables(this.options.tokenOptions.allowDefaultDesignTokens // Explicitly check for true
28
35
  ? merge(csDesignTokens, userDesignTokens)
29
36
  : userDesignTokens);
30
37
  this.tokens = processedDesignTokens;
31
38
  this.cssVariables = cssVariablesValues;
32
39
  this.cssVariablesToDesignTokens = cssVariablesToDesignTokens;
40
+ this.tokenOrigins = getTokenOrigins(cssVariablesValues, origins);
33
41
  }
34
42
  getDesignTokens() {
35
43
  return this.tokens;
@@ -43,15 +51,26 @@ class DesignRegistry {
43
51
  getCssVariablesToDesignTokens() {
44
52
  return this.cssVariablesToDesignTokens;
45
53
  }
54
+ /** Where each registered token comes from; see {@link CssVariablesToOrigin}. */
55
+ getDesignTokenOrigins() {
56
+ return this.tokenOrigins;
57
+ }
46
58
  /**
47
59
  * If the design tokens are already processed, we can use this method to update the design tokens
48
60
  * without processing them again.
49
61
  * @param tokens The processed design tokens
62
+ * @param cssVariables The token values. Without them the registry keeps
63
+ * answering {@link getDesignTokenCssVariables} with the defaults' values.
64
+ * @param tokenOrigins Where each token comes from, when the sender knows.
50
65
  */
51
- updateDesignTokens(tokens, cssVariablesToDesignTokens, options) {
66
+ updateDesignTokens(tokens, cssVariablesToDesignTokens, options, cssVariables, tokenOrigins) {
52
67
  this.tokens = tokens;
53
68
  this.options.tokenOptions = options;
54
69
  this.cssVariablesToDesignTokens = cssVariablesToDesignTokens;
70
+ if (cssVariables)
71
+ this.cssVariables = cssVariables;
72
+ if (tokenOrigins)
73
+ this.tokenOrigins = tokenOrigins;
55
74
  }
56
75
  clearDesignTokens() {
57
76
  this.tokens = getDefaultDesignTokens();
@@ -90,6 +109,30 @@ class DesignRegistry {
90
109
  }, {});
91
110
  }
92
111
  }
112
+ /**
113
+ * The CSS variables the defaults and the app each define. A variable is
114
+ * derived from the token's path, so a token the app redefines has the same
115
+ * variable as the default it replaces.
116
+ */
117
+ function tokenOriginSources(defaultTokens, userTokens) {
118
+ return {
119
+ defaults: new Set(defaultTokens
120
+ ? Object.keys(designTokensToCssVariables(defaultTokens).cssVariablesValues)
121
+ : []),
122
+ own: new Set(Object.keys(designTokensToCssVariables(userTokens).cssVariablesValues)),
123
+ };
124
+ }
125
+ /** Marks each registered token by where it comes from. */
126
+ function getTokenOrigins(registered, { defaults, own }) {
127
+ return Object.fromEntries(Object.keys(registered).map((cssVariable) => [
128
+ cssVariable,
129
+ own.has(cssVariable)
130
+ ? defaults.has(cssVariable)
131
+ ? "overridden"
132
+ : "app"
133
+ : "default",
134
+ ]));
135
+ }
93
136
 
94
137
  export { DesignRegistry };
95
138
  //# sourceMappingURL=design-registry.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"design-registry.js","sources":["../../../src/design-registry/design-registry.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;MAyBa,cAAc,CAAA;IACjB,OAAO,GAAkC,EAAE;AAC3C,IAAA,MAAM;AACN,IAAA,YAAY;AACZ,IAAA,OAAO,GAA0C;QACvD,YAAY,EAAE,6BAA6B,EAAE;KAC9C;AACD,IAAA,0BAA0B;AAE1B,IAAA,WAAA,GAAA;;AAEE,QAAA,MAAM,cAAc,GAAG,kBAAkB,CAAC,qBAAqB,CAAC;AAChE,QAAA,MAAM,EACJ,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,GAC3B,GAAG,0BAA0B,CAAC,cAAc,CAAC;AAE9C,QAAA,IAAI,CAAC,MAAM,GAAG,qBAAqB;AACnC,QAAA,IAAI,CAAC,YAAY,GAAG,kBAAkB;AACtC,QAAA,IAAI,CAAC,0BAA0B,GAAG,0BAA0B;IAC9D;AAEA,IAAA,oBAAoB,CAClB,MAAyB,EACzB,OAAA,GAA6C,EAAE,EAAA;AAE/C,QAAA,MAAM,cAAc,GAAG,kBAAkB,CAAC,qBAAqB,CAAC;AAChE,QAAA,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,MAAM,CAAC;AACnD,QAAA,MAAM,MAAM,GAAG,0BAA0B,CAAC,OAAO,CAAC;AAClD,QAAA,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,MAAM;AAElC,QAAA,MAAM,EACJ,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,GAC3B,GAAG,0BAA0B,CAC5B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,wBAAwB;AAChD,cAAE,KAAK,CAAC,cAAc,EAAE,gBAAgB;cACtC,gBAAgB,CACrB;AAED,QAAA,IAAI,CAAC,MAAM,GAAG,qBAAqB;AACnC,QAAA,IAAI,CAAC,YAAY,GAAG,kBAAkB;AACtC,QAAA,IAAI,CAAC,0BAA0B,GAAG,0BAA0B;IAC9D;IAEA,eAAe,GAAA;QACb,OAAO,IAAI,CAAC,MAAM;IACpB;IAEA,qBAAqB,GAAA;AACnB,QAAA,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY;IAClC;IAEA,0BAA0B,GAAA;QACxB,OAAO,IAAI,CAAC,YAAY;IAC1B;IAEA,6BAA6B,GAAA;QAC3B,OAAO,IAAI,CAAC,0BAA0B;IACxC;AAEA;;;;AAIG;AACH,IAAA,kBAAkB,CAChB,MAAoB,EACpB,0BAAsD,EACtD,OAA4B,EAAA;AAE5B,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;AACpB,QAAA,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,OAAO;AACnC,QAAA,IAAI,CAAC,0BAA0B,GAAG,0BAA0B;IAC9D;IAEA,iBAAiB,GAAA;AACf,QAAA,IAAI,CAAC,MAAM,GAAG,sBAAsB,EAAE;IACxC;AAEA,IAAA,eAAe,CACb,OAAU,EAAA;AAEV,QAAA,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC;AACtD,QAAA,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,gBAAgB,EAAE;AAEvD,QAAA,OAAO,qBAAqB,CAAC,OAAO,CAAC;IACvC;IAEA,UAAU,GAAA;QACR,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;IACpC;AAEA,IAAA,QAAQ,CAAC,IAAY,EAAA;AACnB,QAAA,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B;AAEA,IAAA,QAAQ,CAAC,IAAY,EAAA;QACnB,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B;AAEA,IAAA,wBAAwB,CAAC,KAAa,EAAA;QACpC,MAAM,gBAAgB,GAAG,qBAAqB;AAC9C,QAAA,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;IACrC;AAEA,IAAA,kBAAkB,CAAC,KAAa,EAAA;QAC9B,MAAM,QAAQ,GAAG,QAAQ;AACzB,QAAA,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;IAC7B;AACA;;;;AAIG;AACH,IAAA,aAAa,CAAC,OAAwB,EAAA;AACpC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,WAAW,KAAI;AACjD,YAAA,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW;AACnC,YAAA,OAAO,GAAG;QACZ,CAAC,EAAE,EAAE,CAAC;IACR;AACD;;;;"}
1
+ {"version":3,"file":"design-registry.js","sources":["../../../src/design-registry/design-registry.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;;MA0Ba,cAAc,CAAA;IACjB,OAAO,GAAkC,EAAE;AAC3C,IAAA,MAAM;AACN,IAAA,YAAY;AACZ,IAAA,YAAY;AACZ,IAAA,OAAO,GAA0C;QACvD,YAAY,EAAE,6BAA6B,EAAE;KAC9C;AACD,IAAA,0BAA0B;AAE1B,IAAA,WAAA,GAAA;;AAEE,QAAA,MAAM,cAAc,GAAG,kBAAkB,CAAC,qBAAqB,CAAC;AAChE,QAAA,MAAM,EACJ,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,GAC3B,GAAG,0BAA0B,CAAC,cAAc,CAAC;AAE9C,QAAA,IAAI,CAAC,MAAM,GAAG,qBAAqB;AACnC,QAAA,IAAI,CAAC,YAAY,GAAG,kBAAkB;AACtC,QAAA,IAAI,CAAC,0BAA0B,GAAG,0BAA0B;QAC5D,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,WAAW,CACpC,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,KAAK;YACnD,WAAW;YACX,SAAS;AACV,SAAA,CAAC,CACH;IACH;AAEA,IAAA,oBAAoB,CAClB,MAAyB,EACzB,OAAA,GAA6C,EAAE,EAAA;AAE/C,QAAA,MAAM,cAAc,GAAG,kBAAkB,CAAC,qBAAqB,CAAC;AAChE,QAAA,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,MAAM,CAAC;AACnD,QAAA,MAAM,MAAM,GAAG,0BAA0B,CAAC,OAAO,CAAC;AAClD,QAAA,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,MAAM;;AAElC,QAAA,MAAM,OAAO,GAAG,kBAAkB,CAChC,MAAM,CAAC,wBAAwB,GAAG,cAAc,GAAG,SAAS,EAC5D,gBAAgB,CACjB;AAED,QAAA,MAAM,EACJ,qBAAqB,EACrB,kBAAkB,EAClB,0BAA0B,GAC3B,GAAG,0BAA0B,CAC5B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,wBAAwB;AAChD,cAAE,KAAK,CAAC,cAAc,EAAE,gBAAgB;cACtC,gBAAgB,CACrB;AAED,QAAA,IAAI,CAAC,MAAM,GAAG,qBAAqB;AACnC,QAAA,IAAI,CAAC,YAAY,GAAG,kBAAkB;AACtC,QAAA,IAAI,CAAC,0BAA0B,GAAG,0BAA0B;QAC5D,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,kBAAkB,EAAE,OAAO,CAAC;IAClE;IAEA,eAAe,GAAA;QACb,OAAO,IAAI,CAAC,MAAM;IACpB;IAEA,qBAAqB,GAAA;AACnB,QAAA,OAAO,IAAI,CAAC,OAAO,CAAC,YAAY;IAClC;IAEA,0BAA0B,GAAA;QACxB,OAAO,IAAI,CAAC,YAAY;IAC1B;IAEA,6BAA6B,GAAA;QAC3B,OAAO,IAAI,CAAC,0BAA0B;IACxC;;IAGA,qBAAqB,GAAA;QACnB,OAAO,IAAI,CAAC,YAAY;IAC1B;AAEA;;;;;;;AAOG;IACH,kBAAkB,CAChB,MAAoB,EACpB,0BAAsD,EACtD,OAA4B,EAC5B,YAAkC,EAClC,YAAmC,EAAA;AAEnC,QAAA,IAAI,CAAC,MAAM,GAAG,MAAM;AACpB,QAAA,IAAI,CAAC,OAAO,CAAC,YAAY,GAAG,OAAO;AACnC,QAAA,IAAI,CAAC,0BAA0B,GAAG,0BAA0B;AAC5D,QAAA,IAAI,YAAY;AAAE,YAAA,IAAI,CAAC,YAAY,GAAG,YAAY;AAClD,QAAA,IAAI,YAAY;AAAE,YAAA,IAAI,CAAC,YAAY,GAAG,YAAY;IACpD;IAEA,iBAAiB,GAAA;AACf,QAAA,IAAI,CAAC,MAAM,GAAG,sBAAsB,EAAE;IACxC;AAEA,IAAA,eAAe,CACb,OAAU,EAAA;AAEV,QAAA,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,OAAO,CAAC;AACtD,QAAA,IAAI,CAAC,OAAO,GAAG,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,GAAG,gBAAgB,EAAE;AAEvD,QAAA,OAAO,qBAAqB,CAAC,OAAO,CAAC;IACvC;IAEA,UAAU,GAAA;QACR,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;IACpC;AAEA,IAAA,QAAQ,CAAC,IAAY,EAAA;AACnB,QAAA,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3B;AAEA,IAAA,QAAQ,CAAC,IAAY,EAAA;QACnB,OAAO,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;IAC7B;AAEA,IAAA,wBAAwB,CAAC,KAAa,EAAA;QACpC,MAAM,gBAAgB,GAAG,qBAAqB;AAC9C,QAAA,OAAO,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC;IACrC;AAEA,IAAA,kBAAkB,CAAC,KAAa,EAAA;QAC9B,MAAM,QAAQ,GAAG,QAAQ;AACzB,QAAA,OAAO,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC;IAC7B;AACA;;;;AAIG;AACH,IAAA,aAAa,CAAC,OAAwB,EAAA;AACpC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,WAAW,KAAI;AACjD,YAAA,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW;AACnC,YAAA,OAAO,GAAG;QACZ,CAAC,EAAE,EAAE,CAAC;IACR;AACD;AAED;;;;AAIG;AACH,SAAS,kBAAkB,CACzB,aAA2E,EAC3E,UAA4D,EAAA;IAE5D,OAAO;AACL,QAAA,QAAQ,EAAE,IAAI,GAAG,CACf;cACI,MAAM,CAAC,IAAI,CACT,0BAA0B,CAAC,aAAa,CAAC,CAAC,kBAAkB;cAE9D,EAAE,CACP;AACD,QAAA,GAAG,EAAE,IAAI,GAAG,CACV,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC,kBAAkB,CAAC,CACvE;KACF;AACH;AAEA;AACA,SAAS,eAAe,CACtB,UAA+B,EAC/B,EAAE,QAAQ,EAAE,GAAG,EAAyC,EAAA;AAExD,IAAA,OAAO,MAAM,CAAC,WAAW,CACvB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,WAAW,KAAK;QAC3C,WAAW;AACX,QAAA,GAAG,CAAC,GAAG,CAAC,WAAW;AACjB,cAAE,QAAQ,CAAC,GAAG,CAAC,WAAW;AACxB,kBAAE;AACF,kBAAE;AACJ,cAAE,SAAS;AACd,KAAA,CAAC,CACH;AACH;;;;"}