@elementor/elementor-mcp-common 4.1.0-754

package/dist/index.d.mts

@@ -0,0 +1,289 @@
+type WaitForElementorOptions = {
+    maxRetries: number;
+    retryInterval?: number;
+    checkFn: () => boolean;
+};
+declare function isGutenbergEditor(): boolean;
+declare function isElementorEditor(): boolean;
+declare function isElementorAIActive(): boolean;
+declare function hasGutenbergUI(): boolean;
+declare function ensureElementorFrontend(): void;
+declare function isElementorEditorReady(): boolean;
+declare function waitForElementorEditor(): Promise<void>;
+declare function waitForElementor(options?: WaitForElementorOptions): Promise<void>;
+declare function whenElementorReady<T>(fn: () => T | Promise<T>, options?: WaitForElementorOptions): Promise<T>;
+
+interface GutenbergBlockEditorDispatch {
+    updateBlockAttributes: (clientId: string, attributes: Record<string, unknown>) => void;
+}
+interface GutenbergBlockEditorSelect {
+    getBlock: (clientId: string) => {
+        name: string;
+    } | null;
+}
+interface GutenbergBlock {
+    name: string;
+}
+declare function injectElementCSS(elementId: string, css: string): void;
+declare function removeElementCSS(elementId: string): void;
+declare function updateElementSettings({ id, settings, }: {
+    id: string;
+    settings: Record<string, unknown>;
+}): Promise<unknown>;
+declare function getElementSettings(id: string): unknown;
+declare function getGutenbergBlockEditorApis(): {
+    blockEditorDispatch: GutenbergBlockEditorDispatch;
+    blockEditorSelect: GutenbergBlockEditorSelect;
+};
+declare function validateAndGetGutenbergBlock(blockEditorSelect: GutenbergBlockEditorSelect, blockId: string): GutenbergBlock;
+declare function updateGutenbergBlockAttributes(blockId: string, attributes: Record<string, unknown>): {
+    blockId: string;
+    blockName: string;
+    updatedAttributes: string[];
+};
+declare function extractElementImageData(targetElementId: string, fallbackImageId?: string, fallbackImageUrl?: string): {
+    imageId: string;
+    imageUrl: string;
+};
+declare function isSelectAllCheckbox(input: HTMLInputElement): boolean;
+
+type WpApiResponse = unknown;
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type CallWpApiOptions = {
+    binaryData?: ArrayBufferLike;
+    customHeaders?: Record<string, string>;
+};
+type CallWpApiResult<T> = {
+    data: T;
+    totalItems?: number;
+    totalPages?: number;
+};
+declare function callWpApi<T = WpApiResponse>(endpoint: string, method: HttpMethod, data?: Record<string, unknown>, options?: CallWpApiOptions): Promise<CallWpApiResult<T>>;
+declare function extractJSONFromResponse(responseText: string): unknown;
+
+declare function initNonceRefresh(): void;
+declare function refreshNonce(): Promise<string>;
+declare function isNonceError(status: number, responseText: string): boolean;
+
+interface WpApiSettings {
+    nonce: string;
+    root: string;
+}
+interface ElementorContainer {
+    id: string;
+    model: {
+        id: string;
+        get: (key: string) => unknown;
+        attributes?: Record<string, unknown>;
+        editor_settings?: {
+            title?: string;
+        };
+    };
+    settings: {
+        get: (key: string) => unknown;
+        attributes?: Record<string, unknown>;
+        controls?: Record<string, unknown>;
+    };
+    children?: ElementorContainer[];
+    view?: {
+        el: HTMLElement;
+    };
+    parent?: ElementorContainer;
+}
+interface ElementorDocument {
+    id: string;
+    container: ElementorContainer;
+    config?: {
+        type?: string;
+        settings?: Record<string, unknown>;
+    };
+    editor?: {
+        status?: string;
+        isChanged?: boolean;
+    };
+    history?: {
+        active?: boolean;
+        setActive?: (active: boolean) => void;
+    };
+}
+interface ElementorChannels {
+    deviceMode?: {
+        request: (key?: string) => unknown;
+    };
+    dataEditMode?: {
+        request: (key?: string) => unknown;
+    };
+}
+interface ElementorInstance {
+    documents: {
+        getCurrent: () => ElementorDocument | null;
+        get?: (id: string | number) => ElementorDocument | null;
+    };
+    getContainer: (id: string) => ElementorContainer | null;
+    getCurrentElement: () => {
+        model: {
+            id: string;
+        };
+    } | null;
+    on: (event: string, callback: () => void) => void;
+    config?: {
+        responsive?: {
+            breakpoints?: Record<string, unknown>;
+        };
+        controls?: Record<string, unknown>;
+        v4Promotions?: Record<string, unknown>;
+        default_schemes?: Record<string, unknown>;
+        atomicDynamicTags?: {
+            tags?: Record<string, unknown>;
+            groups?: Record<string, unknown>;
+        };
+    };
+    helpers?: {
+        hasPro?: () => boolean;
+        enqueueFont?: (font: string) => void;
+    };
+    $preview?: [HTMLIFrameElement];
+    selection?: {
+        elements?: Record<string, unknown>;
+        getElements?: () => unknown[];
+    };
+    hooks?: {
+        addFilter: (name: string, callback: (...args: unknown[]) => unknown) => void;
+    };
+    dynamicTags?: {
+        getConfig: (key: string) => Record<string, unknown>;
+        tagDataToTagText: (id: string, name: string, settings: Record<string, unknown>) => string;
+        createTag?: (options: Record<string, unknown>) => unknown;
+        loadTagDataFromCache?: (tag: unknown, key: string) => unknown;
+        refreshCacheFromServer?: (tag: unknown, callback: () => void) => void;
+    };
+    widgetsCache?: Record<string, {
+        controls?: Record<string, unknown>;
+        title?: string;
+        atomic_controls?: unknown[];
+    }>;
+    channels?: ElementorChannels;
+    getPanelView?: () => {
+        getHeaderView?: () => {
+            setTitle?: (title: string) => void;
+        };
+        getCurrentPageView?: () => unknown;
+    };
+    getPreferences?: (key: string) => unknown;
+    changeEditMode?: (mode: string) => void;
+    modules?: Record<string, unknown>;
+}
+interface ElementorFrontendInstance {
+    elements: {
+        $body: JQuery & HTMLElement[];
+    };
+    on: (event: string, callback: () => void) => void;
+    config?: {
+        responsive?: {
+            activeBreakpoints?: Record<string, unknown>;
+        };
+        kit?: {
+            active_breakpoints?: string[];
+        };
+        experimentalFeatures?: Record<string, boolean>;
+        is_rtl?: boolean;
+    };
+}
+interface ElementorCommandsInstance {
+    run: (command: string, args?: Record<string, unknown>) => Promise<unknown>;
+    components: {
+        get: (name: string) => {
+            getCommands?: () => {
+                open?: {
+                    registerConfig: {
+                        command: string;
+                    };
+                };
+                close?: {
+                    registerConfig: {
+                        command: string;
+                    };
+                };
+            };
+            getNamespace?: () => string;
+        } | null;
+        getAll?: () => string[];
+    };
+    routes?: {
+        getAll?: () => string[];
+        isPartOf?: (route: string) => boolean;
+        to?: (route: string, args?: Record<string, unknown>) => void;
+        register?: (route: string, callback: () => void) => void;
+        saveState?: (namespace: string) => void;
+        back?: (namespace: string) => void;
+        getComponent?: (route: string) => {
+            getNamespace: () => string;
+        };
+    };
+    data?: {
+        get?: (key: string) => Promise<unknown>;
+    };
+    modules?: {
+        hookData?: Record<string, unknown>;
+    };
+}
+interface WpDataInstance {
+    select: (store: string) => Record<string, unknown> | undefined;
+    dispatch: (store: string) => Record<string, unknown>;
+}
+interface JQuery {
+    resize: () => void;
+    [index: number]: HTMLElement;
+}
+interface ElementorCommonInstance {
+    eventsManager?: {
+        dispatchEvent?: (name: string, data: unknown, options?: Record<string, unknown>) => void;
+        canSendEvents?: () => boolean;
+        initializeMixpanel?: (onLoaded: (mpInstance?: unknown) => void) => void;
+        config?: Record<string, unknown>;
+    };
+    config?: {
+        isRTL?: boolean;
+        version?: string;
+        experimentalFeatures?: Record<string, boolean>;
+        urls?: Record<string, string>;
+    };
+    helpers?: {
+        getUniqueId?: () => number | string;
+    };
+    ajax?: {
+        addRequest?: (endpoint: string, options: {
+            success?: (data: unknown) => void;
+        }) => Promise<void>;
+    };
+}
+
+interface McpWindow {
+    elementor?: ElementorInstance;
+    elementorFrontend?: ElementorFrontendInstance;
+    $e?: ElementorCommandsInstance;
+    elementorCommon?: ElementorCommonInstance;
+    wpApiSettings?: WpApiSettings;
+    ajaxurl?: string;
+    wp?: {
+        data: WpDataInstance;
+    };
+    jQuery?: (selector: unknown) => {
+        on: (event: string, callback: (event: unknown, data: unknown) => void) => void;
+        get?: (index: number) => HTMLElement;
+    };
+    ElementorAiConfig?: Record<string, unknown>;
+}
+declare const getElementor: () => ElementorInstance | undefined;
+declare const getElementorFrontend: () => ElementorFrontendInstance | undefined;
+declare const get$e: () => ElementorCommandsInstance | undefined;
+declare const getElementorCommon: () => ElementorCommonInstance | undefined;
+declare const getWpApiSettings: () => WpApiSettings | undefined;
+declare const getAjaxUrl: () => string | undefined;
+declare const getWp: () => {
+    data: WpDataInstance;
+} | undefined;
+declare const getJQuery: () => McpWindow["jQuery"];
+declare const getElementorAiConfig: () => Record<string, unknown> | undefined;
+
+export { type ElementorChannels, type ElementorCommandsInstance, type ElementorCommonInstance, type ElementorContainer, type ElementorDocument, type ElementorFrontendInstance, type ElementorInstance, type JQuery, type WpApiSettings, type WpDataInstance, callWpApi, ensureElementorFrontend, extractElementImageData, extractJSONFromResponse, get$e, getAjaxUrl, getElementSettings, getElementor, getElementorAiConfig, getElementorCommon, getElementorFrontend, getGutenbergBlockEditorApis, getJQuery, getWp, getWpApiSettings, hasGutenbergUI, initNonceRefresh, injectElementCSS, isElementorAIActive, isElementorEditor, isElementorEditorReady, isGutenbergEditor, isNonceError, isSelectAllCheckbox, refreshNonce, removeElementCSS, updateElementSettings, updateGutenbergBlockAttributes, validateAndGetGutenbergBlock, waitForElementor, waitForElementorEditor, whenElementorReady };

