@wordpress/data 6.3.0 → 6.3.1-next.a55ed9455a.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/data",
-	"version": "6.3.0",
+	"version": "6.3.1-next.a55ed9455a.0",
 	"description": "Data module for WordPress.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -28,12 +28,12 @@
 	"sideEffects": false,
 	"dependencies": {
 		"@babel/runtime": "^7.16.0",
-		"@wordpress/compose": "^5.1.2",
-		"@wordpress/deprecated": "^3.3.1",
-		"@wordpress/element": "^4.1.1",
-		"@wordpress/is-shallow-equal": "^4.3.1",
-		"@wordpress/priority-queue": "^2.3.1",
-		"@wordpress/redux-routine": "^4.3.1",
+		"@wordpress/compose": "^5.1.3-next.a55ed9455a.0",
+		"@wordpress/deprecated": "^3.3.2-next.a55ed9455a.0",
+		"@wordpress/element": "^4.1.3-next.a55ed9455a.0",
+		"@wordpress/is-shallow-equal": "^4.3.2-next.a55ed9455a.0",
+		"@wordpress/priority-queue": "^2.3.2-next.a55ed9455a.0",
+		"@wordpress/redux-routine": "^4.3.2-next.a55ed9455a.0",
 		"equivalent-key-map": "^0.2.2",
 		"is-promise": "^4.0.0",
 		"lodash": "^4.17.21",
@@ -47,5 +47,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "4566ac290359553d04de4eb574545309343f790b"
+	"gitHead": "c5108185851b824d531bce55991a3589947e8551"
 }

package/src/components/use-select/index.js

@@ -213,7 +213,7 @@ export default function useSelect( mapSelect, deps ) {
 			}
 		};
 
