@usethrottle/builder-react 0.2.4 → 0.3.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.
@@ -1368,11 +1368,16 @@ function BuilderRenderer(props) {
1368
1368
  ] });
1369
1369
  }
1370
1370
 
1371
+ // src/context.ts
1372
+ import { createContext, useContext } from "react";
1373
+ var BuilderContext = typeof createContext === "function" ? createContext(null) : null;
1374
+ var useBuilder = () => useContext(BuilderContext);
1375
+
1371
1376
  // src/part-view.tsx
1372
1377
  import { jsx as jsx18 } from "react/jsx-runtime";
1373
1378
  var BoundaryBase = Component ?? class {
1374
1379
  };
1375
- var PartBoundary = class extends BoundaryBase {
1380
+ var Boundary = class extends BoundaryBase {
1376
1381
  constructor() {
1377
1382
  super(...arguments);
1378
1383
  __publicField(this, "state", { failed: false });
@@ -1382,11 +1387,27 @@ var PartBoundary = class extends BoundaryBase {
1382
1387
  }
1383
1388
  componentDidCatch(error, _info) {
1384
1389
  warnOnce(`part:${this.props.label}`, `${this.props.label} failed to render (${String(error)}); rendering nothing for it`);
1390
+ try {
1391
+ this.props.onError?.(error, { part: this.props.label });
1392
+ } catch {
1393
+ }
1394
+ }
1395
+ componentDidUpdate(previous) {
1396
+ const moved = previous.resetKeys.length !== this.props.resetKeys.length || previous.resetKeys.some((key, i) => !Object.is(key, this.props.resetKeys[i]));
1397
+ if (moved && this.state.failed) this.setState({ failed: false });
1385
1398
  }
1386
1399
  render() {
1387
1400
  return this.state.failed ? null : this.props.children;
1388
1401
  }
1389
1402
  };
1403
+ function PartBoundary({
1404
+ label,
1405
+ resetKey,
1406
+ children
1407
+ }) {
1408
+ const builder = useBuilder();
1409
+ return /* @__PURE__ */ jsx18(Boundary, { label, resetKeys: [builder?.site, resetKey], onError: builder?.onError, children });
1410
+ }
1390
1411
 
1391
1412
  // src/custom/template-widget.tsx
1392
1413
  import { Suspense } from "react";
@@ -1368,11 +1368,16 @@ function BuilderRenderer(props) {
1368
1368
  ] });
1369
1369
  }
1370
1370
 
1371
+ // src/context.ts
1372
+
1373
+ var BuilderContext = typeof _react.createContext === "function" ? _react.createContext.call(void 0, null) : null;
1374
+ var useBuilder = () => _react.useContext.call(void 0, BuilderContext);
1375
+
1371
1376
  // src/part-view.tsx
1372
1377
 
1373
1378
  var BoundaryBase = _nullishCoalesce(_react.Component, () => ( class {
1374
1379
  }));
