@weaverse/core 1.0.48 → 1.0.49

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as Stitches from '@stitches/core';
-import { RefObject, ForwardRefExoticComponent } from 'react';
+import { ForwardRefExoticComponent, RefObject } from 'react';
 import Stitches$1 from '@stitches/core/types/stitches';
 
 declare let stitchesUtils: {
@@ -40,119 +40,6 @@ declare let stitchesUtils: {
     };
 };
 
-declare class WeaverseItemStore {
-    weaverse: Weaverse;
-    listeners: Set<(_: ElementData) => void>;
-    ref: RefObject<HTMLElement>;
-    stitchesClass: string;
-    private _store;
-    constructor(itemData: ElementData, weaverse: Weaverse);
-    get _id(): string;
-    get _element(): HTMLElement | null;
-    get _flags(): Partial<Record<FlagType, boolean>>;
-    get Element(): WeaverseElement | undefined;
-    set data(update: Omit<ElementData, "id" | "type">);
-    get data(): ElementData;
-    setData: (update: Omit<ElementData, "id" | "type">) => ElementData;
-    subscribe: (fn: (_: ElementData) => void) => void;
-    unsubscribe: (fn: (_: ElementData) => void) => void;
-    triggerUpdate: () => void;
-}
-declare class Weaverse {
-    /**
-     * The `weaverse-content-root` element of Weaverse SDK
-     */
-    contentRootElement: HTMLElement | undefined;
-    /**
-     * For storing, registering element React component from Weaverse or created by user/developer
-     */
-    elementInstances: Map<string, WeaverseElement>;
-    /**
-     * list of element/items store to provide data, handle state update, state sharing, etc.
-     */
-    itemInstances: Map<string | number, WeaverseItemStore>;
-    /**
-     * Weaverse base URL that can provide by user/developer. for local development, use localhost:3000
-     */
-    weaverseHost: string;
-    /**
-     * Weaverse version, it can be used to load the correct version of Weaverse SDK
-     */
-    weaverseVersion: string;
-    /**
-     * Weaverse project key to access project data via API
-     */
-    projectId: string;
-    pageId: string;
-    /**
-     * Weaverse project data, by default, user can provide project data via React Component:
-     * <WeaverseRoot data={data} /> it will be used to server-side rendering
-     */
-    data: WeaverseProjectDataType;
-    /**
-     * Storing subscribe callback function for any component that want to listen to the change of WeaverseRoot
-     */
-    listeners: Set<() => void>;
-    /**
-     * Check whether the sdk is in editor or not.
-     * If isDesignMode is true, it means the sdk is isDesignMode mode, render the editor UI,
-     * else render the preview UI, plain HTML + CSS + React hydrate
-     */
-    isDesignMode: boolean;
-    /**
-     * Check the platform, shopify-section or react-ssr(hydrogen)
-     */
-    platformType: PlatformTypeEnum;
-    /**
-     * Check whether the sdk is in preview mode or not
-     */
-    isPreviewMode: boolean;
-    /**
-     * Use in element to optionally render special HTML for hydration
-     */
-    ssrMode: boolean;
-    /**
-     * Stitches instance for handling CSS stylesheet, media, theme for Weaverse project
-     */
-    stitchesInstance: Stitches$1 | any;
-    studioBridge?: any;
-    elementSchemas: ElementSchema[];
-    static WeaverseItemStore: typeof WeaverseItemStore;
-    mediaBreakPoints: BreakPoints;
-    /**
-     * constructor
-     * @param weaverseHost {string} Weaverse base URL that can provide by user/developer. for local development, use localhost:3000
-     * @param projectId {string} Weaverse project key to access project data via API
-     * @param data {WeaverseProjectDataType} Weaverse project data, by default, user can provide project data via React Component.
-     * @param mediaBreakPoints {object} Pass down custom media query breakpoints or just use the default.
-     * @param isDesignMode {boolean} check whether the sdk is isDesignMode or not
-     * @param ssrMode {boolean} Use in element to optionally render special HTML for hydration
-     * @param elementSchemas {Array<ElementSchema>} List of element schemas
-     * @param platformType {PlatformTypeEnum} Check the platform, shopify-section or react-ssr(hydrogen)
-     */
-    constructor(params?: WeaverseType);
-    /**
-     * Register the custom React Component to Weaverse, store it into Weaverse.elementInstances
-     * @param element {WeaverseElement} custom React Component
-     */
-    registerElement(element: WeaverseElement): void;
-    initStitches: (externalConfig?: {}) => void;
-    subscribe(fn: any): void;
-    unsubscribe(fn: any): void;
-    triggerUpdate(): void;
-    refreshAllItems(): void;
-    /**
-     * When applying new template,
-     * we need to reset the project data and re-initialize the project item data
-     * @param data {WeaverseProjectDataType}
-     */
-    setProjectData(data: WeaverseProjectDataType): void;
-    /**
-     * Create new WeaverseItemStore instance for each item in project data
-     */
-    initProject(): void;
-}
-
 interface WeaverseProjectDataType {
     items: ElementData[];
     rootId: string;
@@ -283,7 +170,7 @@ interface BasicInput<ConfigsType = AdditionalInputConfigs> {
      * `imagesPerRow.gt.1`
      */
     condition?: string;
-    defaultValue?: string | number | boolean;
+    defaultValue: string | number | boolean;
     placeholder?: string;
     helpText?: string;
 }
@@ -322,16 +209,129 @@ interface DataSortInputConfigs {
 type InputType = "color" | "datepicker" | "image" | "range" | "select" | "children-sort" | "data-sort" | "switch" | "text" | "textarea" | "toggle-group" | "position" | "information" | "product" | "product-list" | "product-swatches" | "text-editor" | "custom.html" | "instagram" | "collection-list" | "collection" | "article-list" | "map-autocomplete";
 declare global {
     interface Window {
-        createWeaverseStudioBridge: (weaverse: Weaverse) => Promise<any>;
         weaverseStudioInitialized: boolean;
         Blinkloader: any;
-        __weaverse: Weaverse;
+        __weaverse: any;
         __weaverses: {
-            [key: string]: Weaverse;
+            [key: string]: any;
         };
+        createWeaverseStudioBridge: (weaverse: any) => Promise<any>;
     }
 }
 
+declare class WeaverseItemStore {
+    weaverse: Weaverse;
+    listeners: Set<(_: ElementData) => void>;
+    ref: RefObject<HTMLElement>;
+    stitchesClass: string;
+    private _store;
+    constructor(itemData: ElementData, weaverse: Weaverse);
+    get _id(): string;
+    get _element(): HTMLElement | null;
+    get _flags(): Partial<Record<FlagType, boolean>>;
+    get Element(): WeaverseElement | undefined;
+    set data(update: Omit<ElementData, "id" | "type">);
+    get data(): ElementData;
+    setData: (update: Omit<ElementData, "id" | "type">) => ElementData;
+    subscribe: (fn: (_: ElementData) => void) => void;
+    unsubscribe: (fn: (_: ElementData) => void) => void;
+    triggerUpdate: () => void;
+}
+declare class Weaverse {
+    /**
+     * The `weaverse-content-root` element of Weaverse SDK
+     */
+    contentRootElement: HTMLElement | undefined;
+    /**
+     * For storing, registering element React component from Weaverse or created by user/developer
+     */
+    elementInstances: Map<string, WeaverseElement>;
+    /**
+     * list of element/items store to provide data, handle state update, state sharing, etc.
+     */
+    itemInstances: Map<string | number, WeaverseItemStore>;
+    /**
+     * Weaverse base URL that can provide by user/developer. for local development, use localhost:3000
+     */
+    weaverseHost: string;
+    /**
+     * Weaverse version, it can be used to load the correct version of Weaverse SDK
+     */
+    weaverseVersion: string;
+    /**
+     * Weaverse project key to access project data via API
+     */
+    projectId: string;
+    pageId: string;
+    /**
+     * Weaverse project data, by default, user can provide project data via React Component:
+     * <WeaverseRoot data={data} /> it will be used to server-side rendering
+     */
+    data: WeaverseProjectDataType;
+    /**
+     * Storing subscribe callback function for any component that want to listen to the change of WeaverseRoot
+     */
+    listeners: Set<() => void>;
+    /**
+     * Check whether the sdk is in editor or not.
+     * If isDesignMode is true, it means the sdk is isDesignMode mode, render the editor UI,
+     * else render the preview UI, plain HTML + CSS + React hydrate
+     */
+    isDesignMode: boolean;
+    /**
+     * Check the platform, shopify-section or react-ssr(hydrogen)
+     */
+    platformType: PlatformTypeEnum;
+    /**
+     * Check whether the sdk is in preview mode or not
+     */
+    isPreviewMode: boolean;
+    /**
+     * Use in element to optionally render special HTML for hydration
+     */
+    ssrMode: boolean;
+    /**
+     * Stitches instance for handling CSS stylesheet, media, theme for Weaverse project
+     */
+    stitchesInstance: Stitches$1 | any;
+    studioBridge?: any;
+    elementSchemas: ElementSchema[];
+    static WeaverseItemStore: typeof WeaverseItemStore;
+    mediaBreakPoints: BreakPoints;
+    /**
+     * constructor
+     * @param weaverseHost {string} Weaverse base URL that can provide by user/developer. for local development, use localhost:3000
+     * @param projectId {string} Weaverse project key to access project data via API
+     * @param data {WeaverseProjectDataType} Weaverse project data, by default, user can provide project data via React Component.
+     * @param mediaBreakPoints {object} Pass down custom media query breakpoints or just use the default.
+     * @param isDesignMode {boolean} check whether the sdk is isDesignMode or not
+     * @param ssrMode {boolean} Use in element to optionally render special HTML for hydration
+     * @param elementSchemas {Array<ElementSchema>} List of element schemas
+     * @param platformType {PlatformTypeEnum} Check the platform, shopify-section or react-ssr(hydrogen)
+     */
+    constructor(params?: WeaverseType);
+    /**
+     * Register the custom React Component to Weaverse, store it into Weaverse.elementInstances
+     * @param element {WeaverseElement} custom React Component
+     */
+    registerElement(element: WeaverseElement): void;
+    initStitches: (externalConfig?: {}) => void;
+    subscribe(fn: any): void;
+    unsubscribe(fn: any): void;
+    triggerUpdate(): void;
+    refreshAllItems(): void;
+    /**
+     * When applying new template,
+     * we need to reset the project data and re-initialize the project item data
+     * @param data {WeaverseProjectDataType}
+     */
+    setProjectData(data: WeaverseProjectDataType): void;
+    /**
+     * Create new WeaverseItemStore instance for each item in project data
+     */
+    initProject(): void;
+}
+
 declare let loadScript: (src: string) => Promise<unknown>;
 
 declare let isReactNative: boolean;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.48",
+  "version": "1.0.49",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",