-		// catch any possible state changes during mount before the subscription
+		// Catch any possible state changes during mount before the subscription
 		// could be set.
 		if ( latestIsAsync.current ) {
 			renderQueue.add( queueContext, onStoreChange );

package/src/components/use-select/test/index.js

@@ -57,7 +57,7 @@ describe( 'useSelect', () => {
 		expect( selectSpy ).toHaveBeenCalledTimes( 2 );
 		expect( TestComponent ).toHaveBeenCalledTimes( 1 );
 
-		// ensure expected state was rendered
+		// Ensure expected state was rendered.
 		expect( testInstance.findByType( 'div' ).props ).toEqual( {
 			children: 'bar',
 		} );
@@ -92,12 +92,12 @@ describe( 'useSelect', () => {
 		expect( selectSpyBar ).toHaveBeenCalledTimes( 0 );
 		expect( TestComponent ).toHaveBeenCalledTimes( 1 );
 
-		// ensure expected state was rendered
+		// Ensure expected state was rendered.
 		expect( testInstance.findByType( 'div' ).props ).toEqual( {
 			children: 'foo',
 		} );
 
-		//rerender with non dependency changed
+		// Rerender with non dependency changed.
 		act( () => {
 			renderer.update(
 				<RegistryProvider value={ registry }>
@@ -110,12 +110,12 @@ describe( 'useSelect', () => {
 		expect( selectSpyBar ).toHaveBeenCalledTimes( 0 );
 		expect( TestComponent ).toHaveBeenCalledTimes( 2 );
 
-		// ensure expected state was rendered
+		// Ensure expected state was rendered.
 		expect( testInstance.findByType( 'div' ).props ).toEqual( {
 			children: 'foo',
 		} );
 
-		// rerender with dependency changed
+		// Rerender with dependency changed.
 		act( () => {
 			renderer.update(
 				<RegistryProvider value={ registry }>
@@ -128,7 +128,7 @@ describe( 'useSelect', () => {
 		expect( selectSpyBar ).toHaveBeenCalledTimes( 2 );
 		expect( TestComponent ).toHaveBeenCalledTimes( 3 );
 
-		// ensure expected state was rendered
+		// Ensure expected state was rendered.
 		expect( testInstance.findByType( 'div' ).props ).toEqual( {
 			children: 'bar',
 		} );
@@ -189,7 +189,7 @@ describe( 'useSelect', () => {
 					);
 				} );
 				const testInstance = renderer.root;
-				// ensure expected state was rendered.
+				// Ensure expected state was rendered.
 				expect( testInstance.findByType( 'div' ).props.data ).toEqual(
 					valueA
 				);

package/src/components/with-select/test/index.js

@@ -131,7 +131,7 @@ describe( 'withSelect', () => {
 		expect( mapSelectToProps ).toHaveBeenCalledTimes( 2 );
 		expect( mapDispatchToProps ).toHaveBeenCalledTimes( 1 );
 
-		// Simulate a click on the button
+		// Simulate a click on the button.
 		act( () => {
 			testInstance.findByType( 'button' ).props.onClick();
 		} );
@@ -139,7 +139,7 @@ describe( 'withSelect', () => {
 		expect( testInstance.findByType( 'button' ).props.children ).toBe( 1 );
 		// 2 times =
 		//  1. Initial mount
-		//  2. When click handler is called
+		// 2. When click handler is called.
 		expect( mapDispatchToProps ).toHaveBeenCalledTimes( 2 );
 		// 4 times
 		// - 1 on initial render
@@ -147,7 +147,7 @@ describe( 'withSelect', () => {
 		// - 1 on click triggering subscription firing.
 		// - 1 on rerender.
 		expect( mapSelectToProps ).toHaveBeenCalledTimes( 4 );
-		// verifies component only renders twice.
+		// Verifies component only renders twice.
 		expect( OriginalComponent ).toHaveBeenCalledTimes( 2 );
 	} );
 

package/src/factory.js

@@ -36,7 +36,7 @@
  * @return {Function} Registry selector that can be registered with a store.
  */
 export function createRegistrySelector( registrySelector ) {
-	// create a selector function that is bound to the registry referenced by `selector.registry`
+	// Create a selector function that is bound to the registry referenced by `selector.registry`
 	// and that has the same API as a regular selector. Binding it in such a way makes it
 	// possible to call the selector directly from another selector.
 	const selector = ( ...args ) =>

package/src/plugins/persistence/index.js

@@ -222,6 +222,128 @@ function persistencePlugin( registry, pluginOptions ) {
 	};
 }
 
+/**
+ * Move the 'features' object in local storage from the sourceStoreName to the
+ * preferences store.
+ *
+ * @param {Object} persistence     The persistence interface.
+ * @param {string} sourceStoreName The name of the store that has persisted
+ *                                 preferences to migrate to the preferences
+ *                                 package.
+ */
+export function migrateFeaturePreferencesToPreferencesStore(
+	persistence,
+	sourceStoreName
+) {
+	const preferencesStoreName = 'core/preferences';
+	const interfaceStoreName = 'core/interface';
+
+	const state = persistence.get();
+
+	// Features most recently (and briefly) lived in the interface package.
+	// If data exists there, prioritize using that for the migration. If not
+	// also check the original package as the user may have updated from an
+	// older block editor version.
+	const interfaceFeatures =
+		state[ interfaceStoreName ]?.preferences?.features?.[ sourceStoreName ];
+	const sourceFeatures = state[ sourceStoreName ]?.preferences?.features;
+	const featuresToMigrate = interfaceFeatures
+		? interfaceFeatures
+		: sourceFeatures;
+
+	if ( featuresToMigrate ) {
+		const targetFeatures = state[ preferencesStoreName ]?.preferences;
+
+		// Avoid migrating features again if they've previously been migrated.
+		if ( ! targetFeatures?.[ sourceStoreName ] ) {
+			// Set the feature values in the interface store, the features
+			// object is keyed by 'scope', which matches the store name for
+			// the source.
+			persistence.set( preferencesStoreName, {
+				preferences: {
+					...targetFeatures,
+					[ sourceStoreName ]: featuresToMigrate,
+				},
+			} );
+
+			// Remove migrated feature preferences from `interface`.
+			if ( interfaceFeatures ) {
+				const otherInterfaceFeatures =
+					state[ interfaceStoreName ]?.preferences?.features;
+
+				persistence.set( interfaceStoreName, {
+					preferences: {
+						features: {
+							...otherInterfaceFeatures,
+							[ sourceStoreName ]: undefined,
+						},
+					},
+				} );
+			}
+
+			// Remove migrated feature preferences from the source.
+			if ( sourceFeatures ) {
+				const sourcePreferences = state[ sourceStoreName ]?.preferences;
+
+				persistence.set( sourceStoreName, {
+					preferences: {
+						...sourcePreferences,
+						features: undefined,
+					},
+				} );
+			}
+		}
+	}
+}
+
+export function migrateIndividualPreferenceToPreferencesStore(
+	persistence,
+	sourceStoreName,
+	key
+) {
+	const preferencesStoreName = 'core/preferences';
+	const state = persistence.get();
+	const sourcePreference = state[ sourceStoreName ]?.preferences?.[ key ];
+
+	// There's nothing to migrate, exit early.
+	if ( ! sourcePreference ) {
+		return;
+	}
+
+	const targetPreference =
+		state[ preferencesStoreName ]?.preferences?.[ sourceStoreName ]?.[
+			key
+		];
+
+	// There's existing data at the target, so don't overwrite it, exit early.
+	if ( targetPreference ) {
+		return;
+	}
+
+	const allPreferences = state[ preferencesStoreName ]?.preferences;
+	const targetPreferences =
+		state[ preferencesStoreName ]?.preferences?.[ sourceStoreName ];
+
+	persistence.set( preferencesStoreName, {
+		preferences: {
+			...allPreferences,
+			[ sourceStoreName ]: {
+				...targetPreferences,
+				[ key ]: sourcePreference,
+			},
+		},
+	} );
+
+	// Remove migrated feature preferences from the source.
+	const allSourcePreferences = state[ sourceStoreName ]?.preferences;
+	persistence.set( sourceStoreName, {
+		preferences: {
+			...allSourcePreferences,
+			[ key ]: undefined,
+		},
+	} );
+}
+
 /**
  * Move the 'features' object in local storage from the sourceStoreName to the
  * interface store.
@@ -269,23 +391,35 @@ export function migrateFeaturePreferencesToInterfaceStore(
 	}
 }
 
-/**
- * Deprecated: Remove this function and the code in WordPress Core that calls
- * it once WordPress 6.0 is released.
- */
-
 persistencePlugin.__unstableMigrate = ( pluginOptions ) => {
 	const persistence = createPersistenceInterface( pluginOptions );
 
-	migrateFeaturePreferencesToInterfaceStore(
+	migrateFeaturePreferencesToPreferencesStore(
 		persistence,
 		'core/edit-widgets'
 	);
-	migrateFeaturePreferencesToInterfaceStore(
+	migrateFeaturePreferencesToPreferencesStore(
 		persistence,
 		'core/customize-widgets'
 	);
-	migrateFeaturePreferencesToInterfaceStore( persistence, 'core/edit-post' );
+	migrateFeaturePreferencesToPreferencesStore(
+		persistence,
+		'core/edit-post'
+	);
+	migrateIndividualPreferenceToPreferencesStore(
+		persistence,
+		'core/edit-post',
+		'hiddenBlockTypes'
+	);
+	migrateFeaturePreferencesToPreferencesStore(
+		persistence,
+		'core/edit-site'
+	);
+	migrateIndividualPreferenceToPreferencesStore(
+		persistence,
+		'core/edit-site',
+		'editorMode'
+	);
 };
 
 export default persistencePlugin;