1375
- var PartBoundary = class extends BoundaryBase {
1380
+ var Boundary = class extends BoundaryBase {
1376
1381
  constructor() {
1377
1382
  super(...arguments);
1378
1383
  __publicField(this, "state", { failed: false });
@@ -1382,11 +1387,27 @@ var PartBoundary = class extends BoundaryBase {
1382
1387
  }
1383
1388
  componentDidCatch(error, _info) {
1384
1389
  warnOnce(`part:${this.props.label}`, `${this.props.label} failed to render (${String(error)}); rendering nothing for it`);
1390
+ try {
1391
+ _optionalChain([this, 'access', _47 => _47.props, 'access', _48 => _48.onError, 'optionalCall', _49 => _49(error, { part: this.props.label })]);
1392
+ } catch (e5) {
1393
+ }
1394
+ }
1395
+ componentDidUpdate(previous) {
1396
+ const moved = previous.resetKeys.length !== this.props.resetKeys.length || previous.resetKeys.some((key, i) => !Object.is(key, this.props.resetKeys[i]));
1397
+ if (moved && this.state.failed) this.setState({ failed: false });
1385
1398
  }
1386
1399
  render() {
1387
1400
  return this.state.failed ? null : this.props.children;
1388
1401
  }
1389
1402
  };
1403
+ function PartBoundary({
1404
+ label,
1405
+ resetKey,
1406
+ children
1407
+ }) {
1408
+ const builder = useBuilder();
1409
+ return /* @__PURE__ */ _jsxruntime.jsx.call(void 0, Boundary, { label, resetKeys: [_optionalChain([builder, 'optionalAccess', _50 => _50.site]), resetKey], onError: _optionalChain([builder, 'optionalAccess', _51 => _51.onError]), children });
1410
+ }
1390
1411
 
1391
1412
  // src/custom/template-widget.tsx
1392
1413
 
@@ -1499,7 +1520,7 @@ var ROLES = new Set(_builderschema.ALLOWED_ROLES);
1499
1520
  function attrAllowed(tag, name) {
1500
1521
  if (_builderschema.DATA_ATTR_RE.test(name)) return !name.startsWith(_builderschema.RESERVED_DATA_PREFIX);
1501
1522
  const own = Object.hasOwn(_builderschema.ALLOWED_ATTRS, tag) ? _builderschema.ALLOWED_ATTRS[tag] : void 0;
1502
- return (_nullishCoalesce(_optionalChain([_builderschema.ALLOWED_ATTRS, 'access', _47 => _47["*"], 'optionalAccess', _48 => _48.includes, 'call', _49 => _49(name)]), () => ( false))) || (_nullishCoalesce(_optionalChain([own, 'optionalAccess', _50 => _50.includes, 'call', _51 => _51(name)]), () => ( false)));
1523
+ return (_nullishCoalesce(_optionalChain([_builderschema.ALLOWED_ATTRS, 'access', _52 => _52["*"], 'optionalAccess', _53 => _53.includes, 'call', _54 => _54(name)]), () => ( false))) || (_nullishCoalesce(_optionalChain([own, 'optionalAccess', _55 => _55.includes, 'call', _56 => _56(name)]), () => ( false)));
1503
1524
  }
1504
1525
  function attrText(attr, env, scope) {
1505
1526
  return attr.value.map((part) => part.type === "text" ? part.value : filtered(lookup(part.path, env, scope), part.filters)).join("");
@@ -1622,14 +1643,14 @@ function compile(snapshot, registry) {
1622
1643
  const source = snapshot.template;
1623
1644
  if (typeof source !== "string") return refuse("no template source");
1624
1645
  const parsed = _builderschema.parseTemplate.call(void 0, source);
1625
- if (!parsed.ok) return refuse(`template does not parse: ${_nullishCoalesce(_optionalChain([parsed, 'access', _52 => _52.issues, 'access', _53 => _53[0], 'optionalAccess', _54 => _54.message]), () => ( "invalid"))}`);
1646
+ if (!parsed.ok) return refuse(`template does not parse: ${_nullishCoalesce(_optionalChain([parsed, 'access', _57 => _57.issues, 'access', _58 => _58[0], 'optionalAccess', _59 => _59.message]), () => ( "invalid"))}`);
1626
1647
  const data = snapshot.data;
1627
1648
  const issues = _builderschema.validateTemplate.call(void 0, parsed.ast, {
1628
1649
  settings: snapshot.settings,
1629
1650
  data: typeof data === "object" && data !== null ? data : {},
1630
1651
  sources: registry.sources()
1631
1652
  });
1632
- if (issues.length > 0) return refuse(`template does not validate: ${_nullishCoalesce(_optionalChain([issues, 'access', _55 => _55[0], 'optionalAccess', _56 => _56.message]), () => ( "invalid"))}`);
1653
+ if (issues.length > 0) return refuse(`template does not validate: ${_nullishCoalesce(_optionalChain([issues, 'access', _60 => _60[0], 'optionalAccess', _61 => _61.message]), () => ( "invalid"))}`);
1633
1654
  if (!fitsBudget(parsed.ast)) return refuse(`it can render more than ${String(_builderschema.MAX_TEMPLATE_WEIGHT)} nodes`);
1634
1655
  const css = scopedCss(snapshot.css, snapshot.type);
1635
1656
  if (css === null) return refuse("its css does not pass the sanitiser");
@@ -1661,16 +1682,16 @@ function parseBody(raw) {
1661
1682
  const stack = Array.isArray(raw.stack) ? raw.stack : void 0;
1662
1683
  if (columns === void 0 === (stack === void 0)) return null;
1663
1684
  const children = columns !== void 0 ? [{ id: WRAP.inner, type: "inner-section", props: {}, columns }] : _nullishCoalesce(stack, () => ( []));
1664
- if (_optionalChain([stack, 'optionalAccess', _57 => _57.some, 'call', _58 => _58((node) => isRecord3(node) && node.type === "inner-section")])) return null;
1685
+ if (_optionalChain([stack, 'optionalAccess', _62 => _62.some, 'call', _63 => _63((node) => isRecord3(node) && node.type === "inner-section")])) return null;
1665
1686
  const parsed = _builderschema.pageDocumentSchema.safeParse({
1666
1687
  schemaVersion: 1,
1667
1688
  sections: [{ id: WRAP.section, type: "section", props: {}, columns: [{ id: WRAP.column, type: "column", props: { width: 100 }, children }] }]
1668
1689
  });
1669
1690
  if (!parsed.success) return null;
1670
- const first = _nullishCoalesce(_optionalChain([parsed, 'access', _59 => _59.data, 'access', _60 => _60.sections, 'access', _61 => _61[0], 'optionalAccess', _62 => _62.columns, 'access', _63 => _63[0], 'optionalAccess', _64 => _64.children]), () => ( []));
1691
+ const first = _nullishCoalesce(_optionalChain([parsed, 'access', _64 => _64.data, 'access', _65 => _65.sections, 'access', _66 => _66[0], 'optionalAccess', _67 => _67.columns, 'access', _68 => _68[0], 'optionalAccess', _69 => _69.children]), () => ( []));
1671
1692
  if (columns !== void 0) {
1672
1693
  const inner = first[0];
1673
- return _optionalChain([inner, 'optionalAccess', _65 => _65.type]) === "inner-section" ? { columns: inner.columns } : null;
1694
+ return _optionalChain([inner, 'optionalAccess', _70 => _70.type]) === "inner-section" ? { columns: inner.columns } : null;
1674
1695
  }
1675
1696
  return { stack: first.filter((node) => node.type !== "inner-section") };
1676
1697
  }
@@ -1724,7 +1745,7 @@ var DEVICES3 = ["tablet", "phone"];
1724
1745
  function withoutAnchor(node) {
1725
1746
  delete node.props.anchor;
1726
1747
  const responsive = node.responsive;
1727
- for (const device of DEVICES3) if (_optionalChain([responsive, 'optionalAccess', _66 => _66[device]]) !== void 0) delete responsive[device].anchor;
1748
+ for (const device of DEVICES3) if (_optionalChain([responsive, 'optionalAccess', _71 => _71[device]]) !== void 0) delete responsive[device].anchor;
1728
1749
  }
1729
1750
  function instanceId(outer, inner) {
1730
1751
  let a = 3735928559;
@@ -1744,9 +1765,9 @@ function build(input) {
1744
1765
  const assets = {};
1745
1766
  const hrefs = /* @__PURE__ */ new Map();
1746
1767
  const innerData = {};
1747
- const keep = (child) => _optionalChain([registry, 'access', _67 => _67.widget, 'call', _68 => _68(child.type, child.v), 'optionalAccess', _69 => _69.kind]) !== "composite";
1748
- const columns = _optionalChain([body, 'access', _70 => _70.columns, 'optionalAccess', _71 => _71.map, 'call', _72 => _72((column2) => ({ ...column2, children: column2.children.filter(keep) }))]);
1749
- const stack = _optionalChain([body, 'access', _73 => _73.stack, 'optionalAccess', _74 => _74.filter, 'call', _75 => _75(keep)]);
1768
+ const keep = (child) => _optionalChain([registry, 'access', _72 => _72.widget, 'call', _73 => _73(child.type, child.v), 'optionalAccess', _74 => _74.kind]) !== "composite";
1769
+ const columns = _optionalChain([body, 'access', _75 => _75.columns, 'optionalAccess', _76 => _76.map, 'call', _77 => _77((column2) => ({ ...column2, children: column2.children.filter(keep) }))]);
1770
+ const stack = _optionalChain([body, 'access', _78 => _78.stack, 'optionalAccess', _79 => _79.filter, 'call', _80 => _80(keep)]);
1750
1771
  const widgets2 = columns !== void 0 ? columns.flatMap((column2) => column2.children) : _nullishCoalesce(stack, () => ( []));
1751
1772
  for (const widget of widgets2) {
1752
1773
  withoutAnchor(widget);
@@ -1781,15 +1802,15 @@ function build(input) {
1781
1802
  const value = props[binding.setting];
1782
1803
  for (const target of binding.targets) {
1783
1804
  const inner = byId.get(target.node);
1784
- const innerField = inner === void 0 ? void 0 : _optionalChain([registry, 'access', _76 => _76.widget, 'call', _77 => _77(inner.type, inner.v), 'optionalAccess', _78 => _78.settings, 'access', _79 => _79.find, 'call', _80 => _80((f) => f.key === target.prop)]);
1805
+ const innerField = inner === void 0 ? void 0 : _optionalChain([registry, 'access', _81 => _81.widget, 'call', _82 => _82(inner.type, inner.v), 'optionalAccess', _83 => _83.settings, 'access', _84 => _84.find, 'call', _85 => _85((f) => f.key === target.prop)]);
1785
1806
  if (inner === void 0 || innerField === void 0 || innerField.control !== field.control) continue;
1786
1807
  const converted = convert(field, value);
1787
1808
  if (_builderschema.validateSettingValue.call(void 0, innerField, converted) !== null) continue;
1788
1809
  inner.props[target.prop] = converted;
1789
1810
  const responsive = inner.responsive;
1790
1811
  for (const device of DEVICES3) {
1791
- if (_optionalChain([responsive, 'optionalAccess', _81 => _81[device]]) !== void 0) delete responsive[device][target.prop];
1792
- const raw = _optionalChain([outer, 'access', _82 => _82.responsive, 'optionalAccess', _83 => _83[device]]);
1812
+ if (_optionalChain([responsive, 'optionalAccess', _86 => _86[device]]) !== void 0) delete responsive[device][target.prop];
1813
+ const raw = _optionalChain([outer, 'access', _87 => _87.responsive, 'optionalAccess', _88 => _88[device]]);
1793
1814
  const plain = field.output === "css" && field.translatable !== true && field.control !== "image" && field.control !== "link";
1794
1815
  if (plain && raw !== void 0 && Object.hasOwn(raw, binding.setting) && _builderschema.validateSettingValue.call(void 0, innerField, raw[binding.setting]) === null) {
1795
1816
  const target$ = _nullishCoalesce(inner.responsive, () => ( (inner.responsive = {})));
@@ -1804,7 +1825,7 @@ function build(input) {
1804
1825
  for (const target of input$.targets) {
1805
1826
  const inner = byId.get(target.node);
1806
1827
  const def = inner === void 0 ? void 0 : registry.widget(inner.type, inner.v);
1807
- if (inner === void 0 || _optionalChain([def, 'optionalAccess', _84 => _84.data]) === void 0 || !Object.hasOwn(def.data, target.input)) continue;
1828
+ if (inner === void 0 || _optionalChain([def, 'optionalAccess', _89 => _89.data]) === void 0 || !Object.hasOwn(def.data, target.input)) continue;
1808
1829
  inner.data = { ..._nullishCoalesce(inner.data, () => ( {})), [target.input]: { source: key } };
1809
1830
  innerData[key] = data[name];
1810
1831
  }
@@ -1822,7 +1843,7 @@ function build(input) {
1822
1843
  schemaVersion: 1,
1823
1844
  sections: [{ id: ids.section, type: "section", props: { width: "full" }, columns: [column] }]
1824
1845
  };
1825
- let weight = 2 + (_nullishCoalesce(_optionalChain([columns, 'optionalAccess', _85 => _85.length]), () => ( 0))) + (columns === void 0 ? 0 : 1);
1846
+ let weight = 2 + (_nullishCoalesce(_optionalChain([columns, 'optionalAccess', _90 => _90.length]), () => ( 0))) + (columns === void 0 ? 0 : 1);
1826
1847
  for (const widget of widgets2) {
1827
1848
  const component = registry.component(widget);
1828
1849
  weight += 1 + (component === void 0 ? 0 : _nullishCoalesce(componentWeights.get(component), () => ( 0)));
@@ -1847,7 +1868,7 @@ function CompositeBody(props) {
1847
1868
  locale,
1848
1869
  assets: built.assets,
1849
1870
  mediaOrigin,
1850
- resolveLink: (target) => _nullishCoalesce(_nullishCoalesce(built.hrefs.get(JSON.stringify(target)), () => ( _optionalChain([resolveLink, 'optionalCall', _86 => _86(target)]))), () => ( null))
1871
+ resolveLink: (target) => _nullishCoalesce(_nullishCoalesce(built.hrefs.get(JSON.stringify(target)), () => ( _optionalChain([resolveLink, 'optionalCall', _91 => _91(target)]))), () => ( null))
1851
1872
  }
1852
1873
  );
1853
1874
  }
@@ -1972,7 +1993,7 @@ function pagePathOf(settings, page, resolve) {
1972
1993
  return _nullishCoalesce(_builderschema.safeUrl.call(void 0, resolve({ ...page, path }), "href", { mediaOrigin: "" }), () => ( path));
1973
1994
  }
1974
1995
  function originOf(storeUrl) {
1975
- const origin = _optionalChain([storeUrl, 'optionalAccess', _87 => _87.replace, 'call', _88 => _88(/\/+$/u, "")]);
1996
+ const origin = _optionalChain([storeUrl, 'optionalAccess', _92 => _92.replace, 'call', _93 => _93(/\/+$/u, "")]);
1976
1997
  return origin !== void 0 && ORIGIN_RE.test(origin) ? origin : void 0;
1977
1998
  }
1978
1999
  function siteLocales(settings) {
package/dist/index.cjs CHANGED
@@ -684,7 +684,7 @@ var import_ui6 = require("@usethrottle/ui");
684
684
 
685
685
  // src/context.ts
686
686
  var import_react2 = require("react");
687
- var BuilderContext = (0, import_react2.createContext)(null);
687
+ var BuilderContext = typeof import_react2.createContext === "function" ? (0, import_react2.createContext)(null) : null;
688
688
  var useBuilder = () => (0, import_react2.useContext)(BuilderContext);
689
689
 
690
690
  // src/page.tsx
@@ -833,7 +833,7 @@ var import_react5 = require("react");
833
833
  var import_jsx_runtime6 = require("react/jsx-runtime");
834
834
  var BoundaryBase = import_react5.Component ?? class {
835
835
  };
836
- var PartBoundary = class extends BoundaryBase {
836
+ var Boundary = class extends BoundaryBase {
837
837
  constructor() {
838
838
  super(...arguments);
839
839
  __publicField(this, "state", { failed: false });
@@ -843,11 +843,27 @@ var PartBoundary = class extends BoundaryBase {
843
843
  }
844
844
  componentDidCatch(error, _info) {
845
845
  warnOnce(`part:${this.props.label}`, `${this.props.label} failed to render (${String(error)}); rendering nothing for it`);
846
+ try {
847
+ this.props.onError?.(error, { part: this.props.label });
848
+ } catch {
849
+ }
850
+ }
851
+ componentDidUpdate(previous) {
852
+ const moved = previous.resetKeys.length !== this.props.resetKeys.length || previous.resetKeys.some((key, i) => !Object.is(key, this.props.resetKeys[i]));
853
+ if (moved && this.state.failed) this.setState({ failed: false });
846
854
  }
847
855
  render() {
848
856
  return this.state.failed ? null : this.props.children;
849
857
  }
850
858
  };
859
+ function PartBoundary({
860
+ label,
861
+ resetKey,
862
+ children
863
+ }) {
864
+ const builder = useBuilder();
865
+ return /* @__PURE__ */ (0, import_jsx_runtime6.jsx)(Boundary, { label, resetKeys: [builder?.site, resetKey], onError: builder?.onError, children });
866
+ }
851
867
  function contextData(context) {
852
868
  if (typeof context !== "object" || context === null) return {};
853
869
  return Object.fromEntries(Object.entries(context).map(([key, value]) => [`context.${key}`, value]));
@@ -2059,6 +2075,14 @@ function createRendererRegistry(packs, options = {}) {
2059
2075
  // src/slot.tsx
2060
2076
  var import_react14 = require("react");
2061
2077
  var import_jsx_runtime24 = require("react/jsx-runtime");
2078
+ function contextKey(context) {
2079
+ if (typeof context !== "object" || context === null) return "";
2080
+ return Object.values(context).map((value) => {
2081
+ const record = typeof value === "object" && value !== null ? value : {};
2082
+ const id = record["id"] ?? record["handle"] ?? record["slug"];
2083
+ return typeof id === "string" || typeof id === "number" ? String(id) : "";
2084
+ }).join("|");
2085
+ }
2062
2086
  function BuilderSlot({ name, context }) {
2063
2087
  const builder = useBuilder();
2064
2088
  if (builder === null || builder.site.status !== "ok") return null;
@@ -2066,7 +2090,7 @@ function BuilderSlot({ name, context }) {
2066
2090
  if (part === void 0 || part.document.sections.length === 0) return null;
2067
2091
  return (
2068
2092
  // Suspense inside the boundary: see parts.tsx.
2069
- /* @__PURE__ */ (0, import_jsx_runtime24.jsx)(PartBoundary, { label: `Builder slot ${name}`, children: /* @__PURE__ */ (0, import_jsx_runtime24.jsx)("div", { "data-throttle-part": "builder-slot", "data-b-slot": name, children: /* @__PURE__ */ (0, import_jsx_runtime24.jsx)(import_react14.Suspense, { fallback: null, children: /* @__PURE__ */ (0, import_jsx_runtime24.jsx)(PartView, { part, context }) }) }) })
2093
+ /* @__PURE__ */ (0, import_jsx_runtime24.jsx)(PartBoundary, { label: `Builder slot ${name}`, resetKey: contextKey(context), children: /* @__PURE__ */ (0, import_jsx_runtime24.jsx)("div", { "data-throttle-part": "builder-slot", "data-b-slot": name, children: /* @__PURE__ */ (0, import_jsx_runtime24.jsx)(import_react14.Suspense, { fallback: null, children: /* @__PURE__ */ (0, import_jsx_runtime24.jsx)(PartView, { part, context }) }) }) })
2070
2094
  );
2071
2095
  }
2072
2096
 
@@ -2256,7 +2280,7 @@ var EMPTY = {};
2256
2280
  function useParentFont() {
2257
2281
  return (0, import_react15.useContext)(import_ui6.AppearanceContext)?.variables?.fontFamily;
2258
2282
  }
2259
- function BuilderProvider({ builderKey, client, packs, site, children }) {
2283
+ function BuilderProvider({ builderKey, client, packs, site, onError, children }) {
2260
2284
  const packsKey = packs.map((pack) => `${pack.id}@${pack.version}`).join("|");
2261
2285
  const registryRef = (0, import_react15.useRef)(null);
2262
2286
  if (registryRef.current?.key !== packsKey) {
@@ -2298,8 +2322,8 @@ function BuilderProvider({ builderKey, client, packs, site, children }) {
2298
2322
  [site]
2299
2323
  );
2300
2324
  const value = (0, import_react15.useMemo)(
2301
- () => ({ client: builder, packs, registry, site, locale: site.locale, mediaOrigin, resolveLink }),
2302
- [builder, packs, registry, site, mediaOrigin, resolveLink]
2325
+ () => ({ client: builder, packs, registry, site, locale: site.locale, mediaOrigin, onError, resolveLink }),
2326
+ [builder, packs, registry, site, mediaOrigin, onError, resolveLink]
2303
2327
  );
2304
2328
  const design = (0, import_react15.useMemo)(
2305
2329
  () => site.status === "ok" ? siteDesignOf(site.settings, resolveLink, pageOutlet, mediaOrigin) : null,
package/dist/index.d.cts CHANGED
@@ -1,5 +1,4 @@
1
- import * as react from 'react';
2
- import { ReactNode, ComponentType, CSSProperties } from 'react';
1
+ import { ReactNode, ComponentType, CSSProperties, Context } from 'react';
3
2
  import { TemplateAst, WidgetNode, SettingValue, WidgetDefinition, DataSourceDescriptor, PageDocument, FrozenAsset, WidgetRegistry, CustomWidgetSnapshot, SettingField, DataBinding } from '@usethrottle/builder-schema';
4
3
  import { BuilderClient } from '@usethrottle/builder';
5
4
  export { BuilderNotFoundError, BuilderUnavailableError } from '@usethrottle/builder';
@@ -301,6 +300,10 @@ type BuilderProviderProps = {
301
300
  packs: readonly WidgetPack[];
302
301
  /** What `loadSite()` read on the server. */
303
302
  site: LoadedSite;
303
+ /** Called when a part, slot or page fails to render (it then renders nothing): send it to your error monitoring. `info.part` names it. */
304
+ onError?: (error: unknown, info: {
305
+ part: string;
306
+ }) => void;
304
307
  children: ReactNode;
305
308
  };
306
309
  /**
@@ -317,7 +320,7 @@ type BuilderProviderProps = {
317
320
  * With a site the Builder could not answer (`status: 'unavailable'`) it fills
318
321
  * nothing, so the catalog's own design shows and every part renders nothing.
319
322
  */
320
- declare function BuilderProvider({ builderKey, client, packs, site, children }: BuilderProviderProps): ReactNode;
323
+ declare function BuilderProvider({ builderKey, client, packs, site, onError, children }: BuilderProviderProps): ReactNode;
321
324
 
322
325
  type BuilderContextValue = {
323
326
  client: BuilderClient | null;
@@ -326,12 +329,20 @@ type BuilderContextValue = {
326
329
  site: LoadedSite;
327
330
  locale: string;
328
331
  mediaOrigin: string;
332
+ onError?: ((error: unknown, info: {
333
+ part: string;
334
+ }) => void) | undefined;
329
335
  resolveLink: (target: {
330
336
  kind: string;
331
337
  [key: string]: unknown;
332
338
  }) => string | null;
333
339
  };
334
- declare const BuilderContext: react.Context<BuilderContextValue | null>;
340
+ /**
341
+ * `react` has no `createContext` in a React Server Components build, and the server entries share this module's chunk
342
+ * through `PartBoundary`. Nothing reads the context on the server (`useBuilder` runs only in client components), so
343
+ * evaluating this module there must not throw.
344
+ */
345
+ declare const BuilderContext: Context<BuilderContextValue | null>;
335
346
  /** The provider's value, or null outside a `BuilderProvider`. */
336
347
  declare const useBuilder: () => BuilderContextValue | null;
337
348
 
package/dist/index.d.ts CHANGED
@@ -1,5 +1,4 @@
1
- import * as react from 'react';
2
- import { ReactNode, ComponentType, CSSProperties } from 'react';
1
+ import { ReactNode, ComponentType, CSSProperties, Context } from 'react';
3
2
  import { TemplateAst, WidgetNode, SettingValue, WidgetDefinition, DataSourceDescriptor, PageDocument, FrozenAsset, WidgetRegistry, CustomWidgetSnapshot, SettingField, DataBinding } from '@usethrottle/builder-schema';
4
3
  import { BuilderClient } from '@usethrottle/builder';
5
4
  export { BuilderNotFoundError, BuilderUnavailableError } from '@usethrottle/builder';
@@ -301,6 +300,10 @@ type BuilderProviderProps = {
301
300
  packs: readonly WidgetPack[];
302
301
  /** What `loadSite()` read on the server. */
303
302
  site: LoadedSite;
303
+ /** Called when a part, slot or page fails to render (it then renders nothing): send it to your error monitoring. `info.part` names it. */
304
+ onError?: (error: unknown, info: {
305
+ part: string;
306
+ }) => void;
304
307
  children: ReactNode;
305
308
  };
306
309
  /**
@@ -317,7 +320,7 @@ type BuilderProviderProps = {
317
320
  * With a site the Builder could not answer (`status: 'unavailable'`) it fills
318
321
  * nothing, so the catalog's own design shows and every part renders nothing.
319
322
  */
320
- declare function BuilderProvider({ builderKey, client, packs, site, children }: BuilderProviderProps): ReactNode;
323
+ declare function BuilderProvider({ builderKey, client, packs, site, onError, children }: BuilderProviderProps): ReactNode;
321
324
 
322
325
  type BuilderContextValue = {
323
326
  client: BuilderClient | null;
@@ -326,12 +329,20 @@ type BuilderContextValue = {
326
329
  site: LoadedSite;
327
330
  locale: string;
328
331
  mediaOrigin: string;
332
+ onError?: ((error: unknown, info: {
333
+ part: string;
334
+ }) => void) | undefined;
329
335
  resolveLink: (target: {
330
336
  kind: string;
331
337
  [key: string]: unknown;
332
338
  }) => string | null;
333
339
  };
334
- declare const BuilderContext: react.Context<BuilderContextValue | null>;
340
+ /**
341
+ * `react` has no `createContext` in a React Server Components build, and the server entries share this module's chunk
342
+ * through `PartBoundary`. Nothing reads the context on the server (`useBuilder` runs only in client components), so
343
+ * evaluating this module there must not throw.
344
+ */
345
+ declare const BuilderContext: Context<BuilderContextValue | null>;
335
346
  /** The provider's value, or null outside a `BuilderProvider`. */
336
347
  declare const useBuilder: () => BuilderContextValue | null;
337
348
 
package/dist/index.js CHANGED
@@ -638,7 +638,7 @@ import { AppearanceContext, SiteDesignProvider, SlotOutletProvider, ThrottleUIPr
638
638
 
639
639
  // src/context.ts
640
640
  import { createContext, useContext } from "react";
641
- var BuilderContext = createContext(null);
641
+ var BuilderContext = typeof createContext === "function" ? createContext(null) : null;
642
642
  var useBuilder = () => useContext(BuilderContext);
643
643
 
644
644
  // src/page.tsx
@@ -787,7 +787,7 @@ import { Component } from "react";
787
787
  import { jsx as jsx6 } from "react/jsx-runtime";
788
788
  var BoundaryBase = Component ?? class {
789
789
  };
790
- var PartBoundary = class extends BoundaryBase {
790
+ var Boundary = class extends BoundaryBase {
791
791
  constructor() {
792
792
  super(...arguments);
793
793
  __publicField(this, "state", { failed: false });
@@ -797,11 +797,27 @@ var PartBoundary = class extends BoundaryBase {
797
797
  }
798
798
  componentDidCatch(error, _info) {
799
799
  warnOnce(`part:${this.props.label}`, `${this.props.label} failed to render (${String(error)}); rendering nothing for it`);
800
+ try {
801
+ this.props.onError?.(error, { part: this.props.label });
802
+ } catch {
803
+ }
804
+ }
805
+ componentDidUpdate(previous) {
806
+ const moved = previous.resetKeys.length !== this.props.resetKeys.length || previous.resetKeys.some((key, i) => !Object.is(key, this.props.resetKeys[i]));
807
+ if (moved && this.state.failed) this.setState({ failed: false });
800
808
  }
801
809
  render() {
802
810
  return this.state.failed ? null : this.props.children;
803
811
  }
804
812
  };
813
+ function PartBoundary({
814
+ label,
815
+ resetKey,
816
+ children
817
+ }) {
818
+ const builder = useBuilder();
819
+ return /* @__PURE__ */ jsx6(Boundary, { label, resetKeys: [builder?.site, resetKey], onError: builder?.onError, children });
820
+ }
805
821
  function contextData(context) {
806
822
  if (typeof context !== "object" || context === null) return {};
807
823
  return Object.fromEntries(Object.entries(context).map(([key, value]) => [`context.${key}`, value]));
@@ -2024,6 +2040,14 @@ function createRendererRegistry(packs, options = {}) {
2024
2040
  // src/slot.tsx
2025
2041
  import { Suspense as Suspense3 } from "react";
2026
2042
  import { jsx as jsx24 } from "react/jsx-runtime";
2043
+ function contextKey(context) {
2044
+ if (typeof context !== "object" || context === null) return "";
2045
+ return Object.values(context).map((value) => {
2046
+ const record = typeof value === "object" && value !== null ? value : {};
2047
+ const id = record["id"] ?? record["handle"] ?? record["slug"];
2048
+ return typeof id === "string" || typeof id === "number" ? String(id) : "";
2049
+ }).join("|");
2050
+ }
2027
2051
  function BuilderSlot({ name, context }) {
2028
2052
  const builder = useBuilder();
2029
2053
  if (builder === null || builder.site.status !== "ok") return null;
@@ -2031,7 +2055,7 @@ function BuilderSlot({ name, context }) {
2031
2055
  if (part === void 0 || part.document.sections.length === 0) return null;
2032
2056
  return (
2033
2057
  // Suspense inside the boundary: see parts.tsx.
2034
- /* @__PURE__ */ jsx24(PartBoundary, { label: `Builder slot ${name}`, children: /* @__PURE__ */ jsx24("div", { "data-throttle-part": "builder-slot", "data-b-slot": name, children: /* @__PURE__ */ jsx24(Suspense3, { fallback: null, children: /* @__PURE__ */ jsx24(PartView, { part, context }) }) }) })
2058
+ /* @__PURE__ */ jsx24(PartBoundary, { label: `Builder slot ${name}`, resetKey: contextKey(context), children: /* @__PURE__ */ jsx24("div", { "data-throttle-part": "builder-slot", "data-b-slot": name, children: /* @__PURE__ */ jsx24(Suspense3, { fallback: null, children: /* @__PURE__ */ jsx24(PartView, { part, context }) }) }) })
2035
2059
  );
2036
2060
  }
2037
2061
 
@@ -2221,7 +2245,7 @@ var EMPTY = {};
2221
2245
  function useParentFont() {
2222
2246
  return useContext2(AppearanceContext)?.variables?.fontFamily;
2223
2247
  }
2224
- function BuilderProvider({ builderKey, client, packs, site, children }) {
2248
+ function BuilderProvider({ builderKey, client, packs, site, onError, children }) {
2225
2249
  const packsKey = packs.map((pack) => `${pack.id}@${pack.version}`).join("|");
2226
2250
  const registryRef = useRef2(null);
2227
2251
  if (registryRef.current?.key !== packsKey) {
@@ -2263,8 +2287,8 @@ function BuilderProvider({ builderKey, client, packs, site, children }) {
2263
2287
  [site]
2264
2288
  );
2265
2289
  const value = useMemo(
2266
- () => ({ client: builder, packs, registry, site, locale: site.locale, mediaOrigin, resolveLink }),
2267
- [builder, packs, registry, site, mediaOrigin, resolveLink]
2290
+ () => ({ client: builder, packs, registry, site, locale: site.locale, mediaOrigin, onError, resolveLink }),
2291
+ [builder, packs, registry, site, mediaOrigin, onError, resolveLink]
2268
2292
  );
2269
2293
  const design = useMemo(
2270
2294
  () => site.status === "ok" ? siteDesignOf(site.settings, resolveLink, pageOutlet, mediaOrigin) : null,
package/dist/next.cjs CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
 
6
6
 
7
- var _chunkWZOWM2I7cjs = require('./chunk-WZOWM2I7.cjs');
7
+ var _chunkZCXPIZU7cjs = require('./chunk-ZCXPIZU7.cjs');
8
8
 
9
9
  // src/next/index.ts
10
10
  var _react = require('react');
@@ -55,7 +55,7 @@ function createBuilderPage(options) {
55
55
  const slug = slugOf(options, params);
56
56
  const currency = await currencyOf(options, params);
57
57
  const { currency: _currency, ...rest } = options;
58
- const loaded = await _chunkWZOWM2I7cjs.loadBuilderPage.call(void 0, {
58
+ const loaded = await _chunkZCXPIZU7cjs.loadBuilderPage.call(void 0, {
59
59
  ...rest,
60
60
  slug,
61
61
  locale: await localeOf(options, params),
@@ -75,12 +75,12 @@ function createBuilderPage(options) {
75
75
  const params = await props.params;
76
76
  const slug = slugOf(options, params);
77
77
  const locale = await localeOf(options, params);
78
- const client = _chunkWZOWM2I7cjs.clientOf.call(void 0, options);
78
+ const client = _chunkZCXPIZU7cjs.clientOf.call(void 0, options);
79
79
  try {
80
- const bundle = await _chunkWZOWM2I7cjs.getBundle.call(void 0, { client, locale, page: slug, slots: options.slots });
80
+ const bundle = await _chunkZCXPIZU7cjs.getBundle.call(void 0, { client, locale, page: slug, slots: options.slots });
81
81
  const page = bundle.page;
82
- if (page === void 0 || _chunkWZOWM2I7cjs.isRedirect.call(void 0, page)) return {};
83
- return _chunkWZOWM2I7cjs.metadataOf.call(void 0, page, {
82
+ if (page === void 0 || _chunkZCXPIZU7cjs.isRedirect.call(void 0, page)) return {};
83
+ return _chunkZCXPIZU7cjs.metadataOf.call(void 0, page, {
84
84
  settings: bundle.site.settings,
85
85
  mediaOrigin: _nullishCoalesce(options.mediaOrigin, () => ( "")),
86
86
  storeUrl: options.storeUrl,
package/dist/next.js CHANGED
@@ -4,7 +4,7 @@ import {
4
4
  isRedirect,
5
5
  loadBuilderPage,
6
6
  metadataOf
7
- } from "./chunk-IBRAMTUT.js";
7
+ } from "./chunk-65KZ5CIP.js";
8
8
 
9
9
  // src/next/index.ts
10
10
  import { createElement } from "react";
package/dist/server.cjs CHANGED
@@ -12,25 +12,25 @@
12
12
 
13
13
 
14
14
 
15
- var _chunkWZOWM2I7cjs = require('./chunk-WZOWM2I7.cjs');
15
+ var _chunkZCXPIZU7cjs = require('./chunk-ZCXPIZU7.cjs');
16
16
 
17
17
  // src/server/load-site.ts
18
18
  var _builder = require('@usethrottle/builder');
19
19
  async function loadSite(options) {
20
20
  const { locale, slots = [], packs = [], page, mediaOrigin = "", currency } = options;
21
- const client = _chunkWZOWM2I7cjs.clientOf.call(void 0, options);
21
+ const client = _chunkZCXPIZU7cjs.clientOf.call(void 0, options);
22
22
  let bundle;
23
23
  try {
24
- bundle = await _chunkWZOWM2I7cjs.getBundle.call(void 0, { client, locale, slots, page });
24
+ bundle = await _chunkZCXPIZU7cjs.getBundle.call(void 0, { client, locale, slots, page });
25
25
  } catch (error) {
26
26
  if (!(error instanceof _builder.BuilderUnavailableError) || client.mode === "build") throw error;
27
- _chunkWZOWM2I7cjs.warnOnce.call(void 0, "site-unavailable", `The Builder could not be read (${error.reason}); the store renders without its Builder header, footer and slots`);
27
+ _chunkZCXPIZU7cjs.warnOnce.call(void 0, "site-unavailable", `The Builder could not be read (${error.reason}); the store renders without its Builder header, footer and slots`);
28
28
  return { status: "unavailable", locale };
29
29
  }
30
- const registry = _chunkWZOWM2I7cjs.createRendererRegistry.call(void 0, packs);
30
+ const registry = _chunkZCXPIZU7cjs.createRendererRegistry.call(void 0, packs);
31
31
  const names = Object.keys(bundle.slots);
32
32
  const documents = [bundle.header.document, bundle.footer.document, ...names.map((n) => bundle.slots[n].document)];
33
- const data = await _chunkWZOWM2I7cjs.staticDataFor.call(void 0, documents, registry, locale, currency);
33
+ const data = await _chunkZCXPIZU7cjs.staticDataFor.call(void 0, documents, registry, locale, currency);
34
34
  return {
35
35
  status: "ok",
36
36
  locale,
@@ -38,9 +38,9 @@ async function loadSite(options) {
38
38
  siteVersion: bundle.site.siteVersion,
39
39
  mediaOrigin,
40
40
  settings: bundle.site.settings,
41
- header: _chunkWZOWM2I7cjs.partOf.call(void 0, bundle.header, data),
42
- footer: _chunkWZOWM2I7cjs.partOf.call(void 0, bundle.footer, data),
43
- slots: Object.fromEntries(names.map((name) => [name, _chunkWZOWM2I7cjs.partOf.call(void 0, bundle.slots[name], data)]))
41
+ header: _chunkZCXPIZU7cjs.partOf.call(void 0, bundle.header, data),
42
+ footer: _chunkZCXPIZU7cjs.partOf.call(void 0, bundle.footer, data),
43
+ slots: Object.fromEntries(names.map((name) => [name, _chunkZCXPIZU7cjs.partOf.call(void 0, bundle.slots[name], data)]))
44
44
  };
45
45
  }
46
46
 
@@ -48,13 +48,13 @@ async function loadSite(options) {
48
48
 
49
49
  async function builderSitemap(options) {
50
50
  if (options.client === void 0 && (options.builderKey === void 0 || options.builderKey === "")) {
51
- _chunkWZOWM2I7cjs.warnOnce.call(void 0, "sitemap-no-key", "builderSitemap has no builderKey (is THROTTLE_BUILDER_KEY set?); the sitemap leaves out the Builder pages");
51
+ _chunkZCXPIZU7cjs.warnOnce.call(void 0, "sitemap-no-key", "builderSitemap has no builderKey (is THROTTLE_BUILDER_KEY set?); the sitemap leaves out the Builder pages");
52
52
  return [];
53
53
  }
54
- const client = _chunkWZOWM2I7cjs.clientOf.call(void 0, options);
55
- const origin = _chunkWZOWM2I7cjs.originOf.call(void 0, options.storeUrl);
54
+ const client = _chunkZCXPIZU7cjs.clientOf.call(void 0, options);
55
+ const origin = _chunkZCXPIZU7cjs.originOf.call(void 0, options.storeUrl);
56
56
  if (origin === void 0) {
57
- _chunkWZOWM2I7cjs.warnOnce.call(void 0, "sitemap-origin", "builderSitemap needs a storeUrl (https://shop.example.com) that is an http(s) origin. The Builder does not publish the store URL.");
57
+ _chunkZCXPIZU7cjs.warnOnce.call(void 0, "sitemap-origin", "builderSitemap needs a storeUrl (https://shop.example.com) that is an http(s) origin. The Builder does not publish the store URL.");
58
58
  return [];
59
59
  }
60
60
  const locale = _nullishCoalesce(options.locale, () => ( "en"));
@@ -62,16 +62,16 @@ async function builderSitemap(options) {
62
62
  const pages = await client.pages.list();
63
63
  const { settings } = await client.site({ locale });
64
64
  const indexable = await withoutNoindex(client, pages, locale);
65
- const { list } = _chunkWZOWM2I7cjs.siteLocales.call(void 0, settings);
65
+ const { list } = _chunkZCXPIZU7cjs.siteLocales.call(void 0, settings);
66
66
  const prefixes = options.localeRoute !== true ? [void 0] : list.length > 0 ? list : [locale];
67
67
  return indexable.flatMap((page) => {
68
- const path = _chunkWZOWM2I7cjs.pagePathOf.call(void 0, settings, page, options.pagePath);
68
+ const path = _chunkZCXPIZU7cjs.pagePathOf.call(void 0, settings, page, options.pagePath);
69
69
  if (path === null) return [];
70
- return prefixes.map((prefix) => ({ url: `${origin}${_chunkWZOWM2I7cjs.localized.call(void 0, path, prefix)}`, lastModified: new Date(page.updatedAt) }));
70
+ return prefixes.map((prefix) => ({ url: `${origin}${_chunkZCXPIZU7cjs.localized.call(void 0, path, prefix)}`, lastModified: new Date(page.updatedAt) }));
71
71
  });
72
72
  } catch (error) {
73
73
  if (!(error instanceof _builder.BuilderUnavailableError) || client.mode === "build") throw error;
74
- _chunkWZOWM2I7cjs.warnOnce.call(void 0, "sitemap-unavailable", `The Builder could not be read (${error.reason}); the sitemap leaves out its pages`);
74
+ _chunkZCXPIZU7cjs.warnOnce.call(void 0, "sitemap-unavailable", `The Builder could not be read (${error.reason}); the sitemap leaves out its pages`);
75
75
  return [];
76
76
  }
77
77
  }
@@ -85,14 +85,14 @@ async function withoutNoindex(client, pages, locale) {
85
85
  slice.map(
86
86
  (page) => client.pages.get(page.slug, { locale }).catch((error) => {
87
87
  if (error instanceof _builder.BuilderNotFoundError) return "gone";
88
- _chunkWZOWM2I7cjs.warnOnce.call(void 0, "sitemap-page-read", `A page could not be read for the sitemap (${error instanceof Error ? error.message : "unknown error"}); it stays listed`);
88
+ _chunkZCXPIZU7cjs.warnOnce.call(void 0, "sitemap-page-read", `A page could not be read for the sitemap (${error instanceof Error ? error.message : "unknown error"}); it stays listed`);
89
89
  return void 0;
90
90
  })
91
91
  )
92
92
  );
93
93
  slice.forEach((page, index) => {
94
94
  const answer = answers[index];
95
- if (answer === "gone" || answer !== void 0 && (_chunkWZOWM2I7cjs.isRedirect.call(void 0, answer) || _chunkWZOWM2I7cjs.pageSeoOf.call(void 0, answer).noindex)) skip.add(page.slug);
95
+ if (answer === "gone" || answer !== void 0 && (_chunkZCXPIZU7cjs.isRedirect.call(void 0, answer) || _chunkZCXPIZU7cjs.pageSeoOf.call(void 0, answer).noindex)) skip.add(page.slug);
96
96
  });
97
97
  }
98
98
  return pages.filter((page) => !skip.has(page.slug));
@@ -100,7 +100,7 @@ async function withoutNoindex(client, pages, locale) {
100
100
 
101
101
  // src/server/static-params.ts
102
102
  async function builderStaticParams(options) {
103
- const client = _chunkWZOWM2I7cjs.clientOf.call(void 0, options);
103
+ const client = _chunkZCXPIZU7cjs.clientOf.call(void 0, options);
104
104
  if (client.mode !== "build")
105
105
  throw new TypeError(
106
106
  'builderStaticParams generates every page of a frozen release: give it a client made with createBuilderClient({ mode: "build" }). A live store keeps its pages dynamic.'
@@ -119,4 +119,4 @@ async function builderStaticParams(options) {
119
119
 
120
120
 
121
121
 
122
- exports.BuilderNotFoundError = _builder.BuilderNotFoundError; exports.BuilderUnavailableError = _builder.BuilderUnavailableError; exports.builderSitemap = builderSitemap; exports.builderStaticParams = builderStaticParams; exports.getBundle = _chunkWZOWM2I7cjs.getBundle; exports.loadBuilderPage = _chunkWZOWM2I7cjs.loadBuilderPage; exports.loadSite = loadSite;
122
+ exports.BuilderNotFoundError = _builder.BuilderNotFoundError; exports.BuilderUnavailableError = _builder.BuilderUnavailableError; exports.builderSitemap = builderSitemap; exports.builderStaticParams = builderStaticParams; exports.getBundle = _chunkZCXPIZU7cjs.getBundle; exports.loadBuilderPage = _chunkZCXPIZU7cjs.loadBuilderPage; exports.loadSite = loadSite;
package/dist/server.js CHANGED
@@ -12,7 +12,7 @@ import {
12
12
  siteLocales,
13
13
  staticDataFor,
14
14
  warnOnce
15
- } from "./chunk-IBRAMTUT.js";
15
+ } from "./chunk-65KZ5CIP.js";
16
16
 
17
17
  // src/server/load-site.ts
18
18
  import { BuilderUnavailableError } from "@usethrottle/builder";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@usethrottle/builder-react",
3
- "version": "0.2.4",
3
+ "version": "0.3.0",
4
4
  "description": "Renders a published Throttle Builder page document as React in a merchant's store: responsive CSS, header, footer, slots and the site design provider.",
5
5
  "license": "MIT",
6
6
  "type": "module",
@@ -59,7 +59,7 @@
59
59
  "dependencies": {
60
60
  "@usethrottle/builder-schema": "^0.1.2",
61
61
  "@usethrottle/ui": "^0.1.2",
62
- "@usethrottle/builder": "^0.3.0"
62
+ "@usethrottle/builder": "^0.4.0"
63
63
  },
64
64
  "peerDependencies": {
65
65
  "next": ">=15",