@weaverse/hydrogen 5.12.1 → 5.13.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/dist/index.d.mts CHANGED
@@ -131,6 +131,8 @@ declare function ThemeTextProvider({ staticContent, merchantOverrides, t: extern
131
131
  */
132
132
  declare function useThemeText(): ThemeTextValue;
133
133
 
134
+ type WeaverseDataValue = WeaverseLoaderData | Promise<WeaverseLoaderData> | null;
135
+
134
136
  declare class WeaverseHydrogenItem extends WeaverseItemStore {
135
137
  weaverse: WeaverseHydrogen;
136
138
  /**
@@ -226,12 +228,22 @@ declare class WeaverseHydrogen extends Weaverse {
226
228
  * ```
227
229
  */
228
230
  declare function registerComponent(element: HydrogenElement): void;
229
- declare const WeaverseHydrogenRoot: React$1.MemoExoticComponent<({ components, errorComponent: ErrorComponent, }: {
231
+ declare const WeaverseHydrogenRoot: React$1.MemoExoticComponent<({ components, data: dataProp, errorComponent: ErrorComponent, }: {
230
232
  components: HydrogenComponent[];
233
+ /**
234
+ * Optional explicit `weaverseData` payload. When provided, bypasses the
235
+ * automatic route-scoped resolution. Accepts a resolved value, a
236
+ * `Promise` (handled via `<Await>`), or `null` to suppress rendering.
237
+ *
238
+ * Recommended for nested layout + child route compositions where two
239
+ * `<WeaverseHydrogenRoot>` instances need to render different Weaverse
240
+ * pages on the same URL. See issue #451.
241
+ */
242
+ data?: WeaverseDataValue;
231
243
  errorComponent?: React.FC<{
232
244
  error: Error | unknown;
233
245
  }>;
234
- }) => react_jsx_runtime.JSX.Element>;
246
+ }) => react_jsx_runtime.JSX.Element | null>;
235
247
  /**
236
248
  * Options for the `withWeaverse` HOC.
237
249
  */
@@ -431,6 +443,14 @@ declare class WeaverseClient {
431
443
  * @returns HydrogenPageData with single main component containing the message
432
444
  */
433
445
  generateFallbackPage: (message: string) => HydrogenPageData;
446
+ /**
447
+ * Fetch all published custom pages for sitemap generation.
448
+ * Paginates automatically, never throws, returns accumulated results on partial failure.
449
+ */
450
+ fetchCustomPages(opts?: {
451
+ locale?: string;
452
+ limit?: number;
453
+ }): Promise<CustomPageEntry[]>;
434
454
  /**
435
455
  * Load page data from Weaverse API with optional route-level project override.
436
456
  * Fetches page content, executes component loaders, and handles empty items fallback.
@@ -816,6 +836,14 @@ type ProjectIdValidationResult = {
816
836
  valid: boolean;
817
837
  error?: string;
818
838
  };
839
+ interface CustomPageEntry {
840
+ changeFrequency?: 'daily' | 'weekly' | 'monthly';
841
+ handle: string;
842
+ lastModified: string;
843
+ locale: string | null;
844
+ path: string;
845
+ priority?: number;
846
+ }
819
847
  /**
820
848
  * Type guards for response validation
821
849
  */
@@ -1127,4 +1155,4 @@ declare const IMAGES_PLACEHOLDERS: {
1127
1155
  product_18: string;
1128
1156
  };
1129
1157
 
1130
- export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };
1158
+ export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type CustomPageEntry, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };
package/dist/index.d.ts CHANGED
@@ -131,6 +131,8 @@ declare function ThemeTextProvider({ staticContent, merchantOverrides, t: extern
131
131
  */
132
132
  declare function useThemeText(): ThemeTextValue;
133
133
 
134
+ type WeaverseDataValue = WeaverseLoaderData | Promise<WeaverseLoaderData> | null;
135
+
134
136
  declare class WeaverseHydrogenItem extends WeaverseItemStore {
135
137
  weaverse: WeaverseHydrogen;
136
138
  /**
@@ -226,12 +228,22 @@ declare class WeaverseHydrogen extends Weaverse {
226
228
  * ```
227
229
  */
228
230
  declare function registerComponent(element: HydrogenElement): void;
229
- declare const WeaverseHydrogenRoot: React$1.MemoExoticComponent<({ components, errorComponent: ErrorComponent, }: {
231
+ declare const WeaverseHydrogenRoot: React$1.MemoExoticComponent<({ components, data: dataProp, errorComponent: ErrorComponent, }: {
230
232
  components: HydrogenComponent[];
233
+ /**
234
+ * Optional explicit `weaverseData` payload. When provided, bypasses the
235
+ * automatic route-scoped resolution. Accepts a resolved value, a
236
+ * `Promise` (handled via `<Await>`), or `null` to suppress rendering.
237
+ *
238
+ * Recommended for nested layout + child route compositions where two
239
+ * `<WeaverseHydrogenRoot>` instances need to render different Weaverse
240
+ * pages on the same URL. See issue #451.
241
+ */
242
+ data?: WeaverseDataValue;
231
243
  errorComponent?: React.FC<{
232
244
  error: Error | unknown;
233
245
  }>;
234
- }) => react_jsx_runtime.JSX.Element>;
246
+ }) => react_jsx_runtime.JSX.Element | null>;
235
247
  /**
236
248
  * Options for the `withWeaverse` HOC.
237
249
  */
@@ -431,6 +443,14 @@ declare class WeaverseClient {
431
443
  * @returns HydrogenPageData with single main component containing the message
432
444
  */
433
445
  generateFallbackPage: (message: string) => HydrogenPageData;
446
+ /**
447
+ * Fetch all published custom pages for sitemap generation.
448
+ * Paginates automatically, never throws, returns accumulated results on partial failure.
449
+ */
450
+ fetchCustomPages(opts?: {
451
+ locale?: string;
452
+ limit?: number;
453
+ }): Promise<CustomPageEntry[]>;
434
454
  /**
435
455
  * Load page data from Weaverse API with optional route-level project override.
436
456
  * Fetches page content, executes component loaders, and handles empty items fallback.
@@ -816,6 +836,14 @@ type ProjectIdValidationResult = {
816
836
  valid: boolean;
817
837
  error?: string;
818
838
  };
839
+ interface CustomPageEntry {
840
+ changeFrequency?: 'daily' | 'weekly' | 'monthly';
841
+ handle: string;
842
+ lastModified: string;
843
+ locale: string | null;
844
+ path: string;
845
+ priority?: number;
846
+ }
819
847
  /**
820
848
  * Type guards for response validation
821
849
  */
@@ -1127,4 +1155,4 @@ declare const IMAGES_PLACEHOLDERS: {
1127
1155
  product_18: string;
1128
1156
  };
1129
1157
 
1130
- export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };
1158
+ export { type CacheResponseValidator, type ComponentDataValue, type ComponentLoaderArgs, type CreateHydrogenSchemaOptions, type CustomPageEntry, type DirectFetchResponse, type FetchProjectPayload, type FetchProjectRequestBody, type HydrogenComponent, type HydrogenComponentData, type HydrogenComponentPresets, type HydrogenComponentProps, type HydrogenComponentSchema, type HydrogenElement, type HydrogenPageAssignment, type HydrogenPageData, type HydrogenProjectType, type HydrogenSchemaValidationResult, type HydrogenThemeSchema, type HydrogenThemeSettings, IMAGES_PLACEHOLDERS, type LoadPageParams, type ProjectIdValidationResult, type ProjectIdValue, type PublicEnv, type RouteLoaderArgs, type ThemeSettingsResponse, ThemeTextProvider, type ThemeTextProviderProps, ThemeTextStore, type ThemeTextValue, type TranslateFunction, type TranslationChanges, type TranslationEntry, type TranslationItemEntry, type TranslationMap, type TranslationMapEntry, type WeaverseArticle, type WeaverseBlog, WeaverseClient, type WeaverseClientArgs, type WeaverseCollection, type WeaverseDataContext, WeaverseError, WeaverseHydrogen, WeaverseHydrogenItem, type WeaverseHydrogenParams, WeaverseHydrogenRoot, type WeaverseI18n, type WeaverseInternal, type WeaverseLoaderData, type WeaverseLoaderRequestInfo, type WeaverseMetaObject, type WeaverseProduct, type WeaverseProjectConfigs, type WeaverseStudioQueries, type WithCacheFetchResponse, type WithWeaverseOptions, createWeaverseDataContext, defaultComponents, generateDataFromSchema, getNestedKey, getPreviewData, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, hasError, hasWeaverseStudio, interpolate, isFetchProjectPayload, isProjectIdFunction, isThemeSettingsResponse, isValidHydrogenSchema, isWithCacheFetchResponse, registerComponent, useThemeSettings, useThemeText, useWeaverseDataContext, withWeaverse };
package/dist/index.js CHANGED
@@ -417,6 +417,29 @@ var ThemeTextStore = class {
417
417
  }
418
418
  };
419
419
  };
420
+
421
+ // src/utils/pick-weaverse-data.ts
422
+ function pickWeaverseData(dataProp, ownLoaderData, matches) {
423
+ if (dataProp !== void 0) {
424
+ return dataProp;
425
+ }
426
+ if (hasWeaverseData(ownLoaderData)) {
427
+ return ownLoaderData.weaverseData;
428
+ }
429
+ for (let i = matches.length - 1; i >= 0; i--) {
430
+ const loaderData = matches[i].loaderData;
431
+ if (hasWeaverseData(loaderData)) {
432
+ return loaderData.weaverseData;
433
+ }
434
+ }
435
+ return null;
436
+ }
437
+ function hasWeaverseData(value) {
438
+ if (typeof value !== "object" || value === null || !("weaverseData" in value)) {
439
+ return false;
440
+ }
441
+ return value.weaverseData !== void 0;
442
+ }
420
443
  var ThemeSettingsStore = class {
421
444
  settings = {};
422
445
  schema;
@@ -709,7 +732,7 @@ var WeaverseHydrogen = class extends react.Weaverse {
709
732
  const entries = [];
710
733
  const languageId = this.translationLanguageId;
711
734
  if (!(this.translationLocale && languageId)) {
712
- return void 0;
735
+ return;
713
736
  }
714
737
  for (const [itemId, fields] of Object.entries(this.translationMap)) {
715
738
  for (const [key, entry] of Object.entries(fields)) {
@@ -722,7 +745,7 @@ var WeaverseHydrogen = class extends react.Weaverse {
722
745
  }
723
746
  }
724
747
  if (entries.length === 0) {
725
- return void 0;
748
+ return;
726
749
  }
727
750
  return { languageId, entries };
728
751
  };
@@ -786,20 +809,19 @@ function registerComponent(element) {
786
809
  var WeaverseHydrogenRoot = react$1.memo(
787
810
  ({
788
811
  components,
812
+ data: dataProp,
789
813
  errorComponent: ErrorComponent = ({ error }) => /* @__PURE__ */ jsxRuntime.jsx("div", { children: error instanceof Error ? error.message : "An unexpected error occurred" })
790
814
  }) => {
791
815
  const matches = reactRouter.useMatches();
792
816
  const enhancedDataContext = createWeaverseDataContext(matches);
793
- const weaverseData = react$1.useMemo(() => {
794
- for (let i = matches.length - 1; i >= 0; i--) {
795
- const match = matches[i];
796
- const loaderData = match.loaderData;
797
- if (loaderData && "weaverseData" in loaderData) {
798
- return loaderData.weaverseData;
799
- }
800
- }
817
+ const ownLoaderData = reactRouter.useLoaderData();
818
+ const weaverseData = react$1.useMemo(
819
+ () => pickWeaverseData(dataProp, ownLoaderData, matches),
820
+ [dataProp, ownLoaderData, matches]
821
+ );
822
+ if (dataProp === null) {
801
823
  return null;
802
- }, [matches]);
824
+ }
803
825
  if (weaverseData) {
804
826
  if (weaverseData instanceof Promise) {
805
827
  return /* @__PURE__ */ jsxRuntime.jsx(reactErrorBoundary.ErrorBoundary, { fallbackRender: ErrorComponent, children: /* @__PURE__ */ jsxRuntime.jsx(react$1.Suspense, { children: /* @__PURE__ */ jsxRuntime.jsx(reactRouter.Await, { resolve: weaverseData, children: (resolvedData) => /* @__PURE__ */ jsxRuntime.jsx(
@@ -1355,7 +1377,7 @@ var WeaverseClient = class {
1355
1377
  const { projectId, weaverseHost } = this.configs;
1356
1378
  const i18n = this.storefront.i18n;
1357
1379
  if (!(projectId && weaverseHost)) {
1358
- return void 0;
1380
+ return;
1359
1381
  }
1360
1382
  const language = (i18n?.language || "en").toLowerCase();
1361
1383
  const country = (i18n?.country || "us").toLowerCase();
@@ -1374,13 +1396,13 @@ var WeaverseClient = class {
1374
1396
  if (typeof overrides === "object" && overrides !== null) {
1375
1397
  return overrides;
1376
1398
  }
1377
- return void 0;
1399
+ return;
1378
1400
  } catch (error) {
1379
1401
  console.warn(
1380
1402
  "Unable to load merchant overrides, using theme defaults:",
1381
1403
  this.extractErrorMessage(error)
1382
1404
  );
1383
- return void 0;
1405
+ return;
1384
1406
  }
1385
1407
  };
1386
1408
  /**
@@ -1405,6 +1427,49 @@ var WeaverseClient = class {
1405
1427
  ]
1406
1428
  };
1407
1429
  };
1430
+ /**
1431
+ * Fetch all published custom pages for sitemap generation.
1432
+ * Paginates automatically, never throws, returns accumulated results on partial failure.
1433
+ */
1434
+ async fetchCustomPages(opts) {
1435
+ const { weaverseHost, projectId } = this.configs;
1436
+ const entries = [];
1437
+ const MAX_PAGES = 100;
1438
+ let cursor = null;
1439
+ for (let i = 0; i < MAX_PAGES; i++) {
1440
+ const params = new URLSearchParams();
1441
+ if (opts?.locale) {
1442
+ params.set("locale", opts.locale);
1443
+ }
1444
+ if (opts?.limit) {
1445
+ params.set("limit", String(opts.limit));
1446
+ }
1447
+ if (cursor) {
1448
+ params.set("cursor", cursor);
1449
+ }
1450
+ const qs = params.toString();
1451
+ const url = `${weaverseHost}/api/public/v1/projects/${projectId}/custom-pages${qs ? `?${qs}` : ""}`;
1452
+ try {
1453
+ const result = await this.fetchWithCache(url);
1454
+ entries.push(...result.data || []);
1455
+ if (!result.nextCursor) {
1456
+ return entries;
1457
+ }
1458
+ cursor = result.nextCursor;
1459
+ } catch (err) {
1460
+ const status = err?.status;
1461
+ const msg = err?.message || String(err);
1462
+ console.warn(
1463
+ entries.length === 0 ? `[Weaverse] Failed to fetch custom pages: ${msg}${status ? ` (HTTP ${status})` : ""}` : `[Weaverse] Custom pages pagination interrupted: ${msg}`
1464
+ );
1465
+ return entries;
1466
+ }
1467
+ }
1468
+ console.warn(
1469
+ "[Weaverse] Custom pages pagination cap reached (100 iterations)"
1470
+ );
1471
+ return entries;
1472
+ }
1408
1473
  /**
1409
1474
  * Load page data from Weaverse API with optional route-level project override.
1410
1475
  * Fetches page content, executes component loaders, and handles empty items fallback.
@@ -1516,7 +1581,9 @@ var WeaverseClient = class {
1516
1581
  };
1517
1582
  }
1518
1583
  if (!page) {
1519
- page = this.generateFallbackPage("Please add new section to start.");
1584
+ page = this.generateFallbackPage(
1585
+ '<div style="text-align: center;">Please add new section to start.</div>'
1586
+ );
1520
1587
  }
1521
1588
  if (page?.items?.length === 0) {
1522
1589
  page.items.push({