@wordpress/core-data 7.42.0 → 7.43.2-next.v.202604091042.0

package/src/queried-data/selectors.js

@@ -26,12 +26,15 @@ const queriedItemsCacheByState = new WeakMap();
 /**
  * Returns items for a given query, or null if the items are not known.
  *
- * @param {Object}  state State object.
- * @param {?Object} query Optional query.
+ * @param {Object}  state                      State object.
+ * @param {?Object} query                      Optional query.
+ * @param {?Object} options                    Optional pagination options.
+ * @param {boolean} options.supportsPagination Whether the entity supports pagination. Default true.
  *
  * @return {?Array} Query items.
  */
-function getQueriedItemsUncached( state, query ) {
+function getQueriedItemsUncached( state, query, options = {} ) {
+	const { supportsPagination = true } = options;
 	const {
 		stableKey,
 		page,
@@ -47,31 +50,20 @@ function getQueriedItemsUncached( state, query ) {
 		return null;
 	}
 
-	const startOffset = perPage === -1 ? 0 : ( page - 1 ) * perPage;
-	const endOffset =
-		perPage === -1
-			? itemIds.length
-			: Math.min( startOffset + perPage, itemIds.length );
+	const isPaginated = supportsPagination && perPage !== -1;
+	const startOffset = isPaginated ? queryOffset ?? ( page - 1 ) * perPage : 0;
+	const endOffset = isPaginated
+		? Math.min( startOffset + perPage, itemIds.length )
+		: itemIds.length;
 
 	// If the requested page range exceeds the stored itemIds, the data for
 	// this specific pagination window may not have been fetched yet. Return
 	// null unless totalItems confirms we already have all available items.
-	if ( perPage !== -1 && itemIds.length < startOffset + perPage ) {
+	if ( isPaginated && 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;
 		}
 	}
 
@@ -128,27 +120,31 @@ function getQueriedItemsUncached( state, query ) {
  *
  * `getQueriedItems( state, {} ) !== getQueriedItems( state, {} )`
  *
- * @param {Object}  state State object.
- * @param {?Object} query Optional query.
+ * @param {Object}  state                      State object.
+ * @param {?Object} query                      Optional query.
+ * @param {?Object} options                    Optional pagination options.
+ * @param {boolean} options.supportsPagination Whether the entity supports pagination. Default true.
  *
  * @return {?Array} Query items.
  */
-export const getQueriedItems = createSelector( ( state, query = {} ) => {
-	let queriedItemsCache = queriedItemsCacheByState.get( state );
-	if ( queriedItemsCache ) {
-		const queriedItems = queriedItemsCache.get( query );
-		if ( queriedItems !== undefined ) {
-			return queriedItems;
+export const getQueriedItems = createSelector(
+	( state, query = {}, options = {} ) => {
+		let queriedItemsCache = queriedItemsCacheByState.get( state );
+		if ( queriedItemsCache ) {
+			const queriedItems = queriedItemsCache.get( query );
+			if ( queriedItems !== undefined ) {
+				return queriedItems;
+			}
+		} else {
+			queriedItemsCache = new EquivalentKeyMap();
+			queriedItemsCacheByState.set( state, queriedItemsCache );
 		}
-	} else {
-		queriedItemsCache = new EquivalentKeyMap();
-		queriedItemsCacheByState.set( state, queriedItemsCache );
-	}
 
-	const items = getQueriedItemsUncached( state, query );
-	queriedItemsCache.set( query, items );
-	return items;
-} );
+		const items = getQueriedItemsUncached( state, query, options );
+		queriedItemsCache.set( query, items );
+		return items;
+	}
+);
 
 export function getQueriedTotalItems( state, query = {} ) {
 	const { stableKey, context } = getQueryParts( query );

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', () => {
@@ -261,7 +262,11 @@ describe( 'getQueriedItems', () => {
 			},
 		};
 
-		const result = getQueriedItems( state, { per_page: 3 } );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 3 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toBe( null );
 	} );
 
@@ -284,18 +289,22 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=100': {
-						itemIds: [ 101, 102, 103 ],
+					'': {
+						itemIds: getMergedItemIds( [], [ 101, 102, 103 ], {
+							offset: 100,
+							perPage: 50,
+						} ),
 						meta: { totalItems: 103 },
 					},
 				},
 			},
 		};
 
-		const result = getQueriedItems( state, {
-			per_page: 50,
-			offset: 100,
-		} );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 50, offset: 100 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toEqual( [ { id: 101 }, { id: 102 }, { id: 103 } ] );
 	} );
 
