@wordpress/core-data 4.2.0 → 4.4.0

package/src/test/actions.js

@@ -30,21 +30,25 @@ jest.mock( '../batch', () => {
 
 describe( 'editEntityRecord', () => {
 	it( 'throws when the edited entity does not have a loaded config.', async () => {
-		const entity = { kind: 'someKind', name: 'someName', id: 'someId' };
+		const entityConfig = {
+			kind: 'someKind',
+			name: 'someName',
+			id: 'someId',
+		};
 		const select = {
-			getEntity: jest.fn(),
+			getEntityConfig: jest.fn(),
 		};
 		const fulfillment = () =>
 			editEntityRecord(
-				entity.kind,
-				entity.name,
-				entity.id,
+				entityConfig.kind,
+				entityConfig.name,
+				entityConfig.id,
 				{}
 			)( { select } );
 		expect( fulfillment ).toThrow(
-			`The entity being edited (${ entity.kind }, ${ entity.name }) does not have a loaded config.`
+			`The entity being edited (${ entityConfig.kind }, ${ entityConfig.name }) does not have a loaded config.`
 		);
-		expect( select.getEntity ).toHaveBeenCalledTimes( 1 );
+		expect( select.getEntityConfig ).toHaveBeenCalledTimes( 1 );
 	} );
 } );
 
@@ -56,7 +60,7 @@ describe( 'deleteEntityRecord', () => {
 
 	it( 'triggers a DELETE request for an existing record', async () => {
 		const deletedRecord = { title: 'new post', id: 10 };
-		const entities = [
+		const configs = [
 			{ name: 'post', kind: 'postType', baseURL: '/wp/v2/posts' },
 		];
 
@@ -66,7 +70,7 @@ describe( 'deleteEntityRecord', () => {
 			__unstableReleaseStoreLock: jest.fn(),
 		} );
 		// Provide entities
-		dispatch.mockReturnValueOnce( entities );
+		dispatch.mockReturnValueOnce( configs );
 
 		// Provide response
 		apiFetch.mockImplementation( () => deletedRecord );
@@ -106,6 +110,68 @@ describe( 'deleteEntityRecord', () => {
 
 		expect( result ).toBe( deletedRecord );
 	} );
+
+	it( 'throws on error when throwOnError is true', async () => {
+		const entities = [
+			{ name: 'post', kind: 'postType', baseURL: '/wp/v2/posts' },
+		];
+
+		const dispatch = Object.assign( jest.fn(), {
+			receiveEntityRecords: jest.fn(),
+			__unstableAcquireStoreLock: jest.fn(),
+			__unstableReleaseStoreLock: jest.fn(),
+		} );
+		// Provide entities
+		dispatch.mockReturnValueOnce( entities );
+
+		// Provide response
+		apiFetch.mockImplementation( () => {
+			throw new Error( 'API error' );
+		} );
+
+		await expect(
+			deleteEntityRecord(
+				'postType',
+				'post',
+				10,
+				{},
+				{
+					throwOnError: true,
+				}
+			)( { dispatch } )
+		).rejects.toEqual( new Error( 'API error' ) );
+	} );
+
+	it( 'resolves on error when throwOnError is false', async () => {
+		const entities = [
+			{ name: 'post', kind: 'postType', baseURL: '/wp/v2/posts' },
+		];
+
+		const dispatch = Object.assign( jest.fn(), {
+			receiveEntityRecords: jest.fn(),
+			__unstableAcquireStoreLock: jest.fn(),
+			__unstableReleaseStoreLock: jest.fn(),
+		} );
+		// Provide entities
+		dispatch.mockReturnValueOnce( entities );
+
+		// Provide response
+		apiFetch.mockImplementation( () => {
+			throw new Error( 'API error' );
+		} );
+
+		await expect(
+			deleteEntityRecord(
+				'postType',
+				'post',
+				10,
+				{},
+				{
+					throwOnError: false,
+				}
+			)( { dispatch } )
+		).resolves.toBe( false );
+	} );
 } );
 
 describe( 'saveEditedEntityRecord', () => {
@@ -116,7 +182,7 @@ describe( 'saveEditedEntityRecord', () => {
 
 	it( 'Uses "id" as a key when no entity key is provided', async () => {
 		const area = { id: 1, menu: 0 };
-		const entities = [
+		const configs = [
 			{
 				kind: 'root',
 				name: 'navigationArea',
@@ -132,7 +198,7 @@ describe( 'saveEditedEntityRecord', () => {
 			saveEntityRecord: jest.fn(),
 		} );
 		// Provide entities
-		dispatch.mockReturnValueOnce( entities );
+		dispatch.mockReturnValueOnce( configs );
 
 		// Provide response
 		const updatedRecord = { ...area, menu: 10 };
@@ -156,7 +222,7 @@ describe( 'saveEditedEntityRecord', () => {
 
 	it( 'Uses the entity key when provided', async () => {
 		const area = { area: 'primary', menu: 0 };
-		const entities = [
+		const configs = [
 			{
 				kind: 'root',
 				name: 'navigationArea',
@@ -173,7 +239,7 @@ describe( 'saveEditedEntityRecord', () => {
 			saveEntityRecord: jest.fn(),
 		} );
 		// Provide entities
-		dispatch.mockReturnValueOnce( entities );
+		dispatch.mockReturnValueOnce( configs );
 
 		// Provide response
 		const updatedRecord = { ...area, menu: 10 };
@@ -197,27 +263,28 @@ describe( 'saveEditedEntityRecord', () => {
 } );
 
 describe( 'saveEntityRecord', () => {
+	let dispatch;
 	beforeEach( async () => {
 		apiFetch.mockReset();
 		jest.useFakeTimers();
+		dispatch = Object.assign( jest.fn(), {
+			receiveEntityRecords: jest.fn(),
+			__unstableAcquireStoreLock: jest.fn(),
+			__unstableReleaseStoreLock: jest.fn(),
+		} );
 	} );
 
 	it( 'triggers a POST request for a new record', async () => {
 		const post = { title: 'new post' };
-		const entities = [
+		const configs = [
 			{ name: 'post', kind: 'postType', baseURL: '/wp/v2/posts' },
 		];
 		const select = {
 			getRawEntityRecord: () => post,
 		};
 
-		const dispatch = Object.assign( jest.fn(), {
-			receiveEntityRecords: jest.fn(),
-			__unstableAcquireStoreLock: jest.fn(),
-			__unstableReleaseStoreLock: jest.fn(),
-		} );
 		// Provide entities
-		dispatch.mockReturnValueOnce( entities );
+		dispatch.mockReturnValueOnce( configs );
 
 		// Provide response
 		const updatedRecord = { ...post, id: 10 };
@@ -274,8 +341,8 @@ describe( 'saveEntityRecord', () => {
 		expect( result ).toBe( updatedRecord );
 	} );
 
-	it( 'triggers a PUT request for an existing record', async () => {
-		const post = { id: 10, title: 'new post' };
+	it( 'throws on error when throwOnError is true', async () => {
+		const post = { title: 'new post' };
 		const entities = [
 			{ name: 'post', kind: 'postType', baseURL: '/wp/v2/posts' },
 		];
@@ -283,14 +350,57 @@ describe( 'saveEntityRecord', () => {
 			getRawEntityRecord: () => post,
 		};
 
-		const dispatch = Object.assign( jest.fn(), {
-			receiveEntityRecords: jest.fn(),
-			__unstableAcquireStoreLock: jest.fn(),
-			__unstableReleaseStoreLock: jest.fn(),
+		// Provide entities
+		dispatch.mockReturnValueOnce( entities );
+
+		// Provide response
+		apiFetch.mockImplementation( () => {
+			throw new Error( 'API error' );
 		} );
+
+		await expect(
+			saveEntityRecord( 'postType', 'post', post, {
+				throwOnError: true,
+			} )( { select, dispatch } )
+		).rejects.toEqual( new Error( 'API error' ) );
+	} );
+
+	it( 'resolves on error when throwOnError is false', async () => {
+		const post = { title: 'new post' };
+		const entities = [
+			{ name: 'post', kind: 'postType', baseURL: '/wp/v2/posts' },
+		];
+		const select = {
+			getRawEntityRecord: () => post,
+		};
+
 		// Provide entities
 		dispatch.mockReturnValueOnce( entities );
 
+		// Provide response
+		apiFetch.mockImplementation( () => {
+			throw new Error( 'API error' );
+		} );
+
+		await expect(
+			saveEntityRecord( 'postType', 'post', post, {
+				throwOnError: false,
+			} )( { select, dispatch } )
+		).resolves.toEqual( undefined );
+	} );
+
+	it( 'triggers a PUT request for an existing record', async () => {
+		const post = { id: 10, title: 'new post' };
+		const configs = [
+			{ name: 'post', kind: 'postType', baseURL: '/wp/v2/posts' },
+		];
+		const select = {
+			getRawEntityRecord: () => post,
+		};
+
+		// Provide entities
+		dispatch.mockReturnValueOnce( configs );
+
 		// Provide response
 		const updatedRecord = { ...post, id: 10 };
 		apiFetch.mockImplementation( () => {
@@ -348,7 +458,7 @@ describe( 'saveEntityRecord', () => {
 
 	it( 'triggers a PUT request for an existing record with a custom key', async () => {
 		const postType = { slug: 'page', title: 'Pages' };
-		const entities = [
+		const configs = [
 			{
 				name: 'postType',
 				kind: 'root',
@@ -360,13 +470,8 @@ describe( 'saveEntityRecord', () => {
 			getRawEntityRecord: () => ( {} ),
 		};
 
-		const dispatch = Object.assign( jest.fn(), {
-			receiveEntityRecords: jest.fn(),
-			__unstableAcquireStoreLock: jest.fn(),
-			__unstableReleaseStoreLock: jest.fn(),
-		} );
 		// Provide entities
-		dispatch.mockReturnValueOnce( entities );
+		dispatch.mockReturnValueOnce( configs );
 
 		// Provide response
 		apiFetch.mockImplementation( () => postType );

package/src/test/entities.js

@@ -9,8 +9,8 @@ jest.mock( '@wordpress/api-fetch' );
  */
 import {
 	getMethodName,
-	defaultEntities,
-	getKindEntities,
+	rootEntitiesConfig,
+	getOrLoadEntitiesConfig,
 	prePersistPostType,
 } from '../entities';
 
@@ -40,10 +40,10 @@ describe( 'getMethodName', () => {
 	} );
 
 	it( 'should include the kind in the method name', () => {
-		const id = defaultEntities.length;
-		defaultEntities[ id ] = { name: 'book', kind: 'postType' };
+		const id = rootEntitiesConfig.length;
+		rootEntitiesConfig[ id ] = { name: 'book', kind: 'postType' };
 		const methodName = getMethodName( 'postType', 'book' );
-		delete defaultEntities[ id ];
+		delete rootEntitiesConfig[ id ];
 
 		expect( methodName ).toEqual( 'getPostTypeBook' );
 	} );
@@ -58,19 +58,19 @@ describe( 'getKindEntities', () => {
 	it( 'shouldn’t do anything if the entities have already been resolved', async () => {
 		const dispatch = jest.fn();
 		const select = {
-			getEntitiesByKind: jest.fn( () => entities ),
+			getEntitiesConfig: jest.fn( () => entities ),
 		};
 		const entities = [ { kind: 'postType' } ];
-		await getKindEntities( 'postType' )( { dispatch, select } );
+		await getOrLoadEntitiesConfig( 'postType' )( { dispatch, select } );
 		expect( dispatch ).not.toHaveBeenCalled();
 	} );
 
 	it( 'shouldn’t do anything if there no defined kind config', async () => {
 		const dispatch = jest.fn();
 		const select = {
-			getEntitiesByKind: jest.fn( () => [] ),
+			getEntitiesConfig: jest.fn( () => [] ),
 		};
-		await getKindEntities( 'unknownKind' )( { dispatch, select } );
+		await getOrLoadEntitiesConfig( 'unknownKind' )( { dispatch, select } );
 		expect( dispatch ).not.toHaveBeenCalled();
 	} );
 
@@ -85,11 +85,11 @@ describe( 'getKindEntities', () => {
 		];
 		const dispatch = jest.fn();
 		const select = {
-			getEntitiesByKind: jest.fn( () => [] ),
+			getEntitiesConfig: jest.fn( () => [] ),
 		};
 		triggerFetch.mockImplementation( () => fetchedEntities );
 
-		await getKindEntities( 'postType' )( { dispatch, select } );
+		await getOrLoadEntitiesConfig( 'postType' )( { dispatch, select } );
 		expect( dispatch ).toHaveBeenCalledTimes( 1 );
 		expect( dispatch.mock.calls[ 0 ][ 0 ].type ).toBe( 'ADD_ENTITIES' );
 		expect( dispatch.mock.calls[ 0 ][ 0 ].entities.length ).toBe( 1 );

package/src/test/reducer.js

@@ -46,7 +46,7 @@ describe( 'entities', () => {
 	it( 'returns the default state for all defined entities', () => {
 		const state = entities( undefined, {} );
 
-		expect( state.data.root.postType.queriedData ).toEqual( {
+		expect( state.records.root.postType.queriedData ).toEqual( {
 			items: {},
 			queries: {},
 			itemIsComplete: {},
@@ -65,7 +65,7 @@ describe( 'entities', () => {
 			name: 'postType',
 		} );
 
-		expect( state.data.root.postType.queriedData ).toEqual( {
+		expect( state.records.root.postType.queriedData ).toEqual( {
 			items: {
 				default: {
 					b: { slug: 'b', title: 'beach' },
@@ -84,7 +84,7 @@ describe( 'entities', () => {
 
 	it( 'appends the received post types by slug', () => {
 		const originalState = deepFreeze( {
-			data: {
+			records: {
 				root: {
 					postType: {
 						queriedData: {
@@ -111,7 +111,7 @@ describe( 'entities', () => {
 			name: 'postType',
 		} );
 
-		expect( state.data.root.postType.queriedData ).toEqual( {
+		expect( state.records.root.postType.queriedData ).toEqual( {
 			items: {
 				default: {
 					w: { slug: 'w', title: 'water' },

package/src/test/resolvers.js

@@ -201,7 +201,7 @@ describe( 'getEntityRecords', () => {
 			dispatch.__unstableAcquireStoreLock
 		).toHaveBeenCalledWith(
 			'core',
-			[ 'entities', 'data', 'root', 'postType' ],
+			[ 'entities', 'records', 'root', 'postType' ],
 			{ exclusive: false }
 		);
 		expect( dispatch.__unstableReleaseStoreLock ).toHaveBeenCalledTimes(
@@ -393,14 +393,14 @@ describe( 'getAutosaves', () => {
 		const postType = 'post';
 		const postId = 1;
 		const restBase = 'posts';
-		const postEntity = { rest_base: restBase };
+		const postEntityConfig = { rest_base: restBase };
 
 		triggerFetch.mockImplementation( () => SUCCESSFUL_RESPONSE );
 		const dispatch = Object.assign( jest.fn(), {
 			receiveAutosaves: jest.fn(),
 		} );
 		const resolveSelect = Object.assign( jest.fn(), {
-			getPostType: jest.fn( () => postEntity ),
+			getPostType: jest.fn( () => postEntityConfig ),
 		} );
 		await getAutosaves( postType, postId )( { dispatch, resolveSelect } );
 
@@ -417,14 +417,14 @@ describe( 'getAutosaves', () => {
 		const postType = 'post';
 		const postId = 1;
 		const restBase = 'posts';
-		const postEntity = { rest_base: restBase };
+		const postEntityConfig = { rest_base: restBase };
 
 		triggerFetch.mockImplementation( () => [] );
 		const dispatch = Object.assign( jest.fn(), {
 			receiveAutosaves: jest.fn(),
 		} );
 		const resolveSelect = Object.assign( jest.fn(), {
-			getPostType: jest.fn( () => postEntity ),
+			getPostType: jest.fn( () => postEntityConfig ),
 		} );
 		await getAutosaves( postType, postId )( { dispatch, resolveSelect } );
 

package/src/test/selectors.js

@@ -32,7 +32,7 @@ describe.each( [
 	it( 'should return undefined for unknown entity kind, name', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {
@@ -51,7 +51,7 @@ describe.each( [
 	it( 'should return undefined for unknown record’s key', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {
@@ -70,7 +70,7 @@ describe.each( [
 	it( 'should return a record by key', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {
@@ -105,7 +105,7 @@ describe.each( [
 	it( 'should return filtered item if complete item received, filtered item requested', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					postType: {
 						post: {
 							queriedData: {
@@ -142,7 +142,7 @@ describe( 'hasEntityRecords', () => {
 	it( 'returns false if entity records have not been received', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {
@@ -162,7 +162,7 @@ describe( 'hasEntityRecords', () => {
 	it( 'returns false if the entity configuration is not known', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {},
+				records: {},
 			},
 		} );
 
@@ -172,7 +172,7 @@ describe( 'hasEntityRecords', () => {
 	it( 'returns true if entity records have been received', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {
@@ -239,7 +239,7 @@ describe( 'getRawEntityRecord', () => {
 						name: 'someName',
 					},
 				],
-				data: { ...data },
+				records: { ...data },
 			},
 		} );
 		expect(
@@ -261,7 +261,7 @@ describe( 'getRawEntityRecord', () => {
 						rawAttributes: [ 'title' ],
 					},
 				],
-				data: { ...data },
+				records: { ...data },
 			},
 		} );
 		expect(
@@ -278,7 +278,7 @@ describe( 'getEntityRecords', () => {
 	it( 'should return null by default', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {
@@ -297,7 +297,7 @@ describe( 'getEntityRecords', () => {
 	it( 'should return null for an unknown entity configuration', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {},
+				records: {},
 			},
 		} );
 
@@ -307,7 +307,7 @@ describe( 'getEntityRecords', () => {
 	it( 'should return all the records', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {
@@ -343,7 +343,7 @@ describe( 'getEntityRecords', () => {
 	it( 'should return filtered items', () => {
 		const state = deepFreeze( {
 			entities: {
-				data: {
+				records: {
 					postType: {
 						post: {
 							queriedData: {
@@ -382,7 +382,7 @@ describe( 'getEntityRecords', () => {
 	it( 'should return the same instance with the same arguments', () => {
 		let state = deepFreeze( {
 			entities: {
-				data: {},
+				records: {},
 			},
 		} );
 
@@ -427,7 +427,7 @@ describe( '__experimentalGetDirtyEntityRecords', () => {
 						transientEdits: { someTransientEditProperty: true },
 					},
 				],
-				data: {
+				records: {
 					someKind: {
 						someName: {
 							queriedData: {
@@ -476,7 +476,7 @@ describe( '__experimentalGetDirtyEntityRecords', () => {
 						transientEdits: { someTransientEditProperty: true },
 					},
 				],
-				data: {
+				records: {
 					someKind: {
 						someName: {
 							queriedData: {
@@ -533,7 +533,7 @@ describe( '__experimentalGetEntitiesBeingSaved', () => {
 						transientEdits: { someTransientEditProperty: true },
 					},
 				],
-				data: {
+				records: {
 					someKind: {
 						someName: {
 							queriedData: {
@@ -573,7 +573,7 @@ describe( '__experimentalGetEntitiesBeingSaved', () => {
 describe( 'getEntityRecordNonTransientEdits', () => {
 	it( 'should return an empty object when the entity does not have a loaded config.', () => {
 		const state = deepFreeze( {
-			entities: { config: [], data: {} },
+			entities: { config: [], records: {} },
 		} );
 		expect(
 			getEntityRecordNonTransientEdits(
@@ -597,11 +597,11 @@ describe( 'getEmbedPreview()', () => {
 
 		state = deepFreeze( {
 			embedPreviews: {
-				'http://example.com/': { data: 42 },
+				'http://example.com/': { records: 42 },
 			},
 		} );
 		expect( getEmbedPreview( state, 'http://example.com/' ) ).toEqual( {
-			data: 42,
+			records: 42,
 		} );
 	} );
 } );
@@ -653,7 +653,7 @@ describe( 'canUserEditEntityRecord', () => {
 	it( 'returns false by default', () => {
 		const state = deepFreeze( {
 			userPermissions: {},
-			entities: { data: {} },
+			entities: { records: {} },
 		} );
 		expect( canUserEditEntityRecord( state, 'postType', 'post' ) ).toBe(
 			false
@@ -674,7 +674,7 @@ describe( 'canUserEditEntityRecord', () => {
 						__unstable_rest_base: 'posts',
 					},
 				],
-				data: {
+				records: {
 					root: {
 						postType: {
 							queriedData: {

package/src/types.ts

@@ -0,0 +1,3 @@
+export interface AnyFunction {
+	( ...args: any[] ): any;
+}

package/src/utils/conservative-map-item.js

@@ -4,7 +4,7 @@
 import { isEqual } from 'lodash';
 
 /**
- * Given the current and next item entity, returns the minimally "modified"
+ * Given the current and next item entity record, returns the minimally "modified"
  * result of the next item, preferring value references from the original item
  * if equal. If all values match, the original item is returned.
  *

package/src/utils/if-matching-action.js

@@ -1,11 +1,13 @@
+/** @typedef {import('../types').AnyFunction} AnyFunction */
+
 /**
  * A higher-order reducer creator which invokes the original reducer only if
  * the dispatching action matches the given predicate, **OR** if state is
  * initializing (undefined).
  *
- * @param {Function} isMatch Function predicate for allowing reducer call.
+ * @param {AnyFunction} isMatch Function predicate for allowing reducer call.
  *
- * @return {Function} Higher-order reducer.
+ * @return {AnyFunction} Higher-order reducer.
  */
 const ifMatchingAction = ( isMatch ) => ( reducer ) => ( state, action ) => {
 	if ( state === undefined || isMatch( action ) ) {

package/src/utils/is-raw-attribute.js

@@ -1,7 +1,7 @@
 /**
  * Checks whether the attribute is a "raw" attribute or not.
  *
- * @param {Object} entity    Entity data.
+ * @param {Object} entity    Entity record.
  * @param {string} attribute Attribute name.
  *
  * @return {boolean} Is the attribute raw

package/src/utils/on-sub-key.js

@@ -1,10 +1,12 @@
+/** @typedef {import('../types').AnyFunction} AnyFunction */
+
 /**
  * Higher-order reducer creator which creates a combined reducer object, keyed
  * by a property on the action object.
  *
  * @param {string} actionProperty Action property by which to key object.
  *
- * @return {Function} Higher-order reducer.
+ * @return {AnyFunction} Higher-order reducer.
  */
 export const onSubKey = ( actionProperty ) => ( reducer ) => (
 	state = {},

package/src/utils/replace-action.js

@@ -1,10 +1,12 @@
+/** @typedef {import('../types').AnyFunction} AnyFunction */
+
 /**
  * Higher-order reducer creator which substitutes the action object before
  * passing to the original reducer.
  *
- * @param {Function} replacer Function mapping original action to replacement.
+ * @param {AnyFunction} replacer Function mapping original action to replacement.
  *
- * @return {Function} Higher-order reducer.
+ * @return {AnyFunction} Higher-order reducer.
  */
 const replaceAction = ( replacer ) => ( reducer ) => ( state, action ) => {
 	return reducer( state, replacer( action ) );