@wordpress/data 6.1.4 → 6.2.1

package/src/plugins/index.js

@@ -1,2 +1 @@
-export { default as controls } from './controls';
 export { default as persistence } from './persistence';

package/src/redux-store/index.js

@@ -22,9 +22,9 @@ import metadataReducer from './metadata/reducer';
 import * as metadataSelectors from './metadata/selectors';
 import * as metadataActions from './metadata/actions';
 
-/** @typedef {import('../types').WPDataRegistry} WPDataRegistry */
-/** @typedef {import('../types').WPDataStore} WPDataStore */
-/** @typedef {import('../types').WPDataReduxStoreConfig} WPDataReduxStoreConfig */
+/** @typedef {import('../types').DataRegistry} DataRegistry */
+/** @typedef {import('../types').StoreDescriptor} StoreDescriptor */
+/** @typedef {import('../types').ReduxStoreConfig} ReduxStoreConfig */
 
 const trimUndefinedValues = ( array ) => {
 	const result = [ ...array ];
@@ -68,7 +68,7 @@ function createResolversCache() {
 }
 
 /**
- * Creates a data store definition for the provided Redux store options containing
+ * Creates a data store descriptor for the provided Redux store configuration containing
  * properties describing reducer, actions, selectors, controls and resolvers.
  *
  * @example
@@ -83,12 +83,12 @@ function createResolversCache() {
  * } );
  * ```
  *
- * @param {string}                 key     Unique namespace identifier.
- * @param {WPDataReduxStoreConfig} options Registered store options, with properties
- *                                         describing reducer, actions, selectors,
- *                                         and resolvers.
+ * @param {string}           key     Unique namespace identifier.
+ * @param {ReduxStoreConfig} options Registered store options, with properties
+ *                                   describing reducer, actions, selectors,
+ *                                   and resolvers.
  *
- * @return {WPDataStore} Store Object.
+ * @return {StoreDescriptor} Store Object.
  */
 export default function createReduxStore( key, options ) {
 	return {
@@ -210,12 +210,12 @@ export default function createReduxStore( key, options ) {
 /**
  * Creates a redux store for a namespace.
  *
- * @param {string}         key       Unique namespace identifier.
- * @param {Object}         options   Registered store options, with properties
- *                                   describing reducer, actions, selectors,
- *                                   and resolvers.
- * @param {WPDataRegistry} registry  Registry reference.
- * @param {Object}         thunkArgs Argument object for the thunk middleware.
+ * @param {string}       key       Unique namespace identifier.
+ * @param {Object}       options   Registered store options, with properties
+ *                                 describing reducer, actions, selectors,
+ *                                 and resolvers.
+ * @param {DataRegistry} registry  Registry reference.
+ * @param {Object}       thunkArgs Argument object for the thunk middleware.
  * @return {Object} Newly created redux store.
  */
 function instantiateReduxStore( key, options, registry, thunkArgs ) {

package/src/registry.js

@@ -3,15 +3,19 @@
  */
 import { mapValues, isObject, forEach } from 'lodash';
 
+/**
+ * WordPress dependencies
+ */
+import deprecated from '@wordpress/deprecated';
+
 /**
  * Internal dependencies
  */
 import createReduxStore from './redux-store';
-import createCoreDataStore from './store';
-import { STORE_NAME } from './store/name';
+import coreDataStore from './store';
 import { createEmitter } from './utils/emitter';
 
-/** @typedef {import('./types').WPDataStore} WPDataStore */
+/** @typedef {import('./types').StoreDescriptor} StoreDescriptor */
 
 /**
  * @typedef {Object} WPDataRegistry An isolated orchestrator of store registrations.
@@ -74,15 +78,15 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
 	/**
 	 * Calls a selector given the current state and extra arguments.
 	 *
-	 * @param {string|WPDataStore} storeNameOrDefinition Unique namespace identifier for the store
-	 *                                                   or the store definition.
+	 * @param {string|StoreDescriptor} storeNameOrDescriptor Unique namespace identifier for the store
+	 *                                                       or the store descriptor.
 	 *
 	 * @return {*} The selector's returned value.
 	 */
-	function select( storeNameOrDefinition ) {
-		const storeName = isObject( storeNameOrDefinition )
-			? storeNameOrDefinition.name
-			: storeNameOrDefinition;
+	function select( storeNameOrDescriptor ) {
+		const storeName = isObject( storeNameOrDescriptor )
+			? storeNameOrDescriptor.name
+			: storeNameOrDescriptor;
 		__experimentalListeningStores.add( storeName );
 		const store = stores[ storeName ];
 		if ( store ) {
@@ -105,15 +109,15 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
 	 * and modified so that they return promises that resolve to their eventual values,
 	 * after any resolvers have ran.
 	 *
-	 * @param {string|WPDataStore} storeNameOrDefinition Unique namespace identifier for the store
-	 *                                                   or the store definition.
+	 * @param {string|StoreDescriptor} storeNameOrDescriptor Unique namespace identifier for the store
+	 *                                                       or the store descriptor.
 	 *
 	 * @return {Object} Each key of the object matches the name of a selector.
 	 */
-	function resolveSelect( storeNameOrDefinition ) {
-		const storeName = isObject( storeNameOrDefinition )
-			? storeNameOrDefinition.name
-			: storeNameOrDefinition;
+	function resolveSelect( storeNameOrDescriptor ) {
+		const storeName = isObject( storeNameOrDescriptor )
+			? storeNameOrDescriptor.name
+			: storeNameOrDescriptor;
 		__experimentalListeningStores.add( storeName );
 		const store = stores[ storeName ];
 		if ( store ) {
@@ -126,15 +130,15 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
 	/**
 	 * Returns the available actions for a part of the state.
 	 *
-	 * @param {string|WPDataStore} storeNameOrDefinition Unique namespace identifier for the store
-	 *                                                   or the store definition.
+	 * @param {string|StoreDescriptor} storeNameOrDescriptor Unique namespace identifier for the store
+	 *                                                       or the store descriptor.
 	 *
 	 * @return {*} The action's returned value.
 	 */
-	function dispatch( storeNameOrDefinition ) {
-		const storeName = isObject( storeNameOrDefinition )
-			? storeNameOrDefinition.name
-			: storeNameOrDefinition;
+	function dispatch( storeNameOrDescriptor ) {
+		const storeName = isObject( storeNameOrDescriptor )
+			? storeNameOrDescriptor.name
+			: storeNameOrDescriptor;
 		const store = stores[ storeName ];
 		if ( store ) {
 			return store.getActions();
@@ -159,56 +163,80 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
 	}
 
 	/**
-	 * Registers a generic store.
+	 * Registers a store instance.
 	 *
-	 * @param {string} key    Store registry key.
-	 * @param {Object} config Configuration (getSelectors, getActions, subscribe).
+	 * @param {string} name  Store registry name.
+	 * @param {Object} store Store instance object (getSelectors, getActions, subscribe).
 	 */
-	function registerGenericStore( key, config ) {
-		if ( typeof config.getSelectors !== 'function' ) {
-			throw new TypeError( 'config.getSelectors must be a function' );
+	function registerStoreInstance( name, store ) {
+		if ( typeof store.getSelectors !== 'function' ) {
+			throw new TypeError( 'store.getSelectors must be a function' );
 		}
-		if ( typeof config.getActions !== 'function' ) {
-			throw new TypeError( 'config.getActions must be a function' );
+		if ( typeof store.getActions !== 'function' ) {
+			throw new TypeError( 'store.getActions must be a function' );
 		}
-		if ( typeof config.subscribe !== 'function' ) {
-			throw new TypeError( 'config.subscribe must be a function' );
+		if ( typeof store.subscribe !== 'function' ) {
+			throw new TypeError( 'store.subscribe must be a function' );
 		}
-		// Thi emitter is used to keep track of active listeners when the registry
+		// The emitter is used to keep track of active listeners when the registry
 		// get paused, that way, when resumed we should be able to call all these
 		// pending listeners.
-		config.emitter = createEmitter();
-		const currentSubscribe = config.subscribe;
-		config.subscribe = ( listener ) => {
-			const unsubscribeFromStoreEmitter = config.emitter.subscribe(
-				listener
-			);
-			const unsubscribeFromRootStore = currentSubscribe( () => {
-				if ( config.emitter.isPaused ) {
-					config.emitter.emit();
+		store.emitter = createEmitter();
+		const currentSubscribe = store.subscribe;
+		store.subscribe = ( listener ) => {
+			const unsubscribeFromEmitter = store.emitter.subscribe( listener );
+			const unsubscribeFromStore = currentSubscribe( () => {
+				if ( store.emitter.isPaused ) {
+					store.emitter.emit();
 					return;
 				}
 				listener();
 			} );
 
 			return () => {
-				if ( unsubscribeFromRootStore ) {
-					unsubscribeFromRootStore();
-				}
-				unsubscribeFromStoreEmitter();
+				unsubscribeFromStore?.();
+				unsubscribeFromEmitter?.();
 			};
 		};
-		stores[ key ] = config;
-		config.subscribe( globalListener );
+		stores[ name ] = store;
+		store.subscribe( globalListener );
 	}
 
 	/**
-	 * Registers a new store definition.
+	 * Registers a new store given a store descriptor.
 	 *
-	 * @param {WPDataStore} store Store definition.
+	 * @param {StoreDescriptor} store Store descriptor.
 	 */
 	function register( store ) {
-		registerGenericStore( store.name, store.instantiate( registry ) );
+		registerStoreInstance( store.name, store.instantiate( registry ) );
+	}
+
+	function registerGenericStore( name, store ) {
+		deprecated( 'wp.data.registerGenericStore', {
+			since: '5.9',
+			alternative: 'wp.data.register( storeDescriptor )',
+		} );
+		registerStoreInstance( name, store );
+	}
+
+	/**
+	 * Registers a standard `@wordpress/data` store.
+	 *
+	 * @param {string} storeName Unique namespace identifier.
+	 * @param {Object} options   Store description (reducer, actions, selectors, resolvers).
+	 *
+	 * @return {Object} Registered store object.
+	 */
+	function registerStore( storeName, options ) {
+		if ( ! options.reducer ) {
+			throw new TypeError( 'Must specify store reducer' );
+		}
+
+		const store = createReduxStore( storeName, options ).instantiate(
+			registry
+		);
+		registerStoreInstance( storeName, store );
+		return store.store;
 	}
 
 	/**
@@ -244,7 +272,6 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
 
 	let registry = {
 		batch,
-		registerGenericStore,
 		stores,
 		namespaces: stores, // TODO: Deprecate/remove this.
 		subscribe,
@@ -253,35 +280,21 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
 		dispatch,
 		use,
 		register,
+		registerGenericStore,
+		registerStore,
 		__experimentalMarkListeningStores,
 		__experimentalSubscribeStore,
 	};
 
-	/**
-	 * Registers a standard `@wordpress/data` store.
-	 *
-	 * @param {string} storeName Unique namespace identifier.
-	 * @param {Object} options   Store description (reducer, actions, selectors, resolvers).
-	 *
-	 * @return {Object} Registered store object.
-	 */
-	registry.registerStore = ( storeName, options ) => {
-		if ( ! options.reducer ) {
-			throw new TypeError( 'Must specify store reducer' );
-		}
-
-		const store = createReduxStore( storeName, options ).instantiate(
-			registry
-		);
-		registerGenericStore( storeName, store );
-		return store.store;
-	};
-
 	//
 	// TODO:
 	// This function will be deprecated as soon as it is no longer internally referenced.
 	//
 	function use( plugin, options ) {
+		if ( ! plugin ) {
+			return;
+		}
+
 		registry = {
 			...registry,
 			...plugin( registry, options ),
@@ -290,11 +303,11 @@ export function createRegistry( storeConfigs = {}, parent = null ) {
 		return registry;
 	}
 
-	registerGenericStore( STORE_NAME, createCoreDataStore( registry ) );
+	registry.register( coreDataStore );
 
-	Object.entries( storeConfigs ).forEach( ( [ name, config ] ) =>
-		registry.registerStore( name, config )
-	);
+	for ( const [ name, config ] of Object.entries( storeConfigs ) ) {
+		registry.register( createReduxStore( name, config ) );
+	}
 
 	if ( parent ) {
 		parent.subscribe( globalListener );

package/src/resolvers-cache-middleware.js

@@ -6,7 +6,7 @@ import { get } from 'lodash';
 /**
  * Internal dependencies
  */
-import { STORE_NAME } from './store/name';
+import coreDataStore from './store';
 
 /** @typedef {import('./registry').WPDataRegistry} WPDataRegistry */
 
@@ -24,7 +24,7 @@ const createResolversCacheMiddleware = ( registry, reducerKey ) => () => (
 	next
 ) => ( action ) => {
 	const resolvers = registry
-		.select( STORE_NAME )
+		.select( coreDataStore )
 		.getCachedResolvers( reducerKey );
 	Object.entries( resolvers ).forEach(
 		( [ selectorName, resolversByArgs ] ) => {
@@ -49,7 +49,7 @@ const createResolversCacheMiddleware = ( registry, reducerKey ) => () => (
 
 				// Trigger cache invalidation
 				registry
-					.dispatch( STORE_NAME )
+					.dispatch( coreDataStore )
 					.invalidateResolution( reducerKey, selectorName, args );
 			} );
 		}

package/src/store/index.js

@@ -1,53 +1,54 @@
-function createCoreDataStore( registry ) {
-	const getCoreDataSelector = ( selectorName ) => ( key, ...args ) => {
-		return registry.select( key )[ selectorName ]( ...args );
-	};
+const coreDataStore = {
+	name: 'core/data',
+	instantiate( registry ) {
+		const getCoreDataSelector = ( selectorName ) => ( key, ...args ) => {
+			return registry.select( key )[ selectorName ]( ...args );
+		};
 
-	const getCoreDataAction = ( actionName ) => ( key, ...args ) => {
-		return registry.dispatch( key )[ actionName ]( ...args );
-	};
+		const getCoreDataAction = ( actionName ) => ( key, ...args ) => {
+			return registry.dispatch( key )[ actionName ]( ...args );
+		};
 
-	return {
-		getSelectors() {
-			return [
-				'getIsResolving',
-				'hasStartedResolution',
-				'hasFinishedResolution',
-				'isResolving',
-				'getCachedResolvers',
-			].reduce(
-				( memo, selectorName ) => ( {
-					...memo,
-					[ selectorName ]: getCoreDataSelector( selectorName ),
-				} ),
-				{}
-			);
-		},
+		return {
+			getSelectors() {
+				return Object.fromEntries(
+					[
+						'getIsResolving',
+						'hasStartedResolution',
+						'hasFinishedResolution',
+						'isResolving',
+						'getCachedResolvers',
+					].map( ( selectorName ) => [
+						selectorName,
+						getCoreDataSelector( selectorName ),
+					] )
+				);
+			},
 
-		getActions() {
-			return [
-				'startResolution',
-				'finishResolution',
-				'invalidateResolution',
-				'invalidateResolutionForStore',
-				'invalidateResolutionForStoreSelector',
-			].reduce(
-				( memo, actionName ) => ( {
-					...memo,
-					[ actionName ]: getCoreDataAction( actionName ),
-				} ),
-				{}
-			);
-		},
+			getActions() {
+				return Object.fromEntries(
+					[
+						'startResolution',
+						'finishResolution',
+						'invalidateResolution',
+						'invalidateResolutionForStore',
+						'invalidateResolutionForStoreSelector',
+					].map( ( actionName ) => [
+						actionName,
+						getCoreDataAction( actionName ),
+					] )
+				);
+			},
 
-		subscribe() {
-			// There's no reasons to trigger any listener when we subscribe to this store
-			// because there's no state stored in this store that need to retrigger selectors
-			// if a change happens, the corresponding store where the tracking stated live
-			// would have already triggered a "subscribe" call.
-			return () => {};
-		},
-	};
-}
+			subscribe() {
+				// There's no reasons to trigger any listener when we subscribe to this store
+				// because there's no state stored in this store that need to retrigger selectors
+				// if a change happens, the corresponding store where the tracking stated live
+				// would have already triggered a "subscribe" call.
+				return () => () => {};
+			},
+		};
+	},
+};
 
-export default createCoreDataStore;
+export default coreDataStore;

package/src/test/registry.js

@@ -9,9 +9,9 @@ import { castArray, mapValues } from 'lodash';
 import { createRegistry } from '../registry';
 import { createRegistrySelector } from '../factory';
 import createReduxStore from '../redux-store';
-import { STORE_NAME } from '../store/name';
+import coreDataStore from '../store';
 
-jest.useFakeTimers();
+jest.useFakeTimers( 'legacy' );
 
 describe( 'createRegistry', () => {
 	let registry;
@@ -72,6 +72,7 @@ describe( 'createRegistry', () => {
 					subscribe,
 				} )
 			).toThrow();
+			expect( console ).toHaveWarned();
 		} );
 
 		describe( 'getSelectors', () => {
@@ -276,7 +277,7 @@ describe( 'createRegistry', () => {
 			expect( resolver ).toHaveBeenCalledTimes( 2 );
 		} );
 
-		it( 'should support the object resolver definition', () => {
+		it( 'should support the object resolver descriptor', () => {
 			const resolver = jest.fn();
 			registry.registerStore( 'demo', {
 				reducer: ( state = 'OK' ) => state,
@@ -377,7 +378,7 @@ describe( 'createRegistry', () => {
 				() => registry.select( 'demo' ).getValue() === 'OK',
 				() =>
 					registry
-						.select( STORE_NAME )
+						.select( coreDataStore )
 						.hasFinishedResolution( 'demo', 'getValue' ),
 			] );
 
@@ -404,7 +405,7 @@ describe( 'createRegistry', () => {
 				() => registry.select( 'demo' ).getValue() === 'OK',
 				() =>
 					registry
-						.select( STORE_NAME )
+						.select( coreDataStore )
 						.hasFinishedResolution( 'demo', 'getValue' ),
 			] );
 
@@ -414,31 +415,6 @@ describe( 'createRegistry', () => {
 			return promise;
 		} );
 
-		it( 'should resolve promise non-action to dispatch', () => {
-			let shouldThrow = false;
-			registry.registerStore( 'demo', {
-				reducer: ( state = 'OK' ) => {
-					if ( shouldThrow ) {
-						throw 'Should not have dispatched';
-					}
-
-					return state;
-				},
-				selectors: {
-					getValue: ( state ) => state,
-				},
-				resolvers: {
-					getValue: () => Promise.resolve(),
-				},
-			} );
-			shouldThrow = true;
-
-			registry.select( 'demo' ).getValue();
-			jest.runAllTimers();
-
-			return new Promise( ( resolve ) => process.nextTick( resolve ) );
-		} );
-
 		it( 'should not dispatch resolved promise action on subsequent selector calls', () => {
 			registry.registerStore( 'demo', {
 				reducer: ( state = 'NOTOK', action ) => {
@@ -508,7 +484,7 @@ describe( 'createRegistry', () => {
 	} );
 
 	describe( 'register', () => {
-		it( 'should work with the store definition as param for select', () => {
+		it( 'should work with the store descriptor as param for select', () => {
 			const store = createReduxStore( 'demo', {
 				reducer: ( state = 'OK' ) => state,
 				selectors: {
@@ -520,7 +496,7 @@ describe( 'createRegistry', () => {
 			expect( registry.select( store ).getValue() ).toBe( 'OK' );
 		} );
 
-		it( 'should work with the store definition as param for dispatch', async () => {
+		it( 'should work with the store descriptor as param for dispatch', async () => {
 			const store = createReduxStore( 'demo', {
 				reducer( state = 'OK', action ) {
 					if ( action.type === 'UPDATE' ) {
@@ -807,15 +783,19 @@ describe( 'createRegistry', () => {
 			const getSelectors = () => ( { mySelector } );
 			const getActions = () => ( { myAction } );
 			const subscribe = () => {};
-			registry.registerGenericStore( 'store', {
-				getSelectors,
-				getActions,
-				subscribe,
-			} );
+			const myStore = {
+				name: 'store',
+				instantiate: () => ( {
+					getSelectors,
+					getActions,
+					subscribe,
+				} ),
+			};
+			registry.register( myStore );
 			const subRegistry = createRegistry( {}, registry );
 
-			subRegistry.select( 'store' ).mySelector();
-			subRegistry.dispatch( 'store' ).myAction();
+			subRegistry.select( myStore ).mySelector();
+			subRegistry.dispatch( myStore ).myAction();
 
 			expect( mySelector ).toHaveBeenCalled();
 			expect( myAction ).toHaveBeenCalled();
@@ -827,10 +807,13 @@ describe( 'createRegistry', () => {
 			const getSelectors = () => ( { mySelector } );
 			const getActions = () => ( { myAction } );
 			const subscribe = () => {};
-			registry.registerGenericStore( 'store', {
-				getSelectors,
-				getActions,
-				subscribe,
+			registry.register( {
+				name: 'store',
+				instantiate: () => ( {
+					getSelectors,
+					getActions,
+					subscribe,
+				} ),
 			} );
 
 			const subRegistry = createRegistry( {}, registry );
@@ -839,10 +822,13 @@ describe( 'createRegistry', () => {
 			const getSelectors2 = () => ( { mySelector: mySelector2 } );
 			const getActions2 = () => ( { myAction: myAction2 } );
 			const subscribe2 = () => {};
-			subRegistry.registerGenericStore( 'store', {
-				getSelectors: getSelectors2,
-				getActions: getActions2,
-				subscribe: subscribe2,
+			subRegistry.register( {
+				name: 'store',
+				instantiate: () => ( {
+					getSelectors: getSelectors2,
+					getActions: getActions2,
+					subscribe: subscribe2,
+				} ),
 			} );
 
 			subRegistry.select( 'store' ).mySelector();