@wordpress/core-data 6.22.0 → 6.24.0

package/src/selectors.ts

@@ -46,6 +46,7 @@ export interface State {
 	users: UserState;
 	navigationFallbackId: EntityRecordKey;
 	userPatternCategories: Array< UserPatternCategory >;
+	defaultTemplates: Record< string, string >;
 }
 
 type EntityRecordKey = string | number;
@@ -61,6 +62,16 @@ interface QueriedData {
 	queries: Record< ET.Context, Record< string, Array< number > > >;
 }
 
+type RevisionRecord =
+	| Record< ET.Context, Record< number, ET.PostRevision > >
+	| Record< ET.Context, Record< number, ET.GlobalStylesRevision > >;
+
+interface RevisionsQueriedData {
+	items: RevisionRecord;
+	itemIsComplete: Record< ET.Context, Record< number, boolean > >;
+	queries: Record< ET.Context, Record< string, Array< number > > >;
+}
+
 interface EntityState< EntityRecord extends ET.EntityRecord > {
 	edits: Record< string, Partial< EntityRecord > >;
 	saving: Record<
@@ -69,6 +80,7 @@ interface EntityState< EntityRecord extends ET.EntityRecord > {
 	>;
 	deleting: Record< string, Partial< { pending: boolean; error: Error } > >;
 	queriedData: QueriedData;
+	revisions?: RevisionsQueriedData;
 }
 
 interface EntityConfig {
@@ -81,6 +93,12 @@ interface UserState {
 	byId: Record< EntityRecordKey, ET.User< 'edit' > >;
 }
 
+type TemplateQuery = {
+	slug?: string;
+	is_custom?: boolean;
+	ignore_empty?: boolean;
+};
+
 export interface UserPatternCategory {
 	id: number;
 	name: string;
@@ -1335,13 +1353,20 @@ export function getUserPatternCategories(
 /**
  * Returns the revisions of the current global styles theme.
  *
- * @param state Data state.
+ * @deprecated since WordPress 6.5.0. Callers should use `select( 'core' ).getRevisions( 'root', 'globalStyles', ${ recordKey } )` instead, where `recordKey` is the id of the global styles parent post.
+ *
+ * @param      state Data state.
  *
  * @return The current global styles.
  */
 export function getCurrentThemeGlobalStylesRevisions(
 	state: State
 ): Array< object > | null {
+	deprecated( "select( 'core' ).getCurrentThemeGlobalStylesRevisions()", {
+		since: '6.5.0',
+		alternative:
+			"select( 'core' ).getRevisions( 'root', 'globalStyles', ${ recordKey } )",
+	} );
 	const currentGlobalStylesId =
 		__experimentalGetCurrentGlobalStylesId( state );
 
@@ -1351,3 +1376,118 @@ export function getCurrentThemeGlobalStylesRevisions(
 
 	return state.themeGlobalStyleRevisions[ currentGlobalStylesId ];
 }
+
+/**
+ * Returns the default template use to render a given query.
+ *
+ * @param state Data state.
+ * @param query Query.
+ *
+ * @return The default template id for the given query.
+ */
+export function getDefaultTemplateId(
+	state: State,
+	query: TemplateQuery
+): string {
+	return state.defaultTemplates[ JSON.stringify( query ) ];
+}
+
+/**
+ * Returns an entity's revisions.
+ *
+ * @param state     State tree
+ * @param kind      Entity kind.
+ * @param name      Entity name.
+ * @param recordKey The key of the entity record whose revisions you want to fetch.
+ * @param query     Optional query. If requesting specific
+ *                  fields, fields must always include the ID. For valid query parameters see revisions schema in [the REST API Handbook](https://developer.wordpress.org/rest-api/reference/). Then see the arguments available "Retrieve a [Entity kind]".
+ *
+ * @return Record.
+ */
+export const getRevisions = (
+	state: State,
+	kind: string,
+	name: string,
+	recordKey: EntityRecordKey,
+	query?: GetRecordsHttpQuery
+): RevisionRecord[] | null => {
+	const queriedStateRevisions =
+		state.entities.records?.[ kind ]?.[ name ]?.revisions?.[ recordKey ];
+	if ( ! queriedStateRevisions ) {
+		return null;
+	}
+
+	return getQueriedItems( queriedStateRevisions, query );
+};
+
+/**
+ * Returns a single, specific revision of a parent entity.
+ *
+ * @param state       State tree
+ * @param kind        Entity kind.
+ * @param name        Entity name.
+ * @param recordKey   The key of the entity record whose revisions you want to fetch.
+ * @param revisionKey The revision's key.
+ * @param query       Optional query. If requesting specific
+ *                    fields, fields must always include the ID. For valid query parameters see revisions schema in [the REST API Handbook](https://developer.wordpress.org/rest-api/reference/). Then see the arguments available "Retrieve a [entity kind]".
+ *
+ * @return Record.
+ */
+export const getRevision = createSelector(
+	(
+		state: State,
+		kind: string,
+		name: string,
+		recordKey: EntityRecordKey,
+		revisionKey: EntityRecordKey,
+		query?: GetRecordsHttpQuery
+	): RevisionRecord | Record< PropertyKey, never > | undefined => {
+		const queriedState =
+			state.entities.records?.[ kind ]?.[ name ]?.revisions?.[
+				recordKey
+			];
+
+		if ( ! queriedState ) {
+			return undefined;
+		}
+
+		const context = query?.context ?? 'default';
+
+		if ( query === undefined ) {
+			// If expecting a complete item, validate that completeness.
+			if ( ! queriedState.itemIsComplete[ context ]?.[ revisionKey ] ) {
+				return undefined;
+			}
+
+			return queriedState.items[ context ][ revisionKey ];
+		}
+
+		const item = queriedState.items[ context ]?.[ revisionKey ];
+		if ( item && query._fields ) {
+			const filteredItem = {};
+			const fields = getNormalizedCommaSeparable( query._fields ) ?? [];
+
+			for ( let f = 0; f < fields.length; f++ ) {
+				const field = fields[ f ].split( '.' );
+				let value = item;
+				field.forEach( ( fieldName ) => {
+					value = value?.[ fieldName ];
+				} );
+				setNestedValue( filteredItem, field, value );
+			}
+
+			return filteredItem;
+		}
+
+		return item;
+	},
+	( state: State, kind, name, recordKey, revisionKey, query ) => {
+		const context = query?.context ?? 'default';
+		return [
+			state.entities.records?.[ kind ]?.[ name ]?.revisions?.[ recordKey ]
+				?.items?.[ context ]?.[ revisionKey ],
+			state.entities.records?.[ kind ]?.[ name ]?.revisions?.[ recordKey ]
+				?.itemIsComplete?.[ context ]?.[ revisionKey ],
+		];
+	}
+);

package/src/test/entities.js

@@ -80,6 +80,9 @@ describe( 'getKindEntities', () => {
 				labels: {
 					singular_name: 'post',
 				},
+				supports: {
+					revisions: true,
+				},
 			},
 		];
 		const dispatch = jest.fn();
@@ -95,6 +98,12 @@ describe( 'getKindEntities', () => {
 		expect( dispatch.mock.calls[ 0 ][ 0 ].entities[ 0 ].baseURL ).toBe(
 			'/wp/v2/posts'
 		);
+		expect(
+			dispatch.mock.calls[ 0 ][ 0 ].entities[ 0 ].getRevisionsUrl( 1 )
+		).toBe( '/wp/v2/posts/1/revisions' );
+		expect(
+			dispatch.mock.calls[ 0 ][ 0 ].entities[ 0 ].getRevisionsUrl( 1, 2 )
+		).toBe( '/wp/v2/posts/1/revisions/2' );
 	} );
 } );
 

package/src/test/reducer.js

@@ -139,6 +139,241 @@ describe( 'entities', () => {
 				.map( ( [ , cfg ] ) => cfg )
 		).toEqual( [ { kind: 'postType', name: 'posts' } ] );
 	} );
+
+	describe( 'entity revisions', () => {
+		const stateWithConfig = entities( undefined, {
+			type: 'ADD_ENTITIES',
+			entities: [
+				{
+					kind: 'root',
+					name: 'postType',
+					supports: { revisions: true },
+				},
+			],
+		} );
+		it( 'appends revisions state', () => {
+			expect( stateWithConfig.records.root.postType ).toHaveProperty(
+				'revisions',
+				{}
+			);
+		} );
+
+		it( 'returns with received revisions', () => {
+			const initialState = deepFreeze( {
+				config: stateWithConfig.config,
+				records: {},
+			} );
+			const state = entities( initialState, {
+				type: 'RECEIVE_ITEM_REVISIONS',
+				items: [ { id: 1, parent: 2 } ],
+				kind: 'root',
+				name: 'postType',
+				recordKey: 2,
+			} );
+			expect( state.records.root.postType.revisions ).toEqual( {
+				2: {
+					items: {
+						default: {
+							1: { id: 1, parent: 2 },
+						},
+					},
+					itemIsComplete: {
+						default: {
+							1: true,
+						},
+					},
+					queries: {},
+				},
+			} );
+		} );
+
+		it( 'returns with appended received revisions at the parent level', () => {
+			const initialState = deepFreeze( {
+				config: stateWithConfig.config,
+				records: {
+					root: {
+						postType: {
+							revisions: {
+								2: {
+									items: {
+										default: {
+											1: { id: 1, parent: 2 },
+										},
+									},
+									itemIsComplete: {
+										default: {
+											1: true,
+										},
+									},
+									queries: {},
+								},
+							},
+						},
+					},
+				},
+			} );
+			const state = entities( initialState, {
+				type: 'RECEIVE_ITEM_REVISIONS',
+				items: [ { id: 3, parent: 4 } ],
+				kind: 'root',
+				name: 'postType',
+				recordKey: 4,
+			} );
+			expect( state.records.root.postType.revisions ).toEqual( {
+				2: {
+					items: {
+						default: {
+							1: { id: 1, parent: 2 },
+						},
+					},
+					itemIsComplete: {
+						default: {
+							1: true,
+						},
+					},
+					queries: {},
+				},
+				4: {
+					items: {
+						default: {
+							3: { id: 3, parent: 4 },
+						},
+					},
+					itemIsComplete: {
+						default: {
+							3: true,
+						},
+					},
+					queries: {},
+				},
+			} );
+		} );
+
+		it( 'returns with appended received revision items', () => {
+			const initialState = deepFreeze( {
+				config: stateWithConfig.config,
+				records: {
+					root: {
+						postType: {
+							revisions: {
+								2: {
+									items: {
+										default: {
+											1: { id: 1, parent: 2 },
+										},
+									},
+									itemIsComplete: {
+										default: {
+											1: true,
+										},
+									},
+									queries: {},
+								},
+							},
+						},
+					},
+				},
+			} );
+			const state = entities( initialState, {
+				type: 'RECEIVE_ITEM_REVISIONS',
+				items: [ { id: 7, parent: 2 } ],
+				kind: 'root',
+				name: 'postType',
+				recordKey: 2,
+			} );
+			expect( state.records.root.postType.revisions ).toEqual( {
+				2: {
+					items: {
+						default: {
+							1: { id: 1, parent: 2 },
+							7: { id: 7, parent: 2 },
+						},
+					},
+					itemIsComplete: {
+						default: {
+							1: true,
+							7: true,
+						},
+					},
+					queries: {},
+				},
+			} );
+		} );
+
+		it( 'returns with removed revision items', () => {
+			const initialState = deepFreeze( {
+				config: stateWithConfig.config,
+				records: {
+					root: {
+						postType: {
+							revisions: {
+								2: {
+									items: {
+										default: {
+											1: { id: 1, parent: 2 },
+										},
+									},
+									itemIsComplete: {
+										default: {
+											1: true,
+										},
+									},
+									queries: {},
+								},
+								4: {
+									items: {
+										default: {
+											3: { id: 3, parent: 4 },
+										},
+									},
+									itemIsComplete: {
+										default: {
+											3: true,
+										},
+									},
+									queries: {},
+								},
+								6: {
+									items: {
+										default: {
+											9: { id: 11, parent: 6 },
+										},
+									},
+									itemIsComplete: {
+										default: {
+											9: true,
+										},
+									},
+									queries: {},
+								},
+							},
+						},
+					},
+				},
+			} );
+			const state = entities( initialState, {
+				type: 'REMOVE_ITEMS',
+				itemIds: [ 4, 6 ],
+				kind: 'root',
+				name: 'postType',
+			} );
+			expect( state.records.root.postType.revisions ).toEqual( {
+				2: {
+					items: {
+						default: {
+							1: { id: 1, parent: 2 },
+						},
+					},
+					itemIsComplete: {
+						default: {
+							1: true,
+						},
+					},
+					queries: {},
+				},
+			} );
+		} );
+	} );
 } );
 
 describe( 'embedPreviews()', () => {

package/src/test/selectors.js

@@ -22,6 +22,8 @@ import {
 	getAutosave,
 	getAutosaves,
 	getCurrentUser,
+	getRevisions,
+	getRevision,
 } from '../selectors';
 // getEntityRecord and __experimentalGetEntityRecordNoResolver selectors share the same tests.
 describe.each( [
@@ -896,3 +898,97 @@ describe( 'getCurrentUser', () => {
 		expect( getCurrentUser( state ) ).toEqual( currentUser );
 	} );
 } );
+
+describe( 'getRevisions', () => {
+	it( 'should return revisions', () => {
+		const state = deepFreeze( {
+			entities: {
+				records: {
+					postType: {
+						post: {
+							revisions: {
+								1: {
+									items: {
+										default: {
+											10: {
+												id: 10,
+												content: 'chicken',
+												author: 'bob',
+												parent: 1,
+											},
+										},
+									},
+									itemIsComplete: {
+										default: {
+											10: true,
+										},
+									},
+									queries: {
+										default: {
+											'': { itemIds: [ 10 ] },
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		} );
+
+		expect( getRevisions( state, 'postType', 'post', 1 ) ).toEqual( [
+			{
+				id: 10,
+				content: 'chicken',
+				author: 'bob',
+				parent: 1,
+			},
+		] );
+	} );
+} );
+
+describe( 'getRevision', () => {
+	it( 'should return a specific revision', () => {
+		const state = deepFreeze( {
+			entities: {
+				records: {
+					postType: {
+						post: {
+							revisions: {
+								1: {
+									items: {
+										default: {
+											10: {
+												id: 10,
+												content: 'chicken',
+												author: 'bob',
+												parent: 1,
+											},
+										},
+									},
+									itemIsComplete: {
+										default: {
+											10: true,
+										},
+									},
+									queries: {
+										default: {
+											'': [ 10 ],
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		} );
+
+		expect( getRevision( state, 'postType', 'post', 1, 10 ) ).toEqual( {
+			id: 10,
+			content: 'chicken',
+			author: 'bob',
+			parent: 1,
+		} );
+	} );
+} );