@elementor/editor-elements 3.33.0-98 → 3.35.0-324

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { PropsSchema, PropValue, Props } from '@elementor/editor-props';
-import { StyleDefinitionID, StyleDefinition, StyleDefinitionVariant } from '@elementor/editor-styles';
+import { ClassState, StyleDefinitionID, StyleDefinition, StyleDefinitionVariant } from '@elementor/editor-styles';
 import * as _elementor_editor_v1_adapters from '@elementor/editor-v1-adapters';
 
 type ElementID = string;
@@ -12,6 +12,7 @@ type ElementType = {
     controls: ControlItem[];
     propsSchema: PropsSchema;
     dependenciesPerTargetMapping?: Record<string, string[]>;
+    styleStates?: ClassState[];
     title: string;
 };
 type ControlsSection = {
@@ -36,9 +37,41 @@ type Control = {
         };
     };
 };
-type ControlItem = ControlsSection | Control;
+type ElementControl = {
+    type: 'element-control';
+    value: {
+        type: string;
+        label?: string;
+        props: Record<string, unknown>;
+        meta?: {
+            layout?: ControlLayout;
+            topDivider?: boolean;
+        };
+    };
+};
+type ControlItem = ControlsSection | Control | ElementControl;
 type ControlLayout = 'full' | 'two-columns' | 'custom';
 
+type ExtendedWindow = Window & {
+    elementor?: {
+        selection?: {
+            getElements: () => V1Element[];
+        };
+        widgetsCache?: Record<string, V1ElementConfig>;
+        documents?: {
+            getCurrent?: () => {
+                container: V1Element;
+            } | undefined;
+            getCurrentId?: () => number;
+        };
+        getContainer?: (id: string) => V1Element | undefined;
+    };
+    elementorCommon?: {
+        helpers?: {
+            getUniqueId?: () => string;
+        };
+    };
+};
 type V1Element = {
     id: string;
     model: V1Model<V1ElementModelProps>;
@@ -56,17 +89,41 @@ type V1Element = {
     };
     parent?: V1Element;
 };
+type ElementInteractions = {
+    version: number;
+    items: InteractionItem[];
+};
+type InteractionItem = {
+    interaction_id?: string;
+    animation: {
+        animation_type: string;
+        animation_id: string;
+    };
+};
 type V1ElementModelProps = {
+    isLocked?: boolean;
     widgetType?: string;
     elType: string;
     id: string;
     styles?: Record<StyleDefinitionID, StyleDefinition>;
     elements?: V1Model<V1ElementModelProps>[];
     settings?: V1ElementSettingsProps;
+    editor_settings?: V1ElementEditorSettingsProps;
+    interactions?: string | ElementInteractions;
+};
+type V1ElementData = Omit<V1ElementModelProps, 'elements'> & {
+    elements?: V1ElementData[];
+};
+type V1ElementEditorSettingsProps = {
+    title?: string;
+    initial_position?: number;
+    component_uid?: string;
 };
 type V1ElementSettingsProps = Record<string, PropValue>;
-type V1ElementConfig = {
+type V1ElementConfig<T = object> = {
     title: string;
+    widgetType?: string;
+    elType?: string;
     controls: object;
     atomic?: boolean;
     atomic_controls?: ControlItem[];
@@ -76,7 +133,8 @@ type V1ElementConfig = {
     twig_main_template?: string;
     base_styles?: Record<string, StyleDefinition>;
     base_styles_dictionary?: Record<string, string>;
-};
+    atomic_style_states?: ClassState[];
+} & T;
 type V1Model<T> = {
     get: <K extends keyof T>(key: K) => T[K];
     set: <K extends keyof T>(key: K, value: T[K]) => void;
@@ -85,10 +143,18 @@ type V1Model<T> = {
     }) => T;
 };
 
+type ElementModel = {
+    id: string;
+};
+type ElementChildren = Record<string, ElementModel[]>;
+declare function useElementChildren<T extends ElementChildren>(elementId: ElementID, childrenTypes: Record<string, string>): T;
+
+declare const useElementEditorSettings: (elementId: ElementID) => V1ElementEditorSettingsProps;
+
 declare const useElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
 declare const useElementSettings: <TValue>(elementId: ElementID, settingKeys: string[]) => Record<string, TValue>;
 
