@wordpress/editor 12.7.0 → 12.10.0

package/src/hooks/custom-sources-backwards-compatibility.js

@@ -42,55 +42,56 @@ import { store as editorStore } from '../store';
  */
 const createWithMetaAttributeSource = ( metaAttributes ) =>
 	createHigherOrderComponent(
-		( BlockEdit ) => ( { attributes, setAttributes, ...props } ) => {
-			const postType = useSelect(
-				( select ) => select( editorStore ).getCurrentPostType(),
-				[]
-			);
-			const [ meta, setMeta ] = useEntityProp(
-				'postType',
-				postType,
-				'meta'
-			);
+		( BlockEdit ) =>
+			( { attributes, setAttributes, ...props } ) => {
+				const postType = useSelect(
+					( select ) => select( editorStore ).getCurrentPostType(),
+					[]
+				);
+				const [ meta, setMeta ] = useEntityProp(
+					'postType',
+					postType,
+					'meta'
+				);
 
-			const mergedAttributes = useMemo(
-				() => ( {
-					...attributes,
-					...mapValues(
-						metaAttributes,
-						( metaKey ) => meta[ metaKey ]
-					),
-				} ),
-				[ attributes, meta ]
-			);
+				const mergedAttributes = useMemo(
+					() => ( {
+						...attributes,
+						...mapValues(
+							metaAttributes,
+							( metaKey ) => meta[ metaKey ]
+						),
+					} ),
+					[ attributes, meta ]
+				);
 
-			return (
-				<BlockEdit
-					attributes={ mergedAttributes }
-					setAttributes={ ( nextAttributes ) => {
-						const nextMeta = mapKeys(
-							// Filter to intersection of keys between the updated
-							// attributes and those with an associated meta key.
-							pickBy(
-								nextAttributes,
-								( value, key ) => metaAttributes[ key ]
-							),
+				return (
+					<BlockEdit
+						attributes={ mergedAttributes }
+						setAttributes={ ( nextAttributes ) => {
+							const nextMeta = mapKeys(
+								// Filter to intersection of keys between the updated
+								// attributes and those with an associated meta key.
+								pickBy(
+									nextAttributes,
+									( value, key ) => metaAttributes[ key ]
+								),
 
-							// Rename the keys to the expected meta key name.
-							( value, attributeKey ) =>
-								metaAttributes[ attributeKey ]
-						);
+								// Rename the keys to the expected meta key name.
+								( value, attributeKey ) =>
+									metaAttributes[ attributeKey ]
+							);
 
-						if ( ! isEmpty( nextMeta ) ) {
-							setMeta( nextMeta );
-						}
+							if ( ! isEmpty( nextMeta ) ) {
+								setMeta( nextMeta );
+							}
 
-						setAttributes( nextAttributes );
-					} }
-					{ ...props }
-				/>
-			);
-		},
+							setAttributes( nextAttributes );
+						} }
+						{ ...props }
+					/>
+				);
+			},
 		'withMetaAttributeSource'
 	);
 

package/src/store/actions.js

