@wordpress/edit-post 6.6.0 → 6.9.0

package/src/store/actions.js

@@ -27,18 +27,22 @@ import { store as editPostStore } from '.';
  *
  * @param {?string} name Sidebar name to be opened.
  */
-export const openGeneralSidebar = ( name ) => ( { registry } ) =>
-	registry
-		.dispatch( interfaceStore )
-		.enableComplementaryArea( editPostStore.name, name );
+export const openGeneralSidebar =
+	( name ) =>
+	( { registry } ) =>
+		registry
+			.dispatch( interfaceStore )
+			.enableComplementaryArea( editPostStore.name, name );
 
 /**
  * Returns an action object signalling that the user closed the sidebar.
  */
-export const closeGeneralSidebar = () => ( { registry } ) =>
-	registry
-		.dispatch( interfaceStore )
-		.disableComplementaryArea( editPostStore.name );
+export const closeGeneralSidebar =
+	() =>
+	( { registry } ) =>
+		registry
+			.dispatch( interfaceStore )
+			.disableComplementaryArea( editPostStore.name );
 
 /**
  * Returns an action object used in signalling that the user opened a modal.
@@ -107,58 +111,62 @@ export function togglePublishSidebar() {
  *
  * @return {Object} Action object.
  */
-export const toggleEditorPanelEnabled = ( panelName ) => ( { registry } ) => {
-	const inactivePanels =
-		registry
-			.select( preferencesStore )
-			.get( 'core/edit-post', 'inactivePanels' ) ?? [];
-
-	const isPanelInactive = !! inactivePanels?.includes( panelName );
-
-	// If the panel is inactive, remove it to enable it, else add it to
-	// make it inactive.
-	let updatedInactivePanels;
-	if ( isPanelInactive ) {
-		updatedInactivePanels = inactivePanels.filter(
-			( invactivePanelName ) => invactivePanelName !== panelName
-		);
-	} else {
-		updatedInactivePanels = [ ...inactivePanels, panelName ];
-	}
+export const toggleEditorPanelEnabled =
+	( panelName ) =>
+	( { registry } ) => {
+		const inactivePanels =
+			registry
+				.select( preferencesStore )
+				.get( 'core/edit-post', 'inactivePanels' ) ?? [];
+
+		const isPanelInactive = !! inactivePanels?.includes( panelName );
+
+		// If the panel is inactive, remove it to enable it, else add it to
+		// make it inactive.
+		let updatedInactivePanels;
+		if ( isPanelInactive ) {
+			updatedInactivePanels = inactivePanels.filter(
+				( invactivePanelName ) => invactivePanelName !== panelName
+			);
+		} else {
+			updatedInactivePanels = [ ...inactivePanels, panelName ];
+		}
 
-	registry
-		.dispatch( preferencesStore )
-		.set( 'core/edit-post', 'inactivePanels', updatedInactivePanels );
-};
+		registry
+			.dispatch( preferencesStore )
+			.set( 'core/edit-post', 'inactivePanels', updatedInactivePanels );
+	};
 
 /**
  * Opens a closed panel and closes an open panel.
  *
  * @param {string} panelName A string that identifies the panel to open or close.
  */
