@weaverse/hydrogen 1.3.3 → 1.5.0

package/dist/index.d.mts

@@ -1,13 +1,31 @@
-import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseItemStore, Weaverse } from '@weaverse/react';
-export * from '@weaverse/react';
-import { createWithCache, Storefront } from '@shopify/hydrogen';
-import { LoaderArgs, AppLoadContext } from '@shopify/remix-oxygen';
+import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseCoreParams, WeaverseProjectDataType, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
 import { Params, NavigateFunction } from '@remix-run/react';
+import { createWithCache, Storefront } from '@shopify/hydrogen';
 import { LanguageCode, CountryCode, CurrencyCode } from '@shopify/hydrogen/storefront-api-types';
-import * as React from 'react';
-import React__default, { ForwardRefExoticComponent } from 'react';
+import { LoaderArgs, AppLoadContext } from '@shopify/remix-oxygen';
+import React, { ForwardRefExoticComponent } from 'react';
 import * as _shopify_hydrogen_react_storefront_api_types from '@shopify/hydrogen-react/storefront-api-types';
 
+declare class WeaverseClient {
+    API: string;
+    clientVersion: string;
+    basePageConfigs: Omit<WeaverseProjectConfigs, 'requestInfo'>;
+    basePageRequestBody: Omit<FetchProjectRequestBody, 'url'>;
+    storefront: WeaverseClientArgs['storefront'];
+    components: HydrogenComponent[];
+    countries?: Localizations;
+    themeSchema: HydrogenThemeSchema;
+    configs: WeaverseProjectConfigs;
+    withCache: WeaverseClientArgs['withCache'];
+    constructor(args: WeaverseClientArgs);
+    fetchWithCache: <T>(url: string, options: FetchWithCacheOptions) => Promise<T>;
+    loadThemeSettings: (strategy?: AllCacheOptions) => Promise<any>;
+    loadPage: (args: LoaderArgs, configs?: PageLoadParams & {
+        strategy?: AllCacheOptions;
+    }) => Promise<WeaverseLoaderData | null>;
+    execComponentLoader: (item: HydrogenComponentData, args: LoaderArgs) => Promise<HydrogenComponentData>;
+}
+
 declare class ThemeSettingsStore {
     settings: HydrogenThemeSettings | null;
     listeners: (() => void)[];
@@ -62,19 +80,17 @@ interface RouteLoaderArgs extends LoaderArgs {
         weaverse: WeaverseClient;
     };
 }
