@weaverse/hydrogen 1.1.7 → 1.1.8

package/dist/index.d.mts

@@ -1,8 +1,9 @@
 import React, { ForwardRefExoticComponent } from 'react';
 import { LoaderArgs, AppLoadContext } from '@shopify/remix-oxygen';
-import { ElementData, ElementSchema, BasicInput, WeaverseElement, Weaverse, WeaverseItemStore } from '@weaverse/react';
+import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseItemStore, Weaverse } from '@weaverse/react';
 export * from '@weaverse/react';
 import { LanguageCode, CountryCode, CurrencyCode } from '@shopify/hydrogen/storefront-api-types';
+import { NavigateFunction } from '@remix-run/react';
 import * as _shopify_hydrogen_react_storefront_api_types from '@shopify/hydrogen-react/storefront-api-types';
 
 declare let STORE_PAGES: {
@@ -89,7 +90,8 @@ type WeaverseLoaderRequestInfo = {
     queries: Record<string, string | boolean>;
     i18n: I18nLocale;
 };
-interface WeaverseHydrogen extends Omit<Weaverse, 'itemInstances' | 'elementInstances' | 'registerElement' | 'data'> {
+type WeaverseCore = Omit<Weaverse, 'itemInstances' | 'elementInstances' | 'registerElement' | 'data'>;
+interface WeaverseHydrogen extends WeaverseCore {
     itemInstances: Map<string | number, HydrogenComponentInstance>;
     elementInstances: Map<string, HydrogenElement>;
     registerElement(element: HydrogenElement): void;
@@ -122,7 +124,7 @@ type WeaverseInternal = {
     pageAssignment: HydrogenPageAssignment;
     project: HydrogenProjectType;
     navigate: NavigateFunction;
-    revalidator: TODO;
+    revalidate: () => void;
 };
 type HydrogenComponentPresets = {
     type: string;
@@ -133,6 +135,13 @@ interface HydrogenElement {
     Component: ForwardRefExoticComponent<HydrogenComponentProps>;
     type: string;
     schema?: HydrogenComponentSchema;
+    loader?: HydrogenComponentLoaderFunction;
+}
+interface WeaverseHydrogenInit extends HydrogenPageConfigs {
+    data: HydrogenPageData;
+    pageId: string;
+    platformType: 'shopify-hydrogen';
+    internal: Partial<WeaverseInternal>;
 }
 interface HydrogenComponentInstance extends Omit<WeaverseItemStore, '_flags' | 'data' | 'Element'> {
     get _element(): HTMLElement | null;
@@ -140,18 +149,24 @@ interface HydrogenComponentInstance extends Omit<WeaverseItemStore, '_flags' | '
     get data(): HydrogenComponentData;
     _store: HydrogenComponentData;
 }
+type HydrogenComponentLoaderFunction = (args: WeaverseLoaderArgs) => Promise<unknown>;
 interface HydrogenComponent<T extends HydrogenComponentProps = any> {
     default: ForwardRefExoticComponent<T>;
     schema: HydrogenComponentSchema;
-    loader?: (args: WeaverseLoaderArgs) => Promise<unknown>;
+    loader?: HydrogenComponentLoaderFunction;
 }
+type WeaverseStudioQueries = {
+    weaverseProjectId: string;
+    weaverseHost: string;
+    weaverseVersion: string;
+    isDesignMode: boolean;
+};
 type HydrogenPageConfigs = {
     projectId: string;
     weaverseHost: string;
     weaverseVersion?: string;
     isDesignMode?: boolean;
     requestInfo: WeaverseLoaderRequestInfo;
-    [key: string]: any;
 };
 type HydrogenPageAssignment = {
     projectId: string;
@@ -172,20 +187,6 @@ type HydrogenPageData = {
     items: HydrogenComponentData[];
     [key: string]: any;
 };
-type RelativeRoutingType = 'route' | 'path';
-type To = string | Partial<Path>;
-type Path = {
-    pathname: string;
-    search: string;
-    hash: string;
-};
-type NavigateOptions = {
-    replace?: boolean;
-    state?: any;
-    preventScrollReset?: boolean;
-    relative?: RelativeRoutingType;
-};
-type NavigateFunction = (to: To, options?: NavigateOptions) => void;
 interface WeaverseHydrogenRootProps {
     components: HydrogenComponent[];
     countries: Localizations;
@@ -250,4 +251,4 @@ declare function useThemeSettings(): (Record<string, any> | ((newSettings: any)
 
 declare function WeaverseHydrogenRoot({ errorComponent: ErrorComponent, ...themeConfigs }: WeaverseHydrogenRootProps): React.JSX.Element;
 
-export { FetchProjectRequestBody, HydrogenComponent, HydrogenComponentData, HydrogenComponentInstance, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenToolbarAction, I18nLocale, InspectorGroup, Locale, Localizations, NavigateFunction, PageType, TODO, WeaverseHydrogen, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderArgs, WeaverseLoaderConfigs, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseStorefrontData, WeaverseThemeConfigs, fetchWithServerCache, getRequestQueries, getSelectedProductOptions, useThemeSettings, weaverseLoader };
+export { FetchProjectRequestBody, HydrogenComponent, HydrogenComponentData, HydrogenComponentInstance, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenToolbarAction, I18nLocale, InspectorGroup, Locale, Localizations, PageType, TODO, WeaverseHydrogen, WeaverseHydrogenInit, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderArgs, WeaverseLoaderConfigs, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, fetchWithServerCache, getRequestQueries, getSelectedProductOptions, useThemeSettings, weaverseLoader };

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 import React, { ForwardRefExoticComponent } from 'react';
 import { LoaderArgs, AppLoadContext } from '@shopify/remix-oxygen';
-import { ElementData, ElementSchema, BasicInput, WeaverseElement, Weaverse, WeaverseItemStore } from '@weaverse/react';
+import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseItemStore, Weaverse } from '@weaverse/react';
 export * from '@weaverse/react';
 import { LanguageCode, CountryCode, CurrencyCode } from '@shopify/hydrogen/storefront-api-types';
+import { NavigateFunction } from '@remix-run/react';
 import * as _shopify_hydrogen_react_storefront_api_types from '@shopify/hydrogen-react/storefront-api-types';
 
 declare let STORE_PAGES: {
@@ -89,7 +90,8 @@ type WeaverseLoaderRequestInfo = {
     queries: Record<string, string | boolean>;
     i18n: I18nLocale;
 };
-interface WeaverseHydrogen extends Omit<Weaverse, 'itemInstances' | 'elementInstances' | 'registerElement' | 'data'> {
+type WeaverseCore = Omit<Weaverse, 'itemInstances' | 'elementInstances' | 'registerElement' | 'data'>;
+interface WeaverseHydrogen extends WeaverseCore {
     itemInstances: Map<string | number, HydrogenComponentInstance>;
     elementInstances: Map<string, HydrogenElement>;
     registerElement(element: HydrogenElement): void;
@@ -122,7 +124,7 @@ type WeaverseInternal = {
     pageAssignment: HydrogenPageAssignment;
     project: HydrogenProjectType;
     navigate: NavigateFunction;
-    revalidator: TODO;
+    revalidate: () => void;
 };
 type HydrogenComponentPresets = {
     type: string;
@@ -133,6 +135,13 @@ interface HydrogenElement {
     Component: ForwardRefExoticComponent<HydrogenComponentProps>;
     type: string;
     schema?: HydrogenComponentSchema;
+    loader?: HydrogenComponentLoaderFunction;
+}
+interface WeaverseHydrogenInit extends HydrogenPageConfigs {
+    data: HydrogenPageData;
+    pageId: string;
+    platformType: 'shopify-hydrogen';
+    internal: Partial<WeaverseInternal>;
 }
 interface HydrogenComponentInstance extends Omit<WeaverseItemStore, '_flags' | 'data' | 'Element'> {
     get _element(): HTMLElement | null;
@@ -140,18 +149,24 @@ interface HydrogenComponentInstance extends Omit<WeaverseItemStore, '_flags' | '
     get data(): HydrogenComponentData;
     _store: HydrogenComponentData;
 }
+type HydrogenComponentLoaderFunction = (args: WeaverseLoaderArgs) => Promise<unknown>;
 interface HydrogenComponent<T extends HydrogenComponentProps = any> {
     default: ForwardRefExoticComponent<T>;
     schema: HydrogenComponentSchema;
-    loader?: (args: WeaverseLoaderArgs) => Promise<unknown>;
+    loader?: HydrogenComponentLoaderFunction;
 }
+type WeaverseStudioQueries = {
+    weaverseProjectId: string;
+    weaverseHost: string;
+    weaverseVersion: string;
+    isDesignMode: boolean;
+};
 type HydrogenPageConfigs = {
     projectId: string;
     weaverseHost: string;
     weaverseVersion?: string;
     isDesignMode?: boolean;
     requestInfo: WeaverseLoaderRequestInfo;
-    [key: string]: any;
 };
 type HydrogenPageAssignment = {
     projectId: string;
@@ -172,20 +187,6 @@ type HydrogenPageData = {
     items: HydrogenComponentData[];
     [key: string]: any;
 };
-type RelativeRoutingType = 'route' | 'path';
-type To = string | Partial<Path>;
-type Path = {
-    pathname: string;
-    search: string;
-    hash: string;
-};
-type NavigateOptions = {
-    replace?: boolean;
-    state?: any;
-    preventScrollReset?: boolean;
-    relative?: RelativeRoutingType;
-};
-type NavigateFunction = (to: To, options?: NavigateOptions) => void;
 interface WeaverseHydrogenRootProps {
     components: HydrogenComponent[];
     countries: Localizations;
@@ -250,4 +251,4 @@ declare function useThemeSettings(): (Record<string, any> | ((newSettings: any)
 
 declare function WeaverseHydrogenRoot({ errorComponent: ErrorComponent, ...themeConfigs }: WeaverseHydrogenRootProps): React.JSX.Element;
 
-export { FetchProjectRequestBody, HydrogenComponent, HydrogenComponentData, HydrogenComponentInstance, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenToolbarAction, I18nLocale, InspectorGroup, Locale, Localizations, NavigateFunction, PageType, TODO, WeaverseHydrogen, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderArgs, WeaverseLoaderConfigs, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseStorefrontData, WeaverseThemeConfigs, fetchWithServerCache, getRequestQueries, getSelectedProductOptions, useThemeSettings, weaverseLoader };
+export { FetchProjectRequestBody, HydrogenComponent, HydrogenComponentData, HydrogenComponentInstance, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenToolbarAction, I18nLocale, InspectorGroup, Locale, Localizations, PageType, TODO, WeaverseHydrogen, WeaverseHydrogenInit, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderArgs, WeaverseLoaderConfigs, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, fetchWithServerCache, getRequestQueries, getSelectedProductOptions, useThemeSettings, weaverseLoader };

package/dist/index.js

@@ -79,7 +79,8 @@ function createWeaverseInstance(weaverseData, components) {
     weaverse.registerElement({
       type: comp?.schema?.type,
       Component: comp?.default,
-      schema: comp?.schema
+      schema: comp?.schema,
+      loader: comp?.loader
     });
   });
   return weaverse;
@@ -91,7 +92,7 @@ var import_react3 = require("@weaverse/react");
 var import_react4 = require("react");
 function useStudio(weaverse, countries, schema) {
   let navigate = (0, import_react2.useNavigate)();
-  let revalidator = (0, import_react2.useRevalidator)();
+  let { revalidate } = (0, import_react2.useRevalidator)();
   let { isDesignMode, weaverseHost, weaverseVersion } = weaverse;
   let isStudio = import_react3.isIframe && isDesignMode && weaverseHost && weaverseVersion;
   (0, import_react4.useEffect)(() => {
@@ -99,7 +100,7 @@ function useStudio(weaverse, countries, schema) {
       weaverse.internal = {
         ...weaverse.internal,
         navigate,
-        revalidator,
+        revalidate,
         themeConfigs: { schema, countries }
       };
       window.__weaverse = weaverse;
@@ -111,7 +112,7 @@ function useStudio(weaverse, countries, schema) {
         );
       }
     }
-  }, [weaverse, revalidator]);
+  }, [weaverse]);
 }
 
 // src/index.tsx

package/dist/index.mjs

@@ -39,7 +39,8 @@ function createWeaverseInstance(weaverseData, components) {
     weaverse.registerElement({
       type: comp?.schema?.type,
       Component: comp?.default,
-      schema: comp?.schema
+      schema: comp?.schema,
+      loader: comp?.loader
     });
   });
   return weaverse;
@@ -51,7 +52,7 @@ import { isIframe, loadScript } from "@weaverse/react";
 import { useEffect } from "react";
 function useStudio(weaverse, countries, schema) {
   let navigate = useNavigate();
-  let revalidator = useRevalidator();
+  let { revalidate } = useRevalidator();
   let { isDesignMode, weaverseHost, weaverseVersion } = weaverse;
   let isStudio = isIframe && isDesignMode && weaverseHost && weaverseVersion;
   useEffect(() => {
@@ -59,7 +60,7 @@ function useStudio(weaverse, countries, schema) {
       weaverse.internal = {
         ...weaverse.internal,
         navigate,
-        revalidator,
+        revalidate,
         themeConfigs: { schema, countries }
       };
       window.__weaverse = weaverse;
@@ -71,7 +72,7 @@ function useStudio(weaverse, countries, schema) {
         );
       }
     }
-  }, [weaverse, revalidator]);
+  }, [weaverse]);
 }
 
 // src/index.tsx

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.1.7",
+  "version": "1.1.8",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -34,10 +34,10 @@
   "dependencies": {
     "@remix-run/react": "1.19.1",
     "@shopify/hydrogen": "2023.7.2",
-    "@weaverse/react": "1.1.7",
+    "@weaverse/react": "1.1.8",
     "react-error-boundary": "^4.0.11"
   },
   "devDependencies": {
     "@shopify/remix-oxygen": "^1.1.3"
   }
-}
+}