@wordpress/core-data 4.0.2 → 4.0.6

package/src/resolvers.js

@@ -7,18 +7,14 @@ import { find, includes, get, hasIn, compact, uniq } from 'lodash';
  * WordPress dependencies
  */
 import { addQueryArgs } from '@wordpress/url';
-import triggerFetch from '@wordpress/api-fetch';
+import apiFetch from '@wordpress/api-fetch';
 
 /**
  * Internal dependencies
  */
 import { STORE_NAME } from './name';
-
-/**
- * Internal dependencies
- */
 import { getKindEntities, DEFAULT_ENTITY_KEY } from './entities';
-import { ifNotResolved, getNormalizedCommaSeparable } from './utils';
+import { forwardResolver, getNormalizedCommaSeparable } from './utils';
 
 /**
  * Requests authors from the REST API.
@@ -31,7 +27,7 @@ export const getAuthors = ( query ) => async ( { dispatch } ) => {
 		'/wp/v2/users/?who=authors&per_page=100',
 		query
 	);
-	const users = await triggerFetch( { path } );
+	const users = await apiFetch( { path } );
 	dispatch.receiveUserQuery( path, users );
 };
 
@@ -39,7 +35,7 @@ export const getAuthors = ( query ) => async ( { dispatch } ) => {
  * Requests the current user from the REST API.
  */
 export const getCurrentUser = () => async ( { dispatch } ) => {
-	const currentUser = await triggerFetch( { path: '/wp/v2/users/me' } );
+	const currentUser = await apiFetch( { path: '/wp/v2/users/me' } );
 	dispatch.receiveCurrentUser( currentUser );
 };
 
