Mark createStoreDefinition as unstable

WordPress · Nov 17, 2020 · fcd8c78 · fcd8c78
1 parent c554ef2
commit fcd8c78
Show file tree

Hide file tree

Showing 21 changed files with 97 additions and 60 deletions.
diff --git a/packages/annotations/src/store/index.js b/packages/annotations/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -22,7 +25,7 @@ const STORE_NAME = 'core/annotations';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, {
 	reducer,

diff --git a/packages/block-directory/src/store/index.js b/packages/block-directory/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 import { controls as dataControls } from '@wordpress/data-controls';
 
 /**
@@ -40,6 +43,6 @@ export const storeConfig = {
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, storeConfig );
diff --git a/packages/block-editor/src/store/index.js b/packages/block-editor/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -38,7 +41,7 @@ export const storeConfig = {
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 const store = registerStore( STORE_NAME, {
 	...storeConfig,

diff --git a/packages/blocks/src/store/index.js b/packages/blocks/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -19,6 +22,6 @@ const STORE_NAME = 'core/blocks';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, { reducer, selectors, actions } );
diff --git a/packages/core-data/src/index.js b/packages/core-data/src/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 import { controls } from '@wordpress/data-controls';
 
 /**
@@ -70,7 +73,7 @@ export const storeConfig = {
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 registerStore( STORE_NAME, storeConfig );
 

diff --git a/packages/data/README.md b/packages/data/README.md
@@ -434,24 +434,6 @@ _Returns_
 
 -   `Function`: Registry selector that can be registered with a store.
 
-<a name="createStoreDefinition" href="#createStoreDefinition">#</a> **createStoreDefinition**
-
-Creates a store definition to pass to store API methods.
-
-_Usage_
-
-```js
-const storeDefinition = createStoreDefinition( 'my-shop' );
-```
-
-_Parameters_
-
--   _storeName_ `string`: Unique namespace identifier for the store.
-
-_Returns_
-
--   `Object`: Store definition object.
-
 <a name="dispatch" href="#dispatch">#</a> **dispatch**
 
 Given the name of a registered store, returns an object of the store's action creators.

diff --git a/packages/data/src/factory.js b/packages/data/src/factory.js
@@ -85,14 +85,14 @@ export function createRegistryControl( registryControl ) {
  *
  * @example
  * ```js
- * const storeDefinition = createStoreDefinition( 'my-shop' );
+ * const storeDefinition = __unstableCreateStoreDefinition( 'my-shop' );
  * ```
  *
  * @param {string} storeName Unique namespace identifier for the store.
  *
  * @return {Object} Store definition object.
  */
-export function createStoreDefinition( storeName ) {
+export function __unstableCreateStoreDefinition( storeName ) {
 	return {
 		name: storeName,
 		toString() {

diff --git a/packages/data/src/index.js b/packages/data/src/index.js
@@ -24,7 +24,7 @@ export { createRegistry } from './registry';
 export {
 	createRegistrySelector,
 	createRegistryControl,
-	createStoreDefinition,
+	__unstableCreateStoreDefinition,
 } from './factory';
 export { controls } from './controls';
 

diff --git a/packages/data/src/test/factory.js b/packages/data/src/test/factory.js
@@ -1,17 +1,17 @@
 /**
  * Internal dependencies
  */
-import { createStoreDefinition } from '../factory';
+import { __unstableCreateStoreDefinition } from '../factory';
 
-describe( 'createStoreDefinition', () => {
+describe( '__unstableCreateStoreDefinition', () => {
 	it( 'creates store definition', () => {
-		const result = createStoreDefinition( 'my-shop' );
+		const result = __unstableCreateStoreDefinition( 'my-shop' );
 
 		expect( result.name ).toBe( 'my-shop' );
 	} );
 
 	it( 'casts the definition to string', () => {
-		const result = createStoreDefinition( 'my-shop' );
+		const result = __unstableCreateStoreDefinition( 'my-shop' );
 
 		expect( String( result ) ).toBe( 'my-shop' );
 	} );

diff --git a/packages/data/src/test/registry.js b/packages/data/src/test/registry.js
@@ -7,7 +7,10 @@ import { castArray, mapValues } from 'lodash';
  * Internal dependencies
  */
 import { createRegistry } from '../registry';
-import { createRegistrySelector, createStoreDefinition } from '../factory';
+import {
+	createRegistrySelector,
+	__unstableCreateStoreDefinition,
+} from '../factory';
 
 jest.useFakeTimers();
 
@@ -553,7 +556,9 @@ describe( 'createRegistry', () => {
 
 		it( 'should work with the store definition as param for select', () => {
 			const STORE_NAME = 'demo';
-			const storeDefinition = createStoreDefinition( STORE_NAME );
+			const storeDefinition = __unstableCreateStoreDefinition(
+				STORE_NAME
+			);
 			registry.registerStore( STORE_NAME, {
 				reducer: ( state = 'OK' ) => state,
 				selectors: {
@@ -699,7 +704,9 @@ describe( 'createRegistry', () => {
 
 		it( 'should work with the store object as param for dispatch', async () => {
 			const STORE_NAME = 'demo';
-			const storeDefinition = createStoreDefinition( STORE_NAME );
+			const storeDefinition = __unstableCreateStoreDefinition(
+				STORE_NAME
+			);
 			const store = registry.registerStore( STORE_NAME, {
 				reducer( state = 'OK', action ) {
 					if ( action.type === 'UPDATE' ) {

diff --git a/packages/edit-navigation/src/store/index.js b/packages/edit-navigation/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -39,6 +42,6 @@ export const storeConfig = {
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, storeConfig );
diff --git a/packages/edit-post/src/store/index.js b/packages/edit-post/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -19,7 +22,7 @@ import { STORE_NAME } from './constants';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 const store = registerStore( STORE_NAME, {
 	reducer,

diff --git a/packages/edit-widgets/src/store/index.js b/packages/edit-widgets/src/store/index.js
@@ -2,7 +2,10 @@
  * WordPress dependencies
  */
 import apiFetch from '@wordpress/api-fetch';
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -41,7 +44,7 @@ export const storeConfig = {
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 const store = registerStore( STORE_NAME, storeConfig );
 

diff --git a/packages/editor/src/store/index.js b/packages/editor/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 import { controls as dataControls } from '@wordpress/data-controls';
 
 /**
@@ -37,7 +40,7 @@ export const storeConfig = {
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, {
 	...storeConfig,

diff --git a/packages/interface/src/store/index.js b/packages/interface/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -18,7 +21,7 @@ import { STORE_NAME } from './constants';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, {
 	reducer,

diff --git a/packages/keyboard-shortcuts/src/store/index.js b/packages/keyboard-shortcuts/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -19,7 +22,7 @@ const STORE_NAME = 'core/keyboard-shortcuts';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, {
 	reducer,

diff --git a/packages/notices/src/store/index.js b/packages/notices/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -19,7 +22,7 @@ const STORE_NAME = 'core/notices';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, {
 	reducer,

diff --git a/packages/nux/src/store/index.js b/packages/nux/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -19,7 +22,7 @@ const STORE_NAME = 'core/nux';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, {
 	reducer,

diff --git a/packages/reusable-blocks/src/store/index.js b/packages/reusable-blocks/src/store/index.js
@@ -1,7 +1,10 @@
 /**
  * WordPress dependencies
  */
-import { createStoreDefinition, registerStore } from '@wordpress/data';
+import {
+	__unstableCreateStoreDefinition,
+	registerStore,
+} from '@wordpress/data';
 
 /**
  * Internal dependencies
@@ -20,7 +23,7 @@ const STORE_NAME = 'core/reusable-blocks';
  *
  * @type {Object}
  */
-export const storeDefinition = createStoreDefinition( STORE_NAME );
+export const storeDefinition = __unstableCreateStoreDefinition( STORE_NAME );
 
 export default registerStore( STORE_NAME, {
 	actions,