@@ -314,18 +323,22 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=50': {
-						itemIds: [ 51, 52 ],
+					'': {
+						itemIds: getMergedItemIds( [], [ 51, 52 ], {
+							offset: 50,
+							perPage: 50,
+						} ),
 						meta: { totalItems: 200 },
 					},
 				},
 			},
 		};
 
-		const result = getQueriedItems( state, {
-			per_page: 50,
-			offset: 50,
-		} );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 50, offset: 50 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toBe( null );
 	} );
 
@@ -348,18 +361,22 @@ 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 },
 					},
 				},
 			},
 		};
 
-		const result = getQueriedItems( state, {
-			per_page: 10,
-			offset: 3,
-		} );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 10, offset: 3 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toBe( null );
 	} );
 
@@ -379,7 +396,7 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=0': {
+					'': {
 						itemIds: [ 1, 2 ],
 						meta: { totalItems: 5 },
 					},
@@ -388,10 +405,11 @@ describe( 'getQueriedItems', () => {
 		};
 
 		// 2 items stored, but 5 total exist — should return null.
-		const result = getQueriedItems( state, {
-			per_page: 3,
-			offset: 0,
-		} );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 3, offset: 0 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toBe( null );
 	} );
 
@@ -408,18 +426,22 @@ describe( 'getQueriedItems', () => {
 			},
 			queries: {
 				default: {
-					'offset=84': {
-						itemIds: [],
+					'': {
+						itemIds: getMergedItemIds( [], [], {
+							offset: 84,
+							perPage: 7,
+						} ),
 						meta: { totalItems: 84 },
 					},
 				},
 			},
 		};
 
-		const result = getQueriedItems( state, {
-			per_page: 7,
-			offset: 84,
-		} );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 7, offset: 84 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toEqual( [] );
 	} );
 } );

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

@@ -578,7 +578,7 @@ export const getEntityRecords =
 
 				dispatch.__unstableReleaseStoreLock( lock );
 			} );
-		} catch ( e ) {
+		} catch {
 			dispatch.__unstableReleaseStoreLock( lock );
 		}
 	};
@@ -635,7 +635,7 @@ export const getEmbedPreview =
 				path: addQueryArgs( '/oembed/1.0/proxy', { url } ),
 			} );
 			dispatch.receiveEmbedPreview( url, embedProxyResponse );
-		} catch ( error ) {
+		} catch {
 			// Embed API 404s if the URL cannot be embedded, so we have to catch the error from the apiRequest here.
 			dispatch.receiveEmbedPreview( url, false );
 		}
@@ -706,7 +706,7 @@ export const canUser =
 				method: 'OPTIONS',
 				parse: false,
 			} );
-		} catch ( error ) {
+		} catch {
 			// Do nothing if our OPTIONS request comes back with an API error (4xx or
 			// 5xx). The previously determined isAllowed value will remain in the store.
 			return;
@@ -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 ) => {
@@ -1076,7 +1077,7 @@ export const getRevisions =
 				entityConfig.supportsPagination && query.per_page !== -1;
 			try {
 				response = await apiFetch( { path, parse: ! isPaginated } );
-			} catch ( error ) {
+			} catch {
 				// Do nothing if our request comes back with an API error.
 				return;
 			}
@@ -1219,7 +1220,7 @@ export const getRevision =
 			let record;
 			try {
 				record = await apiFetch( { path } );
-			} catch ( error ) {
+			} catch {
 				// Do nothing if our request comes back with an API error.
 				return;
 			}
@@ -1256,7 +1257,7 @@ export const getRegisteredPostMeta =
 				path: `${ restNamespace }/${ restBase }/?context=edit`,
 				method: 'OPTIONS',
 			} );
-		} catch ( error ) {
+		} catch {
 			// Do nothing if the request comes back with an API error.
 			return;
 		}
@@ -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 );
+	};