@wordpress/core-data 7.42.0 → 7.43.0

package/src/private-selectors.ts

@@ -14,6 +14,8 @@ import logEntityDeprecation from './utils/log-entity-deprecation';
 
 type EntityRecordKey = string | number;
 
+const EMPTY_OBJECT = {};
+
 /**
  * Returns the previous edit from the current undo offset
  * for the entity records edits history, if any.
@@ -170,11 +172,18 @@ export const getHomePage = createRegistrySelector( ( select ) =>
 			).getDefaultTemplateId( {
 				slug: 'front-page',
 			} );
-			// Still resolving getDefaultTemplateId.
-			if ( ! frontPageTemplateId ) {
-				return null;
+			if ( frontPageTemplateId ) {
+				return {
+					postType: 'wp_template',
+					postId: frontPageTemplateId,
+				};
 			}
-			return { postType: 'wp_template', postId: frontPageTemplateId };
+			// Resolution is finished and no front-page template exists.
+			if ( frontPageTemplateId === '' ) {
+				return EMPTY_OBJECT;
+			}
+			// Still resolving getDefaultTemplateId.
+			return null;
 		},
 		( state ) => [
 			// Even though getDefaultTemplateId.shouldInvalidate returns true when root/site changes,
@@ -314,3 +323,27 @@ export function getEditorAssets( state: State ): Record< string, any > | null {
 export function isCollaborationSupported( state: State ): boolean {
 	return state.collaborationSupported;
 }
+
+/**
+ * Returns the view configuration for the given entity type.
+ *
+ * @param state Data state.
+ * @param kind  Entity kind.
+ * @param name  Entity name.
+ *
+ * @return The view configuration or undefined if not loaded.
+ */
+export function getViewConfig(
+	state: State,
+	kind: string,
+	name: string
+): Record< string, any > | undefined {
+	return (
+		state.viewConfigs?.[ `${ kind }/${ name }` ] ?? {
+			default_view: undefined,
+			default_layouts: undefined,
+			view_list: undefined,
+			form: undefined,
+		}
+	);
+}

package/src/queried-data/get-query-parts.js

@@ -15,15 +15,11 @@ import { withWeakMapCache, getNormalizedCommaSeparable } from '../utils';
  *
  * @property {number}      page      The query page (1-based index, default 1).
  * @property {number}      perPage   Items per page for query (default 10).
- * @property {number}      offset    Absolute item offset (default undefined).
- *                                   When present, also encoded into stableKey.
- * @property {string}      stableKey An encoded stable string of all non-
- *                                   pagination, non-fields query parameters.
- * @property {?(string[])} fields    Target subset of fields to derive from
- *                                   item objects.
- * @property {?(number[])} include   Specific item IDs to include.
- * @property {string}      context   Scope under which the request is made;
- *                                   determines returned fields in response.
+ * @property {?number}     offset    Absolute item offset (default null).
+ * @property {string}      stableKey An encoded stable string of all non-pagination, non-fields query parameters.
+ * @property {?(string[])} fields    Target subset of fields to derive from item objects (default null).
+ * @property {?(number[])} include   Specific item IDs to include (default null).
+ * @property {string}      context   Scope under which the request is made; determines returned fields in response.
  */
 
 /**
@@ -43,7 +39,7 @@ export function getQueryParts( query ) {
 		stableKey: '',
 		page: 1,
 		perPage: 10,
-		offset: undefined,
+		offset: null,
 		fields: null,
 		include: null,
 		context: 'default',
@@ -65,21 +61,19 @@ export function getQueryParts( query ) {
 				parts.perPage = Number( value );
 				break;
 
+			case 'offset': {
+				const numericOffset = Number( value );
+				if ( Number.isFinite( numericOffset ) ) {
+					parts.offset = numericOffset;
+				}
+				break;
+			}
+
 			case 'context':
 				parts.context = value;
 				break;
 
 			default:
-				// Extract offset for use in pagination calculations while
-				// still including it in the stableKey (different offsets
-				// produce different result sets).
-				if ( key === 'offset' ) {
-					const numericOffset = Number( value );
-					if ( Number.isFinite( numericOffset ) ) {
-						parts.offset = numericOffset;
-					}
-				}
-
 				// While in theory, we could exclude "_fields" from the stableKey
 				// because two request with different fields have the same results
 				// We're not able to ensure that because the server can decide to omit

package/src/queried-data/reducer.js

@@ -30,24 +30,32 @@ function getContextFromAction( action ) {
  * Returns a merged array of item IDs, given details of the received paginated
  * items. The array is sparse-like with `undefined` entries where holes exist.
  *
- * @param {?Array<number>} itemIds     Original item IDs (default empty array).
- * @param {number[]}       nextItemIds Item IDs to merge.
- * @param {number}         page        Page of items merged.
- * @param {number}         perPage     Number of items per page.
+ * @param {number[]|undefined} itemIds          Original item IDs (default empty array).
+ * @param {number[]}           nextItemIds      Item IDs to merge.
+ * @param {Object}             options          Options object.
+ * @param {number}             [options.page]   Page of items merged.
+ * @param {number}             [options.offset] Offset of items merged.
+ * @param {number}             options.perPage  Number of items per page.
  *
  * @return {number[]} Merged array of item IDs.
  */
