@wordpress/edit-post 6.0.1 → 6.0.2

package/src/store/actions.js

@@ -7,10 +7,9 @@ import { castArray, reduce } from 'lodash';
  * WordPress dependencies
  */
 import { __ } from '@wordpress/i18n';
-import { apiFetch } from '@wordpress/data-controls';
-import { store as interfaceStore } from '@wordpress/interface';
-import { controls, select, subscribe, dispatch } from '@wordpress/data';
+import apiFetch from '@wordpress/api-fetch';
 import { speak } from '@wordpress/a11y';
+import { store as interfaceStore } from '@wordpress/interface';
 import { store as noticesStore } from '@wordpress/notices';
 import { store as coreStore } from '@wordpress/core-data';
 import { store as blockEditorStore } from '@wordpress/block-editor';
@@ -21,34 +20,24 @@ import { store as editorStore } from '@wordpress/editor';
  */
 import { getMetaBoxContainer } from '../utils/meta-boxes';
 import { store as editPostStore } from '.';
+
 /**
  * Returns an action object used in signalling that the user opened an editor sidebar.
  *
  * @param {?string} name Sidebar name to be opened.
- *
- * @yield {Object} Action object.
  */
-export function* openGeneralSidebar( name ) {
-	yield controls.dispatch(
-		interfaceStore,
-		'enableComplementaryArea',
-		editPostStore.name,
-		name
-	);
-}
+export const openGeneralSidebar = ( name ) => ( { registry } ) =>
+	registry
+		.dispatch( interfaceStore )
+		.enableComplementaryArea( editPostStore.name, name );
 
 /**
  * Returns an action object signalling that the user closed the sidebar.
- *
- * @yield {Object} Action object.
  */
-export function* closeGeneralSidebar() {
-	yield controls.dispatch(
-		interfaceStore,
-		'disableComplementaryArea',
-		editPostStore.name
-	);
-}
+export const closeGeneralSidebar = () => ( { registry } ) =>
+	registry
+		.dispatch( interfaceStore )
+		.disableComplementaryArea( editPostStore.name );
 
 /**
  * Returns an action object used in signalling that the user opened a modal.
@@ -157,24 +146,20 @@ export function removeEditorPanel( panelName ) {
  *
  * @param {string} feature Feature name.
  */
-export function* toggleFeature( feature ) {
-	yield controls.dispatch(
-		interfaceStore.name,
-		'toggleFeature',
-		'core/edit-post',
-		feature
-	);
-}
+export const toggleFeature = ( feature ) => ( { registry } ) =>
+	registry
+		.dispatch( interfaceStore )
+		.toggleFeature( 'core/edit-post', feature );
 
