@elementor/editor-components 4.0.0-manual → 4.0.0

package/src/extended/utils/component-form-schema.ts

@@ -1,32 +0,0 @@
-import { z } from '@elementor/schema';
-import { __ } from '@wordpress/i18n';
-
-export const MIN_NAME_LENGTH = 2;
-const MAX_NAME_LENGTH = 50;
-
-const baseComponentSchema = z
-	.string()
-	.trim()
-	.max( MAX_NAME_LENGTH, __( 'Component name is too long. Please keep it under 50 characters.', 'elementor' ) );
-
-export const createBaseComponentSchema = ( existingNames: string[] ) => {
-	return z.object( {
-		componentName: baseComponentSchema.refine( ( value ) => ! existingNames.includes( value ), {
-			message: __( 'Component name already exists', 'elementor' ),
-		} ),
-	} );
-};
-
-export const createSubmitComponentSchema = ( existingNames: string[] ) => {
-	const baseSchema = createBaseComponentSchema( existingNames );
-
-	return baseSchema.extend( {
-		componentName: baseSchema.shape.componentName
-			.refine( ( value ) => value.length > 0, {
-				message: __( 'Component name is required.', 'elementor' ),
-			} )
-			.refine( ( value ) => value.length >= MIN_NAME_LENGTH, {
-				message: __( 'Component name is too short. Please enter at least 2 characters.', 'elementor' ),
-			} ),
-	} );
-};

package/src/extended/utils/component-name-validation.ts

@@ -1,27 +0,0 @@
-import { __getState as getState } from '@elementor/store';
-
-import { selectComponents } from '../../store/store';
-import { createSubmitComponentSchema } from './component-form-schema';
-
-type ValidationResult = { isValid: true; errorMessage: null } | { isValid: false; errorMessage: string };
-
-export function validateComponentName( label: string ): ValidationResult {
-	const existingComponentTitles = selectComponents( getState() )?.map( ( { name } ) => name ) ?? [];
-	const schema = createSubmitComponentSchema( existingComponentTitles );
-	const result = schema.safeParse( { componentName: label.toLowerCase() } );
-
-	if ( result.success ) {
-		return {
-			isValid: true,
-			errorMessage: null,
-		};
-	}
-
-	const formattedErrors = result.error.format();
-	const errorMessage = formattedErrors.componentName?._errors[ 0 ] ?? formattedErrors._errors[ 0 ];
-
-	return {
-		isValid: false,
-		errorMessage,
-	};
-}

package/src/extended/utils/create-component-model.ts

@@ -1,28 +0,0 @@
-import { type V1ElementModelProps } from '@elementor/editor-elements';
-
-export type ComponentInstanceParams = {
-	id?: number;
-	name: string;
-	uid: string;
-};
-
-export const createComponentModel = ( component: ComponentInstanceParams ): Omit< V1ElementModelProps, 'id' > => {
-	return {
-		elType: 'widget',
-		widgetType: 'e-component',
-		settings: {
-			component_instance: {
-				$$type: 'component-instance',
-				value: {
-					component_id: {
-						$$type: 'number',
-						value: component.id ?? component.uid,
-					},
-				},
-			},
-		},
-		editor_settings: {
-			component_uid: component.uid,
-		},
-	};
-};

package/src/extended/utils/get-container-for-new-element.ts

@@ -1,49 +0,0 @@
-import {
-	getContainer,
-	getCurrentDocumentContainer,
-	getSelectedElements,
-	type V1Element,
-} from '@elementor/editor-elements';
-
-export const getContainerForNewElement = (): { container: V1Element | null; options?: { at: number } } => {
-	const currentDocumentContainer = getCurrentDocumentContainer();
-	const selectedElement = getSelectedElementContainer();
-
-	let container, options;
-
-	if ( selectedElement ) {
-		switch ( selectedElement.model.get( 'elType' ) ) {
-			case 'widget': {
-				container = selectedElement?.parent;
-
-				const selectedElIndex = selectedElement.view?._index ?? -1;
-
-				if ( selectedElIndex > -1 ) {
-					options = { at: selectedElIndex + 1 };
-				}
-
-				break;
-			}
-			case 'section': {
-				container = selectedElement?.children?.[ 0 ];
-				break;
-			}
-			default: {
-				container = selectedElement;
-				break;
-			}
-		}
-	}
-
-	return { container: container ?? currentDocumentContainer, options };
-};
-
-function getSelectedElementContainer() {
-	const selectedElements = getSelectedElements();
-
-	if ( selectedElements.length !== 1 ) {
-		return undefined;
-	}
-
-	return getContainer( selectedElements[ 0 ].id );
-}

