@elementor/editor-documents 0.11.4 → 0.11.6

package/src/types.ts

@@ -1,82 +1,82 @@
 export type ExitTo = 'dashboard' | 'all_posts' | 'this_post';
 
 export type Document = {
-	id: number,
-	title: string,
+	id: number;
+	title: string;
 	type: {
-		value: string,
-		label: string,
-	},
+		value: string;
+		label: string;
+	};
 	status: {
-		value: string,
-		label: string,
-	},
+		value: string;
+		label: string;
+	};
 	links: {
-		platformEdit: string,
-		permalink: string,
-	}
-	isDirty: boolean,
-	isSaving: boolean,
-	isSavingDraft: boolean,
+		platformEdit: string;
+		permalink: string;
+	};
+	isDirty: boolean;
+	isSaving: boolean;
+	isSavingDraft: boolean;
 	userCan: {
-		publish?: boolean,
-	},
+		publish?: boolean;
+	};
 	permissions: {
-		allowAddingWidgets: boolean,
-		showCopyAndShare: boolean,
-	},
+		allowAddingWidgets: boolean;
+		showCopyAndShare: boolean;
+	};
 };
 
 export type ExtendedWindow = Window & {
 	elementor: {
 		documents: {
-			documents: Record<string, V1Document>,
-			getCurrentId: () => number,
-			getInitialId: () => number,
-			getCurrent: () => V1Document,
-		},
-		getPreferences: ( key: 'exit_to' ) => ExitTo,
-	}
-}
+			documents: Record< string, V1Document >;
+			getCurrentId: () => number;
+			getInitialId: () => number;
+			getCurrent: () => V1Document;
+		};
+		getPreferences: ( key: 'exit_to' ) => ExitTo;
+	};
+};
 
 export type V1Document = {
-	id: number,
+	id: number;
 	config: {
-		type: string,
+		type: string;
 		user: {
-			can_publish: boolean,
-		},
+			can_publish: boolean;
+		};
 		revisions: {
-			current_id: number,
-		}
+			current_id: number;
+		};
 		panel: {
-			title: string,
-			allow_adding_widgets: boolean,
-			show_copy_and_share: boolean,
-		}
+			title: string;
+			allow_adding_widgets: boolean;
+			show_copy_and_share: boolean;
+		};
 		status: {
-			value: string,
-			label: string,
-		},
+			value: string;
+			label: string;
+		};
 		urls: {
-			exit_to_dashboard: string,
-			permalink: string,
-			main_dashboard: string,
-			all_post_type: string,
-		},
-	},
+			exit_to_dashboard: string;
+			permalink: string;
+			main_dashboard: string;
+			all_post_type: string;
+		};
+	};
 	editor: {
-		isChanged: boolean,
-		isSaving: boolean,
-	},
+		isChanged: boolean;
+		isSaving: boolean;
+	};
 	container: {
-		settings: V1Model<{
-			post_title: string,
-			exit_to: ExitTo,
-		}>,
-	}
-}
+		settings: V1Model< {
+			post_title: string;
+			exit_to: ExitTo;
+		} >;
+	};
+};
 
-type V1Model<T> = {
-	get: <K extends keyof T = keyof T>( key: K ) => T[K],
-}
+type V1Model< T > = {
+	get: < K extends keyof T = keyof T >( key: K ) => T[ K ];
+};

package/src/hooks/__tests__/use-active-document-actions.test.ts

@@ -1,60 +0,0 @@
-import useActiveDocumentActions from '../use-active-document-actions';
-import { __privateOpenRoute as openRoute, __privateRunCommand as runCommand } from '@elementor/editor-v1-adapters';
-import { __createStore, __registerSlice, SliceState, Store } from '@elementor/store';
-import { slice } from '../../store';
-import { renderHookWithStore } from 'test-utils';
-
-jest.mock( '@elementor/editor-v1-adapters' );
-
-describe( '@elementor/editor-documents - useActiveDocumentActions', () => {
-	let store: Store<SliceState<typeof slice>>;
-
-	beforeEach( () => {
-		__registerSlice( slice );
-		store = __createStore();
-	} );
-
-	it( 'should run documents actions', () => {
-		// Arrange.
-		const { result } = renderHookWithStore( useActiveDocumentActions, store );
-
-		const {
-			save,
-			saveDraft,
-			saveTemplate,
-		} = result.current;
-
-		// Act.
-		save();
-		saveDraft();
-		saveTemplate();
-
-		// Assert.
-		expect( runCommand ).toHaveBeenCalledTimes( 2 );
-
-		expect( runCommand ).toHaveBeenNthCalledWith( 1, 'document/save/default' );
-		expect( runCommand ).toHaveBeenNthCalledWith( 2, 'document/save/draft' );
-
-		expect( openRoute ).toHaveBeenCalledTimes( 1 );
-		expect( openRoute ).toHaveBeenCalledWith( 'library/save-template' );
-	} );
-
-	it( 'should return memoized callbacks', () => {
-		// Arrange.
-		const { result, rerender } = renderHookWithStore( useActiveDocumentActions, store );
-
-		const {
-			save,
-			saveDraft,
-			saveTemplate,
-		} = result.current;
-
-		// Act.
-		rerender();
-
-		// Assert.
-		expect( result.current.save ).toBe( save );
-		expect( result.current.saveDraft ).toBe( saveDraft );
-		expect( result.current.saveTemplate ).toBe( saveTemplate );
-	} );
-} );