-export const toggleEditorPanelOpened = ( panelName ) => ( { registry } ) => {
-	const openPanels =
-		registry
-			.select( preferencesStore )
-			.get( 'core/edit-post', 'openPanels' ) ?? [];
-
-	const isPanelOpen = !! openPanels?.includes( panelName );
-
-	// If the panel is open, remove it to close it, else add it to
-	// make it open.
-	let updatedOpenPanels;
-	if ( isPanelOpen ) {
-		updatedOpenPanels = openPanels.filter(
-			( openPanelName ) => openPanelName !== panelName
-		);
-	} else {
-		updatedOpenPanels = [ ...openPanels, panelName ];
-	}
+export const toggleEditorPanelOpened =
+	( panelName ) =>
+	( { registry } ) => {
+		const openPanels =
+			registry
+				.select( preferencesStore )
+				.get( 'core/edit-post', 'openPanels' ) ?? [];
+
+		const isPanelOpen = !! openPanels?.includes( panelName );
+
+		// If the panel is open, remove it to close it, else add it to
+		// make it open.
+		let updatedOpenPanels;
+		if ( isPanelOpen ) {
+			updatedOpenPanels = openPanels.filter(
+				( openPanelName ) => openPanelName !== panelName
+			);
+		} else {
+			updatedOpenPanels = [ ...openPanels, panelName ];
+		}
 
-	registry
-		.dispatch( preferencesStore )
-		.set( 'core/edit-post', 'openPanels', updatedOpenPanels );
-};
+		registry
+			.dispatch( preferencesStore )
+			.set( 'core/edit-post', 'openPanels', updatedOpenPanels );
+	};
 
 /**
  * Returns an action object used to remove a panel from the editor.
@@ -179,45 +187,56 @@ export function removeEditorPanel( panelName ) {
  *
  * @param {string} feature Feature name.
  */
-export const toggleFeature = ( feature ) => ( { registry } ) =>
-	registry.dispatch( preferencesStore ).toggle( 'core/edit-post', feature );
+export const toggleFeature =
+	( feature ) =>
+	( { registry } ) =>
+		registry
+			.dispatch( preferencesStore )
+			.toggle( 'core/edit-post', feature );
 
 /**
  * Triggers an action used to switch editor mode.
  *
  * @param {string} mode The editor mode.
  */
-export const switchEditorMode = ( mode ) => ( { registry } ) => {
-	registry
-		.dispatch( preferencesStore )
-		.set( 'core/edit-post', 'editorMode', mode );
-
-	// Unselect blocks when we switch to the code editor.
-	if ( mode !== 'visual' ) {
-		registry.dispatch( blockEditorStore ).clearSelectedBlock();
-	}
-
-	const message =
-		mode === 'visual'
-			? __( 'Visual editor selected' )
-			: __( 'Code editor selected' );
-	speak( message, 'assertive' );
-};
+export const switchEditorMode =
+	( mode ) =>
+	( { registry } ) => {
+		registry
+			.dispatch( preferencesStore )
+			.set( 'core/edit-post', 'editorMode', mode );
+
+		// Unselect blocks when we switch to the code editor.
+		if ( mode !== 'visual' ) {
+			registry.dispatch( blockEditorStore ).clearSelectedBlock();
+		}
+
+		const message =
+			mode === 'visual'
+				? __( 'Visual editor selected' )
+				: __( 'Code editor selected' );
+		speak( message, 'assertive' );
+	};
 
 /**
  * Triggers an action object used to toggle a plugin name flag.
  *
  * @param {string} pluginName Plugin name.
  */
-export const togglePinnedPluginItem = ( pluginName ) => ( { registry } ) => {
-	const isPinned = registry
-		.select( interfaceStore )
-		.isItemPinned( 'core/edit-post', pluginName );
+export const togglePinnedPluginItem =
+	( pluginName ) =>
+	( { registry } ) => {
+		const isPinned = registry
+			.select( interfaceStore )
+			.isItemPinned( 'core/edit-post', pluginName );
 
-	registry
-		.dispatch( interfaceStore )
-		[ isPinned ? 'unpinItem' : 'pinItem' ]( 'core/edit-post', pluginName );
-};
+		registry
+			.dispatch( interfaceStore )
+			[ isPinned ? 'unpinItem' : 'pinItem' ](
+				'core/edit-post',
+				pluginName
+			);
+	};
 
 /**
  * Returns an action object used in signaling that a style should be auto-applied when a block is created.
@@ -225,85 +244,91 @@ export const togglePinnedPluginItem = ( pluginName ) => ( { registry } ) => {
  * @param {string}  blockName  Name of the block.
  * @param {?string} blockStyle Name of the style that should be auto applied. If undefined, the "auto apply" setting of the block is removed.
  */