package/src/extended/utils/is-editing-component.ts

@@ -1,13 +0,0 @@
-import { __getStore as getStore } from '@elementor/store';
-
-import { type ComponentsSlice, selectCurrentComponentId } from '../../store/store';
-
-export function isEditingComponent(): boolean {
-	const state = getStore()?.getState() as ComponentsSlice | undefined;
-
-	if ( ! state ) {
-		return false;
-	}
-
-	return selectCurrentComponentId( state ) !== null;
-}

package/src/extended/utils/replace-element-with-component.ts

@@ -1,11 +0,0 @@
-import { replaceElement, type V1ElementData } from '@elementor/editor-elements';
-
-import { type ComponentInstanceParams, createComponentModel } from './create-component-model';
-
-export const replaceElementWithComponent = async ( element: V1ElementData, component: ComponentInstanceParams ) => {
-	return await replaceElement( {
-		currentElement: element,
-		newElement: createComponentModel( component ),
-		withHistory: false,
-	} );
-};

package/src/extended/utils/revert-overridable-settings.ts

@@ -1,207 +0,0 @@
-import {
-	getAllDescendants,
-	getContainer,
-	getElementSetting,
-	updateElementSettings,
-	type V1Element,
-	type V1ElementData,
-	type V1ElementSettingsProps,
-} from '@elementor/editor-elements';
-
-import { COMPONENT_WIDGET_TYPE } from '../../create-component-type';
-import {
-	type ComponentInstanceOverrideProp,
-	componentInstanceOverridePropTypeUtil,
-} from '../../prop-types/component-instance-override-prop-type';
-import {
-	componentInstanceOverridesPropTypeUtil,
-	type ComponentInstanceOverridesPropValue,
-} from '../../prop-types/component-instance-overrides-prop-type';
-import {
-	type ComponentInstanceProp,
-	componentInstancePropTypeUtil,
-	type ComponentInstancePropValue,
-} from '../../prop-types/component-instance-prop-type';
-import { componentOverridablePropTypeUtil } from '../../prop-types/component-overridable-prop-type';
-import { isComponentInstance } from '../../utils/is-component-instance';
-
-type RevertSettingsResult = {
-	hasChanges: boolean;
-	settings: V1ElementSettingsProps;
-};
-
-export function revertElementOverridableSetting(
-	elementId: string,
-	settingKey: string,
-	originValue: unknown,
-	overrideKey: string
-): void {
-	const container = getContainer( elementId );
-
-	if ( ! container ) {
-		return;
-	}
-
-	if ( isComponentInstance( container.model.toJSON() ) ) {
-		revertComponentInstanceOverridableSetting( elementId, overrideKey );
-
-		return;
-	}
-
-	updateElementSettings( {
-		id: elementId,
-		props: { [ settingKey ]: originValue ?? null },
-		withHistory: false,
-	} );
-}
-
-function revertComponentInstanceOverridableSetting( elementId: string, overrideKey: string ): void {
-	const setting = getElementSetting< ComponentInstanceProp >( elementId, 'component_instance' );
-
-	const componentInstance = componentInstancePropTypeUtil.extract( setting );
-	const overrides = componentInstanceOverridesPropTypeUtil.extract( componentInstance?.overrides );
-
-	if ( ! overrides?.length ) {
-		return;
-	}
-
-	const revertedOverrides = revertComponentInstanceOverrides( overrides, overrideKey );
-
-	const updatedSetting = componentInstancePropTypeUtil.create( {
-		...componentInstance,
-		overrides: componentInstanceOverridesPropTypeUtil.create( revertedOverrides ),
-	} as ComponentInstancePropValue );
-
-	updateElementSettings( {
-		id: elementId,
-		props: { component_instance: updatedSetting },
-		withHistory: false,
-	} );
-}
-
-function revertComponentInstanceOverrides(
-	overrides: NonNullable< ComponentInstanceOverridesPropValue >,
-	filterByKey?: string
-): ComponentInstanceOverridesPropValue {
-	return overrides
-		.map( ( item ) => {
-			if ( ! componentOverridablePropTypeUtil.isValid( item ) ) {
-				return item;
-			}
-
-			if ( ! componentInstanceOverridePropTypeUtil.isValid( item.value.origin_value ) ) {
-				return null;
-			}
-
-			if ( filterByKey && item.value.override_key !== filterByKey ) {
-				return item;
-			}
-
-			return item.value.origin_value as ComponentInstanceOverrideProp;
-		} )
-		.filter( ( item ): item is NonNullable< typeof item > => item !== null );
-}
-
-function revertOverridablePropsFromSettings( settings: V1ElementSettingsProps ): RevertSettingsResult {
-	let hasChanges = false;
-	const revertedSettings: V1ElementSettingsProps = {};
-
-	for ( const [ key, value ] of Object.entries( settings ) ) {
-		if ( componentOverridablePropTypeUtil.isValid( value ) ) {
-			revertedSettings[ key ] = value.value.origin_value;
-			hasChanges = true;
-		} else {
-			revertedSettings[ key ] = value;
-		}
-	}
-
-	return { hasChanges, settings: revertedSettings };
-}
-
-export function revertAllOverridablesInElementData( elementData: V1ElementData ): V1ElementData {
-	const revertedElement = { ...elementData };
-
-	if ( isComponentInstance( { widgetType: elementData.widgetType, elType: elementData.elType } ) ) {
-		revertedElement.settings = revertComponentInstanceSettings( elementData.settings );
-	} else if ( revertedElement.settings ) {
-		const { settings } = revertOverridablePropsFromSettings( revertedElement.settings );
-		revertedElement.settings = settings;
-	}
-
-	if ( revertedElement.elements ) {
-		revertedElement.elements = revertedElement.elements.map( revertAllOverridablesInElementData );
-	}
-
-	return revertedElement;
-}
-
-function revertComponentInstanceSettings( settings: V1ElementData[ 'settings' ] ): V1ElementData[ 'settings' ] {
-	if ( ! settings?.component_instance ) {
-		return settings;
-	}
-
-	const componentInstance = componentInstancePropTypeUtil.extract( settings.component_instance );
-	const overrides = componentInstanceOverridesPropTypeUtil.extract( componentInstance?.overrides );
-
-	if ( ! overrides?.length ) {
-		return settings;
-	}
-
-	const revertedOverrides = revertComponentInstanceOverrides( overrides );
-
-	return {
-		...settings,
-		component_instance: componentInstancePropTypeUtil.create( {
-			...componentInstance,
-			overrides: componentInstanceOverridesPropTypeUtil.create( revertedOverrides ),
-		} as ComponentInstancePropValue ),
-	};
-}
-
-export function revertAllOverridablesInContainer( container: V1Element ): void {
-	getAllDescendants( container ).forEach( ( element ) => {
-		if ( element.model.get( 'widgetType' ) === COMPONENT_WIDGET_TYPE ) {
-			revertComponentInstanceOverridesInElement( element );
-		} else {
-			revertElementSettings( element );
-		}
-	} );
-}
-
-function revertComponentInstanceOverridesInElement( element: V1Element ): void {
-	const settings = element.settings?.toJSON() ?? {};
-	const componentInstance = componentInstancePropTypeUtil.extract( settings.component_instance );
-	const overrides = componentInstanceOverridesPropTypeUtil.extract( componentInstance?.overrides );
-
-	if ( ! overrides?.length ) {
-		return;
-	}
-
-	const revertedOverrides = revertComponentInstanceOverrides( overrides );
-
-	const updatedSetting = componentInstancePropTypeUtil.create( {
-		...componentInstance,
-		overrides: componentInstanceOverridesPropTypeUtil.create( revertedOverrides ),
-	} as ComponentInstancePropValue );
-
-	updateElementSettings( {
-		id: element.id,
-		props: { component_instance: updatedSetting },
-		withHistory: false,
-	} );
-}
-
-function revertElementSettings( element: V1Element ): void {
-	const settings = element.settings?.toJSON() ?? {};
-	const { hasChanges, settings: revertedSettings } = revertOverridablePropsFromSettings( settings );
-
-	if ( ! hasChanges ) {
-		return;
-	}
-
-	updateElementSettings( {
-		id: element.id,
-		props: revertedSettings,
-		withHistory: false,
-	} );
-}