@elementor/editor-canvas 3.33.0-99 → 3.35.0-325

package/dist/index.d.mts

@@ -1,17 +1,10 @@
 import * as _elementor_editor_props from '@elementor/editor-props';
 import { AnyTransformable, PropTypeKey, PropsSchema, Props } from '@elementor/editor-props';
+import { V1ElementModelProps, V1ElementConfig } from '@elementor/editor-elements';
+import { TwingArrayLoader, TwingEnvironment } from '@elementor/twing';
 
 declare function init(): void;
 
-type UnbrandedTransformer<TValue> = (value: TValue, options: {
-    key: string;
-    signal?: AbortSignal;
-}) => unknown;
-type Transformer<TValue> = UnbrandedTransformer<TValue> & {
-    __transformer: true;
-};
-type AnyTransformer = Transformer<any>;
-
 declare const styleTransformersRegistry: {
     register(type: _elementor_editor_props.PropTypeKey, transformer: AnyTransformer): /*elided*/ any;
     registerFallback(transformer: AnyTransformer): /*elided*/ any;
@@ -30,6 +23,15 @@ declare const settingsTransformersRegistry: {
     };
 };
 
+type UnbrandedTransformer<TValue> = (value: TValue, options: {
+    key: string;
+    signal?: AbortSignal;
+}) => unknown;
+type Transformer<TValue> = UnbrandedTransformer<TValue> & {
+    __transformer: true;
+};
+type AnyTransformer = Transformer<any>;
+
 declare function createTransformer<TValue = never>(cb: TValue extends AnyTransformable ? 'Transformable values are invalid, use the actual value instead.' : UnbrandedTransformer<TValue>): Transformer<NoInfer<TValue>>;
 
 type TransformersRegistry = ReturnType<typeof createTransformersRegistry>;
@@ -59,4 +61,125 @@ type ResolvedProps = Record<string, unknown>;
 type PropsResolver = ReturnType<typeof createPropsResolver>;
 declare function createPropsResolver({ transformers, schema: initialSchema, onPropResolve }: CreatePropResolverArgs): ({ props, schema, signal }: ResolveArgs) => Promise<ResolvedProps>;
 
-export { type PropsResolver, createPropsResolver, createTransformer, createTransformersRegistry, init, settingsTransformersRegistry, styleTransformersRegistry };
+declare const startDragElementFromPanel: (props: Omit<V1ElementModelProps, "id">) => void;
+declare const endDragElementFromPanel: () => void;
+
+type DomRenderer = {
+    register: TwingArrayLoader['setTemplate'];
+    render: TwingEnvironment['render'];
+};
+
+type LegacyWindow = Window & {
+    elementor: {
+        createBackboneElementsCollection: (children: unknown) => BackboneCollection<ElementModel>;
+        modules: {
+            elements: {
+                types: {
+                    Widget: typeof ElementType;
+                };
+                views: {
+                    Widget: typeof ElementView;
+                };
+            };
+        };
+        elementsManager: {
+            registerElementType: (type: ElementType) => void;
+        };
+        $preview: [
+            {
+                contentWindow: {
+                    dispatchEvent: (event: Event) => void;
+                };
+            }
+        ];
+    };
+};
+declare class ElementType {
+    getType(): string;
+    getView(): typeof ElementView;
+}
+declare class ElementView {
+    $el: JQueryElement;
+    model: BackboneModel<ElementModel>;
+    collection: BackboneCollection<ElementModel>;
+    children: {
+        length: number;
+        findByIndex: (index: number) => ElementView;
+    };
+    constructor(...args: unknown[]);
+    onRender(...args: unknown[]): void;
+    onDestroy(...args: unknown[]): void;
+    attributes(): Record<string, unknown>;
+    behaviors(): Record<string, unknown>;
+    getDomElement(): JQueryElement;
+    getHandlesOverlay(): JQueryElement | null;
+    getContextMenuGroups(): ContextMenuGroup[];
+    /**
+     * Templated view methods:
+     */
+    getTemplateType(): string;
+    renderOnChange(): void;
+    render(): void;
+    _renderTemplate(): void;
+    _renderChildren(): void;
+    attachBuffer(collectionView: this, buffer: DocumentFragment): void;
+    triggerMethod(method: string, ...args: unknown[]): void;
+    bindUIElements(): void;
+    _ensureViewIsIntact(): void;
+    _isRendering: boolean;
+    resetChildViewContainer(): void;
+    isRendered: boolean;
+    options?: {
+        model: BackboneModel<ElementModel>;
+    };
+    ui(): Record<string, unknown>;
+    events(): Record<string, unknown>;
+}
+type JQueryElement = {
+    find: (selector: string) => JQueryElement;
+    html: (html: string) => void;
+    get: (index: number) => HTMLElement;
+};
+type BackboneModel<Model extends object> = {
+    get: <T extends keyof Model>(key: T) => Model[T];
+    set: <T extends keyof Model>(key: T, value: Model[T]) => void;
+    toJSON: () => ToJSON<Model>;
+};
+type BackboneCollection<Model extends object> = {
+    models: BackboneModel<Model>[];
+    forEach: (callback: (model: BackboneModel<Model>) => void) => void;
+};
+type ElementModel = {
+    id: string;
+    settings: BackboneModel<Props>;
+    editor_settings: Record<string, unknown>;
+    widgetType: string;
+    editSettings?: BackboneModel<{
+        inactive?: boolean;
+    }>;
+    elements?: BackboneCollection<ElementModel>;
+};
+type ToJSON<T> = {
+    [K in keyof T]: T[K] extends BackboneModel<infer M> ? ToJSON<M> : T[K];
+};
+type ContextMenuGroup = {
+    name: string;
+    actions: unknown[];
+};
+
+type CreateTemplatedElementTypeOptions = {
+    type: string;
+    renderer: DomRenderer;
+    element: TemplatedElementConfig;
+};
+type TemplatedElementConfig = Required<Pick<V1ElementConfig, 'twig_templates' | 'twig_main_template' | 'atomic_props_schema' | 'base_styles_dictionary'>>;
+declare function createTemplatedElementView({ type, renderer, element, }: CreateTemplatedElementTypeOptions): typeof ElementView;
+
+type ElementLegacyType = {
+    [key: string]: (options: CreateTemplatedElementTypeOptions) => typeof ElementType;
+};
+declare function registerElementType(type: string, elementTypeGenerator: ElementLegacyType[keyof ElementLegacyType]): void;
+
+declare function getCanvasIframeDocument(): Document | null | undefined;
+
+export { type AnyTransformer, type BackboneModel, type CreateTemplatedElementTypeOptions, type ElementModel, ElementType, ElementView, type LegacyWindow, type PropsResolver, createPropsResolver, createTemplatedElementView, createTransformer, createTransformersRegistry, endDragElementFromPanel, getCanvasIframeDocument, init, registerElementType, settingsTransformersRegistry, startDragElementFromPanel, styleTransformersRegistry };

