@weaverse/hydrogen 2.2.5 → 2.4.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.
package/dist/index.d.mts CHANGED
@@ -1,5 +1,5 @@
1
- import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseCoreParams, WeaverseProjectDataType, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
2
- export { WeaverseImage } from '@weaverse/react';
1
+ import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseCoreParams, WeaverseProjectDataType, WeaverseResourcePickerData, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
2
+ export { WeaverseImage, useItemInstance, useWeaverse } from '@weaverse/react';
3
3
  import { NavigateFunction } from '@remix-run/react';
4
4
  import { createWithCache, Storefront } from '@shopify/hydrogen';
5
5
  import { LanguageCode, CountryCode, CurrencyCode } from '@shopify/hydrogen/storefront-api-types';
@@ -56,6 +56,8 @@ declare class WeaverseClient {
56
56
  countries?: WeaverseClientArgs['countries'];
57
57
  constructor(args: WeaverseClientArgs);
58
58
  fetchWithCache: <T>(url: string, options: FetchWithCacheOptions) => Promise<T>;
59
+ incrementCacheHits: () => Promise<string>;
60
+ resetCacheHits: () => Promise<void>;
59
61
  loadThemeSettings: (strategy?: AllCacheOptions) => Promise<any>;
60
62
  loadPage: (params?: LoadPageParams) => Promise<WeaverseLoaderData | null>;
61
63
  execComponentLoader: (item: HydrogenComponentData) => Promise<HydrogenComponentData>;
@@ -77,9 +79,7 @@ interface AllCacheOptions {
77
79
  sMaxAge?: number;
78
80
  staleIfError?: number;
79
81
  }
80
- type ComponentLoaderArgs<T = {
81
- [key: string]: any;
82
- }> = {
82
+ type ComponentLoaderArgs<T = any> = {
83
83
  data: T;
84
84
  weaverse: WeaverseClient;
85
85
  };
@@ -256,7 +256,6 @@ type LoadPageParams = PageAssignmentParams & {
256
256
  type FetchProjectRequestBody = {
257
257
  projectId: string;
258
258
  url: string;
259
- countries?: Localizations;
260
259
  i18n?: I18nLocale;
261
260
  params?: PageAssignmentParams;
262
261
  isDesignMode?: boolean;
@@ -294,6 +293,10 @@ type RootRouteData = {
294
293
  };
295
294
  [key: string]: any;
296
295
  };
296
+ type WeaverseProduct = WeaverseResourcePickerData;
297
+ type WeaverseCollection = WeaverseResourcePickerData;
298
+ type WeaverseBlog = WeaverseResourcePickerData;
299
+ type WeaverseArticle = WeaverseResourcePickerData;
297
300
  declare global {
298
301
  interface Window {
299
302
  __weaverse: WeaverseHydrogen;
@@ -316,11 +319,10 @@ declare class WeaverseHydrogen extends Weaverse {
316
319
  requestInfo: WeaverseLoaderRequestInfo;
317
320
  ItemConstructor: typeof WeaverseHydrogenItem;
318
321
  data: HydrogenPageData;
319
- itemInstances: Map<string | number, WeaverseHydrogenItem>;
320
- elementRegistry: Map<string, HydrogenElement>;
322
+ static itemInstances: Map<string, WeaverseHydrogenItem>;
323
+ static elementRegistry: Map<string, HydrogenElement>;
321
324
  constructor(params: WeaverseHydrogenParams, components: HydrogenComponent[]);
322
- registerElement(element: HydrogenElement): void;
323
- registerComponents(components: HydrogenComponent[]): void;
325
+ registerComponents: (components: HydrogenComponent[]) => void;
324
326
  }
325
327
  declare class WeaverseHydrogenItem extends WeaverseItemStore {
326
328
  weaverse: WeaverseHydrogen;
@@ -330,4 +332,4 @@ declare class WeaverseHydrogenItem extends WeaverseItemStore {
330
332
  set data(update: HydrogenComponentData);
331
333
  }
332
334
 
333
- export { AllCacheOptions, ComponentLoaderArgs, FetchProjectPayload, FetchProjectRequestBody, FetchWithCacheOptions, HydrogenComponent, HydrogenComponentData, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeEnv, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenThemeSettings, HydrogenToolbarAction, I18nLocale, InspectorGroup, LoadPageParams, Locale, Localizations, PageAssignmentParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseClient, WeaverseClientArgs, WeaverseHydrogen, WeaverseHydrogenItem, WeaverseHydrogenParams, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, useThemeSettings, withWeaverse };
335
+ export { AllCacheOptions, ComponentLoaderArgs, FetchProjectPayload, FetchProjectRequestBody, FetchWithCacheOptions, HydrogenComponent, HydrogenComponentData, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeEnv, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenThemeSettings, HydrogenToolbarAction, I18nLocale, InspectorGroup, LoadPageParams, Locale, Localizations, PageAssignmentParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseArticle, WeaverseBlog, WeaverseClient, WeaverseClientArgs, WeaverseCollection, WeaverseHydrogen, WeaverseHydrogenItem, WeaverseHydrogenParams, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProduct, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, useThemeSettings, withWeaverse };
package/dist/index.d.ts CHANGED
@@ -1,5 +1,5 @@
1
- import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseCoreParams, WeaverseProjectDataType, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
2
- export { WeaverseImage } from '@weaverse/react';
1
+ import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseCoreParams, WeaverseProjectDataType, WeaverseResourcePickerData, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
2
+ export { WeaverseImage, useItemInstance, useWeaverse } from '@weaverse/react';
3
3
  import { NavigateFunction } from '@remix-run/react';
4
4
  import { createWithCache, Storefront } from '@shopify/hydrogen';
5
5
  import { LanguageCode, CountryCode, CurrencyCode } from '@shopify/hydrogen/storefront-api-types';
@@ -56,6 +56,8 @@ declare class WeaverseClient {
56
56
  countries?: WeaverseClientArgs['countries'];
57
57
  constructor(args: WeaverseClientArgs);
58
58
  fetchWithCache: <T>(url: string, options: FetchWithCacheOptions) => Promise<T>;
59
+ incrementCacheHits: () => Promise<string>;
60
+ resetCacheHits: () => Promise<void>;
59
61
  loadThemeSettings: (strategy?: AllCacheOptions) => Promise<any>;
60
62
  loadPage: (params?: LoadPageParams) => Promise<WeaverseLoaderData | null>;
61
63
  execComponentLoader: (item: HydrogenComponentData) => Promise<HydrogenComponentData>;
@@ -77,9 +79,7 @@ interface AllCacheOptions {
77
79
  sMaxAge?: number;
78
80
  staleIfError?: number;
79
81
  }
80
- type ComponentLoaderArgs<T = {
81
- [key: string]: any;
82
- }> = {
82
+ type ComponentLoaderArgs<T = any> = {
83
83
  data: T;
84
84
  weaverse: WeaverseClient;
85
85
  };
@@ -256,7 +256,6 @@ type LoadPageParams = PageAssignmentParams & {
256
256
  type FetchProjectRequestBody = {
257
257
  projectId: string;
258
258
  url: string;
259
- countries?: Localizations;
260
259
  i18n?: I18nLocale;
261
260
  params?: PageAssignmentParams;
262
261
  isDesignMode?: boolean;
@@ -294,6 +293,10 @@ type RootRouteData = {
294
293
  };
295
294
  [key: string]: any;
296
295
  };
296
+ type WeaverseProduct = WeaverseResourcePickerData;
297
+ type WeaverseCollection = WeaverseResourcePickerData;
298
+ type WeaverseBlog = WeaverseResourcePickerData;
299
+ type WeaverseArticle = WeaverseResourcePickerData;
297
300
  declare global {
298
301
  interface Window {
299
302
  __weaverse: WeaverseHydrogen;
@@ -316,11 +319,10 @@ declare class WeaverseHydrogen extends Weaverse {
316
319
  requestInfo: WeaverseLoaderRequestInfo;
317
320
  ItemConstructor: typeof WeaverseHydrogenItem;
318
321
  data: HydrogenPageData;
319
- itemInstances: Map<string | number, WeaverseHydrogenItem>;
320
- elementRegistry: Map<string, HydrogenElement>;
322
+ static itemInstances: Map<string, WeaverseHydrogenItem>;
323
+ static elementRegistry: Map<string, HydrogenElement>;
321
324
  constructor(params: WeaverseHydrogenParams, components: HydrogenComponent[]);
322
- registerElement(element: HydrogenElement): void;
323
- registerComponents(components: HydrogenComponent[]): void;
325
+ registerComponents: (components: HydrogenComponent[]) => void;
324
326
  }
325
327
  declare class WeaverseHydrogenItem extends WeaverseItemStore {
326
328
  weaverse: WeaverseHydrogen;
@@ -330,4 +332,4 @@ declare class WeaverseHydrogenItem extends WeaverseItemStore {
330
332
  set data(update: HydrogenComponentData);
331
333
  }
332
334
 
333
- export { AllCacheOptions, ComponentLoaderArgs, FetchProjectPayload, FetchProjectRequestBody, FetchWithCacheOptions, HydrogenComponent, HydrogenComponentData, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeEnv, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenThemeSettings, HydrogenToolbarAction, I18nLocale, InspectorGroup, LoadPageParams, Locale, Localizations, PageAssignmentParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseClient, WeaverseClientArgs, WeaverseHydrogen, WeaverseHydrogenItem, WeaverseHydrogenParams, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, useThemeSettings, withWeaverse };
335
+ export { AllCacheOptions, ComponentLoaderArgs, FetchProjectPayload, FetchProjectRequestBody, FetchWithCacheOptions, HydrogenComponent, HydrogenComponentData, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeEnv, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenThemeSettings, HydrogenToolbarAction, I18nLocale, InspectorGroup, LoadPageParams, Locale, Localizations, PageAssignmentParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseArticle, WeaverseBlog, WeaverseClient, WeaverseClientArgs, WeaverseCollection, WeaverseHydrogen, WeaverseHydrogenItem, WeaverseHydrogenParams, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProduct, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, useThemeSettings, withWeaverse };