@weaverse/core 5.17.0 → 5.18.0

package/dist/index.d.mts

@@ -1,413 +0,0 @@
-import { CSSProperties, ForwardRefExoticComponent, RefObject } from 'react';
-
-// This file is generated from Weaverse Studio
-
-type IconName =
-  | 'accessibility'
-  | 'activity-square'
-  | 'alarm-clock-off'
-  | 'alarm-clock'
-  | 'alarm-minus'
-  | 'alarm-plus'
-  | 'album'
-  | 'alert-circle'
-  | 'alert-octagon'
-  | 'alert-triangle'
-  | 'align-box-center-bottom-outline'
-  | 'align-box-center-middle-outline'
-  | 'align-box-center-top-outline'
-  | 'align-box-left-bottom-outline'
-  | 'align-box-left-middle-outline'
-  | 'align-box-left-top-outline'
-  | 'align-box-right-bottom-outline'
-  | 'align-box-right-middle-outline'
-  | 'align-box-right-top-outline'
-  | 'align-center-vertical'
-  | 'align-end-vertical'
-  | 'align-left'
-  | 'align-right'
-  | 'align-start-vertical'
-  | 'arrow-down-a-z'
-  | 'arrow-down-narrow-wide'
-  | 'arrow-left-from-line'
-  | 'arrow-left-right'
-  | 'arrow-up-a-z'
-  | 'arrow-up-narrow-wide'
-  | 'atom'
-  | 'blocks'
-  | 'book-image'
-  | 'book-marked'
-  | 'book-text'
-  | 'book'
-  | 'box-select'
-  | 'box'
-  | 'boxes'
-  | 'brackets'
-  | 'calendar-minus'
-  | 'calendar-plus'
-  | 'calendar'
-  | 'check-check'
-  | 'check-circle'
-  | 'check'
-  | 'chevron-down'
-  | 'chevron-left'
-  | 'chevron-right'
-  | 'chevron-up'
-  | 'chevrons-up-down'
-  | 'circle-dot'
-  | 'circle'
-  | 'code'
-  | 'columns-2'
-  | 'columns-3'
-  | 'concierge-bell'
-  | 'contact'
-  | 'copy'
-  | 'corner-up-left'
-  | 'expand'
-  | 'external-link'
-  | 'eye-off'
-  | 'eye'
-  | 'facebook'
-  | 'file-code-2'
-  | 'file-plus-2'
-  | 'file-search'
-  | 'file-text'
-  | 'file'
-  | 'filter'
-  | 'flag'
-  | 'flask-conical'
-  | 'focus'
-  | 'fold-horizontal'
-  | 'fold-vertical'
-  | 'folder-git-2'
-  | 'folder-open'
-  | 'folder-plus'
-  | 'folder-search'
-  | 'folder-symlink'
-  | 'folder'
-  | 'form-input'
-  | 'frown'
-  | 'gallery-horizontal-end'
-  | 'gallery-horizontal'
-  | 'gauge'
-  | 'github'
-  | 'globe'
-  | 'grid-2x2'
-  | 'grip-vertical'
-  | 'hammer'
-  | 'hard-drive-download'
-  | 'help-circle'
-  | 'home'
-  | 'hourglass'
-  | 'image-off'
-  | 'image-plus'
-  | 'image'
-  | 'images'
-  | 'info'
-  | 'languages'
-  | 'layers'
-  | 'layout-dashboard'
-  | 'layout-grid'
-  | 'layout-list'
-  | 'layout-panel-left'
-  | 'layout-template'
-  | 'life-buoy'
-  | 'lightbulb'
-  | 'link'
-  | 'linkedin'
-  | 'list-end'
-  | 'list-start'
-  | 'list-todo'
-  | 'loader-2'
-  | 'loader'
-  | 'log-out'
-  | 'map-pinned'
-  | 'map'
-  | 'maximize'
-  | 'message-circle'
-  | 'message-square'
-  | 'messages-square'
-  | 'minimize'
-  | 'minus'
-  | 'monitor-play'
-  | 'monitor'
-  | 'moon'
-  | 'more-horizontal'
-  | 'more-vertical'
-  | 'mouse-pointer-2'
-  | 'mouse-pointer-click'
-  | 'mouse-pointer-square-dashed'
-  | 'mouse-pointer-square'
-  | 'mouse-pointer'
-  | 'mouse'
-  | 'move-down-left'
-  | 'move-down-right'
-  | 'move-down'
-  | 'move-horizontal'
-  | 'move-left'
-  | 'move-right'
-  | 'move-up-left'
-  | 'move-up-right'
-  | 'move-up'
-  | 'newspaper'
-  | 'notebook-tabs'
-  | 'package-check'
-  | 'package-open'
-  | 'package'
-  | 'paintbrush-2'
-  | 'paintbrush'
-  | 'palette'
-  | 'panel-left'
-  | 'pen'
-  | 'pencil-line'
-  | 'pencil'
-  | 'phone'
-  | 'plane-landing'
-  | 'play-circle'
-  | 'plus-circle'
-  | 'plus-square'
-  | 'plus'
-  | 'presentation'
-  | 'puzzle'
-  | 'rectangle-horizontal'
-  | 'rocket'
-  | 'search'
-  | 'settings'
-  | 'shield-question'
-  | 'shopping-bag'
-  | 'shopping-cart'
-  | 'shrink'
-  | 'slack'
-  | 'sliders-horizontal'
-  | 'sliders'
-  | 'slideshow-outline'
-  | 'smartphone'
-  | 'sparkles'
-  | 'square'
-  | 'squircle'
-  | 'star-filled'
-  | 'star-half-filled'
-  | 'star'
-  | 'store'
-  | 'stretch-vertical'
-  | 'sun'
-  | 'tag'
-  | 'tags'
-  | 'terminal'
-  | 'text-cursor-input'
-  | 'timer'
-  | 'trash'
-  | 'truck'
-  | 'twitter'
-  | 'type'
-  | 'undo-2'
-  | 'undo'
-  | 'upload-cloud'
-  | 'upload'
-  | 'user'
-  | 'users'
-  | 'video'
-  | 'wand-2'
-  | 'wand-sparkles'
-  | 'x-logo'
-  | 'x-octagon'
-  | 'x'
-  | 'youtube'
-  | 'zap'
-
-type ToolbarAction = 'general-settings' | 'settings-level-2' | 'duplicate' | 'delete' | 'global-sections';
-type AdvancedGroupType = 'border' | 'alignment' | 'background' | 'dimensions' | 'spacing' | 'typography' | 'visibility' | 'shadows-and-effects' | 'layout-background';
-type PositionInputValue = 'top left' | 'top center' | 'top right' | 'center left' | 'center center' | 'center right' | 'bottom left' | 'bottom center' | 'bottom right';
-type InputType = 'blog' | 'collection' | 'collection-list' | 'color' | 'datepicker' | 'image' | 'video' | 'map-autocomplete' | 'position' | 'product' | 'product-list' | 'range' | 'richtext' | 'select' | 'switch' | 'text' | 'textarea' | 'toggle-group' | 'metaobject' | 'url';
-type WeaverseCSSProperties = CSSProperties;
-type ChildElementCSS = Partial<{
-    [selector: string]: WeaverseCSSProperties & ChildElementCSS;
-}>;
-type WeaverseResourcePickerData = {
-    id: number;
-    handle: string;
-};
-type WeaverseImage = {
-    id: string;
-    url: string;
-    altText: string;
-    width: number;
-    height: number;
-    previewSrc: string;
-};
-type WeaverseVideo = {
-    id: string;
-    url: string;
-    altText: string;
-    width: number;
-    height: number;
-    previewSrc: string;
-};
-type AdditionalInputConfigs = SelectInputConfigs | ToggleGroupConfigs | RangeInputConfigs;
-type ElementCSS = {
-    '@desktop'?: WeaverseCSSProperties | ChildElementCSS;
-    '@mobile'?: WeaverseCSSProperties | ChildElementCSS;
-};
-type ElementData = {
-    id: string;
-    type: string;
-    [key: string]: any;
-};
-type WeaverseElement = {
-    Component: ForwardRefExoticComponent<any>;
-    type: string;
-    'data-wv-id': string;
-    'data-wv-type': string;
-};
-type ElementSchema = {
-    title: string;
-    type: string;
-};
-type BreakPoints = {
-    mobile: string;
-    desktop: string;
-};
-type WeaverseProjectDataType = {
-    id?: string;
-    items: ElementData[];
-    rootId: string;
-};
-type WeaverseCoreParams = {
-    mediaBreakPoints?: BreakPoints;
-    weaverseHost?: string;
-    weaverseVersion?: string;
-    projectId: string;
-    data: WeaverseProjectDataType;
-    isDesignMode?: boolean;
-};
-/**
- * BasicInput interface
- *
- * @property {InputType} type - The type of the input
- * @property {string} name - The key of the value of the element data or styles
- * @property {string} [label] - The label of the input
- * @property {ConfigsType} [configs] - Additional options for inputs that require more configuration
- *
- * @example
- * // Bind to `element.data.title`
- * name: "title"
- * // Bind to `element.css["@desktop"].backgroundColor`
- * name: "backgroundColor"
- */
-type BasicInput<ConfigsType = AdditionalInputConfigs> = {
-    type: InputType;
-    name: string;
-    label?: string;
-    configs?: ConfigsType;
-    condition?: string;
-    defaultValue?: string | number | boolean | Partial<WeaverseImage> | {
-        [x: string]: any;
-    };
-    placeholder?: string;
-    helpText?: string;
-};
-type SelectInputConfigs = {
-    options?: {
-        value: string;
-        label: string;
-    }[];
-};
-type ToggleGroupConfigs = {
-    options?: {
-        value: string;
-        label: string;
-        icon?: IconName;
-    }[];
-};
-type RangeInputConfigs = {
-    min?: number;
-    max?: number;
-    step?: number;
-    unit?: string;
-};
-declare global {
-    interface Window {
-        weaverseStudio: any;
-    }
-}
-
-type AnyFunction = (...args: any[]) => any;
-declare class EventEmitter {
-    listeners: Set<AnyFunction>;
-    constructor();
-    subscribe: (fn: AnyFunction) => () => void;
-    unsubscribe: (fn: AnyFunction) => void;
-    emit: (data: any) => void;
-}
-
-declare class WeaverseItemStore extends EventEmitter {
-    weaverse: Weaverse;
-    ref: RefObject<HTMLElement | null>;
-    _store: ElementData;
-    constructor(initialData: ElementData, weaverse: Weaverse);
-    get _id(): string;
-    get _element(): HTMLElement | null;
-    get Element(): any;
-    getDefaultCss: () => ElementCSS;
-    get data(): ElementData;
-    set data(update: Omit<ElementData, 'id' | 'type'>);
-    setData: (update: Omit<ElementData, "id" | "type">) => ElementData;
-    getSnapShot: () => ElementData;
-    triggerUpdate: () => void;
-}
-declare class Weaverse extends EventEmitter {
-    contentRootElement: HTMLElement | null;
-    static itemInstances: Map<any, any>;
-    weaverseHost: string;
-    weaverseVersion: string;
-    sdkVersion: string;
-    projectId: string;
-    isDesignMode: boolean;
-    isPreviewMode: boolean;
-    studioBridge?: any;
-    static ItemConstructor: typeof WeaverseItemStore;
-    data: WeaverseProjectDataType;
-    dataContext: Record<string, unknown> | null;
-    static elementRegistry: Map<any, any>;
-    static mediaBreakPoints: BreakPoints;
-    constructor(params: WeaverseCoreParams);
-    getSnapShot: () => WeaverseProjectDataType;
-    /**
-     * Create new `WeaverseItemStore` instance for each item in the project.
-     */
-    initProject: () => void;
-    get itemInstances(): Map<any, any>;
-    createItemInstance: (data: ElementData) => WeaverseItemStore;
-    /**
-     * Register the custom React Component to Weaverse, store it into Weaverse.elementRegistry
-     */
-    static registerElement: typeof registerElement;
-    get elementRegistry(): Map<any, any>;
-    triggerUpdate: () => void;
-    refreshAllItems(): void;
-    /**
-     * Reset the project data and re-initialize all items.
-     * Used when we need to re-render the project with new data (like applying new template)
-     * @param data {WeaverseProjectDataType}
-     */
-    setProjectData: (data: WeaverseProjectDataType) => void;
-}
-declare function registerElement(element: {
-    type: string;
-    [x: string]: any;
-}): void;
-
-declare let isReactNative: boolean;
-declare let isBrowser: boolean;
-declare let isIframe: boolean;
-/**
- * Deep merge two objects.
- * @param target
- * @param source
- */
-declare function merge(target: Record<string, any>, source: Record<string, any>): {
-    [x: string]: any;
-};
-declare function loadScript(src: string): Promise<unknown>;
-
-export { type AdditionalInputConfigs, type AdvancedGroupType, type BasicInput, type BreakPoints, type ChildElementCSS, type ElementCSS, type ElementData, type ElementSchema, EventEmitter, type InputType, type PositionInputValue, type RangeInputConfigs, type SelectInputConfigs, type ToggleGroupConfigs, type ToolbarAction, Weaverse, type WeaverseCSSProperties, type WeaverseCoreParams, type WeaverseElement, type WeaverseImage, WeaverseItemStore, type WeaverseProjectDataType, type WeaverseResourcePickerData, type WeaverseVideo, isBrowser, isIframe, isReactNative, loadScript, merge, registerElement };