package/dist/index.d.ts

@@ -1,17 +1,10 @@
 import * as _elementor_editor_props from '@elementor/editor-props';
 import { AnyTransformable, PropTypeKey, PropsSchema, Props } from '@elementor/editor-props';
+import { V1ElementModelProps, V1ElementConfig } from '@elementor/editor-elements';
+import { TwingArrayLoader, TwingEnvironment } from '@elementor/twing';
 
 declare function init(): void;
 
-type UnbrandedTransformer<TValue> = (value: TValue, options: {
-    key: string;
-    signal?: AbortSignal;
-}) => unknown;
-type Transformer<TValue> = UnbrandedTransformer<TValue> & {
-    __transformer: true;
-};
-type AnyTransformer = Transformer<any>;
-
 declare const styleTransformersRegistry: {
     register(type: _elementor_editor_props.PropTypeKey, transformer: AnyTransformer): /*elided*/ any;
     registerFallback(transformer: AnyTransformer): /*elided*/ any;
@@ -30,6 +23,15 @@ declare const settingsTransformersRegistry: {
     };
 };
 
+type UnbrandedTransformer<TValue> = (value: TValue, options: {
+    key: string;
+    signal?: AbortSignal;
+}) => unknown;
+type Transformer<TValue> = UnbrandedTransformer<TValue> & {
+    __transformer: true;
+};
+type AnyTransformer = Transformer<any>;
+
 declare function createTransformer<TValue = never>(cb: TValue extends AnyTransformable ? 'Transformable values are invalid, use the actual value instead.' : UnbrandedTransformer<TValue>): Transformer<NoInfer<TValue>>;
 
 type TransformersRegistry = ReturnType<typeof createTransformersRegistry>;
@@ -59,4 +61,125 @@ type ResolvedProps = Record<string, unknown>;
 type PropsResolver = ReturnType<typeof createPropsResolver>;
 declare function createPropsResolver({ transformers, schema: initialSchema, onPropResolve }: CreatePropResolverArgs): ({ props, schema, signal }: ResolveArgs) => Promise<ResolvedProps>;
 