-export function* switchEditorMode( mode ) {
-	yield {
+export const switchEditorMode = ( mode ) => ( { dispatch, registry } ) => {
+	dispatch( {
 		type: 'SWITCH_MODE',
 		mode,
-	};
+	} );
 
 	// Unselect blocks when we switch to the code editor.
 	if ( mode !== 'visual' ) {
-		yield controls.dispatch( blockEditorStore, 'clearSelectedBlock' );
+		registry.dispatch( blockEditorStore ).clearSelectedBlock();
 	}
 
 	const message =
@@ -182,28 +167,22 @@ export function* switchEditorMode( mode ) {
 			? __( 'Visual editor selected' )
 			: __( 'Code editor selected' );
 	speak( message, 'assertive' );
-}
+};
 
 /**
  * Triggers an action object used to toggle a plugin name flag.
  *
  * @param {string} pluginName Plugin name.
  */
-export function* togglePinnedPluginItem( pluginName ) {
-	const isPinned = yield controls.select(
-		interfaceStore,
-		'isItemPinned',
-		'core/edit-post',
-		pluginName
-	);
+export const togglePinnedPluginItem = ( pluginName ) => ( { registry } ) => {
+	const isPinned = registry
+		.select( interfaceStore )
+		.isItemPinned( 'core/edit-post', pluginName );
 
-	yield controls.dispatch(
-		interfaceStore,
-		isPinned ? 'unpinItem' : 'pinItem',
-		'core/edit-post',
-		pluginName
-	);
-}
+	registry
+		.dispatch( interfaceStore )
+		[ isPinned ? 'unpinItem' : 'pinItem' ]( 'core/edit-post', pluginName );
+};
 
 /**
  * Returns an action object used in signalling that block types by the given
@@ -270,25 +249,26 @@ export function showBlockTypes( blockNames ) {
  * what Meta boxes are available in which location.
  *
  * @param {Object} metaBoxesPerLocation Meta boxes per location.
- *
- * @yield {Object} Action object.
  */
-export function* setAvailableMetaBoxesPerLocation( metaBoxesPerLocation ) {
-	yield {
+export const setAvailableMetaBoxesPerLocation = ( metaBoxesPerLocation ) => ( {
+	dispatch,
+} ) =>
+	dispatch( {
 		type: 'SET_META_BOXES_PER_LOCATIONS',
 		metaBoxesPerLocation,
-	};
-}
+	} );
 
 /**
- * Returns an action object used to request meta box update.
- *
- * @yield {Object} Action object.
+ * Update a metabox.
  */
-export function* requestMetaBoxUpdates() {
-	yield {
+export const requestMetaBoxUpdates = () => async ( {
+	registry,
+	select,
+	dispatch,
+} ) => {
+	dispatch( {
 		type: 'REQUEST_META_BOX_UPDATES',
-	};
+	} );
 
 	// Saves the wp_editor fields
 	if ( window.tinyMCE ) {
@@ -297,7 +277,7 @@ export function* requestMetaBoxUpdates() {
 
 	// Additional data needed for backward compatibility.
 	// If we do not provide this data, the post will be overridden with the default values.
-	const post = yield controls.select( editorStore, 'getCurrentPost' );
+	const post = registry.select( editorStore ).getCurrentPost();
 	const additionalData = [
 		post.comment_status ? [ 'comment_status', post.comment_status ] : false,
 		post.ping_status ? [ 'ping_status', post.ping_status ] : false,
@@ -309,10 +289,7 @@ export function* requestMetaBoxUpdates() {
 	const baseFormData = new window.FormData(
 		document.querySelector( '.metabox-base-form' )
 	);
-	const activeMetaBoxLocations = yield controls.select(
-		editPostStore,
-		'getActiveMetaBoxLocations'
-	);
+	const activeMetaBoxLocations = select.getActiveMetaBoxLocations();
 	const formDataToMerge = [
 		baseFormData,
 		...activeMetaBoxLocations.map(
@@ -338,17 +315,17 @@ export function* requestMetaBoxUpdates() {
 
 	try {
 		// Save the metaboxes
-		yield apiFetch( {
+		await apiFetch( {
 			url: window._wpMetaBoxUrl,
 			method: 'POST',
 			body: formData,
 			parse: false,
 		} );
-		yield controls.dispatch( editPostStore, 'metaBoxUpdatesSuccess' );
+		dispatch.metaBoxUpdatesSuccess();
 	} catch {
-		yield controls.dispatch( editPostStore, 'metaBoxUpdatesFailure' );
+		dispatch.metaBoxUpdatesFailure();
 	}
-}
+};
 
 /**
  * Returns an action object used to signal a successful meta box update.
@@ -436,93 +413,80 @@ export function setIsEditingTemplate( value ) {
  *
  * @param {boolean} newTemplate Is new template.
  */
-export function* __unstableSwitchToTemplateMode( newTemplate = false ) {
-	yield setIsEditingTemplate( true );
-
-	const isWelcomeGuideActive = yield controls.select(
-		editPostStore,
-		'isFeatureActive',
+export const __unstableSwitchToTemplateMode = ( newTemplate = false ) => ( {
+	registry,
+	select,
+	dispatch,
+} ) => {
+	dispatch( setIsEditingTemplate( true ) );
+	const isWelcomeGuideActive = select.isFeatureActive(
 		'welcomeGuideTemplate'
 	);
-
 	if ( ! isWelcomeGuideActive ) {
 		const message = newTemplate
 			? __( "Custom template created. You're in template mode now." )
 			: __(
 					'Editing template. Changes made here affect all posts and pages that use the template.'
 			  );
-		yield controls.dispatch( noticesStore, 'createSuccessNotice', message, {
+		registry.dispatch( noticesStore ).createSuccessNotice( message, {
 			type: 'snackbar',
 		} );
 	}
-}
+};
 
 /**
  * Create a block based template.
  *
  * @param {Object?} template Template to create and assign.
  */
-export function* __unstableCreateTemplate( template ) {
-	const savedTemplate = yield controls.dispatch(
-		coreStore,
-		'saveEntityRecord',
-		'postType',
-		'wp_template',
-		template
-	);
-	const post = yield controls.select( editorStore, 'getCurrentPost' );
-
-	yield controls.dispatch(
-		coreStore,
-		'editEntityRecord',
-		'postType',
-		post.type,
-		post.id,
-		{
+export const __unstableCreateTemplate = ( template ) => async ( {
+	registry,
+} ) => {
+	const savedTemplate = await registry
+		.dispatch( coreStore )
+		.saveEntityRecord( 'postType', 'wp_template', template );
+	const post = registry.select( editorStore ).getCurrentPost();
+	registry
+		.dispatch( coreStore )
+		.editEntityRecord( 'postType', post.type, post.id, {
 			template: savedTemplate.slug,
-		}
-	);
-}
+		} );
+};
 
 let metaBoxesInitialized = false;
 
 /**
  * Initializes WordPress `postboxes` script and the logic for saving meta boxes.
  */
-export function* initializeMetaBoxes() {
-	const isEditorReady = yield controls.select(
-		editorStore,
-		'__unstableIsEditorReady'
-	);
+export const initializeMetaBoxes = () => ( { registry, select, dispatch } ) => {
+	const isEditorReady = registry
+		.select( editorStore )
+		.__unstableIsEditorReady();
 
 	if ( ! isEditorReady ) {
 		return;
 	}
-
-	const postType = yield controls.select( editorStore, 'getCurrentPostType' );
-
 	// Only initialize once.
 	if ( metaBoxesInitialized ) {
 		return;
 	}
-
+	const postType = registry.select( editorStore ).getCurrentPostType();
 	if ( window.postboxes.page !== postType ) {
 		window.postboxes.add_postbox_toggles( postType );
 	}
 
 	metaBoxesInitialized = true;
 
-	let wasSavingPost = yield controls.select( editorStore, 'isSavingPost' );
-	let wasAutosavingPost = yield controls.select(
-		editorStore,
-		'isAutosavingPost'
-	);
-	const hasMetaBoxes = yield controls.select( editPostStore, 'hasMetaBoxes' );
+	let wasSavingPost = registry.select( editorStore ).isSavingPost();
+	let wasAutosavingPost = registry.select( editorStore ).isAutosavingPost();
+	const hasMetaBoxes = select.hasMetaBoxes();
 
 	// Save metaboxes when performing a full save on the post.
-	subscribe( () => {
-		const isSavingPost = select( editorStore ).isSavingPost();
-		const isAutosavingPost = select( editorStore ).isAutosavingPost();
+	registry.subscribe( async () => {
+		const isSavingPost = registry.select( editorStore ).isSavingPost();
+		const isAutosavingPost = registry
+			.select( editorStore )
+			.isAutosavingPost();
 
 		// Save metaboxes on save completion, except for autosaves that are not a post preview.
 		//
@@ -541,11 +505,11 @@ export function* initializeMetaBoxes() {
 		wasAutosavingPost = isAutosavingPost;
 
 		if ( shouldTriggerMetaboxesSave ) {
-			dispatch( editPostStore ).requestMetaBoxUpdates();
+			await dispatch.requestMetaBoxUpdates();
 		}
 	} );
 
-	return {
+	dispatch( {
 		type: 'META_BOXES_INITIALIZED',
-	};
-}
+	} );
+};

package/src/store/index.js

@@ -2,7 +2,6 @@
  * WordPress dependencies
  */
 import { createReduxStore, registerStore } from '@wordpress/data';
-import { controls } from '@wordpress/data-controls';
 
 /**
  * Internal dependencies
@@ -16,7 +15,6 @@ const storeConfig = {
 	reducer,
 	actions,
 	selectors,
-	controls,
 	persist: [ 'preferences' ],
 };
 

package/src/store/test/actions.js

@@ -1,120 +1,130 @@
 /**
  * WordPress dependencies
  */
-import { controls } from '@wordpress/data';
+import { createRegistry } from '@wordpress/data';
+import { store as interfaceStore } from '@wordpress/interface';
+import { store as noticesStore } from '@wordpress/notices';
+import { store as coreStore } from '@wordpress/core-data';
+import { store as blockEditorStore } from '@wordpress/block-editor';
+import { store as editorStore } from '@wordpress/editor';
 
 /**
  * Internal dependencies
  */
-import {
-	toggleEditorPanelEnabled,
-	toggleEditorPanelOpened,
-	removeEditorPanel,
-	openPublishSidebar,
-	closePublishSidebar,
-	togglePublishSidebar,
-	openModal,
-	closeModal,
-	requestMetaBoxUpdates,
-	setIsListViewOpened,
-} from '../actions';
+import { store as editPostStore } from '..';
+
+function createRegistryWithStores() {
+	// Create a registry and register used stores.
+	const registry = createRegistry();
+	[
+		editPostStore,
+		noticesStore,
+		blockEditorStore,
+		coreStore,
+		interfaceStore,
+		editorStore,
+	].forEach( registry.register );
+	return registry;
+}
 
 describe( 'actions', () => {
-	describe( 'openPublishSidebar', () => {
-		it( 'should return an OPEN_PUBLISH_SIDEBAR action', () => {
-			expect( openPublishSidebar() ).toEqual( {
-				type: 'OPEN_PUBLISH_SIDEBAR',
-			} );
-		} );
+	let registry;
+	beforeEach( () => {
+		registry = createRegistryWithStores();
 	} );
+	it( 'openGeneralSidebar/closeGeneralSidebar', () => {
+		registry.dispatch( editPostStore ).openGeneralSidebar( 'test/sidebar' );
+		expect(
+			registry
+				.select( interfaceStore )
+				.getActiveComplementaryArea( 'core/edit-post' )
+		).toBe( 'test/sidebar' );
 
-	describe( 'closePublishSidebar', () => {
-		it( 'should return an CLOSE_PUBLISH_SIDEBAR action', () => {
-			expect( closePublishSidebar() ).toEqual( {
-				type: 'CLOSE_PUBLISH_SIDEBAR',
-			} );
-		} );
+		registry
+			.dispatch( editPostStore )
+			.closeGeneralSidebar( 'test/sidebar' );
+		expect(
+			registry
+				.select( interfaceStore )
+				.getActiveComplementaryArea( 'core/edit-post' )
+		).toBeNull();
 	} );
+	it( 'toggleFeature', () => {
+		registry.dispatch( editPostStore ).toggleFeature( 'welcomeGuide' );
+		expect(
+			registry
+				.select( interfaceStore )
+				.isFeatureActive( editPostStore.name, 'welcomeGuide' )
+		).toBe( true );
 
-	describe( 'togglePublishSidebar', () => {
-		it( 'should return an TOGGLE_PUBLISH_SIDEBAR action', () => {
-			expect( togglePublishSidebar() ).toEqual( {
-				type: 'TOGGLE_PUBLISH_SIDEBAR',
-			} );
-		} );
+		registry.dispatch( editPostStore ).toggleFeature( 'welcomeGuide' );
+		expect(
+			registry
+				.select( interfaceStore )
+				.isFeatureActive( editPostStore.name, 'welcomeGuide' )
+		).toBe( false );
 	} );
-
-	describe( 'removeEditorPanel', () => {
-		it( 'should return a REMOVE_PANEL action', () => {
-			expect( removeEditorPanel( 'post-status' ) ).toEqual( {
-				type: 'REMOVE_PANEL',
-				panelName: 'post-status',
-			} );
+	describe( 'switchEditorMode', () => {
+		it( 'to visual', () => {
+			registry.dispatch( editPostStore ).switchEditorMode( 'visual' );
+			expect( registry.select( editPostStore ).getEditorMode() ).toEqual(
+				'visual'
+			);
 		} );
-	} );
+		it( 'to text', () => {
+			// Add a selected client id and make sure it's there.
+			const clientId = 'clientId_1';
+			registry.dispatch( blockEditorStore ).selectionChange( clientId );
+			expect(
+				registry.select( blockEditorStore ).getSelectedBlockClientId()
+			).toEqual( clientId );
 
-	describe( 'toggleEditorPanelEnabled', () => {
-		it( 'should return a TOGGLE_PANEL_ENABLED action', () => {
-			expect( toggleEditorPanelEnabled( 'post-status' ) ).toEqual( {
-				type: 'TOGGLE_PANEL_ENABLED',
-				panelName: 'post-status',
-			} );
+			registry.dispatch( editPostStore ).switchEditorMode( 'text' );
+			expect(
+				registry.select( blockEditorStore ).getSelectedBlockClientId()
+			).toBeNull();
 		} );
 	} );
-
-	describe( 'toggleEditorPanelOpened', () => {
-		it( 'should return a TOGGLE_PANEL_OPENED action', () => {
-			expect( toggleEditorPanelOpened( 'post-status' ) ).toEqual( {
-				type: 'TOGGLE_PANEL_OPENED',
-				panelName: 'post-status',
-			} );
-		} );
+	it( 'togglePinnedPluginItem', () => {
+		registry.dispatch( editPostStore ).togglePinnedPluginItem( 'rigatoni' );
+		// Sidebars are pinned by default.
+		// @See https://github.com/WordPress/gutenberg/pull/21645
+		expect(
+			registry
+				.select( interfaceStore )
+				.isItemPinned( editPostStore.name, 'rigatoni' )
+		).toBe( false );
+		registry.dispatch( editPostStore ).togglePinnedPluginItem( 'rigatoni' );
+		expect(
+			registry
+				.select( interfaceStore )
+				.isItemPinned( editPostStore.name, 'rigatoni' )
+		).toBe( true );
 	} );
-
-	describe( 'openModal', () => {
-		it( 'should return OPEN_MODAL action', () => {
-			const name = 'plugin/my-name';
-			expect( openModal( name ) ).toEqual( {
-				type: 'OPEN_MODAL',
-				name,
-			} );
+	describe( '__unstableSwitchToTemplateMode', () => {
+		it( 'welcome guide is active', () => {
+			// Activate `welcomeGuideTemplate` feature.
+			registry
+				.dispatch( editPostStore )
+				.toggleFeature( 'welcomeGuideTemplate' );
+			registry.dispatch( editPostStore ).__unstableSwitchToTemplateMode();
+			expect(
+				registry.select( editPostStore ).isEditingTemplate()
+			).toBeTruthy();
+			const notices = registry.select( noticesStore ).getNotices();
+			expect( notices ).toHaveLength( 0 );
 		} );
-	} );
-
-	describe( 'closeModal', () => {
-		it( 'should return CLOSE_MODAL action', () => {
-			expect( closeModal() ).toEqual( {
-				type: 'CLOSE_MODAL',
-			} );
-		} );
-	} );
-
-	describe( 'requestMetaBoxUpdates', () => {
-		it( 'should yield the REQUEST_META_BOX_UPDATES action', () => {
-			const fulfillment = requestMetaBoxUpdates();
-			expect( fulfillment.next() ).toEqual( {
-				done: false,
-				value: {
-					type: 'REQUEST_META_BOX_UPDATES',
-				},
-			} );
-			expect( fulfillment.next() ).toEqual( {
-				done: false,
-				value: controls.select( 'core/editor', 'getCurrentPost' ),
-			} );
-		} );
-	} );
-
-	describe( 'setIsListViewOpened', () => {
-		it( 'should return the SET_IS_LIST_VIEW_OPENED action', () => {
-			expect( setIsListViewOpened( true ) ).toEqual( {
-				type: 'SET_IS_LIST_VIEW_OPENED',
-				isOpen: true,
-			} );
-			expect( setIsListViewOpened( false ) ).toEqual( {
-				type: 'SET_IS_LIST_VIEW_OPENED',
-				isOpen: false,
-			} );
+		it( 'welcome guide is inactive', () => {
+			expect(
+				registry.select( editPostStore ).isEditingTemplate()
+			).toBeFalsy();
+			registry.dispatch( editPostStore ).__unstableSwitchToTemplateMode();
+			expect(
+				registry.select( editPostStore ).isEditingTemplate()
+			).toBeTruthy();
+			const notices = registry.select( noticesStore ).getNotices();
+			expect( notices ).toHaveLength( 1 );
+			expect( notices[ 0 ].content ).toMatch( 'template' );
 		} );
 	} );
 } );