-interface HydrogenComponentData extends Omit<ElementData, 'childIds' | 'css'> {
-    id: string;
-    type: string;
-    createdAt: string;
-    updatedAt: string;
-    deletedAt: string;
-    children: {
+interface HydrogenComponentData extends ElementData {
+    data?: Record<string, any>;
+    children?: {
         id: string;
     }[];
-    data: Record<string, any>;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
 }
 type HydrogenToolbarAction = 'general-settings' | 'settings-level-2' | 'duplicate' | 'delete';
-interface HydrogenComponentSchema extends Omit<ElementSchema, 'parentTypes' | 'flags' | 'inspector' | 'gridSize' | 'childElements' | 'catalog' | 'toolbar'> {
+interface HydrogenComponentSchema extends ElementSchema {
     childTypes?: string[];
     inspector: InspectorGroup[];
     presets?: Omit<HydrogenComponentPresets, 'type'>;
@@ -92,7 +108,7 @@ interface InspectorGroup {
 interface HydrogenComponentProps<L = any> extends WeaverseElement {
     className?: string;
     loaderData?: L;
-    children?: React__default.JSX.Element[];
+    children?: React.JSX.Element[];
 }
 type I18nLocale = Locale & {
     pathPrefix: string;
@@ -104,15 +120,6 @@ type WeaverseLoaderRequestInfo = {
     queries: Record<string, string | boolean>;
     i18n: I18nLocale;
 };
-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;
-    internal: WeaverseInternal;
-    data: WeaverseStorefrontData;
-    requestInfo: WeaverseLoaderRequestInfo;
-}
 type WeaverseStorefrontData = {
     id?: string;
     __cachedId?: string;
@@ -155,19 +162,12 @@ interface HydrogenElement {
     schema?: HydrogenComponentSchema;
     loader?: HydrogenComponentLoaderFunction;
 }
-interface WeaverseHydrogenInit extends WeaverseProjectConfigs {
+interface WeaverseHydrogenParams extends Omit<WeaverseCoreParams, 'ItemConstructor'> {
     data: HydrogenPageData;
     pageId: string;
-    platformType: 'shopify-hydrogen';
     internal: Partial<WeaverseInternal>;
     requestInfo: WeaverseLoaderRequestInfo;
 }
-interface HydrogenComponentInstance extends Omit<WeaverseItemStore, '_flags' | 'data' | 'Element'> {
-    get _element(): HTMLElement | null;
-    get Element(): HydrogenElement | undefined;
-    get data(): HydrogenComponentData;
-    _store: HydrogenComponentData;
-}
 type HydrogenComponentLoaderFunction = (args: ComponentLoaderArgs) => Promise<unknown>;
 interface HydrogenComponent<T extends HydrogenComponentProps = any> {
     default: ForwardRefExoticComponent<T>;
@@ -206,16 +206,16 @@ interface WeaverseLoaderData {
     project: HydrogenProjectType;
     pageAssignment: HydrogenPageAssignment;
 }
-type HydrogenPageData = {
+interface HydrogenPageData extends WeaverseProjectDataType {
     id: string;
+    pageId: string;
     name: string;
-    rootId: string;
     items: HydrogenComponentData[];
     [key: string]: any;
-};
+}
 interface WeaverseHydrogenRootProps {
     components: HydrogenComponent[];
-    errorComponent?: React__default.FC<{
+    errorComponent?: React.FC<{
         error: {
             message: string;
             stack?: string;
@@ -286,44 +286,32 @@ declare global {
     }
 }
 
-declare class WeaverseClient {
-    API: string;
-    clientVersion: string;
-    storefront: Storefront<I18nLocale>;
-    components: HydrogenComponent[];
-    countries?: Localizations;
-    themeSchema: HydrogenThemeSchema;
-    configs: WeaverseProjectConfigs;
-    basePageConfigs: Omit<WeaverseProjectConfigs, 'requestInfo'>;
-    basePageRequestBody: Omit<FetchProjectRequestBody, 'url'>;
-    withCache: ReturnType<typeof createWithCache>;
-    constructor(args: WeaverseClientArgs);
-    fetchWithCache: <T>(url: string, options: FetchWithCacheOptions) => Promise<T>;
-    loadThemeSettings: (strategy?: AllCacheOptions) => Promise<any>;
-    loadPage: (args: LoaderArgs, configs?: PageLoadParams & {
-        strategy?: AllCacheOptions;
-    }) => Promise<WeaverseLoaderData | null>;
-    execComponentLoader: (item: HydrogenComponentData, args: LoaderArgs) => Promise<HydrogenComponentData>;
-}
+declare function WeaverseHydrogenRoot({ errorComponent: ErrorComponent, components, }: WeaverseHydrogenRootProps): React.JSX.Element;
+declare function withWeaverse(Component: React.ComponentType): (props: React.JSX.IntrinsicAttributes) => React.JSX.Element;
 
 declare function getRequestQueries<T = Record<string, string | boolean>>(request: Request): T;
 declare function getWeaverseConfigs(request: Request, env: HydrogenThemeEnv): WeaverseProjectConfigs;
-declare function getWeaverseCsp(request: Request): {
-    frameAncestors: string[];
-    defaultSrc: string[];
-    styleSrc: string[];
-};
 
 declare function getSelectedProductOptions(request: Request): _shopify_hydrogen_react_storefront_api_types.SelectedOptionInput[];
-declare function createContentSecurityPolicy(request: Request, directives?: Record<string, string[] | string | boolean>): {
-    nonce: string;
-    header: string;
-    NonceProvider: React.ComponentType<{
-        children: React.ReactNode;
-    }>;
-};
 
-declare function WeaverseHydrogenRoot({ errorComponent: ErrorComponent, components, }: WeaverseHydrogenRootProps): React__default.JSX.Element;
-declare let withWeaverse: (Component: React__default.ComponentType) => (props: React__default.JSX.IntrinsicAttributes) => React__default.JSX.Element;
+declare class WeaverseHydrogen extends Weaverse {
+    platformType: PlatformTypeEnum;
+    pageId: string;
+    internal: Partial<WeaverseInternal>;
+    requestInfo: WeaverseLoaderRequestInfo;
+    ItemConstructor: typeof WeaverseHydrogenItem;
+    data: HydrogenPageData;
+    itemInstances: Map<string | number, WeaverseHydrogenItem>;
+    elementRegistry: Map<string, HydrogenElement>;
+    constructor(params: WeaverseHydrogenParams, components: HydrogenComponent[]);
+    registerElement(element: HydrogenElement): void;
+    registerComponents(components: HydrogenComponent[]): void;
+}
+declare class WeaverseHydrogenItem extends WeaverseItemStore {
+    weaverse: WeaverseHydrogen;
+    constructor(intialData: HydrogenComponentData, weaverse: WeaverseHydrogen);
+    get Element(): HydrogenElement;
+    get data(): HydrogenComponentData;
+}
 
-export { AllCacheOptions, ComponentLoaderArgs, FetchProjectPayload, FetchProjectRequestBody, FetchWithCacheOptions, HydrogenComponent, HydrogenComponentData, HydrogenComponentInstance, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeEnv, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenThemeSettings, HydrogenToolbarAction, I18nLocale, InspectorGroup, Locale, Localizations, PageLoadParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseClient, WeaverseClientArgs, WeaverseHydrogen, WeaverseHydrogenInit, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, createContentSecurityPolicy, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, getWeaverseCsp, useThemeSettings, withWeaverse };
+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, Locale, Localizations, PageLoadParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseClient, WeaverseClientArgs, WeaverseHydrogen, WeaverseHydrogenItem, WeaverseHydrogenParams, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, useThemeSettings, withWeaverse };

package/dist/index.d.ts

@@ -1,13 +1,31 @@
-import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseItemStore, Weaverse } from '@weaverse/react';
-export * from '@weaverse/react';
-import { createWithCache, Storefront } from '@shopify/hydrogen';
-import { LoaderArgs, AppLoadContext } from '@shopify/remix-oxygen';
+import { ElementData, ElementSchema, BasicInput, WeaverseElement, WeaverseCoreParams, WeaverseProjectDataType, Weaverse, PlatformTypeEnum, WeaverseItemStore } from '@weaverse/react';
 import { Params, NavigateFunction } from '@remix-run/react';
+import { createWithCache, Storefront } from '@shopify/hydrogen';
 import { LanguageCode, CountryCode, CurrencyCode } from '@shopify/hydrogen/storefront-api-types';
-import * as React from 'react';
-import React__default, { ForwardRefExoticComponent } from 'react';
+import { LoaderArgs, AppLoadContext } from '@shopify/remix-oxygen';
+import React, { ForwardRefExoticComponent } from 'react';
 import * as _shopify_hydrogen_react_storefront_api_types from '@shopify/hydrogen-react/storefront-api-types';
 
+declare class WeaverseClient {
+    API: string;
+    clientVersion: string;
+    basePageConfigs: Omit<WeaverseProjectConfigs, 'requestInfo'>;
+    basePageRequestBody: Omit<FetchProjectRequestBody, 'url'>;
+    storefront: WeaverseClientArgs['storefront'];
+    components: HydrogenComponent[];
+    countries?: Localizations;
+    themeSchema: HydrogenThemeSchema;
+    configs: WeaverseProjectConfigs;
+    withCache: WeaverseClientArgs['withCache'];
+    constructor(args: WeaverseClientArgs);
+    fetchWithCache: <T>(url: string, options: FetchWithCacheOptions) => Promise<T>;
+    loadThemeSettings: (strategy?: AllCacheOptions) => Promise<any>;
+    loadPage: (args: LoaderArgs, configs?: PageLoadParams & {
+        strategy?: AllCacheOptions;
+    }) => Promise<WeaverseLoaderData | null>;
+    execComponentLoader: (item: HydrogenComponentData, args: LoaderArgs) => Promise<HydrogenComponentData>;
+}
+
 declare class ThemeSettingsStore {
     settings: HydrogenThemeSettings | null;
     listeners: (() => void)[];
@@ -62,19 +80,17 @@ interface RouteLoaderArgs extends LoaderArgs {
         weaverse: WeaverseClient;
     };
 }
-interface HydrogenComponentData extends Omit<ElementData, 'childIds' | 'css'> {
-    id: string;
-    type: string;
-    createdAt: string;
-    updatedAt: string;
-    deletedAt: string;
-    children: {
+interface HydrogenComponentData extends ElementData {
+    data?: Record<string, any>;
+    children?: {
         id: string;
     }[];
-    data: Record<string, any>;
+    createdAt?: string;
+    updatedAt?: string;
+    deletedAt?: string;
 }
 type HydrogenToolbarAction = 'general-settings' | 'settings-level-2' | 'duplicate' | 'delete';
-interface HydrogenComponentSchema extends Omit<ElementSchema, 'parentTypes' | 'flags' | 'inspector' | 'gridSize' | 'childElements' | 'catalog' | 'toolbar'> {
+interface HydrogenComponentSchema extends ElementSchema {
     childTypes?: string[];
     inspector: InspectorGroup[];
     presets?: Omit<HydrogenComponentPresets, 'type'>;
@@ -92,7 +108,7 @@ interface InspectorGroup {
 interface HydrogenComponentProps<L = any> extends WeaverseElement {
     className?: string;
     loaderData?: L;
-    children?: React__default.JSX.Element[];
+    children?: React.JSX.Element[];
 }
 type I18nLocale = Locale & {
     pathPrefix: string;
@@ -104,15 +120,6 @@ type WeaverseLoaderRequestInfo = {
     queries: Record<string, string | boolean>;
     i18n: I18nLocale;
 };
-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;
-    internal: WeaverseInternal;
-    data: WeaverseStorefrontData;
-    requestInfo: WeaverseLoaderRequestInfo;
-}
 type WeaverseStorefrontData = {
     id?: string;
     __cachedId?: string;
@@ -155,19 +162,12 @@ interface HydrogenElement {
     schema?: HydrogenComponentSchema;
     loader?: HydrogenComponentLoaderFunction;
 }
-interface WeaverseHydrogenInit extends WeaverseProjectConfigs {
+interface WeaverseHydrogenParams extends Omit<WeaverseCoreParams, 'ItemConstructor'> {
     data: HydrogenPageData;
     pageId: string;
-    platformType: 'shopify-hydrogen';
     internal: Partial<WeaverseInternal>;
     requestInfo: WeaverseLoaderRequestInfo;
 }
-interface HydrogenComponentInstance extends Omit<WeaverseItemStore, '_flags' | 'data' | 'Element'> {
-    get _element(): HTMLElement | null;
-    get Element(): HydrogenElement | undefined;
-    get data(): HydrogenComponentData;
-    _store: HydrogenComponentData;
-}
 type HydrogenComponentLoaderFunction = (args: ComponentLoaderArgs) => Promise<unknown>;
 interface HydrogenComponent<T extends HydrogenComponentProps = any> {
     default: ForwardRefExoticComponent<T>;
@@ -206,16 +206,16 @@ interface WeaverseLoaderData {
     project: HydrogenProjectType;
     pageAssignment: HydrogenPageAssignment;
 }
-type HydrogenPageData = {
+interface HydrogenPageData extends WeaverseProjectDataType {
     id: string;
+    pageId: string;
     name: string;
-    rootId: string;
     items: HydrogenComponentData[];
     [key: string]: any;
-};
+}
 interface WeaverseHydrogenRootProps {
     components: HydrogenComponent[];
-    errorComponent?: React__default.FC<{
+    errorComponent?: React.FC<{
         error: {
             message: string;
             stack?: string;
@@ -286,44 +286,32 @@ declare global {
     }
 }
 
-declare class WeaverseClient {
-    API: string;
-    clientVersion: string;
-    storefront: Storefront<I18nLocale>;
-    components: HydrogenComponent[];
-    countries?: Localizations;
-    themeSchema: HydrogenThemeSchema;
-    configs: WeaverseProjectConfigs;
-    basePageConfigs: Omit<WeaverseProjectConfigs, 'requestInfo'>;
-    basePageRequestBody: Omit<FetchProjectRequestBody, 'url'>;
-    withCache: ReturnType<typeof createWithCache>;
-    constructor(args: WeaverseClientArgs);
-    fetchWithCache: <T>(url: string, options: FetchWithCacheOptions) => Promise<T>;
-    loadThemeSettings: (strategy?: AllCacheOptions) => Promise<any>;
-    loadPage: (args: LoaderArgs, configs?: PageLoadParams & {
-        strategy?: AllCacheOptions;
-    }) => Promise<WeaverseLoaderData | null>;
-    execComponentLoader: (item: HydrogenComponentData, args: LoaderArgs) => Promise<HydrogenComponentData>;
-}
+declare function WeaverseHydrogenRoot({ errorComponent: ErrorComponent, components, }: WeaverseHydrogenRootProps): React.JSX.Element;
+declare function withWeaverse(Component: React.ComponentType): (props: React.JSX.IntrinsicAttributes) => React.JSX.Element;
 
 declare function getRequestQueries<T = Record<string, string | boolean>>(request: Request): T;
 declare function getWeaverseConfigs(request: Request, env: HydrogenThemeEnv): WeaverseProjectConfigs;
-declare function getWeaverseCsp(request: Request): {
-    frameAncestors: string[];
-    defaultSrc: string[];
-    styleSrc: string[];
-};
 
 declare function getSelectedProductOptions(request: Request): _shopify_hydrogen_react_storefront_api_types.SelectedOptionInput[];
-declare function createContentSecurityPolicy(request: Request, directives?: Record<string, string[] | string | boolean>): {
-    nonce: string;
-    header: string;
-    NonceProvider: React.ComponentType<{
-        children: React.ReactNode;
-    }>;
-};
 
-declare function WeaverseHydrogenRoot({ errorComponent: ErrorComponent, components, }: WeaverseHydrogenRootProps): React__default.JSX.Element;
-declare let withWeaverse: (Component: React__default.ComponentType) => (props: React__default.JSX.IntrinsicAttributes) => React__default.JSX.Element;
+declare class WeaverseHydrogen extends Weaverse {
+    platformType: PlatformTypeEnum;
+    pageId: string;
+    internal: Partial<WeaverseInternal>;
+    requestInfo: WeaverseLoaderRequestInfo;
+    ItemConstructor: typeof WeaverseHydrogenItem;
+    data: HydrogenPageData;
+    itemInstances: Map<string | number, WeaverseHydrogenItem>;
+    elementRegistry: Map<string, HydrogenElement>;
+    constructor(params: WeaverseHydrogenParams, components: HydrogenComponent[]);
+    registerElement(element: HydrogenElement): void;
+    registerComponents(components: HydrogenComponent[]): void;
+}
+declare class WeaverseHydrogenItem extends WeaverseItemStore {
+    weaverse: WeaverseHydrogen;
+    constructor(intialData: HydrogenComponentData, weaverse: WeaverseHydrogen);
+    get Element(): HydrogenElement;
+    get data(): HydrogenComponentData;
+}
 
-export { AllCacheOptions, ComponentLoaderArgs, FetchProjectPayload, FetchProjectRequestBody, FetchWithCacheOptions, HydrogenComponent, HydrogenComponentData, HydrogenComponentInstance, HydrogenComponentLoaderFunction, HydrogenComponentPresets, HydrogenComponentProps, HydrogenComponentSchema, HydrogenElement, HydrogenPageAssignment, HydrogenPageConfigs, HydrogenPageData, HydrogenProjectConfig, HydrogenProjectType, HydrogenThemeEnv, HydrogenThemeInfo, HydrogenThemeSchema, HydrogenThemeSettings, HydrogenToolbarAction, I18nLocale, InspectorGroup, Locale, Localizations, PageLoadParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseClient, WeaverseClientArgs, WeaverseHydrogen, WeaverseHydrogenInit, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, createContentSecurityPolicy, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, getWeaverseCsp, useThemeSettings, withWeaverse };
+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, Locale, Localizations, PageLoadParams, PageType, PublicEnv, RootRouteData, RouteLoaderArgs, ThemeSettingsStore, WeaverseClient, WeaverseClientArgs, WeaverseHydrogen, WeaverseHydrogenItem, WeaverseHydrogenParams, WeaverseHydrogenRoot, WeaverseHydrogenRootProps, WeaverseInternal, WeaverseLoaderData, WeaverseLoaderRequestInfo, WeaverseProjectConfigs, WeaverseStorefrontData, WeaverseStudioQueries, WeaverseThemeConfigs, getRequestQueries, getSelectedProductOptions, getWeaverseConfigs, useThemeSettings, withWeaverse };