-export { type PropsResolver, createPropsResolver, createTransformer, createTransformersRegistry, init, settingsTransformersRegistry, styleTransformersRegistry };
+declare const startDragElementFromPanel: (props: Omit<V1ElementModelProps, "id">) => void;
+declare const endDragElementFromPanel: () => void;
+
+type DomRenderer = {
+    register: TwingArrayLoader['setTemplate'];
+    render: TwingEnvironment['render'];
+};
+
+type LegacyWindow = Window & {
+    elementor: {
+        createBackboneElementsCollection: (children: unknown) => BackboneCollection<ElementModel>;
+        modules: {
+            elements: {
+                types: {
+                    Widget: typeof ElementType;
+                };
+                views: {
+                    Widget: typeof ElementView;
+                };
+            };
+        };
+        elementsManager: {
+            registerElementType: (type: ElementType) => void;
+        };
+        $preview: [
+            {
+                contentWindow: {
+                    dispatchEvent: (event: Event) => void;
+                };
+            }
+        ];
+    };
+};
+declare class ElementType {
+    getType(): string;
+    getView(): typeof ElementView;
+}
+declare class ElementView {
+    $el: JQueryElement;
+    model: BackboneModel<ElementModel>;
+    collection: BackboneCollection<ElementModel>;
+    children: {
+        length: number;
+        findByIndex: (index: number) => ElementView;
+    };
+    constructor(...args: unknown[]);
+    onRender(...args: unknown[]): void;
+    onDestroy(...args: unknown[]): void;
+    attributes(): Record<string, unknown>;
+    behaviors(): Record<string, unknown>;
+    getDomElement(): JQueryElement;
+    getHandlesOverlay(): JQueryElement | null;
+    getContextMenuGroups(): ContextMenuGroup[];
+    /**
+     * Templated view methods:
+     */
+    getTemplateType(): string;
+    renderOnChange(): void;
+    render(): void;
+    _renderTemplate(): void;
+    _renderChildren(): void;
+    attachBuffer(collectionView: this, buffer: DocumentFragment): void;
+    triggerMethod(method: string, ...args: unknown[]): void;
+    bindUIElements(): void;
+    _ensureViewIsIntact(): void;
+    _isRendering: boolean;
+    resetChildViewContainer(): void;
+    isRendered: boolean;
+    options?: {
+        model: BackboneModel<ElementModel>;
+    };
+    ui(): Record<string, unknown>;
+    events(): Record<string, unknown>;
+}
+type JQueryElement = {
+    find: (selector: string) => JQueryElement;
+    html: (html: string) => void;
+    get: (index: number) => HTMLElement;
+};
+type BackboneModel<Model extends object> = {
+    get: <T extends keyof Model>(key: T) => Model[T];
+    set: <T extends keyof Model>(key: T, value: Model[T]) => void;
+    toJSON: () => ToJSON<Model>;
+};
+type BackboneCollection<Model extends object> = {
+    models: BackboneModel<Model>[];
+    forEach: (callback: (model: BackboneModel<Model>) => void) => void;
+};
+type ElementModel = {
+    id: string;
+    settings: BackboneModel<Props>;
+    editor_settings: Record<string, unknown>;
+    widgetType: string;
+    editSettings?: BackboneModel<{
+        inactive?: boolean;
+    }>;
+    elements?: BackboneCollection<ElementModel>;
+};
+type ToJSON<T> = {
+    [K in keyof T]: T[K] extends BackboneModel<infer M> ? ToJSON<M> : T[K];
+};
+type ContextMenuGroup = {
+    name: string;
+    actions: unknown[];
+};
+
+type CreateTemplatedElementTypeOptions = {
+    type: string;
+    renderer: DomRenderer;
+    element: TemplatedElementConfig;
+};
+type TemplatedElementConfig = Required<Pick<V1ElementConfig, 'twig_templates' | 'twig_main_template' | 'atomic_props_schema' | 'base_styles_dictionary'>>;
+declare function createTemplatedElementView({ type, renderer, element, }: CreateTemplatedElementTypeOptions): typeof ElementView;
+
+type ElementLegacyType = {
+    [key: string]: (options: CreateTemplatedElementTypeOptions) => typeof ElementType;
+};
+declare function registerElementType(type: string, elementTypeGenerator: ElementLegacyType[keyof ElementLegacyType]): void;
+
+declare function getCanvasIframeDocument(): Document | null | undefined;
+
+export { type AnyTransformer, type BackboneModel, type CreateTemplatedElementTypeOptions, type ElementModel, ElementType, ElementView, type LegacyWindow, type PropsResolver, createPropsResolver, createTemplatedElementView, createTransformer, createTransformersRegistry, endDragElementFromPanel, getCanvasIframeDocument, init, registerElementType, settingsTransformersRegistry, startDragElementFromPanel, styleTransformersRegistry };