@wordpress/core-data 4.6.0 → 4.9.0

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

@@ -1,3 +1,8 @@
+/**
+ * WordPress dependencies
+ */
+import deprecated from '@wordpress/deprecated';
+
 /**
  * Internal dependencies
  */
@@ -5,7 +10,7 @@ import useQuerySelect from './use-query-select';
 import { store as coreStore } from '../';
 import type { Status } from './constants';
 
-interface EntityRecordResolution< RecordType > {
+export interface EntityRecordResolution< RecordType > {
 	/** The requested entity record */
 	record: RecordType | null;
 
@@ -23,18 +28,22 @@ interface EntityRecordResolution< RecordType > {
 	status: Status;
 }
 
-interface Options {
+export interface Options {
+	/**
+	 * Whether to run the query or short-circuit and return null.
+	 *
+	 * @default true
+	 */
 	enabled: boolean;
 }
 
 /**
  * Resolves the specified entity record.
  *
- * @param  kind                   Kind of the requested entity.
- * @param  name                   Name of the requested  entity.
- * @param  recordId               Record ID of the requested entity.
- * @param  options                Hook options.
- * @param  [options.enabled=true] Whether to run the query or short-circuit and return null. Defaults to true.
+ * @param  kind     Kind of the entity, e.g. `root` or a `postType`. See rootEntitiesConfig in ../entities.ts for a list of available kinds.
+ * @param  name     Name of the entity, e.g. `plugin` or a `post`. See rootEntitiesConfig in ../entities.ts for a list of available names.
+ * @param  recordId ID of the requested entity record.
+ * @param  options  Optional hook options.
  * @example
  * ```js
  * import { useEntityRecord } from '@wordpress/core-data';
@@ -57,10 +66,10 @@ interface Options {
  * application, the page and the resolution details will be retrieved from
  * the store state using `getEntityRecord()`, or resolved if missing.
  *
- * @return {EntityRecordResolution<RecordType>} Entity record data.
+ * @return Entity record data.
  * @template RecordType
  */
-export default function __experimentalUseEntityRecord< RecordType >(
+export default function useEntityRecord< RecordType >(
 	kind: string,
 	name: string,
 	recordId: string | number,
@@ -81,3 +90,16 @@ export default function __experimentalUseEntityRecord< RecordType >(
 		...rest,
 	};
 }
+
+export function __experimentalUseEntityRecord(
+	kind: string,
+	name: string,
+	recordId: any,
+	options: any
+) {
+	deprecated( `wp.data.__experimentalUseEntityRecord`, {
+		alternative: 'wp.data.useEntityRecord',
+		since: '6.1',
+	} );
+	return useEntityRecord( kind, name, recordId, options );
+}

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

@@ -2,48 +2,32 @@
  * WordPress dependencies
  */
 import { addQueryArgs } from '@wordpress/url';
+import deprecated from '@wordpress/deprecated';
 
 /**
  * Internal dependencies
  */
 import useQuerySelect from './use-query-select';
 import { store as coreStore } from '../';
-import type { Status } from './constants';
+import type { Options, EntityRecordResolution } from './use-entity-record';
 
-interface EntityRecordsResolution< RecordType > {
+type EntityRecordsResolution< RecordType > = Omit<
+	EntityRecordResolution< RecordType >,
+	'record'
+> & {
 	/** The requested entity record */
 	records: RecordType[] | null;
+};
 
-	/**
-	 * Is the record still being resolved?
-	 */
-	isResolving: boolean;
-
-	/**
-	 * Is the record resolved by now?
-	 */
-	hasResolved: boolean;
-
-	/** Resolution status */
-	status: Status;
-}
-
-interface Options {
-	/**
-	 * Whether to run the query or short-circuit and return null.
-	 *
-	 * @default true
-	 */
-	enabled: boolean;
-}
+const EMPTY_ARRAY = [];
 
 /**
  * Resolves the specified entity records.
  *
- * @param  kind      Kind of the requested entities.
- * @param  name      Name of the requested entities.
- * @param  queryArgs HTTP query for the requested entities.
- * @param  options   Hook options.
+ * @param  kind      Kind of the entity, e.g. `root` or a `postType`. See rootEntitiesConfig in ../entities.ts for a list of available kinds.
+ * @param  name      Name of the entity, e.g. `plugin` or a `post`. See rootEntitiesConfig in ../entities.ts for a list of available names.
+ * @param  queryArgs Optional HTTP query description for how to fetch the data, passed to the requested API endpoint.
+ * @param  options   Optional hook options.
  * @example
  * ```js
  * import { useEntityRecord } from '@wordpress/core-data';
@@ -75,7 +59,7 @@ interface Options {
  * @return Entity records data.
  * @template RecordType
  */
-export default function __experimentalUseEntityRecords< RecordType >(
+export default function useEntityRecords< RecordType >(
 	kind: string,
 	name: string,
 	queryArgs: Record< string, unknown > = {},
@@ -91,7 +75,8 @@ export default function __experimentalUseEntityRecords< RecordType >(
 		( query ) => {
 			if ( ! options.enabled ) {
 				return {
-					data: [],
+					// Avoiding returning a new reference on every execution.
+					data: EMPTY_ARRAY,
 				};
 			}
 			return query( coreStore ).getEntityRecords( kind, name, queryArgs );
@@ -104,3 +89,16 @@ export default function __experimentalUseEntityRecords< RecordType >(
 		...rest,
 	};
 }
+
+export function __experimentalUseEntityRecords(
+	kind: string,
+	name: string,
+	queryArgs: any,
+	options: any
+) {
+	deprecated( `wp.data.__experimentalUseEntityRecords`, {
+		alternative: 'wp.data.useEntityRecords',
+		since: '6.1',
+	} );
+	return useEntityRecords( kind, name, queryArgs, options );
+}

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

@@ -102,34 +102,36 @@ const enrichSelectors = memoize( ( ( selectors ) => {
 			continue;
 		}
 		Object.defineProperty( resolvers, selectorName, {
-			get: () => ( ...args: unknown[] ) => {
-				const { getIsResolving, hasFinishedResolution } = selectors;
-				const isResolving = !! getIsResolving( selectorName, args );
-				const hasResolved =
-					! isResolving &&
-					hasFinishedResolution( selectorName, args );
-				const data = selectors[ selectorName ]( ...args );
+			get:
+				() =>
+				( ...args: unknown[] ) => {
+					const { getIsResolving, hasFinishedResolution } = selectors;
+					const isResolving = !! getIsResolving( selectorName, args );
+					const hasResolved =
+						! isResolving &&
+						hasFinishedResolution( selectorName, args );
+					const data = selectors[ selectorName ]( ...args );
 
-				let status;
-				if ( isResolving ) {
-					status = Status.Resolving;
-				} else if ( hasResolved ) {
-					if ( data ) {
-						status = Status.Success;
+					let status;
+					if ( isResolving ) {
+						status = Status.Resolving;
+					} else if ( hasResolved ) {
+						if ( data ) {
+							status = Status.Success;
+						} else {
+							status = Status.Error;
+						}
 					} else {
-						status = Status.Error;
+						status = Status.Idle;
 					}
-				} else {
-					status = Status.Idle;
-				}
 
-				return {
-					data,
-					status,
-					isResolving,
-					hasResolved,
-				};
-			},
+					return {
+						data,
+						status,
+						isResolving,
+						hasResolved,
+					};
+				},
 		} );
 	}
 	return resolvers;

package/src/index.js

@@ -68,8 +68,7 @@ export const store = createReduxStore( STORE_NAME, storeConfig() );
 register( store );
 
 export { default as EntityProvider } from './entity-provider';
-export { default as __experimentalUseEntityRecord } from './hooks/use-entity-record';
-export { default as __experimentalUseEntityRecords } from './hooks/use-entity-records';
 export * from './entity-provider';
-export * from './fetch';
 export * from './entity-types';
+export * from './fetch';
+export * from './hooks';

package/src/locks/test/selectors.js

@@ -186,7 +186,8 @@ describe( 'isLockAvailable', () => {
 																			exclusive: true,
 																		},
 																	],
-																	children: {},
+																	children:
+																		{},
 																},
 															},
 														},

package/src/queried-data/selectors.js

@@ -28,14 +28,8 @@ const queriedItemsCacheByState = new WeakMap();
  * @return {?Array} Query items.
  */
 function getQueriedItemsUncached( state, query ) {
-	const {
-		stableKey,
-		page,
-		perPage,
-		include,
-		fields,
-		context,
-	} = getQueryParts( query );
+	const { stableKey, page, perPage, include, fields, context } =
+		getQueryParts( query );
 	let itemIds;
 
 	if ( state.queries?.[ context ]?.[ stableKey ] ) {