@@ -58,7 +54,7 @@ export const getEntityRecord = ( kind, name, key = '', query ) => async ( {
 } ) => {
 	const entities = await dispatch( getKindEntities( kind ) );
 	const entity = find( entities, { kind, name } );
-	if ( ! entity ) {
+	if ( ! entity || entity?.__experimentalNoFetch ) {
 		return;
 	}
 
@@ -89,7 +85,7 @@ export const getEntityRecord = ( kind, name, key = '', query ) => async ( {
 		// for how the request is made to the REST API.
 
 		// eslint-disable-next-line @wordpress/no-unused-vars-before-return
-		const path = addQueryArgs( entity.baseURL + '/' + key, {
+		const path = addQueryArgs( entity.baseURL + ( key ? '/' + key : '' ), {
 			...entity.baseURLParams,
 			...query,
 		} );
@@ -106,11 +102,12 @@ export const getEntityRecord = ( kind, name, key = '', query ) => async ( {
 			}
 		}
 
-		const record = await triggerFetch( { path } );
+		const record = await apiFetch( { path } );
 		dispatch.receiveEntityRecords( kind, name, record, query );
 	} catch ( error ) {
 		// We need a way to handle and access REST API errors in state
 		// Until then, catching the error ensures the resolver is marked as resolved.
+		// See similar implementation in `getEntityRecords()`.
 	} finally {
 		dispatch.__unstableReleaseStoreLock( lock );
 	}
@@ -119,26 +116,12 @@ export const getEntityRecord = ( kind, name, key = '', query ) => async ( {
 /**
  * Requests an entity's record from the REST API.
  */
-export const getRawEntityRecord = ifNotResolved(
-	getEntityRecord,
-	'getEntityRecord'
-);
+export const getRawEntityRecord = forwardResolver( 'getEntityRecord' );
 
 /**
  * Requests an entity's record from the REST API.
  */
-export const getEditedEntityRecord = ifNotResolved(
-	getRawEntityRecord,
-	'getRawEntityRecord'
-);
-
-/**
- * Requests the entity's records from the REST API.
- *
- * @param {string}  kind  Entity kind.
- * @param {string}  name  Entity name.
- * @param {Object?} query Query Object.
- */
+export const getEditedEntityRecord = forwardResolver( 'getEntityRecord' );
 
 /**
  * Requests the entity's records from the REST API.
@@ -152,7 +135,7 @@ export const getEntityRecords = ( kind, name, query = {} ) => async ( {
 } ) => {
 	const entities = await dispatch( getKindEntities( kind ) );
 	const entity = find( entities, { kind, name } );
-	if ( ! entity ) {
+	if ( ! entity || entity?.__experimentalNoFetch ) {
 		return;
 	}
 
@@ -181,7 +164,7 @@ export const getEntityRecords = ( kind, name, query = {} ) => async ( {
 			...query,
 		} );
 
-		let records = Object.values( await triggerFetch( { path } ) );
+		let records = Object.values( await apiFetch( { path } ) );
 		// If we request fields but the result doesn't contain the fields,
 		// explicitely set these fields as "undefined"
 		// that way we consider the query "fullfilled".
@@ -219,6 +202,10 @@ export const getEntityRecords = ( kind, name, query = {} ) => async ( {
 				args: resolutionsArgs,
 			} );
 		}
+	} catch ( error ) {
+		// We need a way to handle and access REST API errors in state
+		// Until then, catching the error ensures the resolver is marked as resolved.
+		// See similar implementation in `getEntityRecord()`.
 	} finally {
 		dispatch.__unstableReleaseStoreLock( lock );
 	}
@@ -236,22 +223,20 @@ getEntityRecords.shouldInvalidate = ( action, kind, name ) => {
 /**
  * Requests the current theme.
  */
-export const getCurrentTheme = () => async ( { dispatch } ) => {
-	const activeThemes = await triggerFetch( {
-		path: '/wp/v2/themes?status=active',
-	} );
+export const getCurrentTheme = () => async ( { dispatch, resolveSelect } ) => {
+	const activeThemes = await resolveSelect.getEntityRecords(
+		'root',
+		'theme',
+		{ status: 'active' }
+	);
+
 	dispatch.receiveCurrentTheme( activeThemes[ 0 ] );
 };
 
 /**
  * Requests theme supports data from the index.
  */
-export const getThemeSupports = () => async ( { dispatch } ) => {
-	const activeThemes = await triggerFetch( {
-		path: '/wp/v2/themes?status=active',
-	} );
-	dispatch.receiveThemeSupports( activeThemes[ 0 ].theme_supports );
-};
+export const getThemeSupports = forwardResolver( 'getCurrentTheme' );
 
 /**
  * Requests a preview from the from the Embed API.
@@ -260,7 +245,7 @@ export const getThemeSupports = () => async ( { dispatch } ) => {
  */
 export const getEmbedPreview = ( url ) => async ( { dispatch } ) => {
 	try {
-		const embedProxyResponse = await triggerFetch( {
+		const embedProxyResponse = await apiFetch( {
 			path: addQueryArgs( '/oembed/1.0/proxy', { url } ),
 		} );
 		dispatch.receiveEmbedPreview( url, embedProxyResponse );
@@ -296,7 +281,7 @@ export const canUser = ( action, resource, id ) => async ( { dispatch } ) => {
 
 	let response;
 	try {
-		response = await triggerFetch( {
+		response = await apiFetch( {
 			path,
 			// Ideally this would always be an OPTIONS request, but unfortunately there's
 			// a bug in the REST API which causes the Allow header to not be sent on
@@ -359,7 +344,7 @@ export const getAutosaves = ( postType, postId ) => async ( {
 	resolveSelect,
 } ) => {
 	const { rest_base: restBase } = await resolveSelect.getPostType( postType );
-	const autosaves = await triggerFetch( {
+	const autosaves = await apiFetch( {
 		path: `/wp/v2/${ restBase }/${ postId }/autosaves?context=edit`,
 	} );
 
@@ -430,3 +415,43 @@ __experimentalGetTemplateForLink.shouldInvalidate = ( action ) => {
 		action.name === 'wp_template'
 	);
 };
+
+export const __experimentalGetCurrentGlobalStylesId = () => async ( {
+	dispatch,
+	resolveSelect,
+} ) => {
+	const activeThemes = await resolveSelect.getEntityRecords(
+		'root',
+		'theme',
+		{ status: 'active' }
+	);
+	const globalStylesURL = get( activeThemes, [
+		0,
+		'_links',
+		'wp:user-global-styles',
+		0,
+		'href',
+	] );
+	if ( globalStylesURL ) {
+		const globalStylesObject = await apiFetch( {
+			url: globalStylesURL,
+		} );
+		dispatch.__experimentalReceiveCurrentGlobalStylesId(
+			globalStylesObject.id
+		);
+	}
+};
+
+export const __experimentalGetCurrentThemeBaseGlobalStyles = () => async ( {
+	resolveSelect,
+	dispatch,
+} ) => {
+	const currentTheme = await resolveSelect.getCurrentTheme();
+	const themeGlobalStyles = await apiFetch( {
+		path: `/wp/v2/global-styles/themes/${ currentTheme.stylesheet }`,
+	} );
+	await dispatch.__experimentalReceiveThemeBaseGlobalStyles(
+		currentTheme.stylesheet,
+		themeGlobalStyles
+	);
+};

package/src/selectors.js

@@ -19,6 +19,15 @@ import { getQueriedItems } from './queried-data';
 import { DEFAULT_ENTITY_KEY } from './entities';
 import { getNormalizedCommaSeparable, isRawAttribute } from './utils';
 
+/**
+ * Shared reference to an empty object for cases where it is important to avoid
+ * returning a new object reference on every invocation, as in a connected or
+ * other pure component which performs `shouldComponentUpdate` check on props.
+ * This should be used as a last resort, since the normalized data should be
+ * maintained by the reducer result in state.
+ */
+const EMPTY_OBJECT = {};
+
 /**
  * Shared reference to an empty array for cases where it is important to avoid
  * returning a new array reference on every invocation, as in a connected or
@@ -134,40 +143,63 @@ export function getEntity( state, kind, name ) {
  *
  * @return {Object?} Record.
  */
-export function getEntityRecord( state, kind, name, key, query ) {
-	const queriedState = get( state.entities.data, [
-		kind,
-		name,
-		'queriedData',
-	] );
-	if ( ! queriedState ) {
-		return undefined;
-	}
-	const context = query?.context ?? 'default';
-
-	if ( query === undefined ) {
-		// If expecting a complete item, validate that completeness.
-		if ( ! queriedState.itemIsComplete[ context ]?.[ key ] ) {
+export const getEntityRecord = createSelector(
+	( state, kind, name, key, query ) => {
+		const queriedState = get( state.entities.data, [
+			kind,
+			name,
+			'queriedData',
+		] );
+		if ( ! queriedState ) {
 			return undefined;
 		}
+		const context = query?.context ?? 'default';
 
-		return queriedState.items[ context ][ key ];
-	}
+		if ( query === undefined ) {
+			// If expecting a complete item, validate that completeness.
+			if ( ! queriedState.itemIsComplete[ context ]?.[ key ] ) {
+				return undefined;
+			}
 
-	const item = queriedState.items[ context ]?.[ key ];
-	if ( item && query._fields ) {
-		const filteredItem = {};
-		const fields = getNormalizedCommaSeparable( query._fields );
-		for ( let f = 0; f < fields.length; f++ ) {
-			const field = fields[ f ].split( '.' );
-			const value = get( item, field );
-			set( filteredItem, field, value );
+			return queriedState.items[ context ][ key ];
 		}
-		return filteredItem;
-	}
 
-	return item;
-}
+		const item = queriedState.items[ context ]?.[ key ];
+		if ( item && query._fields ) {
+			const filteredItem = {};
+			const fields = getNormalizedCommaSeparable( query._fields );
+			for ( let f = 0; f < fields.length; f++ ) {
+				const field = fields[ f ].split( '.' );
+				const value = get( item, field );
+				set( filteredItem, field, value );
+			}
+			return filteredItem;
+		}
+
+		return item;
+	},
+	( state, kind, name, recordId, query ) => {
+		const context = query?.context ?? 'default';
+		return [
+			get( state.entities.data, [
+				kind,
+				name,
+				'queriedData',
+				'items',
+				context,
+				recordId,
+			] ),
+			get( state.entities.data, [
+				kind,
+				name,
+				'queriedData',
+				'itemIsComplete',
+				context,
+				recordId,
+			] ),
+		];
+	}
+);
 
 /**
  * Returns the Entity's record object by key. Doesn't trigger a resolver nor requests the entity from the API if the entity record isn't available in the local state.
@@ -221,7 +253,28 @@ export const getRawEntityRecord = createSelector(
 			}, {} )
 		);
 	},
-	( state ) => [ state.entities.data ]
+	( state, kind, name, recordId, query ) => {
+		const context = query?.context ?? 'default';
+		return [
+			state.entities.config,
+			get( state.entities.data, [
+				kind,
+				name,
+				'queriedData',
+				'items',
+				context,
+				recordId,
+			] ),
+			get( state.entities.data, [
+				kind,
+				name,
+				'queriedData',
+				'itemIsComplete',
+				context,
+				recordId,
+			] ),
+		];
+	}
 );
 
 /**
@@ -282,8 +335,12 @@ export const __experimentalGetDirtyEntityRecords = createSelector(
 			Object.keys( data[ kind ] ).forEach( ( name ) => {
 				const primaryKeys = Object.keys(
 					data[ kind ][ name ].edits
-				).filter( ( primaryKey ) =>
-					hasEditsForEntityRecord( state, kind, name, primaryKey )
+				).filter(
+					( primaryKey ) =>
+						// The entity record must exist (not be deleted),
+						// and it must have edits.
+						getEntityRecord( state, kind, name, primaryKey ) &&
+						hasEditsForEntityRecord( state, kind, name, primaryKey )
 				);
 
 				if ( primaryKeys.length ) {
@@ -408,7 +465,10 @@ export const getEntityRecordNonTransientEdits = createSelector(
 			return acc;
 		}, {} );
 	},
-	( state ) => [ state.entities.config, state.entities.data ]
+	( state, kind, name, recordId ) => [
+		state.entities.config,
+		get( state.entities.data, [ kind, name, 'edits', recordId ] ),
+	]
 );
 
 /**
@@ -446,7 +506,29 @@ export const getEditedEntityRecord = createSelector(
 		...getRawEntityRecord( state, kind, name, recordId ),
 		...getEntityRecordEdits( state, kind, name, recordId ),
 	} ),
-	( state ) => [ state.entities.data ]
+	( state, kind, name, recordId, query ) => {
+		const context = query?.context ?? 'default';
+		return [
+			state.entities.config,
+			get( state.entities.data, [
+				kind,
+				name,
+				'queriedData',
+				'items',
+				context,
+				recordId,
+			] ),
+			get( state.entities.data, [
+				kind,
+				name,
+				'queriedData',
+				'itemIsComplete',
+				context,
+				recordId,
+			] ),
+			get( state.entities.data, [ kind, name, 'edits', recordId ] ),
+		];
+	}
 );
 
 /**
@@ -615,7 +697,18 @@ export function hasRedo( state ) {
  * @return {Object} The current theme.
  */
 export function getCurrentTheme( state ) {
-	return state.themes[ state.currentTheme ];
+	return getEntityRecord( state, 'root', 'theme', state.currentTheme );
+}
+
+/**
+ * Return the ID of the current global styles object.
+ *
+ * @param {Object} state Data state.
+ *
+ * @return {string} The current global styles ID.
+ */
+export function __experimentalGetCurrentGlobalStylesId( state ) {
+	return state.currentGlobalStylesId;
 }
 
 /**
@@ -626,7 +719,7 @@ export function getCurrentTheme( state ) {
  * @return {*} Index data.
  */
 export function getThemeSupports( state ) {
-	return state.themeSupports;
+	return getCurrentTheme( state )?.theme_supports ?? EMPTY_OBJECT;
 }
 
 /**
@@ -813,3 +906,18 @@ export function __experimentalGetTemplateForLink( state, link ) {
 	}
 	return template;
 }
+
+/**
+ * Retrieve the current theme's base global styles
+ *
+ * @param {Object} state Editor state.
+ *
+ * @return {Object?} The Global Styles object.
+ */
+export function __experimentalGetCurrentThemeBaseGlobalStyles( state ) {
+	const currentTheme = getCurrentTheme( state );
+	if ( ! currentTheme ) {
+		return null;
+	}
+	return state.themeBaseGlobalStyles[ currentTheme.stylesheet ];
+}

package/src/test/actions.js

@@ -11,6 +11,7 @@ jest.mock( '@wordpress/api-fetch' );
 import {
 	editEntityRecord,
 	saveEntityRecord,
+	saveEditedEntityRecord,
 	deleteEntityRecord,
 	receiveUserPermission,
 	receiveAutosaves,
@@ -33,16 +34,17 @@ describe( 'editEntityRecord', () => {
 		const select = {
 			getEntity: jest.fn(),
 		};
-		const fulfillment = editEntityRecord(
-			entity.kind,
-			entity.name,
-			entity.id,
-			{}
-		)( { select } );
-		expect( select.getEntity ).toHaveBeenCalledTimes( 1 );
-		await expect( fulfillment ).rejects.toThrow(
+		const fulfillment = () =>
+			editEntityRecord(
+				entity.kind,
+				entity.name,
+				entity.id,
+				{}
+			)( { select } );
+		expect( fulfillment ).toThrow(
 			`The entity being edited (${ entity.kind }, ${ entity.name }) does not have a loaded config.`
 		);
+		expect( select.getEntity ).toHaveBeenCalledTimes( 1 );
 	} );
 } );
 
@@ -106,6 +108,94 @@ describe( 'deleteEntityRecord', () => {
 	} );
 } );
 
+describe( 'saveEditedEntityRecord', () => {
+	beforeEach( async () => {
+		apiFetch.mockReset();
+		jest.useFakeTimers();
+	} );
+
+	it( 'Uses "id" as a key when no entity key is provided', async () => {
+		const area = { id: 1, menu: 0 };
+		const entities = [
+			{
+				kind: 'root',
+				name: 'navigationArea',
+				baseURL: '/wp/v2/block-navigation-areas',
+			},
+		];
+		const select = {
+			getEntityRecordNonTransientEdits: () => [],
+			hasEditsForEntityRecord: () => true,
+		};
+
+		const dispatch = Object.assign( jest.fn(), {
+			saveEntityRecord: jest.fn(),
+		} );
+		// Provide entities
+		dispatch.mockReturnValueOnce( entities );
+
+		// Provide response
+		const updatedRecord = { ...area, menu: 10 };
+		apiFetch.mockImplementation( () => {
+			return updatedRecord;
+		} );
+
+		await saveEditedEntityRecord(
+			'root',
+			'navigationArea',
+			1
+		)( { dispatch, select } );
+
+		expect( dispatch.saveEntityRecord ).toHaveBeenCalledWith(
+			'root',
+			'navigationArea',
+			{ id: 1 },
+			undefined
+		);
+	} );
+
+	it( 'Uses the entity key when provided', async () => {
+		const area = { area: 'primary', menu: 0 };
+		const entities = [
+			{
+				kind: 'root',
+				name: 'navigationArea',
+				baseURL: '/wp/v2/block-navigation-areas',
+				key: 'area',
+			},
+		];
+		const select = {
+			getEntityRecordNonTransientEdits: () => [],
+			hasEditsForEntityRecord: () => true,
+		};
+
+		const dispatch = Object.assign( jest.fn(), {
+			saveEntityRecord: jest.fn(),
+		} );
+		// Provide entities
+		dispatch.mockReturnValueOnce( entities );
+
+		// Provide response
+		const updatedRecord = { ...area, menu: 10 };
+		apiFetch.mockImplementation( () => {
+			return updatedRecord;
+		} );
+
+		await saveEditedEntityRecord(
+			'root',
+			'navigationArea',
+			'primary'
+		)( { dispatch, select } );
+
+		expect( dispatch.saveEntityRecord ).toHaveBeenCalledWith(
+			'root',
+			'navigationArea',
+			{ area: 'primary' },
+			undefined
+		);
+	} );
+} );
+
 describe( 'saveEntityRecord', () => {
 	beforeEach( async () => {
 		apiFetch.mockReset();
@@ -386,21 +476,7 @@ describe( 'receiveCurrentUser', () => {
 
 describe( '__experimentalBatch', () => {
 	it( 'batches multiple actions together', async () => {
-		const generator = __experimentalBatch(
-			[
-				( { saveEntityRecord: _saveEntityRecord } ) =>
-					_saveEntityRecord( 'root', 'widget', {} ),
-				( { saveEditedEntityRecord: _saveEditedEntityRecord } ) =>
-					_saveEditedEntityRecord( 'root', 'widget', 123 ),
-				( { deleteEntityRecord: _deleteEntityRecord } ) =>
-					_deleteEntityRecord( 'root', 'widget', 123, {} ),
-			],
-			{ __unstableProcessor: ( inputs ) => Promise.resolve( inputs ) }
-		);
-		// Run generator up to `yield getDispatch()`.
-		const { value: getDispatchControl } = generator.next();
-		expect( getDispatchControl ).toEqual( { type: 'GET_DISPATCH' } );
-		const actions = {
+		const dispatch = {
 			saveEntityRecord: jest.fn(
 				( kind, name, record, { __unstableFetch } ) => {
 					__unstableFetch( {} );
@@ -420,36 +496,39 @@ describe( '__experimentalBatch', () => {
 				}
 			),
 		};
-		const dispatch = () => actions;
-		// Run generator up to `yield __unstableAwaitPromise( ... )`.
-		const { value: awaitPromiseControl } = generator.next( dispatch );
-		expect( actions.saveEntityRecord ).toHaveBeenCalledWith(
+
+		const results = await __experimentalBatch(
+			[
+				( { saveEntityRecord: _saveEntityRecord } ) =>
+					_saveEntityRecord( 'root', 'widget', {} ),
+				( { saveEditedEntityRecord: _saveEditedEntityRecord } ) =>
+					_saveEditedEntityRecord( 'root', 'widget', 123 ),
+				( { deleteEntityRecord: _deleteEntityRecord } ) =>
+					_deleteEntityRecord( 'root', 'widget', 123, {} ),
+			],
+			{ __unstableProcessor: ( inputs ) => Promise.resolve( inputs ) }
+		)( { dispatch } );
+
+		expect( dispatch.saveEntityRecord ).toHaveBeenCalledWith(
 			'root',
 			'widget',
 			{},
 			{ __unstableFetch: expect.any( Function ) }
 		);
-		expect( actions.saveEditedEntityRecord ).toHaveBeenCalledWith(
+		expect( dispatch.saveEditedEntityRecord ).toHaveBeenCalledWith(
 			'root',
 			'widget',
 			123,
 			{ __unstableFetch: expect.any( Function ) }
 		);
-		expect( actions.deleteEntityRecord ).toHaveBeenCalledWith(
+		expect( dispatch.deleteEntityRecord ).toHaveBeenCalledWith(
 			'root',
 			'widget',
 			123,
 			{},
 			{ __unstableFetch: expect.any( Function ) }
 		);
-		expect( awaitPromiseControl ).toEqual( {
-			type: 'AWAIT_PROMISE',
-			promise: expect.any( Promise ),
-		} );
-		// Run generator to the end.
-		const { value: results } = generator.next(
-			await awaitPromiseControl.promise
-		);
+
 		expect( results ).toEqual( [
 			{ id: 123, created: true },
 			{ id: 123, updated: true },