@wordpress/core-data 4.0.3 → 4.0.7

package/src/reducer.js

@@ -120,39 +120,36 @@ export function currentTheme( state = undefined, action ) {
 }
 
 /**
- * Reducer managing installed themes.
+ * Reducer managing the current global styles id.
  *
- * @param {Object} state  Current state.
+ * @param {string} state  Current state.
  * @param {Object} action Dispatched action.
  *
- * @return {Object} Updated state.
+ * @return {string} Updated state.
  */
-export function themes( state = {}, action ) {
+export function currentGlobalStylesId( state = undefined, action ) {
 	switch ( action.type ) {
-		case 'RECEIVE_CURRENT_THEME':
-			return {
-				...state,
-				[ action.currentTheme.stylesheet ]: action.currentTheme,
-			};
+		case 'RECEIVE_CURRENT_GLOBAL_STYLES_ID':
+			return action.id;
 	}
 
 	return state;
 }
 
 /**
- * Reducer managing theme supports data.
+ * Reducer managing the theme base global styles.
  *
- * @param {Object} state  Current state.
+ * @param {string} state  Current state.
  * @param {Object} action Dispatched action.
  *
- * @return {Object} Updated state.
+ * @return {string} Updated state.
  */
-export function themeSupports( state = {}, action ) {
+export function themeBaseGlobalStyles( state = {}, action ) {
 	switch ( action.type ) {
-		case 'RECEIVE_THEME_SUPPORTS':
+		case 'RECEIVE_THEME_GLOBAL_STYLES':
 			return {
 				...state,
-				...action.themeSupports,
+				[ action.stylesheet ]: action.globalStyles,
 			};
 	}
 
@@ -570,10 +567,10 @@ export default combineReducers( {
 	terms,
 	users,
 	currentTheme,
+	currentGlobalStylesId,
 	currentUser,
+	themeBaseGlobalStyles,
 	taxonomies,
-	themes,
-	themeSupports,
 	entities,
 	undo,
 	embedPreviews,

package/src/resolvers.js

@@ -14,7 +14,7 @@ import apiFetch from '@wordpress/api-fetch';
  */
 import { STORE_NAME } from './name';
 import { getKindEntities, DEFAULT_ENTITY_KEY } from './entities';
-import { ifNotResolved, getNormalizedCommaSeparable } from './utils';
+import { forwardResolver, getNormalizedCommaSeparable } from './utils';
 
 /**
  * Requests authors from the REST API.
@@ -85,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,
 		} );
@@ -107,6 +107,7 @@ export const getEntityRecord = ( kind, name, key = '', query ) => async ( {
 	} 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 );
 	}
@@ -115,18 +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'
-);
+export const getEditedEntityRecord = forwardResolver( 'getEntityRecord' );
 
 /**
  * Requests the entity's records from the REST API.
@@ -207,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 );
 	}
@@ -224,22 +223,20 @@ getEntityRecords.shouldInvalidate = ( action, kind, name ) => {
 /**
  * Requests the current theme.
  */
-export const getCurrentTheme = () => async ( { dispatch } ) => {
-	const activeThemes = await apiFetch( {
-		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 apiFetch( {
-		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.
@@ -418,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
@@ -326,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 ) {
@@ -684,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;
 }
 
 /**
@@ -695,7 +719,7 @@ export function getCurrentTheme( state ) {
  * @return {*} Index data.
  */
 export function getThemeSupports( state ) {
-	return state.themeSupports;
+	return getCurrentTheme( state )?.theme_supports ?? EMPTY_OBJECT;
 }
 
 /**
@@ -882,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,
@@ -107,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();

package/src/test/selectors.js

@@ -418,7 +418,7 @@ describe( 'getEntityRecords', () => {
 } );
 
 describe( '__experimentalGetDirtyEntityRecords', () => {
-	it( 'should return a map of objects with each raw edited entity record and its corresponding edits', () => {
+	it( 'returns a map of objects with each raw edited entity record and its corresponding edits', () => {
 		const state = deepFreeze( {
 			entities: {
 				config: [
@@ -466,6 +466,61 @@ describe( '__experimentalGetDirtyEntityRecords', () => {
 			{ kind: 'someKind', name: 'someName', key: 'someKey', title: '' },
 		] );
 	} );
+
+	it( 'excludes entity records that no longer exist', () => {
+		const state = deepFreeze( {
+			entities: {
+				config: [
+					{
+						kind: 'someKind',
+						name: 'someName',
+						transientEdits: { someTransientEditProperty: true },
+					},
+				],
+				data: {
+					someKind: {
+						someName: {
+							queriedData: {
+								items: {
+									default: {
+										someKey: {
+											someProperty: 'somePersistedValue',
+											someRawProperty: {
+												raw: 'somePersistedRawValue',
+											},
+											id: 'someKey',
+										},
+									},
+								},
+								itemIsComplete: {
+									default: {
+										someKey: true,
+									},
+								},
+							},
+							edits: {
+								someKey: {
+									someProperty: 'someEditedValue',
+									someRawProperty: 'someEditedRawValue',
+									someTransientEditProperty:
+										'someEditedTransientEditValue',
+								},
+								deletedKey: {
+									someProperty: 'someEditedValue',
+									someRawProperty: 'someEditedRawValue',
+									someTransientEditProperty:
+										'someEditedTransientEditValue',
+								},
+							},
+						},
+					},
+				},
+			},
+		} );
+		expect( __experimentalGetDirtyEntityRecords( state ) ).toEqual( [
+			{ kind: 'someKind', name: 'someName', key: 'someKey', title: '' },
+		] );
+	} );
 } );
 
 describe( '__experimentalGetEntitiesBeingSaved', () => {

package/src/utils/forward-resolver.js

@@ -0,0 +1,14 @@
+/**
+ * Higher-order function which forward the resolution to another resolver with the same arguments.
+ *
+ * @param {string} resolverName forwarded resolver.
+ *
+ * @return {Function} Enhanced resolver.
+ */
+const forwardResolver = ( resolverName ) => ( ...args ) => async ( {
+	resolveSelect,
+} ) => {
+	await resolveSelect[ resolverName ]( ...args );
+};
+
+export default forwardResolver;

package/src/utils/index.js

@@ -1,7 +1,7 @@
 export { default as conservativeMapItem } from './conservative-map-item';
 export { default as getNormalizedCommaSeparable } from './get-normalized-comma-separable';
 export { default as ifMatchingAction } from './if-matching-action';
-export { default as ifNotResolved } from './if-not-resolved';
+export { default as forwardResolver } from './forward-resolver';
 export { default as onSubKey } from './on-sub-key';
 export { default as replaceAction } from './replace-action';
 export { default as withWeakMapCache } from './with-weak-map-cache';

package/build/utils/if-not-resolved.js

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-/**
- * Higher-order function which invokes the given resolver only if it has not
- * already been resolved with the arguments passed to the enhanced function.
- *
- * This only considers resolution state, and notably does not support resolver
- * custom `isFulfilled` behavior.
- *
- * @param {Function} resolver     Original resolver.
- * @param {string}   selectorName Selector name associated with resolver.
- *
- * @return {Function} Enhanced resolver.
- */
-const ifNotResolved = (resolver, selectorName) => (...args) => async ({
-  select,
-  dispatch
-}) => {
-  if (!select.hasStartedResolution(selectorName, args)) {
-    await dispatch(resolver(...args));
-  }
-};
-
-var _default = ifNotResolved;
-exports.default = _default;
-//# sourceMappingURL=if-not-resolved.js.map

package/build/utils/if-not-resolved.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/utils/if-not-resolved.js"],"names":["ifNotResolved","resolver","selectorName","args","select","dispatch","hasStartedResolution"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,aAAa,GAAG,CAAEC,QAAF,EAAYC,YAAZ,KAA8B,CAAE,GAAGC,IAAL,KAAe,OAAQ;AAC1EC,EAAAA,MAD0E;AAE1EC,EAAAA;AAF0E,CAAR,KAG5D;AACN,MAAK,CAAED,MAAM,CAACE,oBAAP,CAA6BJ,YAA7B,EAA2CC,IAA3C,CAAP,EAA2D;AAC1D,UAAME,QAAQ,CAAEJ,QAAQ,CAAE,GAAGE,IAAL,CAAV,CAAd;AACA;AACD,CAPD;;eASeH,a","sourcesContent":["/**\n * Higher-order function which invokes the given resolver only if it has not\n * already been resolved with the arguments passed to the enhanced function.\n *\n * This only considers resolution state, and notably does not support resolver\n * custom `isFulfilled` behavior.\n *\n * @param {Function} resolver     Original resolver.\n * @param {string}   selectorName Selector name associated with resolver.\n *\n * @return {Function} Enhanced resolver.\n */\nconst ifNotResolved = ( resolver, selectorName ) => ( ...args ) => async ( {\n\tselect,\n\tdispatch,\n} ) => {\n\tif ( ! select.hasStartedResolution( selectorName, args ) ) {\n\t\tawait dispatch( resolver( ...args ) );\n\t}\n};\n\nexport default ifNotResolved;\n"]}

package/build-module/utils/if-not-resolved.js

@@ -1,23 +0,0 @@
-/**
- * Higher-order function which invokes the given resolver only if it has not
- * already been resolved with the arguments passed to the enhanced function.
- *
- * This only considers resolution state, and notably does not support resolver
- * custom `isFulfilled` behavior.
- *
- * @param {Function} resolver     Original resolver.
- * @param {string}   selectorName Selector name associated with resolver.
- *
- * @return {Function} Enhanced resolver.
- */
-const ifNotResolved = (resolver, selectorName) => (...args) => async ({
-  select,
-  dispatch
-}) => {
-  if (!select.hasStartedResolution(selectorName, args)) {
-    await dispatch(resolver(...args));
-  }
-};
-
-export default ifNotResolved;
-//# sourceMappingURL=if-not-resolved.js.map

package/build-module/utils/if-not-resolved.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["@wordpress/core-data/src/utils/if-not-resolved.js"],"names":["ifNotResolved","resolver","selectorName","args","select","dispatch","hasStartedResolution"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,MAAMA,aAAa,GAAG,CAAEC,QAAF,EAAYC,YAAZ,KAA8B,CAAE,GAAGC,IAAL,KAAe,OAAQ;AAC1EC,EAAAA,MAD0E;AAE1EC,EAAAA;AAF0E,CAAR,KAG5D;AACN,MAAK,CAAED,MAAM,CAACE,oBAAP,CAA6BJ,YAA7B,EAA2CC,IAA3C,CAAP,EAA2D;AAC1D,UAAME,QAAQ,CAAEJ,QAAQ,CAAE,GAAGE,IAAL,CAAV,CAAd;AACA;AACD,CAPD;;AASA,eAAeH,aAAf","sourcesContent":["/**\n * Higher-order function which invokes the given resolver only if it has not\n * already been resolved with the arguments passed to the enhanced function.\n *\n * This only considers resolution state, and notably does not support resolver\n * custom `isFulfilled` behavior.\n *\n * @param {Function} resolver     Original resolver.\n * @param {string}   selectorName Selector name associated with resolver.\n *\n * @return {Function} Enhanced resolver.\n */\nconst ifNotResolved = ( resolver, selectorName ) => ( ...args ) => async ( {\n\tselect,\n\tdispatch,\n} ) => {\n\tif ( ! select.hasStartedResolution( selectorName, args ) ) {\n\t\tawait dispatch( resolver( ...args ) );\n\t}\n};\n\nexport default ifNotResolved;\n"]}

package/src/utils/if-not-resolved.js

@@ -1,22 +0,0 @@
-/**
- * Higher-order function which invokes the given resolver only if it has not
- * already been resolved with the arguments passed to the enhanced function.
- *
- * This only considers resolution state, and notably does not support resolver
- * custom `isFulfilled` behavior.
- *
- * @param {Function} resolver     Original resolver.
- * @param {string}   selectorName Selector name associated with resolver.
- *
- * @return {Function} Enhanced resolver.
- */
-const ifNotResolved = ( resolver, selectorName ) => ( ...args ) => async ( {
-	select,
-	dispatch,
-} ) => {
-	if ( ! select.hasStartedResolution( selectorName, args ) ) {
-		await dispatch( resolver( ...args ) );
-	}
-};
-
-export default ifNotResolved;

package/src/utils/test/if-not-resolved.js

@@ -1,76 +0,0 @@
-/**
- * WordPress dependencies
- */
-import { controls } from '@wordpress/data';
-
-/**
- * Internal dependencies
- */
-import ifNotResolved from '../if-not-resolved';
-
-jest.mock( '@wordpress/data', () => ( {
-	controls: {
-		select: jest.fn(),
-	},
-} ) );
-
-describe( 'ifNotResolved', () => {
-	beforeEach( () => {
-		controls.select.mockReset();
-	} );
-
-	it( 'returns a new function', () => {
-		const originalResolver = () => {};
-
-		const resolver = ifNotResolved( originalResolver, 'originalResolver' );
-
-		expect( resolver ).toBeInstanceOf( Function );
-	} );
-
-	it( 'triggers original resolver if not already resolved', async () => {
-		const select = { hasStartedResolution: () => false };
-		const dispatch = () => {};
-
-		const originalResolver = jest
-			.fn()
-			.mockImplementation( async function () {} );
-
-		const resolver = ifNotResolved( originalResolver, 'originalResolver' );
-		await resolver()( { select, dispatch } );
-
-		expect( originalResolver ).toHaveBeenCalledTimes( 1 );
-	} );
-
-	it( 'does not trigger original resolver if already resolved', async () => {
-		const select = { hasStartedResolution: () => true };
-		const dispatch = () => {};
-
-		const originalResolver = jest
-			.fn()
-			.mockImplementation( async function () {} );
-
-		const resolver = ifNotResolved( originalResolver, 'originalResolver' );
-		await resolver()( { select, dispatch } );
-
-		expect( originalResolver ).toHaveBeenCalledTimes( 0 );
-	} );
-
-	it( 'returns a promise when the resolver was not already resolved', async () => {
-		const select = { hasStartedResolution: () => false };
-		let thunkRetval;
-		const dispatch = jest.fn( ( thunk ) => {
-			thunkRetval = thunk();
-			return thunkRetval;
-		} );
-
-		const originalResolver = jest.fn( () => () =>
-			Promise.resolve( 'success!' )
-		);
-
-		const resolver = ifNotResolved( originalResolver, 'originalResolver' );
-		const result = resolver()( { select, dispatch } );
-
-		await expect( result ).resolves.toBe( undefined );
-		await expect( thunkRetval ).resolves.toBe( 'success!' );
-	} );
-} );