@contentful/experiences-design 0.6.1 → 0.7.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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,19 @@
1
+ ## 0.7.1 (2026-08-07)
2
+
3
+ ### 🚀 Features
4
+
5
+ - server-side design pre-resolution against a fallback viewport [AIS-386] ([#119](https://github.com/contentful/experiences/pull/119))
6
+
7
+ ### 🧱 Updated Dependencies
8
+
9
+ - Updated core to 0.7.1
10
+
11
+ ## 0.7.0 (2026-08-07)
12
+
13
+ ### 🧱 Updated Dependencies
14
+
15
+ - Updated core to 0.7.0
16
+
1
17
  ## 0.6.1 (2026-08-06)
2
18
 
3
19
  ### 🧱 Updated Dependencies
package/dist/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- export { applyTokenResolver, getValueForViewport, getViewportIndex, resolveDesignProperties, toCssMediaQuery } from './viewport.js';
1
+ export { toCssMediaQuery } from './viewport.js';
2
2
  export { CSS_PROPERTIES, isCssProperty, toCssKey } from './css-properties.js';
3
- import '@contentful/experiences-sdk-core';
3
+ export { applyTokenResolver, getValueForViewport, getViewportIndex, resolveDesignProperties } from '@contentful/experiences-sdk-core';
@@ -1,4 +1,5 @@
1
- import { DesignToken, ResolveToken, DesignPropValue, ViewportDef } from '@contentful/experiences-sdk-core';
1
+ import { ViewportDef } from '@contentful/experiences-sdk-core';
2
+ export { applyTokenResolver, getValueForViewport, getViewportIndex, resolveDesignProperties } from '@contentful/experiences-sdk-core';
2
3
 
3
4
  /**
4
5
  * Convert a Contentful viewport `query` string into a CSS media query.
@@ -6,39 +7,5 @@ import { DesignToken, ResolveToken, DesignPropValue, ViewportDef } from '@conten
6
7
  * or for any unrecognized format.
7
8
  */
8
9
  declare function toCssMediaQuery(viewport: ViewportDef): string | undefined;
9
- /**
10
- * Resolve a viewport ID to its index in the ordered viewports list. Returns 0
11
- * (the wildcard viewport) when the id is unknown or undefined.
12
- */
13
- declare function getViewportIndex(viewports: ViewportDef[], viewportId?: string): number;
14
- /**
15
- * Resolve a single design-property envelope to its render-time value:
16
- * - ManualDesignValue → its scalar
17
- * - DesignToken → the envelope passes through (customer-owned resolution)
18
- * - ValuesByViewport → cascade-lookup against the active viewport, then
19
- * unwrap the inner Manual/Token as above
20
- * - undefined → returns undefined
21
- */
22
- declare function getValueForViewport(prop: DesignPropValue | undefined, viewports: ViewportDef[], activeViewportIndex: number): string | number | boolean | DesignToken | undefined;
23
- /**
24
- * Resolve every design-property envelope on a node into a flat record keyed
25
- * by property name. Customer components receive these values as plain props.
26
- */
27
- declare function resolveDesignProperties(designProperties: Record<string, DesignPropValue> | undefined, viewports: ViewportDef[], activeViewportIndex: number): Record<string, string | number | boolean | DesignToken>;
28
- /**
29
- * Resolves `DesignToken` envelopes in a viewport-resolved design record via
30
- * `resolveToken`; scalars pass through, and with no resolver the record is
31
- * returned unchanged. Keys that resolve to `undefined` are dropped and their
32
- * token ids collected in `unresolved` for a single grouped warning.
33
- *
34
- * When no `resolveToken` is configured but the record contains `DesignToken`
35
- * envelopes, warns once — those keys reach components as raw envelope objects
36
- * (e.g. rendering as `[object Object]`), which is almost always a missing-
37
- * config mistake rather than intent.
38
- */
39
- declare function applyTokenResolver(props: Record<string, string | number | boolean | DesignToken>, resolveToken?: ResolveToken): {
40
- props: Record<string, unknown>;
41
- unresolved: string[];
42
- };
43
10
 
44
- export { applyTokenResolver, getValueForViewport, getViewportIndex, resolveDesignProperties, toCssMediaQuery };
11
+ export { toCssMediaQuery };
package/dist/viewport.js CHANGED
@@ -1,3 +1,9 @@
1
+ import {
2
+ applyTokenResolver,
3
+ getValueForViewport,
4
+ getViewportIndex,
5
+ resolveDesignProperties
6
+ } from "@contentful/experiences-sdk-core";
1
7
  const MEDIA_QUERY_REGEXP = /^(<|>)(\d+)(px|cm|mm|in|pt|pc)$/;
2
8
  function toCssMediaQuery(viewport) {
3
9
  const { query } = viewport;
@@ -14,70 +20,6 @@ function toCssMediaQuery(viewport) {
14
20
  }
15
21
  return void 0;
16
22
  }
17
- function getViewportIndex(viewports, viewportId) {
18
- if (!viewportId) return 0;
19
- const index = viewports.findIndex((v) => v.id === viewportId);
20
- return index === -1 ? 0 : index;
21
- }
22
- function unwrapInner(inner) {
23
- if (!inner) return void 0;
24
- if (inner.type === "ManualDesignValue") return inner.value;
25
- return inner;
26
- }
27
- function resolveValuesByViewport(bag, viewports, activeViewportIndex) {
28
- for (let i = activeViewportIndex; i >= 0; i--) {
29
- const viewport = viewports[i];
30
- if (!viewport) continue;
31
- const candidate = bag.values[viewport.id];
32
- if (candidate !== void 0 && candidate !== null) return candidate;
33
- }
34
- return void 0;
35
- }
36
- function getValueForViewport(prop, viewports, activeViewportIndex) {
37
- if (!prop) return void 0;
38
- if (prop.type === "ManualDesignValue") return prop.value;
39
- if (prop.type === "DesignToken") return prop;
40
- return unwrapInner(resolveValuesByViewport(prop, viewports, activeViewportIndex));
41
- }
42
- function resolveDesignProperties(designProperties, viewports, activeViewportIndex) {
43
- const out = {};
44
- if (!designProperties) return out;
45
- for (const [key, prop] of Object.entries(designProperties)) {
46
- const value = getValueForViewport(prop, viewports, activeViewportIndex);
47
- if (value !== void 0) out[key] = value;
48
- }
49
- return out;
50
- }
51
- let warnedMissingResolver = false;
52
- function applyTokenResolver(props, resolveToken) {
53
- if (!resolveToken) {
54
- if (!warnedMissingResolver && typeof console !== "undefined") {
55
- const tokenKeys = Object.entries(props).filter(([, v]) => typeof v === "object" && v !== null && v.type === "DesignToken").map(([k]) => k);
56
- if (tokenKeys.length) {
57
- warnedMissingResolver = true;
58
- console.warn(
59
- `[@contentful/experiences] Design tokens are present but no \`resolveToken\` is configured on the Config; token-valued design props (${tokenKeys.join(", ")}) reach components unresolved. Add \`resolveToken\` to your Config to map token ids to values.`
60
- );
61
- }
62
- }
63
- return { props, unresolved: [] };
64
- }
65
- const out = {};
66
- const unresolved = [];
67
- for (const [key, value] of Object.entries(props)) {
68
- if (typeof value === "object" && value !== null && value.type === "DesignToken") {
69
- const resolved = resolveToken(value);
70
- if (resolved === void 0) {
71
- unresolved.push(value.value);
72
- continue;
73
- }
74
- out[key] = resolved;
75
- continue;
76
- }
77
- out[key] = value;
78
- }
79
- return { props: out, unresolved };
80
- }
81
23
  export {
82
24
  applyTokenResolver,
83
25
  getValueForViewport,
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/viewport.ts"],"sourcesContent":["/*\n * Viewport math + design-property resolution for the Experiences SDK.\n *\n * ## Cascade model\n *\n * Viewport order in the payload encodes cascade direction:\n * - desktop-first: viewports descend by screen width (`*`, `<992px`, `<576px`)\n * - mobile-first: viewports ascend by screen width (`*`, `>576px`, `>992px`)\n *\n * \"Active viewport\" = the last-matching media query in the ordered list.\n * `getValueForViewport` walks backwards from the active viewport toward\n * viewport[0], returning the first defined value — emulating CSS cascade\n * behavior at runtime.\n *\n * ## DesignPropValue unwrapping\n *\n * v1 design properties arrive as a discriminated union:\n * - ManualDesignValue → unwrap to its scalar `value`\n * - DesignToken → pass the envelope through unchanged so customer\n * components can resolve it themselves (token\n * resolution lands in the future tokens package)\n * - ValuesByViewport → cascade-lookup the inner ManualDesignValue/DesignToken\n * at the active viewport, then unwrap as above\n */\n\nimport type {\n DesignPropValue,\n DesignToken,\n ManualDesignValue,\n ResolveToken,\n ValuesByViewport,\n ViewportDef,\n} from '@contentful/experiences-sdk-core';\n\nconst MEDIA_QUERY_REGEXP = /^(<|>)(\\d+)(px|cm|mm|in|pt|pc)$/;\n\n/**\n * Convert a Contentful viewport `query` string into a CSS media query.\n * Returns `undefined` for the wildcard \"*\" (always matches; no media query needed)\n * or for any unrecognized format.\n */\nexport function toCssMediaQuery(viewport: ViewportDef): string | undefined {\n const { query } = viewport;\n if (query === '*') return undefined;\n const match = query.match(MEDIA_QUERY_REGEXP);\n if (!match) return undefined;\n const [, operator, value, unit] = match;\n if (!operator || !value || !unit) return undefined;\n if (operator === '<') {\n return `(max-width: ${Number(value) - 1}${unit})`;\n }\n if (operator === '>') {\n return `(min-width: ${Number(value) + 1}${unit})`;\n }\n return undefined;\n}\n\n/**\n * Resolve a viewport ID to its index in the ordered viewports list. Returns 0\n * (the wildcard viewport) when the id is unknown or undefined.\n */\nexport function getViewportIndex(viewports: ViewportDef[], viewportId?: string): number {\n if (!viewportId) return 0;\n const index = viewports.findIndex((v) => v.id === viewportId);\n return index === -1 ? 0 : index;\n}\n\n/**\n * Unwrap a non-viewport-keyed envelope into a value the customer component\n * can consume directly. ManualDesignValue → its scalar; DesignToken → the\n * envelope passes through (customer-owned resolution).\n */\nfunction unwrapInner(\n inner: ManualDesignValue | DesignToken | undefined\n): string | number | boolean | DesignToken | undefined {\n if (!inner) return undefined;\n if (inner.type === 'ManualDesignValue') return inner.value;\n return inner;\n}\n\n/**\n * Cascade-lookup for a `ValuesByViewport` envelope. Walks backwards from\n * `activeViewportIndex` toward viewport[0], returning the first defined value.\n */\nfunction resolveValuesByViewport(\n bag: ValuesByViewport,\n viewports: ViewportDef[],\n activeViewportIndex: number\n): ManualDesignValue | DesignToken | undefined {\n for (let i = activeViewportIndex; i >= 0; i--) {\n const viewport = viewports[i];\n if (!viewport) continue;\n const candidate = bag.values[viewport.id];\n if (candidate !== undefined && candidate !== null) return candidate;\n }\n return undefined;\n}\n\n/**\n * Resolve a single design-property envelope to its render-time value:\n * - ManualDesignValue → its scalar\n * - DesignToken → the envelope passes through (customer-owned resolution)\n * - ValuesByViewport → cascade-lookup against the active viewport, then\n * unwrap the inner Manual/Token as above\n * - undefined → returns undefined\n */\nexport function getValueForViewport(\n prop: DesignPropValue | undefined,\n viewports: ViewportDef[],\n activeViewportIndex: number\n): string | number | boolean | DesignToken | undefined {\n if (!prop) return undefined;\n if (prop.type === 'ManualDesignValue') return prop.value;\n if (prop.type === 'DesignToken') return prop;\n return unwrapInner(resolveValuesByViewport(prop, viewports, activeViewportIndex));\n}\n\n/**\n * Resolve every design-property envelope on a node into a flat record keyed\n * by property name. Customer components receive these values as plain props.\n */\nexport function resolveDesignProperties(\n designProperties: Record<string, DesignPropValue> | undefined,\n viewports: ViewportDef[],\n activeViewportIndex: number\n): Record<string, string | number | boolean | DesignToken> {\n const out: Record<string, string | number | boolean | DesignToken> = {};\n if (!designProperties) return out;\n for (const [key, prop] of Object.entries(designProperties)) {\n const value = getValueForViewport(prop, viewports, activeViewportIndex);\n if (value !== undefined) out[key] = value;\n }\n return out;\n}\n\nlet warnedMissingResolver = false;\n\n/**\n * Resolves `DesignToken` envelopes in a viewport-resolved design record via\n * `resolveToken`; scalars pass through, and with no resolver the record is\n * returned unchanged. Keys that resolve to `undefined` are dropped and their\n * token ids collected in `unresolved` for a single grouped warning.\n *\n * When no `resolveToken` is configured but the record contains `DesignToken`\n * envelopes, warns once — those keys reach components as raw envelope objects\n * (e.g. rendering as `[object Object]`), which is almost always a missing-\n * config mistake rather than intent.\n */\nexport function applyTokenResolver(\n props: Record<string, string | number | boolean | DesignToken>,\n resolveToken?: ResolveToken\n): { props: Record<string, unknown>; unresolved: string[] } {\n if (!resolveToken) {\n if (!warnedMissingResolver && typeof console !== 'undefined') {\n const tokenKeys = Object.entries(props)\n .filter(([, v]) => typeof v === 'object' && v !== null && v.type === 'DesignToken')\n .map(([k]) => k);\n if (tokenKeys.length) {\n warnedMissingResolver = true;\n console.warn(\n `[@contentful/experiences] Design tokens are present but no \\`resolveToken\\` is configured on the Config; token-valued design props (${tokenKeys.join(', ')}) reach components unresolved. Add \\`resolveToken\\` to your Config to map token ids to values.`\n );\n }\n }\n return { props, unresolved: [] };\n }\n const out: Record<string, unknown> = {};\n const unresolved: string[] = [];\n for (const [key, value] of Object.entries(props)) {\n if (typeof value === 'object' && value !== null && value.type === 'DesignToken') {\n const resolved = resolveToken(value);\n if (resolved === undefined) {\n unresolved.push(value.value);\n continue;\n }\n out[key] = resolved;\n continue;\n }\n out[key] = value;\n }\n return { props: out, unresolved };\n}\n"],"mappings":"AAkCA,MAAM,qBAAqB;AAOpB,SAAS,gBAAgB,UAA2C;AACzE,QAAM,EAAE,MAAM,IAAI;AAClB,MAAI,UAAU,IAAK,QAAO;AAC1B,QAAM,QAAQ,MAAM,MAAM,kBAAkB;AAC5C,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,CAAC,EAAE,UAAU,OAAO,IAAI,IAAI;AAClC,MAAI,CAAC,YAAY,CAAC,SAAS,CAAC,KAAM,QAAO;AACzC,MAAI,aAAa,KAAK;AACpB,WAAO,eAAe,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI;AAAA,EAChD;AACA,MAAI,aAAa,KAAK;AACpB,WAAO,eAAe,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI;AAAA,EAChD;AACA,SAAO;AACT;AAMO,SAAS,iBAAiB,WAA0B,YAA6B;AACtF,MAAI,CAAC,WAAY,QAAO;AACxB,QAAM,QAAQ,UAAU,UAAU,CAAC,MAAM,EAAE,OAAO,UAAU;AAC5D,SAAO,UAAU,KAAK,IAAI;AAC5B;AAOA,SAAS,YACP,OACqD;AACrD,MAAI,CAAC,MAAO,QAAO;AACnB,MAAI,MAAM,SAAS,oBAAqB,QAAO,MAAM;AACrD,SAAO;AACT;AAMA,SAAS,wBACP,KACA,WACA,qBAC6C;AAC7C,WAAS,IAAI,qBAAqB,KAAK,GAAG,KAAK;AAC7C,UAAM,WAAW,UAAU,CAAC;AAC5B,QAAI,CAAC,SAAU;AACf,UAAM,YAAY,IAAI,OAAO,SAAS,EAAE;AACxC,QAAI,cAAc,UAAa,cAAc,KAAM,QAAO;AAAA,EAC5D;AACA,SAAO;AACT;AAUO,SAAS,oBACd,MACA,WACA,qBACqD;AACrD,MAAI,CAAC,KAAM,QAAO;AAClB,MAAI,KAAK,SAAS,oBAAqB,QAAO,KAAK;AACnD,MAAI,KAAK,SAAS,cAAe,QAAO;AACxC,SAAO,YAAY,wBAAwB,MAAM,WAAW,mBAAmB,CAAC;AAClF;AAMO,SAAS,wBACd,kBACA,WACA,qBACyD;AACzD,QAAM,MAA+D,CAAC;AACtE,MAAI,CAAC,iBAAkB,QAAO;AAC9B,aAAW,CAAC,KAAK,IAAI,KAAK,OAAO,QAAQ,gBAAgB,GAAG;AAC1D,UAAM,QAAQ,oBAAoB,MAAM,WAAW,mBAAmB;AACtE,QAAI,UAAU,OAAW,KAAI,GAAG,IAAI;AAAA,EACtC;AACA,SAAO;AACT;AAEA,IAAI,wBAAwB;AAarB,SAAS,mBACd,OACA,cAC0D;AAC1D,MAAI,CAAC,cAAc;AACjB,QAAI,CAAC,yBAAyB,OAAO,YAAY,aAAa;AAC5D,YAAM,YAAY,OAAO,QAAQ,KAAK,EACnC,OAAO,CAAC,CAAC,EAAE,CAAC,MAAM,OAAO,MAAM,YAAY,MAAM,QAAQ,EAAE,SAAS,aAAa,EACjF,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC;AACjB,UAAI,UAAU,QAAQ;AACpB,gCAAwB;AACxB,gBAAQ;AAAA,UACN,uIAAuI,UAAU,KAAK,IAAI,CAAC;AAAA,QAC7J;AAAA,MACF;AAAA,IACF;AACA,WAAO,EAAE,OAAO,YAAY,CAAC,EAAE;AAAA,EACjC;AACA,QAAM,MAA+B,CAAC;AACtC,QAAM,aAAuB,CAAC;AAC9B,aAAW,CAAC,KAAK,KAAK,KAAK,OAAO,QAAQ,KAAK,GAAG;AAChD,QAAI,OAAO,UAAU,YAAY,UAAU,QAAQ,MAAM,SAAS,eAAe;AAC/E,YAAM,WAAW,aAAa,KAAK;AACnC,UAAI,aAAa,QAAW;AAC1B,mBAAW,KAAK,MAAM,KAAK;AAC3B;AAAA,MACF;AACA,UAAI,GAAG,IAAI;AACX;AAAA,IACF;AACA,QAAI,GAAG,IAAI;AAAA,EACb;AACA,SAAO,EAAE,OAAO,KAAK,WAAW;AAClC;","names":[]}
1
+ {"version":3,"sources":["../src/viewport.ts"],"sourcesContent":["/*\n * Viewport → CSS media-query translation. The cascade + token-resolution\n * helpers now live in core (so the resolve pipeline can pre-resolve design\n * server-side) and are re-exported here to keep this package's API unchanged.\n */\n\nimport type { ViewportDef } from '@contentful/experiences-sdk-core';\n\nexport {\n applyTokenResolver,\n getValueForViewport,\n getViewportIndex,\n resolveDesignProperties,\n} from '@contentful/experiences-sdk-core';\n\nconst MEDIA_QUERY_REGEXP = /^(<|>)(\\d+)(px|cm|mm|in|pt|pc)$/;\n\n/**\n * Convert a Contentful viewport `query` string into a CSS media query.\n * Returns `undefined` for the wildcard \"*\" (always matches; no media query needed)\n * or for any unrecognized format.\n */\nexport function toCssMediaQuery(viewport: ViewportDef): string | undefined {\n const { query } = viewport;\n if (query === '*') return undefined;\n const match = query.match(MEDIA_QUERY_REGEXP);\n if (!match) return undefined;\n const [, operator, value, unit] = match;\n if (!operator || !value || !unit) return undefined;\n if (operator === '<') {\n return `(max-width: ${Number(value) - 1}${unit})`;\n }\n if (operator === '>') {\n return `(min-width: ${Number(value) + 1}${unit})`;\n }\n return undefined;\n}\n"],"mappings":"AAQA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,MAAM,qBAAqB;AAOpB,SAAS,gBAAgB,UAA2C;AACzE,QAAM,EAAE,MAAM,IAAI;AAClB,MAAI,UAAU,IAAK,QAAO;AAC1B,QAAM,QAAQ,MAAM,MAAM,kBAAkB;AAC5C,MAAI,CAAC,MAAO,QAAO;AACnB,QAAM,CAAC,EAAE,UAAU,OAAO,IAAI,IAAI;AAClC,MAAI,CAAC,YAAY,CAAC,SAAS,CAAC,KAAM,QAAO;AACzC,MAAI,aAAa,KAAK;AACpB,WAAO,eAAe,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI;AAAA,EAChD;AACA,MAAI,aAAa,KAAK;AACpB,WAAO,eAAe,OAAO,KAAK,IAAI,CAAC,GAAG,IAAI;AAAA,EAChD;AACA,SAAO;AACT;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@contentful/experiences-design",
3
- "version": "0.6.1",
3
+ "version": "0.7.1",
4
4
  "description": "Viewport math and design-property resolution utilities for Contentful Experiences",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -30,6 +30,6 @@
30
30
  "directory": "packages/design"
31
31
  },
32
32
  "dependencies": {
33
- "@contentful/experiences-sdk-core": "0.6.1"
33
+ "@contentful/experiences-sdk-core": "0.7.1"
34
34
  }
35
35
  }