@@ -37,35 +37,38 @@ import {
  * @param {Object} edits    Initial edited attributes object.
  * @param {Array?} template Block Template.
  */
-export const setupEditor = ( post, edits, template ) => ( { dispatch } ) => {
-	dispatch.setupEditorState( post );
-	// Apply a template for new posts only, if exists.
-	const isNewPost = post.status === 'auto-draft';
-	if ( isNewPost && template ) {
-		// In order to ensure maximum of a single parse during setup, edits are
-		// included as part of editor setup action. Assume edited content as
-		// canonical if provided, falling back to post.
-		let content;
-		if ( has( edits, [ 'content' ] ) ) {
-			content = edits.content;
-		} else {
-			content = post.content.raw;
+export const setupEditor =
+	( post, edits, template ) =>
+	( { dispatch } ) => {
+		dispatch.setupEditorState( post );
+		// Apply a template for new posts only, if exists.
+		const isNewPost = post.status === 'auto-draft';
+		if ( isNewPost && template ) {
+			// In order to ensure maximum of a single parse during setup, edits are
+			// included as part of editor setup action. Assume edited content as
+			// canonical if provided, falling back to post.
+			let content;
+			if ( has( edits, [ 'content' ] ) ) {
+				content = edits.content;
+			} else {
+				content = post.content.raw;
+			}
+			let blocks = parse( content );
+			blocks = synchronizeBlocksWithTemplate( blocks, template );
+			dispatch.resetEditorBlocks( blocks, {
+				__unstableShouldCreateUndoLevel: false,
+			} );
 		}
-		let blocks = parse( content );
-		blocks = synchronizeBlocksWithTemplate( blocks, template );
-		dispatch.resetEditorBlocks( blocks, {
-			__unstableShouldCreateUndoLevel: false,
-		} );
-	}
-	if (
-		edits &&
-		Object.values( edits ).some(
-			( [ key, edit ] ) => edit !== ( post[ key ]?.raw ?? post[ key ] )
-		)
-	) {
-		dispatch.editPost( edits );
-	}
-};
+		if (
+			edits &&
+			Object.values( edits ).some(
+				( [ key, edit ] ) =>
+					edit !== ( post[ key ]?.raw ?? post[ key ] )
+			)
+		) {
+			dispatch.editPost( edits );
+		}
+	};
 
 /**
  * Returns an action object signalling that the editor is being destroyed and
@@ -131,89 +134,96 @@ export function setupEditorState( post ) {
  * @param {Object} edits   Post attributes to edit.
  * @param {Object} options Options for the edit.
  */
-export const editPost = ( edits, options ) => ( { select, registry } ) => {
-	const { id, type } = select.getCurrentPost();
-	registry
-		.dispatch( coreStore )
-		.editEntityRecord( 'postType', type, id, edits, options );
-};
+export const editPost =
+	( edits, options ) =>
+	( { select, registry } ) => {
+		const { id, type } = select.getCurrentPost();
+		registry
+			.dispatch( coreStore )
+			.editEntityRecord( 'postType', type, id, edits, options );
+	};
 
 /**
  * Action for saving the current post in the editor.
  *
  * @param {Object} options
  */
-export const savePost = ( options = {} ) => async ( {
-	select,
-	dispatch,
-	registry,
-} ) => {
-	if ( ! select.isEditedPostSaveable() ) {
-		return;
-	}
-
-	const content = select.getEditedPostContent();
-
-	if ( ! options.isAutosave ) {
-		dispatch.editPost( { content }, { undoIgnore: true } );
-	}
-
-	const previousRecord = select.getCurrentPost();
-	const edits = {
-		id: previousRecord.id,
-		...registry
+export const savePost =
+	( options = {} ) =>
+	async ( { select, dispatch, registry } ) => {
+		if ( ! select.isEditedPostSaveable() ) {
+			return;
+		}
+
+		const content = select.getEditedPostContent();
+
+		if ( ! options.isAutosave ) {
+			dispatch.editPost( { content }, { undoIgnore: true } );
+		}
+
+		const previousRecord = select.getCurrentPost();
+		const edits = {
+			id: previousRecord.id,
+			...registry
+				.select( coreStore )
+				.getEntityRecordNonTransientEdits(
+					'postType',
+					previousRecord.type,
+					previousRecord.id
+				),
+			content,
+		};
+		dispatch( { type: 'REQUEST_POST_UPDATE_START', options } );
+		await registry
+			.dispatch( coreStore )
+			.saveEntityRecord(
+				'postType',
+				previousRecord.type,
+				edits,
+				options
+			);
+		dispatch( { type: 'REQUEST_POST_UPDATE_FINISH', options } );
+
+		const error = registry
 			.select( coreStore )
-			.getEntityRecordNonTransientEdits(
+			.getLastEntitySaveError(
 				'postType',
 				previousRecord.type,
 				previousRecord.id
-			),
-		content,
-	};
-	dispatch( { type: 'REQUEST_POST_UPDATE_START', options } );
-	await registry
-		.dispatch( coreStore )
-		.saveEntityRecord( 'postType', previousRecord.type, edits, options );
-	dispatch( { type: 'REQUEST_POST_UPDATE_FINISH', options } );
-
-	const error = registry
-		.select( coreStore )
-		.getLastEntitySaveError(
-			'postType',
-			previousRecord.type,
-			previousRecord.id
-		);
-	if ( error ) {
-		const args = getNotificationArgumentsForSaveFail( {
-			post: previousRecord,
-			edits,
-			error,
-		} );
-		if ( args.length ) {
-			registry.dispatch( noticesStore ).createErrorNotice( ...args );
-		}
-	} else {
-		const updatedRecord = select.getCurrentPost();
-		const args = getNotificationArgumentsForSaveSuccess( {
-			previousPost: previousRecord,
-			post: updatedRecord,
-			postType: await registry
-				.resolveSelect( coreStore )
-				.getPostType( updatedRecord.type ),
-			options,
-		} );
-		if ( args.length ) {
-			registry.dispatch( noticesStore ).createSuccessNotice( ...args );
-		}
-		// Make sure that any edits after saving create an undo level and are
-		// considered for change detection.
-		if ( ! options.isAutosave ) {
-			registry
-				.dispatch( blockEditorStore )
-				.__unstableMarkLastChangeAsPersistent();
+			);
+		if ( error ) {
+			const args = getNotificationArgumentsForSaveFail( {
+				post: previousRecord,
+				edits,
+				error,
+			} );
+			if ( args.length ) {
+				registry.dispatch( noticesStore ).createErrorNotice( ...args );
+			}
+		} else {
+			const updatedRecord = select.getCurrentPost();
+			const args = getNotificationArgumentsForSaveSuccess( {
+				previousPost: previousRecord,
+				post: updatedRecord,
+				postType: await registry
+					.resolveSelect( coreStore )
+					.getPostType( updatedRecord.type ),
+				options,
+			} );
+			if ( args.length ) {
+				registry
+					.dispatch( noticesStore )
+					.createSuccessNotice( ...args );
+			}
+			// Make sure that any edits after saving create an undo level and are
+			// considered for change detection.
+			if ( ! options.isAutosave ) {
+				registry
+					.dispatch( blockEditorStore )
+					.__unstableMarkLastChangeAsPersistent();
+			}
 		}
-	}
-};
+	};
 
 /**
  * Action for refreshing the current post.
@@ -232,28 +242,30 @@ export function refreshPost() {
 /**
  * Action for trashing the current post in the editor.
  */
-export const trashPost = () => async ( { select, dispatch, registry } ) => {
-	const postTypeSlug = select.getCurrentPostType();
-	const postType = await registry
-		.resolveSelect( coreStore )
-		.getPostType( postTypeSlug );
-	registry.dispatch( noticesStore ).removeNotice( TRASH_POST_NOTICE_ID );
-	try {
-		const post = select.getCurrentPost();
-		await apiFetch( {
-			path: `/wp/v2/${ postType.rest_base }/${ post.id }`,
-			method: 'DELETE',
-		} );
-
-		await dispatch.savePost();
-	} catch ( error ) {
-		registry
-			.dispatch( noticesStore )
-			.createErrorNotice(
-				...getNotificationArgumentsForTrashFail( { error } )
-			);
-	}
-};
+export const trashPost =
+	() =>
+	async ( { select, dispatch, registry } ) => {
+		const postTypeSlug = select.getCurrentPostType();
+		const postType = await registry
+			.resolveSelect( coreStore )
+			.getPostType( postTypeSlug );
+		registry.dispatch( noticesStore ).removeNotice( TRASH_POST_NOTICE_ID );
+		try {
+			const post = select.getCurrentPost();
+			await apiFetch( {
+				path: `/wp/v2/${ postType.rest_base }/${ post.id }`,
+				method: 'DELETE',
+			} );
+
+			await dispatch.savePost();
+		} catch ( error ) {
+			registry
+				.dispatch( noticesStore )
+				.createErrorNotice(
+					...getNotificationArgumentsForTrashFail( { error } )
+				);
+		}
+	};
 
 /**
  * Action that autosaves the current post.  This
@@ -263,35 +275,38 @@ export const trashPost = () => async ( { select, dispatch, registry } ) => {
  *
  * @param {Object?} options Extra flags to identify the autosave.
  */
-export const autosave = ( { local = false, ...options } = {} ) => async ( {
-	select,
-	dispatch,
-} ) => {
-	if ( local ) {
-		const post = select.getCurrentPost();
-		const isPostNew = select.isEditedPostNew();
-		const title = select.getEditedPostAttribute( 'title' );
-		const content = select.getEditedPostAttribute( 'content' );
-		const excerpt = select.getEditedPostAttribute( 'excerpt' );
-		localAutosaveSet( post.id, isPostNew, title, content, excerpt );
-	} else {
-		await dispatch.savePost( { isAutosave: true, ...options } );
-	}
-};
+export const autosave =
+	( { local = false, ...options } = {} ) =>
+	async ( { select, dispatch } ) => {
+		if ( local ) {
+			const post = select.getCurrentPost();
+			const isPostNew = select.isEditedPostNew();
+			const title = select.getEditedPostAttribute( 'title' );
+			const content = select.getEditedPostAttribute( 'content' );
+			const excerpt = select.getEditedPostAttribute( 'excerpt' );
+			localAutosaveSet( post.id, isPostNew, title, content, excerpt );
+		} else {
+			await dispatch.savePost( { isAutosave: true, ...options } );
+		}
+	};
 
 /**
  * Action that restores last popped state in undo history.
  */
-export const redo = () => ( { registry } ) => {
-	registry.dispatch( coreStore ).redo();
-};
+export const redo =
+	() =>
+	( { registry } ) => {
+		registry.dispatch( coreStore ).redo();
+	};
 
 /**
  * Action that pops a record from undo history and undoes the edit.
  */
-export const undo = () => ( { registry } ) => {
-	registry.dispatch( coreStore ).undo();
-};
+export const undo =
+	() =>
+	( { registry } ) => {
+		registry.dispatch( coreStore ).undo();
+	};
 
 /**
  * Action that creates an undo history record.
@@ -323,20 +338,24 @@ export function updatePostLock( lock ) {
 /**
  * Enable the publish sidebar.
  */
-export const enablePublishSidebar = () => ( { registry } ) => {
-	registry
-		.dispatch( preferencesStore )
-		.set( 'core/edit-post', 'isPublishSidebarEnabled', true );
-};
+export const enablePublishSidebar =
+	() =>
+	( { registry } ) => {
+		registry
+			.dispatch( preferencesStore )
+			.set( 'core/edit-post', 'isPublishSidebarEnabled', true );
+	};
 
 /**
  * Disables the publish sidebar.
  */
-export const disablePublishSidebar = () => ( { registry } ) => {
-	registry
-		.dispatch( preferencesStore )
-		.set( 'core/edit-post', 'isPublishSidebarEnabled', false );
-};
+export const disablePublishSidebar =
+	() =>
+	( { registry } ) => {
+		registry
+			.dispatch( preferencesStore )
+			.set( 'core/edit-post', 'isPublishSidebarEnabled', false );
+	};
 
 /**
  * Action that locks post saving.
@@ -454,37 +473,35 @@ export function unlockPostAutosaving( lockName ) {
  * @param {Array}   blocks  Block Array.
  * @param {?Object} options Optional options.
  */
-export const resetEditorBlocks = ( blocks, options = {} ) => ( {
-	select,
-	dispatch,
-	registry,
-} ) => {
-	const { __unstableShouldCreateUndoLevel, selection } = options;
-	const edits = { blocks, selection };
-
-	if ( __unstableShouldCreateUndoLevel !== false ) {
-		const { id, type } = select.getCurrentPost();
-		const noChange =
-			registry
-				.select( coreStore )
-				.getEditedEntityRecord( 'postType', type, id ).blocks ===
-			edits.blocks;
-		if ( noChange ) {
-			registry
-				.dispatch( coreStore )
-				.__unstableCreateUndoLevel( 'postType', type, id );
-			return;
+export const resetEditorBlocks =
+	( blocks, options = {} ) =>
+	( { select, dispatch, registry } ) => {
+		const { __unstableShouldCreateUndoLevel, selection } = options;
+		const edits = { blocks, selection };
+
+		if ( __unstableShouldCreateUndoLevel !== false ) {
+			const { id, type } = select.getCurrentPost();
+			const noChange =
+				registry
+					.select( coreStore )
+					.getEditedEntityRecord( 'postType', type, id ).blocks ===
+				edits.blocks;
+			if ( noChange ) {
+				registry
+					.dispatch( coreStore )
+					.__unstableCreateUndoLevel( 'postType', type, id );
+				return;
+			}
+
+			// We create a new function here on every persistent edit
+			// to make sure the edit makes the post dirty and creates
+			// a new undo level.
+			edits.content = ( { blocks: blocksForSerialization = [] } ) =>
+				__unstableSerializeAndClean( blocksForSerialization );
 		}
 
-		// We create a new function here on every persistent edit
-		// to make sure the edit makes the post dirty and creates
-		// a new undo level.
-		edits.content = ( { blocks: blocksForSerialization = [] } ) =>
-			__unstableSerializeAndClean( blocksForSerialization );
-	}
-
-	dispatch.editPost( edits );
-};
+		dispatch.editPost( edits );
+	};
 
 /*
  * Returns an action object used in signalling that the post editor settings have been updated.
@@ -504,14 +521,18 @@ export function updateEditorSettings( settings ) {
  * Backward compatibility
  */
 
-const getBlockEditorAction = ( name ) => ( ...args ) => ( { registry } ) => {
-	deprecated( "`wp.data.dispatch( 'core/editor' )." + name + '`', {
-		since: '5.3',
-		alternative: "`wp.data.dispatch( 'core/block-editor' )." + name + '`',
-		version: '6.2',
-	} );
-	registry.dispatch( blockEditorStore )[ name ]( ...args );
-};
+const getBlockEditorAction =
+	( name ) =>
+	( ...args ) =>
+	( { registry } ) => {
+		deprecated( "`wp.data.dispatch( 'core/editor' )." + name + '`', {
+			since: '5.3',
+			alternative:
+				"`wp.data.dispatch( 'core/block-editor' )." + name + '`',
+			version: '6.2',
+		} );
+		registry.dispatch( blockEditorStore )[ name ]( ...args );
+	};
 
 /**
  * @see resetBlocks in core/block-editor store.

package/src/store/selectors.js

@@ -146,9 +146,8 @@ export const isEditedPostDirty = createRegistrySelector(
  */
 export const hasNonPostEntityChanges = createRegistrySelector(
 	( select ) => ( state ) => {
-		const dirtyEntityRecords = select(
-			coreStore
-		).__experimentalGetDirtyEntityRecords();
+		const dirtyEntityRecords =
+			select( coreStore ).__experimentalGetDirtyEntityRecords();
 		const { type, id } = getCurrentPost( state );
 		return some(
 			dirtyEntityRecords,
@@ -708,9 +707,8 @@ export const isSavingPost = createRegistrySelector( ( select ) => ( state ) => {
  */
 export const isSavingNonPostEntityChanges = createRegistrySelector(
 	( select ) => ( state ) => {
-		const entitiesBeingSaved = select(
-			coreStore
-		).__experimentalGetEntitiesBeingSaved();
+		const entitiesBeingSaved =
+			select( coreStore ).__experimentalGetEntitiesBeingSaved();
 		const { type, id } = getCurrentPost( state );
 		return some(
 			entitiesBeingSaved,
@@ -1244,9 +1242,8 @@ export const isBlockValid = getBlockEditorSelector( 'isBlockValid' );
 /**
  * @see getBlockAttributes in core/block-editor store.
  */
-export const getBlockAttributes = getBlockEditorSelector(
-	'getBlockAttributes'
-);
+export const getBlockAttributes =
+	getBlockEditorSelector( 'getBlockAttributes' );
 
 /**
  * @see getBlock in core/block-editor store.
@@ -1476,9 +1473,8 @@ export const isMultiSelecting = getBlockEditorSelector( 'isMultiSelecting' );
 /**
  * @see isSelectionEnabled in core/block-editor store.
  */
-export const isSelectionEnabled = getBlockEditorSelector(
-	'isSelectionEnabled'
-);
+export const isSelectionEnabled =
+	getBlockEditorSelector( 'isSelectionEnabled' );
 
 /**
  * @see getBlockMode in core/block-editor store.
@@ -1529,9 +1525,8 @@ export const getTemplateLock = getBlockEditorSelector( 'getTemplateLock' );
 /**
  * @see canInsertBlockType in core/block-editor store.
  */
-export const canInsertBlockType = getBlockEditorSelector(
-	'canInsertBlockType'
-);
+export const canInsertBlockType =
+	getBlockEditorSelector( 'canInsertBlockType' );
 
 /**
  * @see getInserterItems in core/block-editor store.
@@ -1606,14 +1601,14 @@ export function __experimentalGetTemplateInfo( state, template ) {
 		return {};
 	}
 
-	const { excerpt, slug, title, area } = template;
-	const {
-		title: defaultTitle,
-		description: defaultDescription,
-	} = __experimentalGetDefaultTemplateType( state, slug );
+	const { description, slug, title, area } = template;
+	const { title: defaultTitle, description: defaultDescription } =
+		__experimentalGetDefaultTemplateType( state, slug );
 
 	const templateTitle = isString( title ) ? title : title?.rendered;
-	const templateDescription = isString( excerpt ) ? excerpt : excerpt?.raw;
+	const templateDescription = isString( description )
+		? description
+		: description?.raw;
 	const templateIcon =
 		__experimentalGetDefaultTemplatePartAreas( state ).find(
 			( item ) => area === item.area