Core data revisions: extend support to other post types (#56353)

* Initial commit: add revisions support for templates

* Renames constant to be clearer about what these post types apply to.
Adds wp_block and wp_navigation

* Testing updating record.key in the action.

* Moving `revisionKey` to the entity config and use it in the action and resolvers

* Me: Pray, depart hence, thou knavish trifle! Thy utility be as absent as mirth in a grave, a jest without jesters. Begone, thou witless motley, for even a jest doth surpass thy meager worth!
Empty line: *whimper*

docs/reference-guides/data/data-core.md

@@ -741,7 +741,7 @@ _Returns_
 
 ### receiveRevisions
 
-Returns an action object used in signalling that revisions have been received.
+Action triggered to receive revision items.
 
 _Parameters_
 
@@ -753,10 +753,6 @@ _Parameters_
 -   _invalidateCache_ `?boolean`: Should invalidate query caches.
 -   _meta_ `?Object`: Meta information about pagination.
 
-_Returns_
-
--   `Object`: Action object.
-
 ### receiveThemeSupports
 
 > **Deprecated** since WP 5.9, this is not useful anymore, use the selector direclty.

packages/core-data/README.md

@@ -250,7 +250,7 @@ _Returns_
 
 ### receiveRevisions
 
-Returns an action object used in signalling that revisions have been received.
+Action triggered to receive revision items.
 
 _Parameters_
 
@@ -262,10 +262,6 @@ _Parameters_
 -   _invalidateCache_ `?boolean`: Should invalidate query caches.
 -   _meta_ `?Object`: Meta information about pagination.
 
-_Returns_
-
--   `Object`: Action object.
-
 ### receiveThemeSupports
 
 > **Deprecated** since WP 5.9, this is not useful anymore, use the selector direclty.

packages/core-data/src/actions.js

@@ -935,7 +935,7 @@ export function receiveDefaultTemplateId( query, templateId ) {
 }
 
 /**
- * Returns an action object used in signalling that revisions have been received.
+ * Action triggered to receive revision items.
  *
  * @param {string}        kind            Kind of the received entity record revisions.
  * @param {string}        name            Name of the received entity record revisions.
@@ -944,25 +944,28 @@ export function receiveDefaultTemplateId( query, templateId ) {
  * @param {?Object}       query           Query Object.
  * @param {?boolean}      invalidateCache Should invalidate query caches.
  * @param {?Object}       meta            Meta information about pagination.
- * @return {Object} Action object.
  */
-export function receiveRevisions(
-	kind,
-	name,
-	recordKey,
-	records,
-	query,
-	invalidateCache = false,
-	meta
-) {
-	return {
-		type: 'RECEIVE_ITEM_REVISIONS',
-		items: Array.isArray( records ) ? records : [ records ],
-		recordKey,
-		meta,
-		query,
-		kind,
-		name,
-		invalidateCache,
+export const receiveRevisions =
+	( kind, name, recordKey, records, query, invalidateCache = false, meta ) =>
+	async ( { dispatch } ) => {
+		const configs = await dispatch( getOrLoadEntitiesConfig( kind ) );
+		const entityConfig = configs.find(
+			( config ) => config.kind === kind && config.name === name
+		);
+		const key =
+			entityConfig && entityConfig?.revisionKey
+				? entityConfig.revisionKey
+				: DEFAULT_ENTITY_KEY;
+
+		dispatch( {
+			type: 'RECEIVE_ITEM_REVISIONS',
+			key,
+			items: Array.isArray( records ) ? records : [ records ],
+			recordKey,
+			meta,
+			query,
+			kind,
+			name,
+			invalidateCache,
+		} );
 	};
-}

packages/core-data/src/entities.js

@@ -20,8 +20,16 @@ export const DEFAULT_ENTITY_KEY = 'id';
 const POST_RAW_ATTRIBUTES = [ 'title', 'excerpt', 'content' ];
 
 // A hardcoded list of post types that support revisions.
+// Reflects post types in Core's src/wp-includes/post.php.
 // @TODO: Ideally this should be fetched from the  `/types` REST API's view context.
-const POST_TYPES_WITH_REVISIONS_SUPPORT = [ 'post', 'page' ];
+const POST_TYPE_ENTITIES_WITH_REVISIONS_SUPPORT = [
+	'post',
+	'page',
+	'wp_block',
+	'wp_navigation',
+	'wp_template',
+	'wp_template_part',
+];
 
 export const rootEntitiesConfig = [
 	{
@@ -308,7 +316,7 @@ async function loadPostTypeEntities() {
 			},
 			mergedEdits: { meta: true },
 			supports: {
-				revisions: POST_TYPES_WITH_REVISIONS_SUPPORT.includes(
+				revisions: POST_TYPE_ENTITIES_WITH_REVISIONS_SUPPORT.includes(
 					postType?.slug
 				),
 			},
@@ -351,6 +359,7 @@ async function loadPostTypeEntities() {
 				}/${ parentId }/revisions${
 					revisionId ? '/' + revisionId : ''
 				}`,
+			revisionKey: isTemplate ? 'wp_id' : DEFAULT_ENTITY_KEY,
 		};
 	} );
 }

packages/core-data/src/reducer.js

@@ -238,8 +238,8 @@ function entity( entityConfig ) {
 		// Inject the entity config into the action.
 		replaceAction( ( action ) => {
 			return {
-				...action,
 				key: entityConfig.key || DEFAULT_ENTITY_KEY,
+				...action,
 			};
 		} ),
 	] )(

packages/core-data/src/resolvers.js

@@ -755,7 +755,7 @@ export const getRevisions =
 					...new Set( [
 						...( getNormalizedCommaSeparable( query._fields ) ||
 							[] ),
-						DEFAULT_ENTITY_KEY,
+						entityConfig.revisionKey || DEFAULT_ENTITY_KEY,
 					] ),
 				].join(),
 			};
@@ -868,7 +868,7 @@ export const getRevision =
 					...new Set( [
 						...( getNormalizedCommaSeparable( query._fields ) ||
 							[] ),
-						DEFAULT_ENTITY_KEY,
+						entityConfig.revisionKey || DEFAULT_ENTITY_KEY,
 					] ),
 				].join(),
 			};