@elementor/editor-v1-adapters 0.8.2 → 0.8.4

package/src/readers/index.ts

@@ -1,4 +1,4 @@
-import { ExtendedWindow } from './types';
+import { type ExtendedWindow } from './types';
 
 export function isRouteActive( route: string ) {
 	const extendedWindow = window as unknown as ExtendedWindow;

package/src/undoable/get-history-manager.ts

@@ -0,0 +1,39 @@
+import { createError } from '@elementor/utils';
+
+export type HistoryItem = {
+	title: string;
+	subTitle: string;
+	type: string;
+	restore: ( item: HistoryItem, isRedo: boolean ) => void;
+};
+
+type AddHistoryItem = ( item: HistoryItem ) => void;
+
+export type WindowWithHistoryManager = Window & {
+	elementor?: {
+		documents?: {
+			getCurrent?: () => {
+				history?: {
+					addItem: AddHistoryItem;
+				};
+			};
+		};
+	};
+};
+
+export const HistoryManagerNotAvailable = createError( {
+	code: 'history_manager_not_available',
+	message: 'Cannot access History manager.',
+} );
+
+export function getHistoryManager() {
+	const extendedWindow = window as unknown as WindowWithHistoryManager;
+
+	const historyManger = extendedWindow.elementor?.documents?.getCurrent?.()?.history;
+
+	if ( ! historyManger ) {
+		throw new HistoryManagerNotAvailable();
+	}
+
+	return historyManger;
+}

package/src/undoable/index.ts

@@ -0,0 +1 @@
+export { undoable } from './undoable';

package/src/undoable/undoable.ts

@@ -0,0 +1,64 @@
+import { getHistoryManager } from './get-history-manager';
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type Payload = Record< string, any > | undefined;
+
+type LabelGenerator< TPayload extends Payload, TDoReturn > = (
+	payload: TPayload,
+	doReturn: Awaited< TDoReturn >
+) => string;
+
+type Actions< TPayload extends Payload, TDoReturn, TUndoReturn > = {
+	do: ( payload: TPayload ) => TDoReturn;
+	undo: ( payload: TPayload, doReturn: Awaited< TDoReturn > ) => TUndoReturn;
+	redo?: ( payload: TPayload, doReturn: Awaited< TDoReturn > ) => TDoReturn;
+};
+
+type Options< TPayload extends Payload, TDoReturn > = {
+	title: string | LabelGenerator< TPayload, TDoReturn >;
+	subtitle?: string | LabelGenerator< TPayload, TDoReturn >;
+};
+
+// Action WITHOUT a payload.
+export function undoable< TDoReturn, TUndoReturn >(
+	actions: Actions< undefined, TDoReturn, TUndoReturn >,
+	options: Options< undefined, TDoReturn >
+): () => Promise< Awaited< TDoReturn > >;
+
+// Action WITH a payload.
+export function undoable< TPayload extends NonNullable< Payload >, TDoReturn, TUndoReturn >(
+	actions: Actions< TPayload, TDoReturn, TUndoReturn >,
+	options: Options< TPayload, TDoReturn >
+): ( payload: TPayload ) => Promise< Awaited< TDoReturn > >;
+
+export function undoable< TPayload extends Payload, TDoReturn, TUndoReturn >(
+	actions: Actions< TPayload, TDoReturn, TUndoReturn >,
+	options: Options< TPayload, TDoReturn >
+): ( payload?: Payload ) => Promise< Awaited< TDoReturn > > {
+	actions.redo ??= ( payload ) => actions.do( payload );
+
+	return async ( payload ): Promise< Awaited< TDoReturn > > => {
+		const _payload = payload as TPayload;
+		const _actions = actions as Required< Actions< TPayload, TDoReturn, TUndoReturn > >;
+
+		const history = getHistoryManager();
+
+		const result = await _actions.do( _payload );
+
+		history.addItem( {
+			title: normalizeToGenerator( options.title )( _payload, result ),
+			subTitle: normalizeToGenerator( options.subtitle )( _payload, result ),
+			type: '',
+			restore: ( _, isRedo ) =>
+				isRedo ? _actions.redo( _payload, result ) : _actions.undo( _payload, result ),
+		} );
+
+		return result;
+	};
+}
+
+function normalizeToGenerator< TPayload extends Payload, TDoReturn >(
+	value: string | undefined | LabelGenerator< TPayload, TDoReturn >
+) {
+	return typeof value === 'function' ? value : () => value ?? '';
+}