package/dist/index.d.ts

@@ -0,0 +1,289 @@
+type WaitForElementorOptions = {
+    maxRetries: number;
+    retryInterval?: number;
+    checkFn: () => boolean;
+};
+declare function isGutenbergEditor(): boolean;
+declare function isElementorEditor(): boolean;
+declare function isElementorAIActive(): boolean;
+declare function hasGutenbergUI(): boolean;
+declare function ensureElementorFrontend(): void;
+declare function isElementorEditorReady(): boolean;
+declare function waitForElementorEditor(): Promise<void>;
+declare function waitForElementor(options?: WaitForElementorOptions): Promise<void>;
+declare function whenElementorReady<T>(fn: () => T | Promise<T>, options?: WaitForElementorOptions): Promise<T>;
+
+interface GutenbergBlockEditorDispatch {
+    updateBlockAttributes: (clientId: string, attributes: Record<string, unknown>) => void;
+}
+interface GutenbergBlockEditorSelect {
+    getBlock: (clientId: string) => {
+        name: string;
+    } | null;
+}
+interface GutenbergBlock {
+    name: string;
+}
+declare function injectElementCSS(elementId: string, css: string): void;
+declare function removeElementCSS(elementId: string): void;
+declare function updateElementSettings({ id, settings, }: {
+    id: string;
+    settings: Record<string, unknown>;
+}): Promise<unknown>;
+declare function getElementSettings(id: string): unknown;
+declare function getGutenbergBlockEditorApis(): {
+    blockEditorDispatch: GutenbergBlockEditorDispatch;
+    blockEditorSelect: GutenbergBlockEditorSelect;
+};
+declare function validateAndGetGutenbergBlock(blockEditorSelect: GutenbergBlockEditorSelect, blockId: string): GutenbergBlock;
+declare function updateGutenbergBlockAttributes(blockId: string, attributes: Record<string, unknown>): {
+    blockId: string;
+    blockName: string;
+    updatedAttributes: string[];
+};
+declare function extractElementImageData(targetElementId: string, fallbackImageId?: string, fallbackImageUrl?: string): {
+    imageId: string;
+    imageUrl: string;
+};
+declare function isSelectAllCheckbox(input: HTMLInputElement): boolean;
+
+type WpApiResponse = unknown;
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS';
+type CallWpApiOptions = {
+    binaryData?: ArrayBufferLike;
+    customHeaders?: Record<string, string>;
+};
+type CallWpApiResult<T> = {
+    data: T;
+    totalItems?: number;
+    totalPages?: number;
+};
+declare function callWpApi<T = WpApiResponse>(endpoint: string, method: HttpMethod, data?: Record<string, unknown>, options?: CallWpApiOptions): Promise<CallWpApiResult<T>>;
+declare function extractJSONFromResponse(responseText: string): unknown;
+
+declare function initNonceRefresh(): void;
+declare function refreshNonce(): Promise<string>;
+declare function isNonceError(status: number, responseText: string): boolean;
+
+interface WpApiSettings {
+    nonce: string;
+    root: string;
+}
+interface ElementorContainer {
+    id: string;
+    model: {
+        id: string;
+        get: (key: string) => unknown;
+        attributes?: Record<string, unknown>;
+        editor_settings?: {
+            title?: string;
+        };
+    };
+    settings: {
+        get: (key: string) => unknown;
+        attributes?: Record<string, unknown>;
+        controls?: Record<string, unknown>;
+    };
+    children?: ElementorContainer[];
+    view?: {
+        el: HTMLElement;
+    };
+    parent?: ElementorContainer;
+}
+interface ElementorDocument {
+    id: string;
+    container: ElementorContainer;
+    config?: {
+        type?: string;
+        settings?: Record<string, unknown>;
+    };
+    editor?: {
+        status?: string;
+        isChanged?: boolean;
+    };
+    history?: {
+        active?: boolean;
+        setActive?: (active: boolean) => void;
+    };
+}
+interface ElementorChannels {
+    deviceMode?: {
+        request: (key?: string) => unknown;
+    };
+    dataEditMode?: {
+        request: (key?: string) => unknown;
+    };
+}
+interface ElementorInstance {
+    documents: {
+        getCurrent: () => ElementorDocument | null;
+        get?: (id: string | number) => ElementorDocument | null;
+    };
+    getContainer: (id: string) => ElementorContainer | null;
+    getCurrentElement: () => {
+        model: {
+            id: string;
+        };
+    } | null;
+    on: (event: string, callback: () => void) => void;
+    config?: {
+        responsive?: {
+            breakpoints?: Record<string, unknown>;
+        };
+        controls?: Record<string, unknown>;
+        v4Promotions?: Record<string, unknown>;
+        default_schemes?: Record<string, unknown>;
+        atomicDynamicTags?: {
+            tags?: Record<string, unknown>;
+            groups?: Record<string, unknown>;
+        };
+    };
+    helpers?: {
+        hasPro?: () => boolean;
+        enqueueFont?: (font: string) => void;
+    };
+    $preview?: [HTMLIFrameElement];
+    selection?: {
+        elements?: Record<string, unknown>;
+        getElements?: () => unknown[];
+    };
+    hooks?: {
+        addFilter: (name: string, callback: (...args: unknown[]) => unknown) => void;
+    };
+    dynamicTags?: {
+        getConfig: (key: string) => Record<string, unknown>;
+        tagDataToTagText: (id: string, name: string, settings: Record<string, unknown>) => string;
+        createTag?: (options: Record<string, unknown>) => unknown;
+        loadTagDataFromCache?: (tag: unknown, key: string) => unknown;
+        refreshCacheFromServer?: (tag: unknown, callback: () => void) => void;
+    };
+    widgetsCache?: Record<string, {
+        controls?: Record<string, unknown>;
+        title?: string;
+        atomic_controls?: unknown[];
+    }>;
+    channels?: ElementorChannels;
+    getPanelView?: () => {
+        getHeaderView?: () => {
+            setTitle?: (title: string) => void;
+        };
+        getCurrentPageView?: () => unknown;
+    };
+    getPreferences?: (key: string) => unknown;
+    changeEditMode?: (mode: string) => void;
+    modules?: Record<string, unknown>;
+}
+interface ElementorFrontendInstance {
+    elements: {
+        $body: JQuery & HTMLElement[];
+    };
+    on: (event: string, callback: () => void) => void;
+    config?: {
+        responsive?: {
+            activeBreakpoints?: Record<string, unknown>;
+        };
+        kit?: {
+            active_breakpoints?: string[];
+        };
+        experimentalFeatures?: Record<string, boolean>;
+        is_rtl?: boolean;
+    };
+}
+interface ElementorCommandsInstance {
+    run: (command: string, args?: Record<string, unknown>) => Promise<unknown>;
+    components: {
+        get: (name: string) => {
+            getCommands?: () => {
+                open?: {
+                    registerConfig: {
+                        command: string;
+                    };
+                };
+                close?: {
+                    registerConfig: {
+                        command: string;
+                    };
+                };
+            };
+            getNamespace?: () => string;
+        } | null;
+        getAll?: () => string[];
+    };
+    routes?: {
+        getAll?: () => string[];
+        isPartOf?: (route: string) => boolean;
+        to?: (route: string, args?: Record<string, unknown>) => void;
+        register?: (route: string, callback: () => void) => void;
+        saveState?: (namespace: string) => void;
+        back?: (namespace: string) => void;
+        getComponent?: (route: string) => {
+            getNamespace: () => string;
+        };
+    };
+    data?: {
+        get?: (key: string) => Promise<unknown>;
+    };
+    modules?: {
+        hookData?: Record<string, unknown>;
+    };
+}
+interface WpDataInstance {
+    select: (store: string) => Record<string, unknown> | undefined;
+    dispatch: (store: string) => Record<string, unknown>;
+}
+interface JQuery {
+    resize: () => void;
+    [index: number]: HTMLElement;
+}
+interface ElementorCommonInstance {
+    eventsManager?: {
+        dispatchEvent?: (name: string, data: unknown, options?: Record<string, unknown>) => void;
+        canSendEvents?: () => boolean;
+        initializeMixpanel?: (onLoaded: (mpInstance?: unknown) => void) => void;
+        config?: Record<string, unknown>;
+    };
+    config?: {
+        isRTL?: boolean;
+        version?: string;
+        experimentalFeatures?: Record<string, boolean>;
+        urls?: Record<string, string>;
+    };
+    helpers?: {
+        getUniqueId?: () => number | string;
+    };
+    ajax?: {
+        addRequest?: (endpoint: string, options: {
+            success?: (data: unknown) => void;
+        }) => Promise<void>;
+    };
+}
+
+interface McpWindow {
+    elementor?: ElementorInstance;
+    elementorFrontend?: ElementorFrontendInstance;
+    $e?: ElementorCommandsInstance;
+    elementorCommon?: ElementorCommonInstance;
+    wpApiSettings?: WpApiSettings;
+    ajaxurl?: string;
+    wp?: {
+        data: WpDataInstance;
+    };
+    jQuery?: (selector: unknown) => {
+        on: (event: string, callback: (event: unknown, data: unknown) => void) => void;
+        get?: (index: number) => HTMLElement;
+    };
+    ElementorAiConfig?: Record<string, unknown>;
+}
+declare const getElementor: () => ElementorInstance | undefined;
+declare const getElementorFrontend: () => ElementorFrontendInstance | undefined;
+declare const get$e: () => ElementorCommandsInstance | undefined;
+declare const getElementorCommon: () => ElementorCommonInstance | undefined;
+declare const getWpApiSettings: () => WpApiSettings | undefined;
+declare const getAjaxUrl: () => string | undefined;
+declare const getWp: () => {
+    data: WpDataInstance;
+} | undefined;
+declare const getJQuery: () => McpWindow["jQuery"];
+declare const getElementorAiConfig: () => Record<string, unknown> | undefined;
+
+export { type ElementorChannels, type ElementorCommandsInstance, type ElementorCommonInstance, type ElementorContainer, type ElementorDocument, type ElementorFrontendInstance, type ElementorInstance, type JQuery, type WpApiSettings, type WpDataInstance, callWpApi, ensureElementorFrontend, extractElementImageData, extractJSONFromResponse, get$e, getAjaxUrl, getElementSettings, getElementor, getElementorAiConfig, getElementorCommon, getElementorFrontend, getGutenbergBlockEditorApis, getJQuery, getWp, getWpApiSettings, hasGutenbergUI, initNonceRefresh, injectElementCSS, isElementorAIActive, isElementorEditor, isElementorEditorReady, isGutenbergEditor, isNonceError, isSelectAllCheckbox, refreshNonce, removeElementCSS, updateElementSettings, updateGutenbergBlockAttributes, validateAndGetGutenbergBlock, waitForElementor, waitForElementorEditor, whenElementorReady };