From ff4f4f4b991233d33a1b109e0ce9aadb0545de81 Mon Sep 17 00:00:00 2001 From: Riad Benguella Date: Tue, 17 Nov 2020 09:57:40 +0100 Subject: [PATCH] Rename storeDefinition to just store --- packages/annotations/src/index.js | 2 +- packages/annotations/src/store/index.js | 8 ++++---- packages/block-directory/src/index.js | 2 +- packages/block-directory/src/store/index.js | 11 ++++------- packages/block-editor/README.md | 12 ++++++------ packages/block-editor/src/index.js | 2 +- packages/block-editor/src/store/index.js | 10 +++++----- packages/blocks/README.md | 4 ++-- packages/blocks/src/index.js | 2 +- packages/blocks/src/store/index.js | 8 ++++---- packages/core-data/src/index.js | 11 ++++------- packages/core-data/src/test/integration.js | 6 +++--- packages/data/README.md | 4 ++-- packages/data/src/index.js | 4 ++-- packages/data/src/redux-store/index.js | 8 ++++---- packages/data/src/registry.js | 18 +++++++----------- packages/data/src/test/registry.js | 15 ++++++--------- packages/data/src/types.d.ts | 6 +++--- packages/edit-navigation/src/store/index.js | 11 ++++------- packages/edit-post/src/store/index.js | 13 +++++-------- packages/edit-widgets/src/store/index.js | 11 ++++------- packages/editor/src/index.js | 2 +- packages/editor/src/index.native.js | 2 +- packages/editor/src/store/index.js | 8 ++++---- .../src/components/complementary-area/index.js | 2 +- packages/interface/src/index.js | 2 +- packages/interface/src/store/index.js | 8 ++++---- packages/keyboard-shortcuts/README.md | 4 ++-- packages/keyboard-shortcuts/src/index.js | 2 +- packages/keyboard-shortcuts/src/store/index.js | 8 ++++---- packages/notices/src/index.js | 2 +- packages/notices/src/store/index.js | 8 ++++---- packages/nux/src/index.js | 2 +- packages/nux/src/store/index.js | 8 ++++---- .../reusable-block-convert-button.js | 4 ++-- .../reusable-block-delete-button.js | 4 ++-- packages/reusable-blocks/src/index.js | 2 +- packages/reusable-blocks/src/index.native.js | 2 +- packages/reusable-blocks/src/store/index.js | 8 ++++---- packages/rich-text/README.md | 4 ++-- packages/rich-text/src/index.js | 2 +- packages/rich-text/src/store/index.js | 8 ++++---- packages/viewport/README.md | 4 ++-- packages/viewport/src/index.js | 2 +- packages/viewport/src/listener.js | 4 ++-- packages/viewport/src/listener.native.js | 4 ++-- packages/viewport/src/store/index.js | 8 ++++---- .../viewport/src/with-viewport-match.native.js | 4 ++-- 48 files changed, 132 insertions(+), 154 deletions(-) diff --git a/packages/annotations/src/index.js b/packages/annotations/src/index.js index 5cde89f35395b..4624351fd98a6 100644 --- a/packages/annotations/src/index.js +++ b/packages/annotations/src/index.js @@ -4,4 +4,4 @@ import './format'; import './block'; -export { storeDefinition } from './store'; +export { store } from './store'; diff --git a/packages/annotations/src/store/index.js b/packages/annotations/src/store/index.js index ca8dc5b5e5cc2..81dee6efd82b4 100644 --- a/packages/annotations/src/store/index.js +++ b/packages/annotations/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { register, createReduxStoreDefinition } from '@wordpress/data'; +import { register, createReduxStore } from '@wordpress/data'; /** * Internal dependencies @@ -18,14 +18,14 @@ const STORE_NAME = 'core/annotations'; /** * Store definition for the annotations namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, selectors, actions, } ); -register( storeDefinition ); +register( store ); diff --git a/packages/block-directory/src/index.js b/packages/block-directory/src/index.js index 35885e76a11b0..673db46644895 100644 --- a/packages/block-directory/src/index.js +++ b/packages/block-directory/src/index.js @@ -8,4 +8,4 @@ import '@wordpress/notices'; */ import './plugins'; -export { storeDefinition } from './store'; +export { store } from './store'; diff --git a/packages/block-directory/src/store/index.js b/packages/block-directory/src/store/index.js index cf5a162ebfd67..ca3f2c8b939dd 100644 --- a/packages/block-directory/src/store/index.js +++ b/packages/block-directory/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; import { controls as dataControls } from '@wordpress/data-controls'; /** @@ -36,13 +36,10 @@ export const storeConfig = { /** * Store definition for the block directory namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( - STORE_NAME, - storeConfig -); +export const store = createReduxStore( STORE_NAME, storeConfig ); -register( storeDefinition ); +register( store ); diff --git a/packages/block-editor/README.md b/packages/block-editor/README.md index 9db71da2fea39..cfadf407b3b65 100644 --- a/packages/block-editor/README.md +++ b/packages/block-editor/README.md @@ -504,25 +504,25 @@ _Properties_ Undocumented declaration. -# **storeConfig** +# **store** -Block editor data store configuration. +Store definition for the block editor namespace. _Related_ -- +- _Type_ - `Object` -# **storeDefinition** +# **storeConfig** -Store definition for the block editor namespace. +Block editor data store configuration. _Related_ -- +- _Type_ diff --git a/packages/block-editor/src/index.js b/packages/block-editor/src/index.js index 59a12deb4534b..1e12ca9f4acae 100644 --- a/packages/block-editor/src/index.js +++ b/packages/block-editor/src/index.js @@ -12,5 +12,5 @@ import '@wordpress/notices'; import './hooks'; export * from './components'; export * from './utils'; -export { storeConfig, storeDefinition } from './store'; +export { storeConfig, store } from './store'; export { SETTINGS_DEFAULTS } from './store/defaults'; diff --git a/packages/block-editor/src/store/index.js b/packages/block-editor/src/store/index.js index c998d36fdd7e4..958eef41b4fed 100644 --- a/packages/block-editor/src/store/index.js +++ b/packages/block-editor/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, registerStore } from '@wordpress/data'; +import { createReduxStore, registerStore } from '@wordpress/data'; /** * Internal dependencies @@ -34,19 +34,19 @@ export const storeConfig = { /** * Store definition for the block editor namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { ...storeConfig, persist: [ 'preferences' ], } ); // Ideally we'd use register instead of register stores. // We should be able to make the switch once we remove the "effects" middleware. -const store = registerStore( STORE_NAME, { +const instantiatedStore = registerStore( STORE_NAME, { ...storeConfig, persist: [ 'preferences' ], } ); -applyMiddlewares( store ); +applyMiddlewares( instantiatedStore ); diff --git a/packages/blocks/README.md b/packages/blocks/README.md index 09a15ed4eb88d..233883c81b7ee 100644 --- a/packages/blocks/README.md +++ b/packages/blocks/README.md @@ -740,13 +740,13 @@ _Parameters_ - _blockName_ `string`: Block name. -# **storeDefinition** +# **store** Store definition for the blocks namespace. _Related_ -- +- _Type_ diff --git a/packages/blocks/src/index.js b/packages/blocks/src/index.js index 6b004258a18f5..0af3f5e0ae720 100644 --- a/packages/blocks/src/index.js +++ b/packages/blocks/src/index.js @@ -8,6 +8,6 @@ // Blocks are inferred from the HTML source of a post through a parsing mechanism // and then stored as objects in state, from which it is then rendered for editing. -export { storeDefinition } from './store'; +export { store } from './store'; export * from './api'; export { withBlockContentContext } from './block-content-provider'; diff --git a/packages/blocks/src/store/index.js b/packages/blocks/src/store/index.js index 6bdd726c02302..7672b6e5e7fb8 100644 --- a/packages/blocks/src/store/index.js +++ b/packages/blocks/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -15,14 +15,14 @@ const STORE_NAME = 'core/blocks'; /** * Store definition for the blocks namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, selectors, actions, } ); -register( storeDefinition ); +register( store ); diff --git a/packages/core-data/src/index.js b/packages/core-data/src/index.js index 989e94b35ecba..fc2c051a52165 100644 --- a/packages/core-data/src/index.js +++ b/packages/core-data/src/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; import { controls } from '@wordpress/data-controls'; /** @@ -67,16 +67,13 @@ const storeConfig = { /** * Store definition for the code data namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( - STORE_NAME, - storeConfig -); +export const store = createReduxStore( STORE_NAME, storeConfig ); -register( storeDefinition ); +register( store ); export { default as EntityProvider } from './entity-provider'; export * from './entity-provider'; diff --git a/packages/core-data/src/test/integration.js b/packages/core-data/src/test/integration.js index 979198d391c0d..43fbdaeb27bd9 100644 --- a/packages/core-data/src/test/integration.js +++ b/packages/core-data/src/test/integration.js @@ -9,7 +9,7 @@ import { createRegistry, controls } from '@wordpress/data'; import * as actions from '../actions'; import * as selectors from '../selectors'; import * as resolvers from '../resolvers'; -import { storeDefinition } from '../'; +import { store } from '../'; // Mock to prevent calling window.fetch in test environment jest.mock( '@wordpress/data-controls', () => { @@ -52,7 +52,7 @@ describe( 'receiveEntityRecord', () => { data: {}, }, }; - registry.register( storeDefinition ); + registry.register( store ); registry.registerStore( 'test/resolution', { actions: { receiveEntityRecords: actions.receiveEntityRecords, @@ -160,7 +160,7 @@ describe( 'receiveEntityRecord', () => { describe( 'saveEntityRecord', () => { function createTestRegistry() { const registry = createRegistry(); - registry.registerStore( storeDefinition ); + registry.register( store ); return registry; } diff --git a/packages/data/README.md b/packages/data/README.md index a89673fb8d0ee..b55e0e8421745 100644 --- a/packages/data/README.md +++ b/packages/data/README.md @@ -345,7 +345,7 @@ _Returns_ Undocumented declaration. -# **createReduxStoreDefinition** +# **createReduxStore** Creates a namespace object with a store derived from the reducer given. @@ -489,7 +489,7 @@ Registers a standard `@wordpress/data` store definition. _Parameters_ -- _storeDefinition_ (unknown type): Store definition. +- _store_ (unknown type): Store definition. # **registerGenericStore** diff --git a/packages/data/src/index.js b/packages/data/src/index.js index b26336cde328d..7e19c370b65ba 100644 --- a/packages/data/src/index.js +++ b/packages/data/src/index.js @@ -23,7 +23,7 @@ export { AsyncModeProvider } from './components/async-mode-provider'; export { createRegistry } from './registry'; export { createRegistrySelector, createRegistryControl } from './factory'; export { controls } from './controls'; -export { default as createReduxStoreDefinition } from './redux-store'; +export { default as createReduxStore } from './redux-store'; /** * Object of available plugins to use with a registry. @@ -182,6 +182,6 @@ export const use = defaultRegistry.use; /** * Registers a standard `@wordpress/data` store definition. * - * @param {import('./types').WPDataStoreDefinition} storeDefinition Store definition. + * @param {import('./types').WPDataStore} store Store definition. */ export const register = defaultRegistry.register; diff --git a/packages/data/src/redux-store/index.js b/packages/data/src/redux-store/index.js index 4abc86efed8de..4fb635d2ba8dc 100644 --- a/packages/data/src/redux-store/index.js +++ b/packages/data/src/redux-store/index.js @@ -59,12 +59,12 @@ function createResolversCache() { * * @return {import('../types').WPDataStoreDefinition} Store Object. */ -export default function createReduxStoreDefinition( key, options ) { +export default function createReduxStore( key, options ) { return { name: key, - __internalAttach: ( registry ) => { + instantiate: ( registry ) => { const reducer = options.reducer; - const store = createReduxStore( key, options, registry ); + const store = instantiateReduxStore( key, options, registry ); const resolversCache = createResolversCache(); let resolvers; @@ -157,7 +157,7 @@ export default function createReduxStoreDefinition( key, options ) { * * @return {Object} Newly created redux store. */ -function createReduxStore( key, options, registry ) { +function instantiateReduxStore( key, options, registry ) { const controls = { ...options.controls, ...builtinControls, diff --git a/packages/data/src/registry.js b/packages/data/src/registry.js index f173c35147515..669589d177cf2 100644 --- a/packages/data/src/registry.js +++ b/packages/data/src/registry.js @@ -7,7 +7,7 @@ import memize from 'memize'; /** * Internal dependencies */ -import createReduxStoreDefinition from './redux-store'; +import createReduxStore from './redux-store'; import createCoreDataStore from './store'; /** @@ -205,13 +205,10 @@ export function createRegistry( storeConfigs = {}, parent = null ) { /** * Registers a new store. * - * @param {import('./types').WPDataStoreDefinition} storeDefinition Store definition. + * @param {import('./types').WPDataStore} store Store definition. */ - function register( storeDefinition ) { - registerGenericStore( - storeDefinition.name, - storeDefinition.__internalAttach( registry ) - ); + function register( store ) { + registerGenericStore( store.name, store.instantiate( registry ) ); } let registry = { @@ -239,10 +236,9 @@ export function createRegistry( storeConfigs = {}, parent = null ) { throw new TypeError( 'Must specify store reducer' ); } - const store = createReduxStoreDefinition( - storeName, - options - ).__internalAttach( registry ); + const store = createReduxStore( storeName, options ).instantiate( + registry + ); registerGenericStore( storeName, store ); return store.store; }; diff --git a/packages/data/src/test/registry.js b/packages/data/src/test/registry.js index 7ce5f6ef3388a..88b8d5b6b7f91 100644 --- a/packages/data/src/test/registry.js +++ b/packages/data/src/test/registry.js @@ -8,7 +8,7 @@ import { castArray, mapValues } from 'lodash'; */ import { createRegistry } from '../registry'; import { createRegistrySelector } from '../factory'; -import createReduxStoreDefinition from '../redux-store'; +import createReduxStore from '../redux-store'; jest.useFakeTimers(); @@ -554,18 +554,16 @@ describe( 'createRegistry', () => { it( 'should work with the store definition as param for select', () => { const STORE_NAME = 'demo'; - const storeDefinition = createReduxStoreDefinition( STORE_NAME, { + const store = createReduxStore( STORE_NAME, { reducer: ( state = 'OK' ) => state, selectors: { getValue: ( state ) => state, }, resolvers: {}, } ); - registry.registry( storeDefinition ); + registry.registry( store ); - expect( registry.select( storeDefinition ).getValue() ).toBe( - 'OK' - ); + expect( registry.select( store ).getValue() ).toBe( 'OK' ); } ); it( 'should run the registry selector from a non-registry selector', () => { @@ -700,7 +698,7 @@ describe( 'createRegistry', () => { it( 'should work with the store object as param for dispatch', async () => { const STORE_NAME = 'demo'; - const storeDefinition = createReduxStoreDefinition( STORE_NAME, { + const store = registry.registerStore( STORE_NAME, { reducer( state = 'OK', action ) { if ( action.type === 'UPDATE' ) { return 'UPDATED'; @@ -713,10 +711,9 @@ describe( 'createRegistry', () => { }, }, } ); - const store = registry.register( storeDefinition ); expect( store.getState() ).toBe( 'OK' ); - await registry.dispatch( storeDefinition ).update(); + await registry.dispatch( store ).update(); expect( store.getState() ).toBe( 'UPDATED' ); } ); } ); diff --git a/packages/data/src/types.d.ts b/packages/data/src/types.d.ts index 1939a80d97565..75041c84bfc81 100644 --- a/packages/data/src/types.d.ts +++ b/packages/data/src/types.d.ts @@ -11,7 +11,7 @@ export type WPDataAttachedStore = { subscribe: (listener: () => void) => (() => void) }; -export type WPDataStoreDefinition = { +export type WPDataStore = { /** * Store Name */ @@ -20,7 +20,7 @@ export type WPDataStoreDefinition = { /** * Store configuration object. */ - __internalAttach: (registry: WPDataRegistry) => WPDataAttachedStore, + instantiate: (registry: WPDataRegistry) => WPDataAttachedStore, }; export type WPDataReduxStoreConfig = { @@ -32,5 +32,5 @@ export type WPDataReduxStoreConfig = { } export type WPDataRegistry = { - register: ( storeDefinition: WPDataStoreDefinition ) => void, + register: ( store: WPDataStore ) => void, } \ No newline at end of file diff --git a/packages/edit-navigation/src/store/index.js b/packages/edit-navigation/src/store/index.js index d640f0d46e838..049f1785c9d20 100644 --- a/packages/edit-navigation/src/store/index.js +++ b/packages/edit-navigation/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -35,13 +35,10 @@ const storeConfig = { /** * Store definition for the edit navigation namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( - STORE_NAME, - storeConfig -); +export const store = createReduxStore( STORE_NAME, storeConfig ); -register( storeDefinition ); +register( store ); diff --git a/packages/edit-post/src/store/index.js b/packages/edit-post/src/store/index.js index 30d7babfbaa60..7d08516f251a4 100644 --- a/packages/edit-post/src/store/index.js +++ b/packages/edit-post/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, registerStore } from '@wordpress/data'; +import { createReduxStore, registerStore } from '@wordpress/data'; /** * Internal dependencies @@ -22,16 +22,13 @@ const storeConfig = { /** * Store definition for the edit post namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( - STORE_NAME, - storeConfig -); +export const store = createReduxStore( STORE_NAME, storeConfig ); // Ideally we use register instead of register store. // We shouuld be able to make the switch once we remove the effects. -const store = registerStore( STORE_NAME, storeConfig ); -applyMiddlewares( store ); +const instantiatedStore = registerStore( STORE_NAME, storeConfig ); +applyMiddlewares( instantiatedStore ); diff --git a/packages/edit-widgets/src/store/index.js b/packages/edit-widgets/src/store/index.js index 9af8c27b404bd..bdbf487125e33 100644 --- a/packages/edit-widgets/src/store/index.js +++ b/packages/edit-widgets/src/store/index.js @@ -2,7 +2,7 @@ * WordPress dependencies */ import apiFetch from '@wordpress/api-fetch'; -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -37,16 +37,13 @@ const storeConfig = { /** * Store definition for the edit widgets namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( - STORE_NAME, - storeConfig -); +export const store = createReduxStore( STORE_NAME, storeConfig ); -register( storeDefinition ); +register( store ); // This package uses a few in-memory post types as wrappers for convenience. // This middleware prevents any network requests related to these types as they are diff --git a/packages/editor/src/index.js b/packages/editor/src/index.js index d683f45da0af1..0a58cd215cd75 100644 --- a/packages/editor/src/index.js +++ b/packages/editor/src/index.js @@ -14,7 +14,7 @@ import '@wordpress/rich-text'; */ import './hooks'; -export { storeConfig, storeDefinition } from './store'; +export { storeConfig, store } from './store'; export * from './components'; export * from './utils'; diff --git a/packages/editor/src/index.native.js b/packages/editor/src/index.native.js index ac0e4afe5b193..d3d3d52c24cee 100644 --- a/packages/editor/src/index.native.js +++ b/packages/editor/src/index.native.js @@ -11,6 +11,6 @@ import '@wordpress/rich-text'; */ import './hooks'; -export { storeDefinition } from './store'; +export { store } from './store'; export * from './components'; export * from './utils'; diff --git a/packages/editor/src/store/index.js b/packages/editor/src/store/index.js index 42123133aa345..4deb450534d67 100644 --- a/packages/editor/src/store/index.js +++ b/packages/editor/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; import { controls as dataControls } from '@wordpress/data-controls'; /** @@ -33,13 +33,13 @@ export const storeConfig = { /** * Store definition for the editor namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { ...storeConfig, persist: [ 'preferences' ], } ); -register( storeDefinition ); +register( store ); diff --git a/packages/interface/src/components/complementary-area/index.js b/packages/interface/src/components/complementary-area/index.js index 40d52e7a5410c..f35fcf9d14bc1 100644 --- a/packages/interface/src/components/complementary-area/index.js +++ b/packages/interface/src/components/complementary-area/index.js @@ -11,7 +11,7 @@ import { useDispatch, useSelect } from '@wordpress/data'; import { __ } from '@wordpress/i18n'; import { check, starEmpty, starFilled } from '@wordpress/icons'; import { useEffect, useRef } from '@wordpress/element'; -import { storeDefinition as viewportStore } from '@wordpress/viewport'; +import { store as viewportStore } from '@wordpress/viewport'; /** * Internal dependencies diff --git a/packages/interface/src/index.js b/packages/interface/src/index.js index adbbd6316b5db..cf6bfc074cc05 100644 --- a/packages/interface/src/index.js +++ b/packages/interface/src/index.js @@ -1,2 +1,2 @@ -export { storeDefinition } from './store'; +export { store } from './store'; export * from './components'; diff --git a/packages/interface/src/store/index.js b/packages/interface/src/store/index.js index a6677e6407190..6ef6a3efa72a7 100644 --- a/packages/interface/src/store/index.js +++ b/packages/interface/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -14,15 +14,15 @@ import { STORE_NAME } from './constants'; /** * Store definition for the interface namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, actions, selectors, persist: [ 'enableItems' ], } ); -register( storeDefinition ); +register( store ); diff --git a/packages/keyboard-shortcuts/README.md b/packages/keyboard-shortcuts/README.md index b6ae0c198e78a..27d7432447bd1 100644 --- a/packages/keyboard-shortcuts/README.md +++ b/packages/keyboard-shortcuts/README.md @@ -16,13 +16,13 @@ _This package assumes that your code will run in an **ES2015+** environment. If -# **storeDefinition** +# **store** Store definition for the keyboard shortcuts namespace. _Related_ -- +- _Type_ diff --git a/packages/keyboard-shortcuts/src/index.js b/packages/keyboard-shortcuts/src/index.js index 9508a82d9d61a..a57718af9c566 100644 --- a/packages/keyboard-shortcuts/src/index.js +++ b/packages/keyboard-shortcuts/src/index.js @@ -1,2 +1,2 @@ -export { storeDefinition } from './store'; +export { store } from './store'; export { default as useShortcut } from './hooks/use-shortcut'; diff --git a/packages/keyboard-shortcuts/src/store/index.js b/packages/keyboard-shortcuts/src/store/index.js index fbe65655afe50..0f40e3f4d7482 100644 --- a/packages/keyboard-shortcuts/src/store/index.js +++ b/packages/keyboard-shortcuts/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -15,14 +15,14 @@ const STORE_NAME = 'core/keyboard-shortcuts'; /** * Store definition for the keyboard shortcuts namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, actions, selectors, } ); -register( storeDefinition ); +register( store ); diff --git a/packages/notices/src/index.js b/packages/notices/src/index.js index 7bee0ed654383..33b78d5a1d117 100644 --- a/packages/notices/src/index.js +++ b/packages/notices/src/index.js @@ -1 +1 @@ -export { storeDefinition } from './store'; +export { store } from './store'; diff --git a/packages/notices/src/store/index.js b/packages/notices/src/store/index.js index 054637d3c2c37..35c5e1d981b47 100644 --- a/packages/notices/src/store/index.js +++ b/packages/notices/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -15,14 +15,14 @@ const STORE_NAME = 'core/notices'; /** * Store definition for the notices namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, actions, selectors, } ); -register( storeDefinition ); +register( store ); diff --git a/packages/nux/src/index.js b/packages/nux/src/index.js index 1a06cd90878e0..ffd4a5e881882 100644 --- a/packages/nux/src/index.js +++ b/packages/nux/src/index.js @@ -3,7 +3,7 @@ */ import deprecated from '@wordpress/deprecated'; -export { storeDefinition } from './store'; +export { store } from './store'; export { default as DotTip } from './components/dot-tip'; deprecated( 'wp.nux', { diff --git a/packages/nux/src/store/index.js b/packages/nux/src/store/index.js index 94b8b60dd8109..492f545d3bea2 100644 --- a/packages/nux/src/store/index.js +++ b/packages/nux/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -15,15 +15,15 @@ const STORE_NAME = 'core/nux'; /** * Store definition for the nux namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, actions, selectors, persist: [ 'preferences' ], } ); -register( storeDefinition ); +register( store ); diff --git a/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-convert-button.js b/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-convert-button.js index fabd6d623d03e..bd24b76261cc9 100644 --- a/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-convert-button.js +++ b/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-convert-button.js @@ -12,7 +12,7 @@ import { __ } from '@wordpress/i18n'; /** * Internal dependencies */ -import { storeDefinition } from '../../store'; +import { store } from '../../store'; /** * Menu control to convert block(s) to reusable block. @@ -69,7 +69,7 @@ export default function ReusableBlockConvertButton( { const { __experimentalConvertBlocksToReusable: convertBlocksToReusable, - } = useDispatch( storeDefinition ); + } = useDispatch( store ); const { createSuccessNotice, createErrorNotice } = useDispatch( 'core/notices' diff --git a/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-delete-button.js b/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-delete-button.js index f5361879722ae..ac3abd0bb471c 100644 --- a/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-delete-button.js +++ b/packages/reusable-blocks/src/components/reusable-blocks-menu-items/reusable-block-delete-button.js @@ -11,7 +11,7 @@ import { BlockSettingsMenuControls } from '@wordpress/block-editor'; /** * Internal dependencies */ -import { storeDefinition } from '../../store'; +import { store } from '../../store'; function ReusableBlockDeleteButton( { clientId } ) { const { isVisible, isDisabled, block } = useSelect( @@ -43,7 +43,7 @@ function ReusableBlockDeleteButton( { clientId } ) { const { __experimentalDeleteReusableBlock: deleteReusableBlock, - } = useDispatch( storeDefinition ); + } = useDispatch( store ); const { createSuccessNotice, createErrorNotice } = useDispatch( 'core/notices' diff --git a/packages/reusable-blocks/src/index.js b/packages/reusable-blocks/src/index.js index 010f878024219..2faa13104e51a 100644 --- a/packages/reusable-blocks/src/index.js +++ b/packages/reusable-blocks/src/index.js @@ -5,5 +5,5 @@ import '@wordpress/block-editor'; import '@wordpress/core-data'; import '@wordpress/notices'; -export { storeDefinition } from './store'; +export { store } from './store'; export * from './components'; diff --git a/packages/reusable-blocks/src/index.native.js b/packages/reusable-blocks/src/index.native.js index 9c9f26eb0b181..2e29e8c63d896 100644 --- a/packages/reusable-blocks/src/index.native.js +++ b/packages/reusable-blocks/src/index.native.js @@ -3,5 +3,5 @@ */ import '@wordpress/core-data'; -export { storeDefinition } from './store'; +export { store } from './store'; export * from './components'; diff --git a/packages/reusable-blocks/src/store/index.js b/packages/reusable-blocks/src/store/index.js index 228fac5f54d76..46a38b67f8b8f 100644 --- a/packages/reusable-blocks/src/store/index.js +++ b/packages/reusable-blocks/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -16,15 +16,15 @@ const STORE_NAME = 'core/reusable-blocks'; /** * Store definition for the reusable blocks namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { actions, controls, reducer, selectors, } ); -register( storeDefinition ); +register( store ); diff --git a/packages/rich-text/README.md b/packages/rich-text/README.md index 09473c272cb90..766eb4566de49 100644 --- a/packages/rich-text/README.md +++ b/packages/rich-text/README.md @@ -302,13 +302,13 @@ _Returns_ - `Array`: An array of new values. -# **storeDefinition** +# **store** Store definition for the rich-text namespace. _Related_ -- +- _Type_ diff --git a/packages/rich-text/src/index.js b/packages/rich-text/src/index.js index feb9bcfe1d520..18791abde00a1 100644 --- a/packages/rich-text/src/index.js +++ b/packages/rich-text/src/index.js @@ -1,4 +1,4 @@ -export { storeDefinition } from './store'; +export { store } from './store'; export { applyFormat } from './apply-format'; export { concat } from './concat'; export { create } from './create'; diff --git a/packages/rich-text/src/store/index.js b/packages/rich-text/src/store/index.js index a34ec22c074c4..02b320b2a43b0 100644 --- a/packages/rich-text/src/store/index.js +++ b/packages/rich-text/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -15,14 +15,14 @@ const STORE_NAME = 'core/rich-text'; /** * Store definition for the rich-text namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, selectors, actions, } ); -register( storeDefinition ); +register( store ); diff --git a/packages/viewport/README.md b/packages/viewport/README.md index a9e343d1ae8f8..ae3cc8dbe04d6 100644 --- a/packages/viewport/README.md +++ b/packages/viewport/README.md @@ -76,13 +76,13 @@ _Returns_ - `Function`: Higher-order component. -# **storeDefinition** +# **store** Store definition for the viewport namespace. _Related_ -- +- _Type_ diff --git a/packages/viewport/src/index.js b/packages/viewport/src/index.js index 2d2d02c6e56c1..8bb1166d60f64 100644 --- a/packages/viewport/src/index.js +++ b/packages/viewport/src/index.js @@ -3,7 +3,7 @@ */ import addDimensionsEventListener from './listener'; -export { storeDefinition } from './store'; +export { store } from './store'; export { default as ifViewportMatches } from './if-viewport-matches'; export { default as withViewportMatch } from './with-viewport-match'; diff --git a/packages/viewport/src/listener.js b/packages/viewport/src/listener.js index cc805b9275bf7..b87e1b7d3bc2a 100644 --- a/packages/viewport/src/listener.js +++ b/packages/viewport/src/listener.js @@ -11,7 +11,7 @@ import { dispatch } from '@wordpress/data'; /** * Internal dependencies */ -import { storeDefinition } from './store'; +import { store } from './store'; const addDimensionsEventListener = ( breakpoints, operators ) => { /** @@ -21,7 +21,7 @@ const addDimensionsEventListener = ( breakpoints, operators ) => { const setIsMatching = debounce( () => { const values = mapValues( queries, ( query ) => query.matches ); - dispatch( storeDefinition ).setIsMatching( values ); + dispatch( store ).setIsMatching( values ); }, { leading: true } ); diff --git a/packages/viewport/src/listener.native.js b/packages/viewport/src/listener.native.js index d9cf815a09748..ec8bf2203d3e0 100644 --- a/packages/viewport/src/listener.native.js +++ b/packages/viewport/src/listener.native.js @@ -12,7 +12,7 @@ import { dispatch } from '@wordpress/data'; /** * Internal dependencies */ -import { storeDefinition } from './store'; +import { store } from './store'; const matchWidth = ( operator, breakpoint ) => { const { width } = Dimensions.get( 'window' ); @@ -39,7 +39,7 @@ const addDimensionsEventListener = ( breakpoints, operators ) => { {} ); - dispatch( storeDefinition ).setIsMatching( matches ); + dispatch( store ).setIsMatching( matches ); }; Dimensions.addEventListener( 'change', setIsMatching ); diff --git a/packages/viewport/src/store/index.js b/packages/viewport/src/store/index.js index 11fb948e8bdd0..29f39dbccc1c1 100644 --- a/packages/viewport/src/store/index.js +++ b/packages/viewport/src/store/index.js @@ -1,7 +1,7 @@ /** * WordPress dependencies */ -import { createReduxStoreDefinition, register } from '@wordpress/data'; +import { createReduxStore, register } from '@wordpress/data'; /** * Internal dependencies @@ -15,14 +15,14 @@ const STORE_NAME = 'core/viewport'; /** * Store definition for the viewport namespace. * - * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStoreDefinition + * @see https://github.com/WordPress/gutenberg/blob/master/packages/data/README.md#createReduxStore * * @type {Object} */ -export const storeDefinition = createReduxStoreDefinition( STORE_NAME, { +export const store = createReduxStore( STORE_NAME, { reducer, actions, selectors, } ); -register( storeDefinition ); +register( store ); diff --git a/packages/viewport/src/with-viewport-match.native.js b/packages/viewport/src/with-viewport-match.native.js index 71910d87143d8..6ef490d0ff1d9 100644 --- a/packages/viewport/src/with-viewport-match.native.js +++ b/packages/viewport/src/with-viewport-match.native.js @@ -12,7 +12,7 @@ import { withSelect } from '@wordpress/data'; /** * Internal dependencies */ -import { storeDefinition } from './store'; +import { store } from './store'; /** * Higher-order component creator, creating a new component which renders with @@ -41,7 +41,7 @@ const withViewportMatch = ( queries ) => createHigherOrderComponent( withSelect( ( select ) => { return mapValues( queries, ( query ) => { - return select( storeDefinition ).isViewportMatch( query ); + return select( store ).isViewportMatch( query ); } ); } ), 'withViewportMatch'