@wordpress/core-data 7.43.0 → 7.44.0

package/src/entities.js

@@ -17,6 +17,7 @@ import { PostEditorAwareness } from './awareness/post-editor-awareness';
 import { getSyncManager } from './sync';
 import {
 	applyPostChangesToCRDTDoc,
+	defaultCollectionSyncConfig,
 	defaultSyncConfig,
 	getPostChangesFromCRDTDoc,
 	POST_META_KEY_FOR_CRDT_DOC_PERSISTENCE,
@@ -68,6 +69,7 @@ export const rootEntitiesConfig = [
 		// The entity doesn't support selecting multiple records.
 		// The property is maintained for backward compatibility.
 		plural: '__unstableBases',
+		supportsPagination: false,
 	},
 	{
 		label: __( 'Post Type' ),
@@ -77,6 +79,7 @@ export const rootEntitiesConfig = [
 		baseURL: '/wp/v2/types',
 		baseURLParams: { context: 'edit' },
 		plural: 'postTypes',
+		supportsPagination: false,
 	},
 	{
 		name: 'media',
@@ -96,6 +99,7 @@ export const rootEntitiesConfig = [
 		baseURLParams: { context: 'edit' },
 		plural: 'taxonomies',
 		label: __( 'Taxonomy' ),
+		supportsPagination: false,
 	},
 	{
 		name: 'sidebar',
@@ -105,6 +109,7 @@ export const rootEntitiesConfig = [
 		plural: 'sidebars',
 		transientEdits: { blocks: true },
 		label: __( 'Widget areas' ),
+		supportsPagination: false,
 	},
 	{
 		name: 'widget',
@@ -114,6 +119,7 @@ export const rootEntitiesConfig = [
 		plural: 'widgets',
 		transientEdits: { blocks: true },
 		label: __( 'Widgets' ),
+		supportsPagination: false,
 	},
 	{
 		name: 'widgetType',
@@ -122,6 +128,7 @@ export const rootEntitiesConfig = [
 		baseURLParams: { context: 'edit' },
 		plural: 'widgetTypes',
 		label: __( 'Widget types' ),
+		supportsPagination: false,
 	},
 	{
 		label: __( 'User' ),
@@ -141,6 +148,7 @@ export const rootEntitiesConfig = [
 		plural: 'comments',
 		label: __( 'Comment' ),
 		supportsPagination: true,
+		syncConfig: defaultCollectionSyncConfig,
 	},
 	{
 		name: 'menu',
@@ -169,6 +177,7 @@ export const rootEntitiesConfig = [
 		plural: 'menuLocations',
 		label: __( 'Menu Location' ),
 		key: 'name',
+		supportsPagination: false,
 	},
 	{
 		label: __( 'Global Styles' ),
@@ -192,6 +201,7 @@ export const rootEntitiesConfig = [
 		baseURLParams: { context: 'edit' },
 		plural: 'themes',
 		key: 'stylesheet',
+		supportsPagination: false,
 	},
 	{
 		label: __( 'Plugins' ),
@@ -201,6 +211,7 @@ export const rootEntitiesConfig = [
 		baseURLParams: { context: 'edit' },
 		plural: 'plugins',
 		key: 'plugin',
+		supportsPagination: false,
 	},
 	{
 		label: __( 'Status' ),
@@ -210,6 +221,7 @@ export const rootEntitiesConfig = [
 		baseURLParams: { context: 'edit' },
 		plural: 'statuses',
 		key: 'slug',
+		supportsPagination: false,
 	},
 	{
 		label: __( 'Registered Templates' ),
@@ -217,6 +229,7 @@ export const rootEntitiesConfig = [
 		kind: 'root',
 		baseURL: '/wp/v2/registered-templates',
 		key: 'id',
+		supportsPagination: false,
 	},
 	{
 		label: __( 'Font Collections' ),
@@ -236,15 +249,9 @@ export const rootEntitiesConfig = [
 		baseURLParams: { context: 'view' },
 		plural: 'icons',
 		key: 'name',
+		supportsPagination: false,
 	},
-].map( ( entity ) => {
-	const syncEnabledRootEntities = new Set( [ 'comment' ] );
-
-	if ( syncEnabledRootEntities.has( entity.name ) ) {
-		entity.syncConfig = defaultSyncConfig;
-	}
-	return entity;
-} );
+];
 
 export const deprecatedEntities = {
 	root: {
@@ -500,6 +507,7 @@ async function loadSiteEntity() {
 		kind: 'root',
 		key: false,
 		baseURL: '/wp/v2/settings',
+		supportsPagination: false,
 		meta: {},
 	};
 

package/src/hooks/index.ts

@@ -9,15 +9,15 @@ import type { WithPermissions } from './use-entity-records';
 export type { WithPermissions };
 export {
 	default as useEntityRecord,
-	__experimentalUseEntityRecord,
+	useDeprecatedEntityRecord as __experimentalUseEntityRecord,
 } from './use-entity-record';
 export {
 	default as useEntityRecords,
-	__experimentalUseEntityRecords,
+	useDeprecatedEntityRecords as __experimentalUseEntityRecords,
 } from './use-entity-records';
 export {
 	default as useResourcePermissions,
-	__experimentalUseResourcePermissions,
+	useDeprecatedResourcePermissions as __experimentalUseResourcePermissions,
 } from './use-resource-permissions';
 export { default as useEntityBlockEditor } from './use-entity-block-editor';
 export { default as useEntityId } from './use-entity-id';

package/src/hooks/test/use-entity-records.js

@@ -55,7 +55,7 @@ describe( 'useEntityRecords', () => {
 			isResolving: false,
 			status: 'IDLE',
 			totalItems: null,
-			totalPages: null,
+			totalPages: 1,
 		} );
 
 		// Fetch request should have been issued

package/src/hooks/use-entity-prop.js

@@ -64,7 +64,7 @@ export default function useEntityProp( kind, name, prop, _id ) {
 				);
 				return revision
 					? {
-							value: revision[ prop ],
+							value: revision[ prop ]?.raw ?? revision[ prop ],
 							fullValue: revision[ prop ],
 					  }
 					: {};

package/src/hooks/use-entity-record.ts

@@ -222,7 +222,7 @@ export default function useEntityRecord< RecordType >(
 	};
 }
 
-export function __experimentalUseEntityRecord(
+export function useDeprecatedEntityRecord(
 	kind: string,
 	name: string,
 	recordId: any,

package/src/hooks/use-entity-records.ts

@@ -153,7 +153,7 @@ export default function useEntityRecords< RecordType >(
 	};
 }
 
-export function __experimentalUseEntityRecords(
+export function useDeprecatedEntityRecords(
 	kind: string,
 	name: string,
 	queryArgs: any,

package/src/hooks/use-query-select.ts

@@ -6,7 +6,7 @@ import { useSelect } from '@wordpress/data';
 /**
  * Internal dependencies
  */
-import memoize from './memoize';
+import memoize from 'memize';
 import { Status } from './constants';
 
 export const META_SELECTORS = [

package/src/hooks/use-resource-permissions.ts

@@ -209,7 +209,7 @@ function useResourcePermissions< IdType = void >(
 
 export default useResourcePermissions;
 
-export function __experimentalUseResourcePermissions(
+export function useDeprecatedResourcePermissions(
 	resource: string,
 	id?: unknown
 ) {

package/src/queried-data/reducer.js

@@ -51,6 +51,7 @@ export function getMergedItemIds(
 	}
 
 	const nextItemIdsStartIndex = offset ?? ( page - 1 ) * perPage;
+	const nextItemIdsRange = Math.max( perPage, nextItemIds.length );
 
 	// If later page has already been received, default to the larger known
 	// size of the existing array, else calculate as extending the existing.
@@ -67,7 +68,8 @@ export function getMergedItemIds(
 		// We need to check against the possible maximum upper boundary because
 		// a page could receive fewer than what was previously stored.
 		const isInNextItemsRange =
-			i >= nextItemIdsStartIndex && i < nextItemIdsStartIndex + perPage;
+			i >= nextItemIdsStartIndex &&
+			i < nextItemIdsStartIndex + nextItemIdsRange;
 		if ( isInNextItemsRange ) {
 			mergedItemIds[ i ] = nextItemIds[ i - nextItemIdsStartIndex ];
 		} else {

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,17 +50,16 @@ function getQueriedItemsUncached( state, query ) {
 		return null;
 	}
 
-	const startOffset =
-		perPage === -1 ? 0 : queryOffset ?? ( 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 ) && itemIds.length < totalItems ) {
@@ -118,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/reducer.js

@@ -100,6 +100,13 @@ describe( 'getMergedItemIds', () => {
 
 		expect( result ).toEqual( [ 1, 2, 9, undefined, 5, 6 ] );
 	} );
+
+	it( 'should keep all received IDs when response exceeds default perPage', () => {
+		const nextItemIds = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ];
+		const result = getMergedItemIds( [], nextItemIds );
+
+		expect( result ).toEqual( nextItemIds );
+	} );
 } );
 
 describe( 'itemIsComplete', () => {

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

@@ -262,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 );
 	} );
 
@@ -296,10 +300,11 @@ describe( 'getQueriedItems', () => {
 			},
 		};
 
-		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 } ] );
 	} );
 
@@ -329,10 +334,11 @@ describe( 'getQueriedItems', () => {
 			},
 		};
 
-		const result = getQueriedItems( state, {
-			per_page: 50,
-			offset: 50,
-		} );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 50, offset: 50 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toBe( null );
 	} );
 
@@ -366,10 +372,11 @@ describe( 'getQueriedItems', () => {
 			},
 		};
 
-		const result = getQueriedItems( state, {
-			per_page: 10,
-			offset: 3,
-		} );
+		const result = getQueriedItems(
+			state,
+			{ per_page: 10, offset: 3 },
+			{ supportsPagination: true }
+		);
 		expect( result ).toBe( null );
 	} );
 
@@ -398,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 );
 	} );
 
@@ -429,10 +437,11 @@ describe( 'getQueriedItems', () => {
 			},
 		};
 
-		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/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;
@@ -1077,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;
 			}
@@ -1220,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;
 			}
@@ -1257,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;
 		}

package/src/selectors.ts

@@ -655,7 +655,10 @@ export const getEntityRecords = ( <
 	if ( ! queriedState ) {
 		return null;
 	}
-	return getQueriedItems( queriedState, query );
+	return getQueriedItems( queriedState, query, {
+		supportsPagination: !! getEntityConfig( state, kind, name )
+			?.supportsPagination,
+	} );
 } ) as GetEntityRecords;
 
 /**
@@ -713,7 +716,10 @@ export const getEntityRecordsTotalPages = (
 	if ( ! queriedState ) {
 		return null;
 	}
-	if ( query?.per_page === -1 ) {
+	if (
+		! getEntityConfig( state, kind, name )?.supportsPagination ||
+		query?.per_page === -1
+	) {
 		return 1;
 	}
 	const totalItems = getQueriedTotalItems( queriedState, query );