-export const updatePreferredStyleVariations = ( blockName, blockStyle ) => ( {
-	registry,
-} ) => {
-	if ( ! blockName ) {
-		return;
-	}
-
-	const existingVariations =
-		registry
-			.select( preferencesStore )
-			.get( 'core/edit-post', 'preferredStyleVariations' ) ?? {};
-
-	// When the blockStyle is omitted, remove the block's preferred variation.
-	if ( ! blockStyle ) {
-		const updatedVariations = {
-			...existingVariations,
-		};
+export const updatePreferredStyleVariations =
+	( blockName, blockStyle ) =>
+	( { registry } ) => {
+		if ( ! blockName ) {
+			return;
+		}
 
-		delete updatedVariations[ blockName ];
+		const existingVariations =
+			registry
+				.select( preferencesStore )
+				.get( 'core/edit-post', 'preferredStyleVariations' ) ?? {};
 
-		registry
-			.dispatch( preferencesStore )
-			.set(
-				'core/edit-post',
-				'preferredStyleVariations',
-				updatedVariations
-			);
-	} else {
-		// Else add the variation.
-		registry
-			.dispatch( preferencesStore )
-			.set( 'core/edit-post', 'preferredStyleVariations', {
+		// When the blockStyle is omitted, remove the block's preferred variation.
+		if ( ! blockStyle ) {
+			const updatedVariations = {
 				...existingVariations,
-				[ blockName ]: blockStyle,
-			} );
-	}
-};
+			};
+
+			delete updatedVariations[ blockName ];
+
+			registry
+				.dispatch( preferencesStore )
+				.set(
+					'core/edit-post',
+					'preferredStyleVariations',
+					updatedVariations
+				);
+		} else {
+			// Else add the variation.
+			registry
+				.dispatch( preferencesStore )
+				.set( 'core/edit-post', 'preferredStyleVariations', {
+					...existingVariations,
+					[ blockName ]: blockStyle,
+				} );
+		}
+	};
 
 /**
  * Update the provided block types to be visible.
  *
  * @param {string[]} blockNames Names of block types to show.
  */
-export const showBlockTypes = ( blockNames ) => ( { registry } ) => {
-	const existingBlockNames =
-		registry
-			.select( preferencesStore )
-			.get( 'core/edit-post', 'hiddenBlockTypes' ) ?? [];
-
-	const newBlockNames = without(
-		existingBlockNames,
-		...castArray( blockNames )
-	);
+export const showBlockTypes =
+	( blockNames ) =>
+	( { registry } ) => {
+		const existingBlockNames =
+			registry
+				.select( preferencesStore )
+				.get( 'core/edit-post', 'hiddenBlockTypes' ) ?? [];
+
+		const newBlockNames = without(
+			existingBlockNames,
+			...castArray( blockNames )
+		);
 
-	registry
-		.dispatch( preferencesStore )
-		.set( 'core/edit-post', 'hiddenBlockTypes', newBlockNames );
-};
+		registry
+			.dispatch( preferencesStore )
+			.set( 'core/edit-post', 'hiddenBlockTypes', newBlockNames );
+	};
 
 /**
  * Update the provided block types to be hidden.
  *
  * @param {string[]} blockNames Names of block types to hide.
  */
-export const hideBlockTypes = ( blockNames ) => ( { registry } ) => {
-	const existingBlockNames =
-		registry
-			.select( preferencesStore )
-			.get( 'core/edit-post', 'hiddenBlockTypes' ) ?? [];
-
-	const mergedBlockNames = new Set( [
-		...existingBlockNames,
-		...castArray( blockNames ),
-	] );
+export const hideBlockTypes =
+	( blockNames ) =>
+	( { registry } ) => {
+		const existingBlockNames =
+			registry
+				.select( preferencesStore )
+				.get( 'core/edit-post', 'hiddenBlockTypes' ) ?? [];
+
+		const mergedBlockNames = new Set( [
+			...existingBlockNames,
+			...castArray( blockNames ),
+		] );
 
-	registry
-		.dispatch( preferencesStore )
-		.set( 'core/edit-post', 'hiddenBlockTypes', [ ...mergedBlockNames ] );
-};
+		registry
+			.dispatch( preferencesStore )
+			.set( 'core/edit-post', 'hiddenBlockTypes', [
+				...mergedBlockNames,
+			] );
+	};
 
 /**
  * Returns an action object used in signaling
@@ -311,82 +336,82 @@ export const hideBlockTypes = ( blockNames ) => ( { registry } ) => {
  *
  * @param {Object} metaBoxesPerLocation Meta boxes per location.
  */
