@wordpress/core-data 4.1.2 → 4.2.0

package/src/batch/create-batch.js

@@ -43,6 +43,7 @@ import defaultProcessor from './default-processor';
  */
 export default function createBatch( processor = defaultProcessor ) {
 	let lastId = 0;
+	/** @type {Array<{ input: any; resolve: ( value: any ) => void; reject: ( error: any ) => void }>} */
 	let queue = [];
 	const pending = new ObservableSet();
 
@@ -100,7 +101,7 @@ export default function createBatch( processor = defaultProcessor ) {
 		 * Runs the batch. This calls `batchProcessor` and resolves or rejects
 		 * all promises returned by `add()`.
 		 *
-		 * @return {Promise} A promise that resolves to a boolean that is true
+		 * @return {Promise<boolean>} A promise that resolves to a boolean that is true
 		 *                   if the processor returned no errors.
 		 */
 		async run() {
@@ -109,7 +110,7 @@ export default function createBatch( processor = defaultProcessor ) {
 					const unsubscribe = pending.subscribe( () => {
 						if ( ! pending.size ) {
 							unsubscribe();
-							resolve();
+							resolve( undefined );
 						}
 					} );
 				} );
@@ -137,15 +138,18 @@ export default function createBatch( processor = defaultProcessor ) {
 
 			let isSuccess = true;
 
-			for ( const [ result, { resolve, reject } ] of zip(
-				results,
-				queue
-			) ) {
+			for ( const pair of zip( results, queue ) ) {
+				/** @type {{error?: unknown, output?: unknown}} */
+				const result = pair[ 0 ];
+
+				/** @type {{resolve: (value: any) => void; reject: (error: any) => void} | undefined} */
+				const queueItem = pair[ 1 ];
+
 				if ( result?.error ) {
-					reject( result.error );
+					queueItem?.reject( result.error );
 					isSuccess = false;
 				} else {
-					resolve( result?.output ?? result );
+					queueItem?.resolve( result?.output ?? result );
 				}
 			}
 
@@ -166,14 +170,14 @@ class ObservableSet {
 		return this.set.size;
 	}
 
-	add( ...args ) {
-		this.set.add( ...args );
+	add( value ) {
+		this.set.add( value );
 		this.subscribers.forEach( ( subscriber ) => subscriber() );
 		return this;
 	}
 
-	delete( ...args ) {
-		const isSuccess = this.set.delete( ...args );
+	delete( value ) {
+		const isSuccess = this.set.delete( value );
 		this.subscribers.forEach( ( subscriber ) => subscriber() );
 		return isSuccess;
 	}

package/src/entities.js

@@ -143,7 +143,7 @@ export const defaultEntities = [
 		kind: 'root',
 		baseURL: '/wp/v2/global-styles',
 		baseURLParams: { context: 'edit' },
-		plural: 'globalStylesVariations', // should be different than name
+		plural: 'globalStylesVariations', // Should be different than name.
 		getTitle: ( record ) => record?.title?.rendered || record?.title,
 	},
 	{

package/src/fetch/__experimental-fetch-link-suggestions.js

@@ -103,7 +103,7 @@ const fetchLinkSuggestions = async (
 						};
 					} );
 				} )
-				.catch( () => [] ) // fail by returning no results
+				.catch( () => [] ) // Fail by returning no results.
 		);
 	}
 
@@ -156,7 +156,7 @@ const fetchLinkSuggestions = async (
 	return Promise.all( queries ).then( ( results ) => {
 		return results
 			.reduce(
-				( accumulator, current ) => accumulator.concat( current ), //flatten list
+				( accumulator, current ) => accumulator.concat( current ), // Flatten list.
 				[]
 			)
 			.filter(

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

@@ -1,3 +1,8 @@
+/**
+ * WordPress dependencies
+ */
+import { addQueryArgs } from '@wordpress/url';
+
 /**
  * Internal dependencies
  */
@@ -29,7 +34,6 @@ interface EntityRecordsResolution< RecordType > {
  * @param  kind      Kind of the requested entities.
  * @param  name      Name of the requested entities.
  * @param  queryArgs HTTP query for the requested entities.
- *
  * @example
  * ```js
  * import { useEntityRecord } from '@wordpress/core-data';
@@ -66,10 +70,16 @@ export default function __experimentalUseEntityRecords< RecordType >(
 	name: string,
 	queryArgs: unknown = {}
 ): EntityRecordsResolution< RecordType > {
+	// Serialize queryArgs to a string that can be safely used as a React dep.
+	// We can't just pass queryArgs as one of the deps, because if it is passed
+	// as an object literal, then it will be a different object on each call even
+	// if the values remain the same.
+	const queryAsString = addQueryArgs( '', queryArgs );
+
 	const { data: records, ...rest } = useQuerySelect(
 		( query ) =>
 			query( coreStore ).getEntityRecords( kind, name, queryArgs ),
-		[ kind, name, queryArgs ]
+		[ kind, name, queryAsString ]
 	);
 
 	return {

package/src/index.js

@@ -77,4 +77,4 @@ export { default as __experimentalUseEntityRecord } from './hooks/use-entity-rec
 export { default as __experimentalUseEntityRecords } from './hooks/use-entity-records';
 export * from './entity-provider';
 export * from './fetch';
-export * from './types';
+export * from './entity-types';

package/src/locks/test/engine.js

@@ -5,7 +5,7 @@ import createLocks from '../engine';
 
 jest.useRealTimers();
 
-// we correctly await all promises with expect calls, but the rule doesn't detect that
+// We correctly await all promises with expect calls, but the rule doesn't detect that.
 /* eslint-disable jest/valid-expect-in-promise */
 
 describe( 'Locks engine', () => {
@@ -15,11 +15,11 @@ describe( 'Locks engine', () => {
 		let l1Granted = false;
 		let l2Granted = false;
 
-		// request two locks
+		// Request two locks.
 		const l1 = locks.acquire( 'store', [ 'root' ], true );
 		const l2 = locks.acquire( 'store', [ 'root' ], true );
 
-		// on each grant, verify that the other lock is not granted at the same time
+		// On each grant, verify that the other lock is not granted at the same time.
 		const check1 = l1.then( () => {
 			l1Granted = true;
 			expect( l2Granted ).toBe( false );
@@ -30,7 +30,7 @@ describe( 'Locks engine', () => {
 			expect( l1Granted ).toBe( false );
 		} );
 
-		// unlock both
+		// Unlock both.
 		const lock1 = await l1;
 		locks.release( lock1 );
 		l1Granted = false;
@@ -39,7 +39,7 @@ describe( 'Locks engine', () => {
 		locks.release( lock2 );
 		l2Granted = false;
 
-		// ensure that both locks were granted and checked
+		// Ensure that both locks were granted and checked.
 		return await Promise.all( [ check1, check2 ] );
 	} );
 
@@ -49,11 +49,11 @@ describe( 'Locks engine', () => {
 		let l1Granted = false;
 		let l2Granted = false;
 
-		// request two locks
+		// Request two locks.
 		const l1 = locks.acquire( 'store', [ 'root' ], false );
 		const l2 = locks.acquire( 'store', [ 'root' ], true );
 
-		// on each grant, verify that the other lock is not granted at the same time
+		// On each grant, verify that the other lock is not granted at the same time.
 		const check1 = l1.then( () => {
 			l1Granted = true;
 			expect( l2Granted ).toBe( false );
@@ -64,7 +64,7 @@ describe( 'Locks engine', () => {
 			expect( l1Granted ).toBe( false );
 		} );
 
-		// unlock both
+		// Unlock both.
 		const lock1 = await l1;
 		locks.release( lock1 );
 		l1Granted = false;
@@ -73,7 +73,7 @@ describe( 'Locks engine', () => {
 		locks.release( lock2 );
 		l2Granted = false;
 
-		// ensure that both locks were granted and checked
+		// Ensure that both locks were granted and checked.
 		return await Promise.all( [ check1, check2 ] );
 	} );
 
@@ -83,11 +83,11 @@ describe( 'Locks engine', () => {
 		let l1Granted = false;
 		let l2Granted = false;
 
-		// request two locks
+		// Request two locks.
 		const l1 = locks.acquire( 'store', [ 'root' ], true );
 		const l2 = locks.acquire( 'store', [ 'root', 'child' ], true );
 
-		// on each grant, verify that the other lock is not granted at the same time
+		// On each grant, verify that the other lock is not granted at the same time.
 		const check1 = l1.then( () => {
 			l1Granted = true;
 			expect( l2Granted ).toBe( false );
@@ -98,7 +98,7 @@ describe( 'Locks engine', () => {
 			expect( l1Granted ).toBe( false );
 		} );
 
-		// unlock both
+		// Unlock both.
 		const lock1 = await l1;
 		locks.release( lock1 );
 		l1Granted = false;
@@ -107,7 +107,7 @@ describe( 'Locks engine', () => {
 		locks.release( lock2 );
 		l2Granted = false;
 
-		// ensure that both locks were granted and checked
+		// Ensure that both locks were granted and checked.
 		return await Promise.all( [ check1, check2 ] );
 	} );
 

package/src/locks/test/reducer.js

@@ -62,7 +62,7 @@ describe( 'locks', () => {
 							red,
 							blue,
 							green: {
-								// ...and add the lock
+								// ...and add the lock.
 								locks: [ lock ],
 								children: {},
 							},
@@ -92,7 +92,7 @@ describe( 'locks', () => {
 							red,
 							blue,
 							green: {
-								// ...and add the lock
+								// ...and add the lock.
 								locks: [ lock ],
 								children: {},
 							},
@@ -118,7 +118,7 @@ describe( 'locks', () => {
 							red,
 							blue,
 							green: {
-								// Should remove the lock
+								// Should remove the lock.
 								locks: [],
 								children: {},
 							},

package/src/locks/test/utils.js

@@ -193,13 +193,13 @@ describe( 'deepCopyLocksTreePath', () => {
 		expect( deepCopy.children ).not.toBe( tree.children );
 		expect( deepCopy.children.target ).not.toBe( tree.children.target );
 
-		// Locks lists should be preserved
+		// Locks lists should be preserved.
 		expect( deepCopy.locks ).toBe( tree.locks );
 		expect( deepCopy.children.target.locks ).toBe(
 			tree.children.target.locks
 		);
 
-		// Specific locks should be preserved
+		// Specific locks should be preserved.
 		expect( deepCopy.locks[ 0 ] ).toBe( tree.locks[ 0 ] );
 
 		// No need to clone lower levels of the tree, let's check if they're still the same:

package/src/reducer.js

@@ -355,7 +355,7 @@ export function entitiesConfig( state = defaultEntities, action ) {
 export const entities = ( state = {}, action ) => {
 	const newConfig = entitiesConfig( state.config, action );
 
-	// Generates a dynamic reducer for the entities
+	// Generates a dynamic reducer for the entities.
 	let entitiesDataReducer = state.reducer;
 	if ( ! entitiesDataReducer || newConfig !== state.config ) {
 		const entitiesByKind = groupBy( newConfig, 'kind' );

package/src/resolvers.js

@@ -292,7 +292,10 @@ export const canUser = ( action, resource, id ) => async ( { dispatch } ) => {
 		return;
 	}
 
-	const allowHeader = response.headers.get( 'allow' );
+	// Optional chaining operator is used here because the API requests don't
+	// return the expected result in the native version. Instead, API requests
+	// only return the result, without including response properties like the headers.
+	const allowHeader = response.headers?.get( 'allow' );
 	const key = compact( [ action, resource, id ] ).join( '/' );
 	const isAllowed = includes( allowHeader, method );
 	dispatch.receiveUserPermission( key, isAllowed );

package/src/test/resolvers.js

@@ -46,12 +46,12 @@ describe( 'getEntityRecord', () => {
 
 		await getEntityRecord( 'root', 'postType', 'post' )( { dispatch } );
 
-		// Fetch request should have been issued
+		// Fetch request should have been issued.
 		expect( triggerFetch ).toHaveBeenCalledWith( {
 			path: '/wp/v2/types/post?context=edit',
 		} );
 
-		// The record should have been received
+		// The record should have been received.
 		expect( dispatch.receiveEntityRecords ).toHaveBeenCalledWith(
 			'root',
 			'postType',
@@ -59,7 +59,7 @@ describe( 'getEntityRecord', () => {
 			undefined
 		);
 
-		// Locks should have been acquired and released
+		// Locks should have been acquired and released.
 		expect( dispatch.__unstableAcquireStoreLock ).toHaveBeenCalledTimes(
 			1
 		);
@@ -94,19 +94,19 @@ describe( 'getEntityRecord', () => {
 			query
 		)( { dispatch, select } );
 
-		// Check resolution cache for an existing entity that fulfills the request with query
+		// Check resolution cache for an existing entity that fulfills the request with query.
 		expect( select.hasEntityRecords ).toHaveBeenCalledWith(
 			'root',
 			'postType',
 			queryObj
 		);
 
-		// Trigger apiFetch, test that the query is present in the url
+		// Trigger apiFetch, test that the query is present in the url.
 		expect( triggerFetch ).toHaveBeenCalledWith( {
 			path: '/wp/v2/types/post?context=view&_envelope=1',
 		} );
 
-		// The record should have been received
+		// The record should have been received.
 		expect( dispatch.receiveEntityRecords ).toHaveBeenCalledWith(
 			'root',
 			'postType',
@@ -114,7 +114,7 @@ describe( 'getEntityRecord', () => {
 			queryObj
 		);
 
-		// Locks should have been acquired and released
+		// Locks should have been acquired and released.
 		expect( dispatch.__unstableAcquireStoreLock ).toHaveBeenCalledTimes(
 			1
 		);
@@ -163,12 +163,12 @@ describe( 'getEntityRecords', () => {
 
 		await getEntityRecords( 'root', 'postType' )( { dispatch } );
 
-		// Fetch request should have been issued
+		// Fetch request should have been issued.
 		expect( triggerFetch ).toHaveBeenCalledWith( {
 			path: '/wp/v2/types?context=edit',
 		} );
 
-		// The record should have been received
+		// The record should have been received.
 		expect( dispatch.receiveEntityRecords ).toHaveBeenCalledWith(
 			'root',
 			'postType',
@@ -191,12 +191,12 @@ describe( 'getEntityRecords', () => {
 
 		await getEntityRecords( 'root', 'postType' )( { dispatch } );
 
-		// Fetch request should have been issued
+		// Fetch request should have been issued.
 		expect( triggerFetch ).toHaveBeenCalledWith( {
 			path: '/wp/v2/types?context=edit',
 		} );
 
-		// The record should have been received
+		// The record should have been received.
 		expect(
 			dispatch.__unstableAcquireStoreLock
 		).toHaveBeenCalledWith(
@@ -223,12 +223,12 @@ describe( 'getEntityRecords', () => {
 
 		await getEntityRecords( 'root', 'postType' )( { dispatch } );
 
-		// Fetch request should have been issued
+		// Fetch request should have been issued.
 		expect( triggerFetch ).toHaveBeenCalledWith( {
 			path: '/wp/v2/types?context=edit',
 		} );
 
-		// The record should have been received
+		// The record should have been received.
 		expect( dispatch ).toHaveBeenCalledWith( {
 			type: 'START_RESOLUTIONS',
 			selectorName: 'getEntityRecord',

package/src/test/selectors.js

@@ -24,8 +24,7 @@ import {
 	getCurrentUser,
 	getReferenceByDistinctEdits,
 } from '../selectors';
-
-// getEntityRecord and __experimentalGetEntityRecordNoResolver selectors share the same tests
+// getEntityRecord and __experimentalGetEntityRecordNoResolver selectors share the same tests.
 describe.each( [
 	[ getEntityRecord ],
 	[ __experimentalGetEntityRecordNoResolver ],
@@ -398,7 +397,7 @@ describe( 'getEntityRecords', () => {
 			'wp_block'
 		);
 
-		// Simulate update states
+		// Simulate update states.
 		state = { ...state };
 
 		const postTypeSecondRecords = getEntityRecords(

package/build/types/base-entity-types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/types/base-entity-types.ts"],"names":["BaseEntityTypes"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;;;iCACiBA,e,+BAAAA,e","sourcesContent":["/**\n * This module exists solely to make the BaseEntityTypes namespace extensible\n * with declaration merging:\n *\n * ```ts\n * declare module './base-entity-types' {\n *     export namespace BaseEntityTypes {\n * \t\t     export interface Comment< C extends Context > {\n * \t\t         id: number;\n * \t\t         // ...\n * \t       }\n * \t   }\n * }\n * ```\n *\n * The huge upside is that consumers of @wordpress/core-data may extend the\n * exported data types using interface merging as follows:\n *\n * ```ts\n * import type { Context } from '@wordpress/core-data';\n * declare module '@wordpress/core-data' {\n *     export namespace BaseEntityTypes {\n *         export interface Comment< C extends Context > {\n *             numberOfViews: number;\n *         }\n *     }\n * }\n *\n * import type { Comment } from '@wordpress/core-data';\n * const c : Comment< 'view' > = ...;\n *\n * // c.numberOfViews is a number\n * // c.id is still present\n * ```\n */\nexport namespace BaseEntityTypes {}\n"]}

package/build-module/types/base-entity-types.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/types/base-entity-types.ts"],"names":["BaseEntityTypes"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;iCAAiBA,e,KAAAA,e","sourcesContent":["/**\n * This module exists solely to make the BaseEntityTypes namespace extensible\n * with declaration merging:\n *\n * ```ts\n * declare module './base-entity-types' {\n *     export namespace BaseEntityTypes {\n * \t\t     export interface Comment< C extends Context > {\n * \t\t         id: number;\n * \t\t         // ...\n * \t       }\n * \t   }\n * }\n * ```\n *\n * The huge upside is that consumers of @wordpress/core-data may extend the\n * exported data types using interface merging as follows:\n *\n * ```ts\n * import type { Context } from '@wordpress/core-data';\n * declare module '@wordpress/core-data' {\n *     export namespace BaseEntityTypes {\n *         export interface Comment< C extends Context > {\n *             numberOfViews: number;\n *         }\n *     }\n * }\n *\n * import type { Comment } from '@wordpress/core-data';\n * const c : Comment< 'view' > = ...;\n *\n * // c.numberOfViews is a number\n * // c.id is still present\n * ```\n */\nexport namespace BaseEntityTypes {}\n"]}