package/src/hooks/__tests__/use-active-document.test.tsx

@@ -1,34 +0,0 @@
-import { slice } from '../../store';
-import useActiveDocument from '../use-active-document';
-import { __createStore, __dispatch, __registerSlice, SliceState, Store } from '@elementor/store';
-import { createMockDocument, renderHookWithStore } from 'test-utils';
-
-describe( '@elementor/editor-documents - useActiveDocument', () => {
-	let store: Store<SliceState<typeof slice>>;
-
-	beforeEach( () => {
-		__registerSlice( slice );
-		store = __createStore();
-	} );
-
-	it( 'should return the current document', () => {
-		// Arrange.
-		const mockDocument = createMockDocument();
-
-		__dispatch( slice.actions.activateDocument( mockDocument ) );
-
-		// Act.
-		const { result } = renderHookWithStore( useActiveDocument, store );
-
-		// Assert.
-		expect( result.current ).toBe( mockDocument );
-	} );
-
-	it( 'should return null when the current document is not found', () => {
-		// Act.
-		const { result } = renderHookWithStore( useActiveDocument, store );
-
-		// Assert.
-		expect( result.current ).toBeNull();
-	} );
-} );

package/src/hooks/__tests__/use-host-document.test.tsx

@@ -1,45 +0,0 @@
-import { slice } from '../../store';
-import { __createStore, __dispatch, __registerSlice, SliceState, Store } from '@elementor/store';
-import useHostDocument from '../use-host-document';
-import { createMockDocument, renderHookWithStore } from 'test-utils';
-
-describe( '@elementor/editor-documents - useHostDocument', () => {
-	const mockDocument = createMockDocument();
-
-	let store: Store<SliceState<typeof slice>>;
-
-	beforeEach( () => {
-		__registerSlice( slice );
-		store = __createStore();
-	} );
-
-	it( 'should return the host document', () => {
-		// Arrange.
-		__dispatch( slice.actions.init( {
-			entities: { [ mockDocument.id ]: mockDocument },
-			activeId: null,
-			hostId: mockDocument.id,
-		} ) );
-
-		// Act.
-		const { result } = renderHookWithStore( useHostDocument, store );
-
-		// Assert.
-		expect( result.current ).toEqual( expect.objectContaining( { id: mockDocument.id } ) );
-	} );
-
-	it( 'should return null when the host document is not found', () => {
-		// Arrange.
-		__dispatch( slice.actions.init( {
-			entities: { [ mockDocument.id ]: mockDocument },
-			activeId: null,
-			hostId: null,
-		} ) );
-
-		// Act.
-		const { result } = renderHookWithStore( useHostDocument, store );
-
-		// Assert.
-		expect( result.current ).toBeNull();
-	} );
-} );

package/src/hooks/__tests__/use-navigate-to-document.test.ts