-declare function useElementType(type?: string): ElementType | null;
+declare function useParentElement(elementId: string | null): any;
 
 declare function useSelectedElement(): {
     element: null;
@@ -98,22 +164,14 @@ declare function useSelectedElement(): {
     elementType: ElementType;
 };
 
-declare function useParentElement(elementId: string | null): V1Element | null | undefined;
-
-type ElementModel = {
-    id: string;
-};
-type ElementChildren = Record<string, ElementModel[]>;
-declare function useElementChildren<T extends ElementChildren>(elementId: ElementID, childrenTypes: (keyof T & string)[]): T;
-
-type Options$2 = {
+type Options$4 = {
     useHistory?: boolean;
     at?: number;
     clone?: boolean;
 };
 type CreateElementParams = {
     containerId: string;
-    options?: Options$2;
+    options?: Options$4;
     model?: Omit<V1ElementModelProps, 'settings' | 'id'> & {
         settings?: V1ElementSettingsProps;
         id?: string;
@@ -121,17 +179,6 @@ type CreateElementParams = {
 };
 declare function createElement({ containerId, model, options }: CreateElementParams): V1Element;
 
-type Options$1 = {
-    useHistory?: boolean;
-    at?: number;
-    clone?: boolean;
-};
-type DuplicateElementParams = {
-    elementId: string;
-    options?: Options$1;
-};
-declare function duplicateElement({ elementId, options }: DuplicateElementParams): V1Element;
-
 type CreateNestedElementsParams = {
     elements: CreateElementParams[];
     title: string;
@@ -148,11 +195,46 @@ type CreatedElementsResult = {
 
 declare const createElements: ({ elements, title, subtitle, }: CreateNestedElementsParams) => CreatedElementsResult;
 
+type Options$3 = {
+    useHistory?: boolean;
+    at?: number;
+};
+declare function deleteElement({ elementId, options, }: {
+    elementId: string;
+    options?: Options$3;
+}): Promise<void>;
+
+type Options$2 = {
+    useHistory?: boolean;
+    at?: number;
+    scrollIntoView: boolean;
+};
+type DropElementParams = {
+    containerId: string;
+    options?: Options$2;
+    model?: Omit<V1ElementModelProps, 'settings' | 'id'> & {
+        settings?: V1ElementSettingsProps;
+        id?: string;
+    };
+};
+declare function dropElement({ containerId, model, options }: DropElementParams): V1Element;
+
+type Options$1 = {
+    useHistory?: boolean;
+    at?: number;
+    clone?: boolean;
+};
+type DuplicateElementParams = {
+    elementId: string;
+    options?: Options$1;
+};
+declare function duplicateElement({ elementId, options }: DuplicateElementParams): V1Element;
+
 type DuplicateElementsParams = {
     elementIds: string[];
     title: string;
     subtitle?: string;
-    onCreate?: (duplicatedElements: DuplicatedElement[]) => DuplicatedElement[];
+    onCreate?: (duplicatedElements: DuplicatedElement[]) => void;
 };
 type DuplicatedElement = {
     id: string;
@@ -166,21 +248,77 @@ type DuplicatedElementsResult = {
     duplicatedElements: DuplicatedElement[];
 };
 
-declare const duplicateElements: ({ elementIds, title, subtitle, onCreate, }: DuplicateElementsParams) => DuplicatedElementsResult;
+declare const duplicateElements: ({ elementIds, title, subtitle, }: DuplicateElementsParams) => DuplicatedElementsResult;
+
+declare const generateElementId: () => string;
+
+declare function getContainer(id: string): V1Element | null;
+declare const selectElement: (elementId: string) => void;
+
+declare function getCurrentDocumentContainer(): V1Element | null;
+
+declare function getCurrentDocumentId(): number | null;
+
+declare function getElementEditorSettings(elementId: ElementID): V1ElementEditorSettingsProps;
+
+declare function getElementLabel(elementId?: ElementID): string;
+
+declare const getElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
+declare const getElementSettings: <TValue>(elementId: ElementID, settingKey: string[]) => Record<string, TValue | null>;
+
+declare const getElementStyles: (elementID: ElementID) => Record<string, StyleDefinition> | null;
+
+declare function getElementType(type: string): ElementType | null;
+
+declare function getElements(root?: ElementID): V1Element[];
+
+declare function getSelectedElements(): Element[];
+
+type WidgetsCache<T> = Record<string, T>;
+declare function getWidgetsCache<T extends V1ElementConfig>(): WidgetsCache<T> | null;
 
 type Options = {
     useHistory?: boolean;
     at?: number;
+    edit?: boolean;
 };
-declare function deleteElement({ elementId, options }: {
+type MoveElementParams = {
     elementId: string;
+    targetContainerId: string;
     options?: Options;
-}): void;
+};
+declare function moveElement({ elementId, targetContainerId, options }: MoveElementParams): V1Element;
+
+type MoveElementsParams = {
+    moves: MoveElementParams[];
+    title: string;
+    subtitle?: string;
+    onMoveElements?: () => void;
+    onRestoreElements?: () => void;
+};
+type OriginalPosition = {
+    elementId: string;
+    originalContainerId: string;
+    originalIndex: number;
+};
+type MovedElement = {
+    elementId: string;
+    originalPosition: OriginalPosition;
+    move: MoveElementParams;
+    element: V1Element;
+};
+type MovedElementsResult = {
+    movedElements: MovedElement[];
+};
+
+declare const moveElements: ({ moves: movesToMake, title, subtitle, onMoveElements, onRestoreElements, }: MoveElementsParams) => MovedElementsResult;
 
 type RemoveNestedElementsParams = {
     elementIds: string[];
     title: string;
     subtitle?: string;
+    onRemoveElements?: () => void;
+    onRestoreElements?: () => void;
 };
 type RemovedElement = {
     elementId: string;
@@ -193,25 +331,19 @@ type RemovedElementsResult = {
     removedElements: RemovedElement[];
 };
 
-declare const removeElements: ({ elementIds, title, subtitle, }: RemoveNestedElementsParams) => RemovedElementsResult;
-
-declare function getContainer(id: string): V1Element | null;
-declare const selectElement: (elementId: string) => void;
-
-declare const getElementSetting: <TValue>(elementId: ElementID, settingKey: string) => TValue | null;
-declare const getElementSettings: <TValue>(elementId: ElementID, settingKey: string[]) => Record<string, TValue | null>;
-
-declare const getElementStyles: (elementID: ElementID) => Record<string, StyleDefinition> | null;
-
-declare function getElementLabel(elementId: ElementID): string;
-
-declare function getElements(root?: ElementID): V1Element[];
-
-declare function getCurrentDocumentId(): number | null;
+declare const removeElements: ({ elementIds, title, subtitle, onRemoveElements, onRestoreElements, }: RemoveNestedElementsParams) => RemovedElementsResult;
 
-declare function getSelectedElements(): Element[];
+type ReplaceElementArgs = {
+    currentElement: V1ElementData;
+    newElement: Omit<V1ElementModelProps, 'id'>;
+    withHistory?: boolean;
+};
+declare const replaceElement: ({ currentElement, newElement, withHistory }: ReplaceElementArgs) => void;
 
-declare function getWidgetsCache(): Record<string, V1ElementConfig> | null;
+declare const updateElementEditorSettings: ({ elementId, settings, }: {
+    elementId: string;
+    settings: V1ElementModelProps["editor_settings"];
+}) => void;
 
 type UpdateElementSettingsArgs = {
     id: ElementID;
@@ -220,14 +352,19 @@ type UpdateElementSettingsArgs = {
 };
 declare const updateElementSettings: ({ id, props, withHistory }: UpdateElementSettingsArgs) => void;
 
-declare const generateElementId: () => string;
-
-type ReplaceElementArgs = {
-    currentElement: V1Element;
-    newElement: Omit<V1ElementModelProps, 'id'>;
-    withHistory?: boolean;
+type LinkInLinkRestriction = {
+    shouldRestrict: true;
+    reason: 'ancestor' | 'descendant';
+    elementId: string | null;
+} | {
+    shouldRestrict: false;
+    reason?: never;
+    elementId?: never;
 };
-declare const replaceElement: ({ currentElement, newElement, withHistory }: ReplaceElementArgs) => void;
+declare function getLinkInLinkRestriction(elementId: string): LinkInLinkRestriction;
+declare function getAnchoredDescendantId(elementId: string): string | null;
+declare function getAnchoredAncestorId(elementId: string): string | null;
+declare function isElementAnchored(elementId: string): boolean;
 
 declare const ELEMENT_STYLE_CHANGE_EVENT = "elementor/editor-v2/editor-elements/style";
 declare const styleRerenderEvents: (_elementor_editor_v1_adapters.CommandEventDescriptor | _elementor_editor_v1_adapters.WindowEventDescriptor)[];
@@ -248,6 +385,8 @@ declare function shouldCreateNewLocalStyle<T>(payload: {
     provider: T | null;
 } | null): boolean;
 
+declare function deleteElementStyle(elementId: ElementID, styleId: StyleDefinitionID): void;
+
 type UpdateElementStyleArgs = {
     elementId: ElementID;
     styleId: StyleDefinition['id'];
@@ -257,20 +396,16 @@ type UpdateElementStyleArgs = {
 };
 declare function updateElementStyle(args: UpdateElementStyleArgs): void;
 
-declare function deleteElementStyle(elementId: ElementID, styleId: StyleDefinitionID): void;
+declare const useElementInteractions: (elementId: ElementID) => ElementInteractions;
 
-type LinkInLinkRestriction = {
-    shouldRestrict: true;
-    reason: 'ancestor' | 'descendant';
-    elementId: string | null;
-} | {
-    shouldRestrict: false;
-    reason?: never;
-    elementId?: never;
-};
-declare function getLinkInLinkRestriction(elementId: string): LinkInLinkRestriction;
-declare function getAnchoredDescendantId(elementId: string): string | null;
-declare function getAnchoredAncestorId(elementId: string): string | null;
-declare function isElementAnchored(elementId: string): boolean;
+declare function getElementInteractions(elementId: ElementID): ElementInteractions | undefined;
+
+declare const updateElementInteractions: ({ elementId, interactions, }: {
+    elementId: string;
+    interactions: V1ElementModelProps["interactions"];
+}) => void;
+declare const playElementInteractions: (elementId: string, animationId: string) => void;
+
+declare function initMcp(): void;
 
-export { type Control, type ControlItem, type ControlLayout, type ControlsSection, type CreateElementParams, type CreateElementStyleArgs, type DuplicateElementParams, type DuplicateElementsParams, type DuplicatedElement, type DuplicatedElementsResult, ELEMENT_STYLE_CHANGE_EVENT, type Element, type ElementChildren, type ElementID, type ElementType, type LinkInLinkRestriction, type UpdateElementSettingsArgs, type UpdateElementStyleArgs, type V1Element, type V1ElementConfig, type V1ElementModelProps, type V1ElementSettingsProps, createElement, createElementStyle, createElements, deleteElement, deleteElementStyle, duplicateElement, duplicateElements, generateElementId, getAnchoredAncestorId, getAnchoredDescendantId, getContainer, getCurrentDocumentId, getElementLabel, getElementSetting, getElementSettings, getElementStyles, getElements, getLinkInLinkRestriction, getSelectedElements, getWidgetsCache, isElementAnchored, removeElements, replaceElement, selectElement, shouldCreateNewLocalStyle, styleRerenderEvents, updateElementSettings, updateElementStyle, useElementChildren, useElementSetting, useElementSettings, useElementType, useParentElement, useSelectedElement };
+export { type Control, type ControlItem, type ControlLayout, type ControlsSection, type CreateElementParams, type CreateElementStyleArgs, type DropElementParams, type DuplicateElementParams, type DuplicateElementsParams, type DuplicatedElement, type DuplicatedElementsResult, ELEMENT_STYLE_CHANGE_EVENT, type Element, type ElementChildren, type ElementControl, type ElementID, type ElementInteractions, type ElementModel, type ElementType, type ExtendedWindow, type InteractionItem, type LinkInLinkRestriction, type MoveElementParams, type MoveElementsParams, type MovedElement, type MovedElementsResult, type UpdateElementSettingsArgs, type UpdateElementStyleArgs, type V1Element, type V1ElementConfig, type V1ElementData, type V1ElementEditorSettingsProps, type V1ElementModelProps, type V1ElementSettingsProps, createElement, createElementStyle, createElements, deleteElement, deleteElementStyle, dropElement, duplicateElement, duplicateElements, generateElementId, getAnchoredAncestorId, getAnchoredDescendantId, getContainer, getCurrentDocumentContainer, getCurrentDocumentId, getElementEditorSettings, getElementInteractions, getElementLabel, getElementSetting, getElementSettings, getElementStyles, getElementType, getElements, getLinkInLinkRestriction, getSelectedElements, getWidgetsCache, initMcp as initElementsMcp, isElementAnchored, moveElement, moveElements, playElementInteractions, removeElements, replaceElement, selectElement, shouldCreateNewLocalStyle, styleRerenderEvents, updateElementEditorSettings, updateElementInteractions, updateElementSettings, updateElementStyle, useElementChildren, useElementEditorSettings, useElementInteractions, useElementSetting, useElementSettings, useParentElement, useSelectedElement };