-export const setAvailableMetaBoxesPerLocation = ( metaBoxesPerLocation ) => ( {
-	dispatch,
-} ) =>
-	dispatch( {
-		type: 'SET_META_BOXES_PER_LOCATIONS',
-		metaBoxesPerLocation,
-	} );
+export const setAvailableMetaBoxesPerLocation =
+	( metaBoxesPerLocation ) =>
+	( { dispatch } ) =>
+		dispatch( {
+			type: 'SET_META_BOXES_PER_LOCATIONS',
+			metaBoxesPerLocation,
+		} );
 
 /**
  * Update a metabox.
  */
-export const requestMetaBoxUpdates = () => async ( {
-	registry,
-	select,
-	dispatch,
-} ) => {
-	dispatch( {
-		type: 'REQUEST_META_BOX_UPDATES',
-	} );
-
-	// Saves the wp_editor fields.
-	if ( window.tinyMCE ) {
-		window.tinyMCE.triggerSave();
-	}
-
-	// Additional data needed for backward compatibility.
-	// If we do not provide this data, the post will be overridden with the default values.
-	const post = registry.select( editorStore ).getCurrentPost();
-	const additionalData = [
-		post.comment_status ? [ 'comment_status', post.comment_status ] : false,
-		post.ping_status ? [ 'ping_status', post.ping_status ] : false,
-		post.sticky ? [ 'sticky', post.sticky ] : false,
-		post.author ? [ 'post_author', post.author ] : false,
-	].filter( Boolean );
-
-	// We gather all the metaboxes locations data and the base form data.
-	const baseFormData = new window.FormData(
-		document.querySelector( '.metabox-base-form' )
-	);
-	const activeMetaBoxLocations = select.getActiveMetaBoxLocations();
-	const formDataToMerge = [
-		baseFormData,
-		...activeMetaBoxLocations.map(
-			( location ) =>
-				new window.FormData( getMetaBoxContainer( location ) )
-		),
-	];
-
-	// Merge all form data objects into a single one.
-	const formData = reduce(
-		formDataToMerge,
-		( memo, currentFormData ) => {
-			for ( const [ key, value ] of currentFormData ) {
-				memo.append( key, value );
-			}
-			return memo;
-		},
-		new window.FormData()
-	);
-	additionalData.forEach( ( [ key, value ] ) =>
-		formData.append( key, value )
-	);
-
-	try {
-		// Save the metaboxes.
-		await apiFetch( {
-			url: window._wpMetaBoxUrl,
-			method: 'POST',
-			body: formData,
-			parse: false,
+export const requestMetaBoxUpdates =
+	() =>
+	async ( { registry, select, dispatch } ) => {
+		dispatch( {
+			type: 'REQUEST_META_BOX_UPDATES',
 		} );
-		dispatch.metaBoxUpdatesSuccess();
-	} catch {
-		dispatch.metaBoxUpdatesFailure();
-	}
-};
+
+		// Saves the wp_editor fields.
+		if ( window.tinyMCE ) {
+			window.tinyMCE.triggerSave();
+		}
+
+		// Additional data needed for backward compatibility.
+		// If we do not provide this data, the post will be overridden with the default values.
+		const post = registry.select( editorStore ).getCurrentPost();
+		const additionalData = [
+			post.comment_status
+				? [ 'comment_status', post.comment_status ]
+				: false,
+			post.ping_status ? [ 'ping_status', post.ping_status ] : false,
+			post.sticky ? [ 'sticky', post.sticky ] : false,
+			post.author ? [ 'post_author', post.author ] : false,
+		].filter( Boolean );
+
+		// We gather all the metaboxes locations data and the base form data.
+		const baseFormData = new window.FormData(
+			document.querySelector( '.metabox-base-form' )
+		);
+		const activeMetaBoxLocations = select.getActiveMetaBoxLocations();
+		const formDataToMerge = [
+			baseFormData,
+			...activeMetaBoxLocations.map(
+				( location ) =>
+					new window.FormData( getMetaBoxContainer( location ) )
+			),
+		];
+
+		// Merge all form data objects into a single one.
+		const formData = reduce(
+			formDataToMerge,
+			( memo, currentFormData ) => {
+				for ( const [ key, value ] of currentFormData ) {
+					memo.append( key, value );
+				}
+				return memo;
+			},
+			new window.FormData()
+		);
+		additionalData.forEach( ( [ key, value ] ) =>
+			formData.append( key, value )
+		);
+
+		try {
+			// Save the metaboxes.
+			await apiFetch( {
+				url: window._wpMetaBoxUrl,
+				method: 'POST',
+				body: formData,
+				parse: false,
+			} );
+			dispatch.metaBoxUpdatesSuccess();
+		} catch {
+			dispatch.metaBoxUpdatesFailure();
+		}
+	};
 
 /**
  * Returns an action object used to signal a successful meta box update.
@@ -474,103 +499,105 @@ export function setIsEditingTemplate( value ) {
  *
  * @param {boolean} newTemplate Is new template.
  */
-export const __unstableSwitchToTemplateMode = ( newTemplate = false ) => ( {
-	registry,
-	select,
-	dispatch,
-} ) => {
-	dispatch( setIsEditingTemplate( true ) );
-	const isWelcomeGuideActive = select.isFeatureActive(
-		'welcomeGuideTemplate'
-	);
-	if ( ! isWelcomeGuideActive ) {
-		const message = newTemplate
-			? __( "Custom template created. You're in template mode now." )
-			: __(
-					'Editing template. Changes made here affect all posts and pages that use the template.'
-			  );
-		registry.dispatch( noticesStore ).createSuccessNotice( message, {
-			type: 'snackbar',
-		} );
-	}
-};
+export const __unstableSwitchToTemplateMode =
+	( newTemplate = false ) =>
+	( { registry, select, dispatch } ) => {
+		dispatch( setIsEditingTemplate( true ) );
+		const isWelcomeGuideActive = select.isFeatureActive(
+			'welcomeGuideTemplate'
+		);
+		if ( ! isWelcomeGuideActive ) {
+			const message = newTemplate
+				? __( "Custom template created. You're in template mode now." )
+				: __(
+						'Editing template. Changes made here affect all posts and pages that use the template.'
+				  );
+			registry.dispatch( noticesStore ).createSuccessNotice( message, {
+				type: 'snackbar',
+			} );
+		}
+	};
 
 /**
  * Create a block based template.
  *
  * @param {Object?} template Template to create and assign.
  */
-export const __unstableCreateTemplate = ( template ) => async ( {
-	registry,
-} ) => {
-	const savedTemplate = await registry
-		.dispatch( coreStore )
-		.saveEntityRecord( 'postType', 'wp_template', template );
-	const post = registry.select( editorStore ).getCurrentPost();
-	registry
-		.dispatch( coreStore )
-		.editEntityRecord( 'postType', post.type, post.id, {
-			template: savedTemplate.slug,
-		} );
-};
+export const __unstableCreateTemplate =
+	( template ) =>
+	async ( { registry } ) => {
+		const savedTemplate = await registry
+			.dispatch( coreStore )
+			.saveEntityRecord( 'postType', 'wp_template', template );
+		const post = registry.select( editorStore ).getCurrentPost();
+		registry
+			.dispatch( coreStore )
+			.editEntityRecord( 'postType', post.type, post.id, {
+				template: savedTemplate.slug,
+			} );
+	};
 
 let metaBoxesInitialized = false;
 
 /**
  * Initializes WordPress `postboxes` script and the logic for saving meta boxes.
  */
-export const initializeMetaBoxes = () => ( { registry, select, dispatch } ) => {
-	const isEditorReady = registry
-		.select( editorStore )
-		.__unstableIsEditorReady();
-
-	if ( ! isEditorReady ) {
-		return;
-	}
-	// Only initialize once.
-	if ( metaBoxesInitialized ) {
-		return;
-	}
-	const postType = registry.select( editorStore ).getCurrentPostType();
-	if ( window.postboxes.page !== postType ) {
-		window.postboxes.add_postbox_toggles( postType );
-	}
-
-	metaBoxesInitialized = true;
-
-	let wasSavingPost = registry.select( editorStore ).isSavingPost();
-	let wasAutosavingPost = registry.select( editorStore ).isAutosavingPost();
-	const hasMetaBoxes = select.hasMetaBoxes();
-
-	// Save metaboxes when performing a full save on the post.
-	registry.subscribe( async () => {
-		const isSavingPost = registry.select( editorStore ).isSavingPost();
-		const isAutosavingPost = registry
+export const initializeMetaBoxes =
+	() =>
+	( { registry, select, dispatch } ) => {
+		const isEditorReady = registry
 			.select( editorStore )
-			.isAutosavingPost();
+			.__unstableIsEditorReady();
 
-		// Save metaboxes on save completion, except for autosaves that are not a post preview.
-		//
-		// Meta boxes are initialized once at page load. It is not necessary to
-		// account for updates on each state change.
-		//
-		// See: https://github.com/WordPress/WordPress/blob/5.1.1/wp-admin/includes/post.php#L2307-L2309.
-		const shouldTriggerMetaboxesSave =
-			hasMetaBoxes &&
-			wasSavingPost &&
-			! isSavingPost &&
-			! wasAutosavingPost;
-
-		// Save current state for next inspection.
-		wasSavingPost = isSavingPost;
-		wasAutosavingPost = isAutosavingPost;
-
-		if ( shouldTriggerMetaboxesSave ) {
-			await dispatch.requestMetaBoxUpdates();
+		if ( ! isEditorReady ) {
+			return;
 		}
-	} );
+		// Only initialize once.
+		if ( metaBoxesInitialized ) {
+			return;
+		}
+		const postType = registry.select( editorStore ).getCurrentPostType();
+		if ( window.postboxes.page !== postType ) {
+			window.postboxes.add_postbox_toggles( postType );
+		}
+
+		metaBoxesInitialized = true;
+
+		let wasSavingPost = registry.select( editorStore ).isSavingPost();
+		let wasAutosavingPost = registry
+			.select( editorStore )
+			.isAutosavingPost();
+		const hasMetaBoxes = select.hasMetaBoxes();
+
+		// Save metaboxes when performing a full save on the post.
+		registry.subscribe( async () => {
+			const isSavingPost = registry.select( editorStore ).isSavingPost();
+			const isAutosavingPost = registry
+				.select( editorStore )
+				.isAutosavingPost();
+
+			// Save metaboxes on save completion, except for autosaves that are not a post preview.
+			//
+			// Meta boxes are initialized once at page load. It is not necessary to
+			// account for updates on each state change.
+			//
+			// See: https://github.com/WordPress/WordPress/blob/5.1.1/wp-admin/includes/post.php#L2307-L2309.
+			const shouldTriggerMetaboxesSave =
+				hasMetaBoxes &&
+				wasSavingPost &&
+				! isSavingPost &&
+				! wasAutosavingPost;
+
+			// Save current state for next inspection.
+			wasSavingPost = isSavingPost;
+			wasAutosavingPost = isAutosavingPost;
+
+			if ( shouldTriggerMetaboxesSave ) {
+				await dispatch.requestMetaBoxUpdates();
+			}
+		} );
 
-	dispatch( {
-		type: 'META_BOXES_INITIALIZED',
-	} );
-};
+		dispatch( {
+			type: 'META_BOXES_INITIALIZED',
+		} );
+	};