@@ -1,60 +0,0 @@
-import { renderHook } from '@testing-library/react';
-import { __privateRunCommand as runCommand } from '@elementor/editor-v1-adapters';
-import { useNavigateToDocument } from '../index';
-
-jest.mock( '@elementor/editor-v1-adapters' );
-
-describe( '@elementor/editor-documents - useNavigateToDocument', () => {
-	const originalReplaceState = history.replaceState;
-	const originalLocation = window.location;
-
-	beforeEach( () => {
-		jest.resetAllMocks();
-
-		history.replaceState = jest.fn();
-
-		/**
-		 * @see https://gist.github.com/the0neWhoKnocks/bdac1d09b93b8418d948558f7ab233d7#setting-props-on-windowlocation
-		 */
-		Object.defineProperty( window, 'location', {
-			writable: true,
-			value: new URL( 'https://localhost/' ),
-		} );
-	} );
-
-	afterAll( () => {
-		history.replaceState = originalReplaceState;
-
-		Object.defineProperty( window, 'location', {
-			writable: false,
-			value: originalLocation,
-		} );
-	} );
-
-	it( 'should navigate to document and change query params', async () => {
-		// Arrange.
-		// TS doesn't allow modifying the location object.
-		( window as unknown as { location: URL } ).location = new URL( 'https://localhost/?post=1&active-document=3' );
-
-		const { result } = renderHook( useNavigateToDocument );
-
-		const navigateToDocument = result.current;
-
-		// Act.
-		await navigateToDocument( 123 );
-
-		// Assert.
-		expect( runCommand ).toHaveBeenCalledTimes( 1 );
-		expect( runCommand ).toHaveBeenCalledWith( 'editor/documents/switch', {
-			id: 123,
-			setAsInitial: true,
-		} );
-
-		expect( history.replaceState ).toHaveBeenCalledTimes( 1 );
-		expect( history.replaceState ).toHaveBeenCalledWith(
-			expect.anything(),
-			expect.anything(),
-			expect.objectContaining( { href: 'https://localhost/?post=123' } )
-		);
-	} );
-} );

package/src/hooks/__tests__/use-sync-document-title.test.ts

@@ -1,99 +0,0 @@
-import { createMockDocument } from 'test-utils';
-import { renderHook } from '@testing-library/react';
-import useHostDocument from '../use-host-document';
-import useActiveDocument from '../use-active-document';
-import useSyncDocumentTitle from '../use-sync-document-title';
-
-jest.mock( '../use-active-document' );
-jest.mock( '../use-host-document' );
-
-describe( 'useSyncDocumentTitle', () => {
-	beforeEach( () => {
-		jest.resetAllMocks();
-	} );
-
-	it( 'should set the document title to be the active document', () => {
-		// Arrange - set the initial document.
-		jest.mocked( useActiveDocument ).mockReturnValue( createMockDocument( {
-			type: {
-				value: 'page',
-				label: 'Page',
-			},
-			title: 'Initial Document',
-		} ) );
-
-		// Act.
-		const { rerender } = renderHook( useSyncDocumentTitle );
-
-		// Assert.
-		expect( window.document.title ).toBe( 'Edit "Initial Document" with Elementor' );
-
-		// Arrange - set the new document.
-		jest.mocked( useActiveDocument ).mockReturnValue( createMockDocument( {
-			type: {
-				value: 'page',
-				label: 'Page',
-			},
-			title: 'New Document',
-		} ) );
-
-		// Act.
-		rerender();
-
-		// Assert.
-		expect( window.document.title ).toBe( 'Edit "New Document" with Elementor' );
-	} );
-
-	it( 'should use the host document title when the active document is a kit', () => {
-		// Arrange.
-		jest.mocked( useActiveDocument ).mockReturnValue( createMockDocument( {
-			type: {
-				value: 'kit',
-				label: 'Kit',
-			},
-			title: 'My Kit',
-		} ) );
-
-		jest.mocked( useHostDocument ).mockReturnValue( createMockDocument( {
-			type: {
-				value: 'page',
-				label: 'Page',
-			},
-			title: 'My Page',
-		} ) );
-
-		window.document.title = 'Old title';
-
-		// Act.
-		renderHook( useSyncDocumentTitle );
-
-		// Assert.
-		expect( window.document.title ).toBe( 'Edit "My Page" with Elementor' );
-	} );
-
-	it( 'should not modify the title when there is no active document', () => {
-		// Arrange.
-		jest.mocked( useActiveDocument ).mockReturnValue( null );
-
-		window.document.title = 'Old title';
-
-		// Act.
-		renderHook( useSyncDocumentTitle );
-
-		// Assert.
-		expect( window.document.title ).toBe( 'Old title' );
-	} );
-
-	it( 'should allow empty string as title', () => {
-		// Arrange.
-		jest.mocked( useActiveDocument ).mockReturnValue( createMockDocument( {
-			title: '',
-		} ) );
-
-		// Act.
-		renderHook( useSyncDocumentTitle );
-
-		// Assert.
-		expect( window.document.title ).toBe( 'Edit "" with Elementor' );
-	} );
-} );