-export function getMergedItemIds( itemIds, nextItemIds, page, perPage ) {
-	const receivedAllIds = page === 1 && perPage === -1;
-	if ( receivedAllIds ) {
+export function getMergedItemIds(
+	itemIds = [],
+	nextItemIds,
+	// The defaults for `page` and `perPage` are the same as in `getQueryParts`.
+	{ page = 1, offset, perPage = 10 } = {}
+) {
+	// If the query is unbounded, then `nextItemIds` is a complete replacement.
+	if ( perPage === -1 ) {
 		return nextItemIds;
 	}
-	const nextItemIdsStartIndex = ( page - 1 ) * perPage;
+
+	const nextItemIdsStartIndex = offset ?? ( page - 1 ) * perPage;
 
 	// If later page has already been received, default to the larger known
 	// size of the existing array, else calculate as extending the existing.
 	const size = Math.max(
-		itemIds?.length ?? 0,
+		itemIds.length,
 		nextItemIdsStartIndex + nextItemIds.length
 	);
 
@@ -60,9 +68,11 @@ export function getMergedItemIds( itemIds, nextItemIds, page, perPage ) {
 		// a page could receive fewer than what was previously stored.
 		const isInNextItemsRange =
 			i >= nextItemIdsStartIndex && i < nextItemIdsStartIndex + perPage;
-		mergedItemIds[ i ] = isInNextItemsRange
-			? nextItemIds[ i - nextItemIdsStartIndex ]
-			: itemIds?.[ i ];
+		if ( isInNextItemsRange ) {
+			mergedItemIds[ i ] = nextItemIds[ i - nextItemIdsStartIndex ];
+		} else {
+			mergedItemIds[ i ] = itemIds[ i ];
+		}
 	}
 
 	return mergedItemIds;
@@ -244,10 +254,13 @@ const receiveQueries = compose( [
 
 	return {
 		itemIds: getMergedItemIds(
-			state?.itemIds || [],
+			state.itemIds,
 			action.items.map( ( item ) => item?.[ key ] ).filter( Boolean ),
-			action.page,
-			action.perPage
+			{
+				page: action.page,
+				offset: action.offset,
+				perPage: action.perPage,
+			}
 		),
 		meta: action.meta,
 	};

package/src/queried-data/selectors.js

@@ -47,7 +47,8 @@ function getQueriedItemsUncached( state, query ) {
 		return null;
 	}
 
-	const startOffset = perPage === -1 ? 0 : ( page - 1 ) * perPage;
+	const startOffset =
+		perPage === -1 ? 0 : queryOffset ?? ( page - 1 ) * perPage;
 	const endOffset =
 		perPage === -1
 			? itemIds.length
@@ -59,19 +60,8 @@ function getQueriedItemsUncached( state, query ) {
 	if ( perPage !== -1 && itemIds.length < startOffset + perPage ) {
 		const totalItems =
 			state.queries[ context ][ stableKey ].meta?.totalItems;
-		if ( Number.isFinite( totalItems ) ) {
-			// For offset-based queries, totalItems (from X-WP-Total)
-			// reflects the global count of all matching items, not the
-			// count remaining after the offset. The number of items
-			// available for this query is (totalItems - offset), so a
-			// partial last page is expected and valid.
-			const effectiveTotal =
-				queryOffset !== undefined
-					? totalItems - queryOffset
-					: totalItems;
-			if ( itemIds.length < effectiveTotal ) {
-				return null;
-			}
+		if ( Number.isFinite( totalItems ) && itemIds.length < totalItems ) {
+			return null;
 		}
 	}
 

package/src/queried-data/test/get-query-parts.js

@@ -11,7 +11,7 @@ describe( 'getQueryParts', () => {
 			context: 'default',
 			page: 2,
 			perPage: 2,
-			offset: undefined,
+			offset: null,
 			stableKey: '',
 			fields: null,
 			include: null,
@@ -29,7 +29,7 @@ describe( 'getQueryParts', () => {
 			context: 'default',
 			page: 1,
 			perPage: 10,
-			offset: undefined,
+			offset: null,
 			stableKey: 'include=1',
 			fields: null,
 			include: [ 1 ],
@@ -45,7 +45,7 @@ describe( 'getQueryParts', () => {
 			context: 'default',
 			page: 1,
 			perPage: 10,
-			offset: undefined,
+			offset: null,
 			stableKey: '%3F=%26&b=2',
 			fields: null,
 			include: null,
@@ -59,7 +59,7 @@ describe( 'getQueryParts', () => {
 			context: 'default',
 			page: 1,
 			perPage: 10,
-			offset: undefined,
+			offset: null,
 			stableKey: 'a%5B0%5D=1&a%5B1%5D=2',
 			fields: null,
 			include: null,
@@ -75,7 +75,7 @@ describe( 'getQueryParts', () => {
 			context: 'default',
 			page: 1,
 			perPage: 10,
-			offset: undefined,
+			offset: null,
 			stableKey: 'b=2',
 			fields: null,
 			include: null,
@@ -89,7 +89,7 @@ describe( 'getQueryParts', () => {
 			context: 'default',
 			page: 1,
 			perPage: -1,
-			offset: undefined,
+			offset: null,
 			stableKey: 'b=2',
 			fields: null,
 			include: null,
@@ -103,7 +103,7 @@ describe( 'getQueryParts', () => {
 			context: 'default',
 			page: 1,
 			perPage: 10,
-			offset: undefined,
+			offset: null,
 			stableKey: '_fields=id%2Ctitle',
 			fields: [ 'id', 'title' ],
 			include: null,
@@ -116,7 +116,7 @@ describe( 'getQueryParts', () => {
 		expect( parts ).toEqual( {
 			page: 1,
 			perPage: 10,
-			offset: undefined,
+			offset: null,
 			stableKey: '',
 			include: null,
 			fields: null,
@@ -124,7 +124,7 @@ describe( 'getQueryParts', () => {
 		} );
 	} );
 
-	it( 'extracts offset and includes it in stableKey', () => {
+	it( 'extracts offset and excludes it from stableKey', () => {
 		const parts = getQueryParts( {
 			per_page: 50,
 			offset: 100,
@@ -135,7 +135,7 @@ describe( 'getQueryParts', () => {
 			page: 1,
 			perPage: 50,
 			offset: 100,
-			stableKey: 'offset=100',
+			stableKey: '',
 			fields: null,
 			include: null,
 		} );
@@ -147,6 +147,6 @@ describe( 'getQueryParts', () => {
 			offset: 'abc',
 		} );
 
-		expect( parts.offset ).toBeUndefined();
+		expect( parts.offset ).toBeNull();
 	} );
 } );

package/src/queried-data/test/reducer.js

@@ -11,7 +11,10 @@ import { removeItems } from '../actions';
 
 describe( 'getMergedItemIds', () => {
 	it( 'should receive a page', () => {
-		const result = getMergedItemIds( [], [ 4, 5, 6 ], 2, 3 );
+		const result = getMergedItemIds( [], [ 4, 5, 6 ], {
+			page: 2,
+			perPage: 3,
+		} );
 
 		expect( result ).toEqual( [
 			undefined,
@@ -32,46 +35,68 @@ describe( 'getMergedItemIds', () => {
 			5,
 			6,
 		] );
-		const result = getMergedItemIds( original, [ 1, 2, 3 ], 1, 3 );
+		const result = getMergedItemIds( original, [ 1, 2, 3 ], {
+			page: 1,
+			perPage: 3,
+		} );
 
 		expect( result ).toEqual( [ 1, 2, 3, 4, 5, 6 ] );
 	} );
 
 	it( 'should replace with new page', () => {
 		const original = deepFreeze( [ 1, 2, 3, 4, 5, 6 ] );
-		const result = getMergedItemIds( original, [ 'replaced', 5, 6 ], 2, 3 );
+		const result = getMergedItemIds( original, [ 'replaced', 5, 6 ], {
+			page: 2,
+			perPage: 3,
+		} );
 
 		expect( result ).toEqual( [ 1, 2, 3, 'replaced', 5, 6 ] );
 	} );
 
 	it( 'should append a new partial page', () => {
 		const original = deepFreeze( [ 1, 2, 3, 4, 5, 6 ] );
-		const result = getMergedItemIds( original, [ 7 ], 3, 3 );
+		const result = getMergedItemIds( original, [ 7 ], {
+			page: 3,
+			perPage: 3,
+		} );
 
 		expect( result ).toEqual( [ 1, 2, 3, 4, 5, 6, 7 ] );
 	} );
 
 	it( 'should return a copy of nextItemIds if it represents all ids (single id removed) (page=1 and perPage=-1)', () => {
 		const original = deepFreeze( [ 1, 2, 3 ] );
-		const result = getMergedItemIds( original, [ 1, 3 ], 1, -1 );
+		const result = getMergedItemIds( original, [ 1, 3 ], {
+			page: 1,
+			perPage: -1,
+		} );
 
 		expect( result ).toEqual( [ 1, 3 ] );
 	} );
 
 	it( 'should return a copy of nextItemIds if it represents all ids (single id removed and another one added) (page=1 and perPage=-1)', () => {
 		const original = deepFreeze( [ 1, 2, 3 ] );
-		const result = getMergedItemIds( original, [ 1, 3, 4 ], 1, -1 );
+		const result = getMergedItemIds( original, [ 1, 3, 4 ], {
+			page: 1,
+			perPage: -1,
+		} );
 
 		expect( result ).toEqual( [ 1, 3, 4 ] );
 	} );
+
 	it( 'should update a page properly if less items are provided than previously stored', () => {
 		let original = deepFreeze( [ 1, 2, 3 ] );
-		let result = getMergedItemIds( original, [ 1, 2 ], 1, 3 );
+		let result = getMergedItemIds( original, [ 1, 2 ], {
+			page: 1,
+			perPage: 3,
+		} );
 
 		expect( result ).toEqual( [ 1, 2 ] );
 
 		original = deepFreeze( [ 1, 2, 3, 4, 5, 6 ] );
-		result = getMergedItemIds( original, [ 9 ], 2, 2 );
+		result = getMergedItemIds( original, [ 9 ], {
+			page: 2,
+			perPage: 2,
+		} );
 
 		expect( result ).toEqual( [ 1, 2, 9, undefined, 5, 6 ] );
 	} );
@@ -197,6 +222,51 @@ describe( 'reducer', () => {
 		} );
 	} );
 
+	it( 'receives a sparse subset of items at given offsets', () => {
+		const original = deepFreeze( {
+			items: { default: {} },
+			queries: {},
+			itemIsComplete: { default: {} },
+		} );
+		const state = [
+			{
+				type: 'RECEIVE_ITEMS',
+				query: { offset: 1, per_page: 2 },
+				items: [
+					{ id: 2, name: 'def' },
+					{ id: 3, name: 'ghi' },
+				],
+			},
+			{
+				type: 'RECEIVE_ITEMS',
+				query: { offset: 4, per_page: 2 },
+				items: [
+					{ id: 5, name: 'mno' },
+					{ id: 6, name: 'pqr' },
+				],
+			},
+		].reduce( reducer, original );
+
+		expect( state ).toEqual( {
+			items: {
+				default: {
+					2: { id: 2, name: 'def' },
+					3: { id: 3, name: 'ghi' },
+					5: { id: 5, name: 'mno' },
+					6: { id: 6, name: 'pqr' },
+				},
+			},
+			itemIsComplete: {
+				default: { 2: true, 3: true, 5: true, 6: true },
+			},
+			queries: {
+				default: {
+					'': { itemIds: [ undefined, 2, 3, undefined, 5, 6 ] },
+				},
+			},
+		} );
+	} );
+
 	it( 'deletes an item', () => {
 		const kind = 'root';
 		const name = 'menu';

package/src/queried-data/test/selectors.js

@@ -2,6 +2,7 @@
  * Internal dependencies
  */
 import { getQueriedItems } from '../selectors';
+import { getMergedItemIds } from '../reducer';
 
 describe( 'getQueriedItems', () => {
 	it( 'should return null if requesting but no item IDs', () => {
@@ -284,8 +285,11 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=100': {
-						itemIds: [ 101, 102, 103 ],
+					'': {
+						itemIds: getMergedItemIds( [], [ 101, 102, 103 ], {
+							offset: 100,
+							perPage: 50,
+						} ),
 						meta: { totalItems: 103 },
 					},
 				},
@@ -314,8 +318,11 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=50': {
-						itemIds: [ 51, 52 ],
+					'': {
+						itemIds: getMergedItemIds( [], [ 51, 52 ], {
+							offset: 50,
+							perPage: 50,
+						} ),
 						meta: { totalItems: 200 },
 					},
 				},
@@ -348,8 +355,11 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=3': {
-						itemIds: [ 4, 5, 6, 7, 8 ],
+					'': {
+						itemIds: getMergedItemIds( [], [ 4, 5, 6, 7, 8 ], {
+							offset: 3,
+							perPage: 10,
+						} ),
 						meta: { totalItems: 50 },
 					},
 				},
@@ -379,7 +389,7 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=0': {
+					'': {
 						itemIds: [ 1, 2 ],
 						meta: { totalItems: 5 },
 					},
@@ -408,8 +418,11 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=84': {
-						itemIds: [],
+					'': {
+						itemIds: getMergedItemIds( [], [], {
+							offset: 84,
+							perPage: 7,
+						} ),
 						meta: { totalItems: 84 },
 					},
 				},

package/src/reducer.js

@@ -721,6 +721,25 @@ export function collaborationSupported( state = true, action ) {
 	return state;
 }
 
+/**
+ * Reducer managing view configs, keyed by `kind/name`.
+ *
+ * @param {Object} state  Current state.
+ * @param {Object} action Dispatched action.
+ *
+ * @return {Object} Updated state.
+ */
+export function viewConfigs( state = {}, action ) {
+	switch ( action.type ) {
+		case 'RECEIVE_VIEW_CONFIG':
+			return {
+				...state,
+				[ `${ action.kind }/${ action.name }` ]: action.config,
+			};
+	}
+	return state;
+}
+
 export default combineReducers( {
 	users,
 	currentTheme,
@@ -745,4 +764,5 @@ export default combineReducers( {
 	editorAssets,
 	syncConnectionStatuses,
 	collaborationSupported,
+	viewConfigs,
 } );

package/src/resolvers.js

@@ -991,11 +991,12 @@ export const getDefaultTemplateId =
 		const id = window?.__experimentalTemplateActivate
 			? template?.wp_id || template?.id
 			: template?.id;
-		// Endpoint may return an empty object if no template is found.
-		if ( id ) {
-			template.id = id;
-			registry.batch( () => {
-				dispatch.receiveDefaultTemplateId( query, id );
+
+		registry.batch( () => {
+			dispatch.receiveDefaultTemplateId( query, id || '' );
+			// Endpoint may return an empty object if no template is found.
+			if ( id ) {
+				template.id = id;
 				dispatch.receiveEntityRecords(
 					'postType',
 					template.type,
@@ -1007,8 +1008,8 @@ export const getDefaultTemplateId =
 					template.type,
 					id,
 				] );
-			} );
-		}
+			}
+		} );
 	};
 
 getDefaultTemplateId.shouldInvalidate = ( action ) => {
@@ -1320,3 +1321,18 @@ export const getEditorAssets =
 		} );
 		dispatch.receiveEditorAssets( assets );
 	};
+
+/**
+ * Requests view config for a given entity type from the REST API.
+ *
+ * @param {string} kind Entity kind.
+ * @param {string} name Entity name.
+ */
+export const getViewConfig =
+	( kind, name ) =>
+	async ( { dispatch } ) => {
+		const config = await apiFetch( {
+			path: addQueryArgs( '/wp/v2/view-config', { kind, name } ),
+		} );
+		dispatch.receiveViewConfig( kind, name, config );
+	};

package/src/selectors.ts

@@ -20,7 +20,6 @@ import { DEFAULT_ENTITY_KEY } from './entities';
 import { getUndoManager } from './private-selectors';
 import {
 	getNormalizedCommaSeparable,
-	isRawAttribute,
 	setNestedValue,
 	isNumericID,
 	getUserPermissionCacheKey,
@@ -55,6 +54,7 @@ export interface State {
 	editorAssets: Record< string, any > | null;
 	syncConnectionStatuses?: Record< string, ConnectionStatus >;
 	collaborationSupported: boolean;
+	viewConfigs: Record< string, Record< string, any > >;
 }
 
 type EntityRecordKey = string | number;
@@ -523,25 +523,26 @@ export const getRawEntityRecord = createSelector(
 			name,
 			key
 		);
-		return (
-			record &&
-			Object.keys( record ).reduce( ( accumulator, _key ) => {
-				if (
-					isRawAttribute( getEntityConfig( state, kind, name ), _key )
-				) {
-					// Because edits are the "raw" attribute values,
-					// we return those from record selectors to make rendering,
-					// comparisons, and joins with edits easier.
-					accumulator[ _key ] =
-						record[ _key ]?.raw !== undefined
-							? record[ _key ]?.raw
-							: record[ _key ];
-				} else {
-					accumulator[ _key ] = record[ _key ];
+		const config = getEntityConfig( state, kind, name );
+		if ( ! record || ! config?.rawAttributes?.length ) {
+			return record;
+		}
+
+		// Because edits are the "raw" attribute values,
+		// we return those from record selectors to make rendering,
+		// comparisons, and joins with edits easier.
+		return Object.fromEntries(
+			Object.keys( record ).map( ( _key ) => {
+				if ( config.rawAttributes.includes( _key ) ) {
+					const rawValue = record[ _key ]?.raw;
+					return [
+						_key,
+						rawValue !== undefined ? rawValue : record[ _key ],
+					];
 				}
-				return accumulator;
-			}, {} as any )
-		);
+				return [ _key, record[ _key ] ];
+			} )
+		) as EntityRecord;
 	},
 	(
 		state: State,