@wordpress/edit-site 5.22.0 → 5.23.0

package/src/store/actions.js

@@ -31,11 +31,14 @@ import {
  */
 export function toggleFeature( featureName ) {
 	return function ( { registry } ) {
-		deprecated( "select( 'core/edit-site' ).toggleFeature( featureName )", {
-			since: '6.0',
-			alternative:
-				"select( 'core/preferences').toggle( 'core/edit-site', featureName )",
-		} );
+		deprecated(
+			"dispatch( 'core/edit-site' ).toggleFeature( featureName )",
+			{
+				since: '6.0',
+				alternative:
+					"dispatch( 'core/preferences').toggle( 'core/edit-site', featureName )",
+			}
+		);
 
 		registry
 			.dispatch( preferencesStore )
@@ -60,44 +63,38 @@ export function __experimentalSetPreviewDeviceType( deviceType ) {
 /**
  * Action that sets a template, optionally fetching it from REST API.
  *
- * @param {number} templateId   The template ID.
- * @param {string} templateSlug The template slug.
  * @return {Object} Action object.
  */
-export const setTemplate =
-	( templateId, templateSlug ) =>
-	async ( { dispatch, registry } ) => {
-		if ( ! templateSlug ) {
-			try {
-				const template = await registry
-					.resolveSelect( coreStore )
-					.getEntityRecord(
-						'postType',
-						TEMPLATE_POST_TYPE,
-						templateId
-					);
-				templateSlug = template?.slug;
-			} catch ( error ) {}
-		}
+export function setTemplate() {
+	deprecated( "dispatch( 'core/edit-site' ).setTemplate", {
+		since: '6.5',
+		version: '6.8',
+		hint: 'The setTemplate is not needed anymore, the correct entity is resolved from the URL automatically.',
+	} );
 
-		dispatch( {
-			type: 'SET_EDITED_POST',
-			postType: TEMPLATE_POST_TYPE,
-			id: templateId,
-			context: { templateSlug },
-		} );
+	return {
+		type: 'NOTHING',
 	};
+}
 
 /**
  * Action that adds a new template and sets it as the current template.
  *
  * @param {Object} template The template.
  *
+ * @deprecated
+ *
  * @return {Object} Action object used to set the current template.
  */
 export const addTemplate =
 	( template ) =>
 	async ( { dispatch, registry } ) => {
+		deprecated( "dispatch( 'core/edit-site' ).addTemplate", {
+			since: '6.5',
+			version: '6.8',
+			hint: 'use saveEntityRecord directly',
+		} );
+
 		const newTemplate = await registry
 			.dispatch( coreStore )
 			.saveEntityRecord( 'postType', TEMPLATE_POST_TYPE, template );
@@ -118,7 +115,6 @@ export const addTemplate =
 			type: 'SET_EDITED_POST',
 			postType: TEMPLATE_POST_TYPE,
 			id: newTemplate.id,
-			context: { templateSlug: newTemplate.slug },
 		} );
 	};
 
@@ -211,14 +207,16 @@ export function setNavigationMenu( navigationMenuId ) {
  *
  * @param {string} postType The entity's post type.
  * @param {string} postId   The entity's ID.
+ * @param {Object} context  The entity's context.
  *
  * @return {Object} Action object.
  */
-export function setEditedEntity( postType, postId ) {
+export function setEditedEntity( postType, postId, context ) {
 	return {
 		type: 'SET_EDITED_POST',
 		postType,
 		id: postId,
+		context,
 	};
 }
 
@@ -254,75 +252,19 @@ export function setEditedPostContext( context ) {
  * Resolves the template for a page and displays both. If no path is given, attempts
  * to use the postId to generate a path like `?p=${ postId }`.
  *
- * @param {Object} page         The page object.
- * @param {string} page.type    The page type.
- * @param {string} page.slug    The page slug.
- * @param {string} page.path    The page path.
- * @param {Object} page.context The page context.
+ * @deprecated
  *
  * @return {number} The resolved template ID for the page route.
  */
-export const setPage =
-	( page ) =>
-	async ( { dispatch, registry } ) => {
-		let template;
-		const getDefaultTemplate = async ( slug ) =>
-			apiFetch( {
-				path: addQueryArgs( '/wp/v2/templates/lookup', {
-					slug: `page-${ slug }`,
-				} ),
-			} );
-
-		if ( page.path ) {
-			template = await registry
-				.resolveSelect( coreStore )
-				.__experimentalGetTemplateForLink( page.path );
-		} else {
-			const editedEntity = await registry
-				.resolveSelect( coreStore )
-				.getEditedEntityRecord(
-					'postType',
-					page.context?.postType || 'post',
-					page.context?.postId
-				);
-			const currentTemplateSlug = editedEntity?.template;
-			if ( currentTemplateSlug ) {
-				const currentTemplate = (
-					await registry
-						.resolveSelect( coreStore )
-						.getEntityRecords( 'postType', TEMPLATE_POST_TYPE, {
-							per_page: -1,
-						} )
-				)?.find( ( { slug } ) => slug === currentTemplateSlug );
-				if ( currentTemplate ) {
-					template = currentTemplate;
-				} else {
-					// If a page has a `template` set and is not included in the list
-					// of the current theme's templates, query for current theme's default template.
-					template = await getDefaultTemplate( editedEntity?.slug );
-				}
-			} else {
-				// Page's `template` is empty, that indicates we need to use the default template for the page.
-				template = await getDefaultTemplate( editedEntity?.slug );
-			}
-		}
-
-		if ( ! template ) {
-			return;
-		}
-
-		dispatch( {
-			type: 'SET_EDITED_POST',
-			postType: TEMPLATE_POST_TYPE,
-			id: template.id,
-			context: {
-				...page.context,
-				templateSlug: template.slug,
-			},
-		} );
+export function setPage() {
+	deprecated( "dispatch( 'core/edit-site' ).setPage", {
+		since: '6.5',
+		version: '6.8',
+		hint: 'The setPage is not needed anymore, the correct entity is resolved from the URL automatically.',
+	} );
 
-		return template.id;
-	};
+	return { type: 'NOTHING' };
+}
 
 /**
  * Action that sets the active navigation panel menu.

package/src/store/selectors.js

@@ -1,15 +1,9 @@
-/**
- * External dependencies
- */
-import createSelector from 'rememo';
-
 /**
  * WordPress dependencies
  */
 import { store as coreDataStore } from '@wordpress/core-data';
 import { createRegistrySelector } from '@wordpress/data';
 import deprecated from '@wordpress/deprecated';
-import { uploadMedia } from '@wordpress/media-utils';
 import { Platform } from '@wordpress/element';
 import { store as preferencesStore } from '@wordpress/preferences';
 import { store as blockEditorStore } from '@wordpress/block-editor';
@@ -18,28 +12,11 @@ import { store as blockEditorStore } from '@wordpress/block-editor';
  * Internal dependencies
  */
 import { getFilteredTemplatePartBlocks } from './utils';
-import {
-	TEMPLATE_POST_TYPE,
-	TEMPLATE_PART_POST_TYPE,
-} from '../utils/constants';
+import { TEMPLATE_PART_POST_TYPE } from '../utils/constants';
 /**
  * @typedef {'template'|'template_type'} TemplateType Template type.
  */
 
-/**
- * Helper for getting a preference from the preferences store.
- *
- * This is only present so that `getSettings` doesn't need to be made a
- * registry selector.
- *
- * It's unstable because the selector needs to be exported and so part of the
- * public API to work.
- */
-export const __unstableGetPreference = createRegistrySelector(
-	( select ) => ( state, name ) =>
-		select( preferencesStore ).get( 'core/edit-site', name )
-);
-
 /**
  * Returns whether the given feature is enabled or not.
  *
@@ -49,14 +26,19 @@ export const __unstableGetPreference = createRegistrySelector(
  *
  * @return {boolean} Is active.
  */
-export function isFeatureActive( state, featureName ) {
-	deprecated( `select( 'core/edit-site' ).isFeatureActive`, {
-		since: '6.0',
-		alternative: `select( 'core/preferences' ).get`,
-	} );
+export const isFeatureActive = createRegistrySelector(
+	( select ) => ( _, featureName ) => {
+		deprecated( `select( 'core/edit-site' ).isFeatureActive`, {
+			since: '6.0',
+			alternative: `select( 'core/preferences' ).get`,
+		} );
 
-	return !! __unstableGetPreference( state, featureName );
-}
+		return !! select( preferencesStore ).get(
+			'core/edit-site',
+			featureName
+		);
+	}
+);
 
 /**
  * Returns the current editing canvas device type.
@@ -88,6 +70,13 @@ export const getCanUserCreateMedia = createRegistrySelector(
  * @return {Array} The available reusable blocks.
  */
 export const getReusableBlocks = createRegistrySelector( ( select ) => () => {
+	deprecated(
+		"select( 'core/core' ).getEntityRecords( 'postType', 'wp_block' )",
+		{
+			since: '6.5',
+			version: '6.8',
+		}
+	);
 	const isWeb = Platform.OS === 'web';
 	return isWeb
 		? select( coreDataStore ).getEntityRecords( 'postType', 'wp_block', {
@@ -97,67 +86,18 @@ export const getReusableBlocks = createRegistrySelector( ( select ) => () => {
 } );
 
 /**
- * Returns the settings, taking into account active features and permissions.
+ * Returns the site editor settings.
  *
- * @param {Object}   state             Global application state.
- * @param {Function} setIsInserterOpen Setter for the open state of the global inserter.
+ * @param {Object} state Global application state.
  *
  * @return {Object} Settings.
  */
-export const getSettings = createSelector(
-	( state, setIsInserterOpen ) => {
-		const settings = {
-			...state.settings,
-			outlineMode: true,
-			focusMode: !! __unstableGetPreference( state, 'focusMode' ),
-			isDistractionFree: !! __unstableGetPreference(
-				state,
-				'distractionFree'
-			),
-			hasFixedToolbar: !! __unstableGetPreference(
-				state,
-				'fixedToolbar'
-			),
-			keepCaretInsideBlock: !! __unstableGetPreference(
-				state,
-				'keepCaretInsideBlock'
-			),
-			showIconLabels: !! __unstableGetPreference(
-				state,
-				'showIconLabels'
-			),
-			__experimentalSetIsInserterOpened: setIsInserterOpen,
-			__experimentalReusableBlocks: getReusableBlocks( state ),
-			__experimentalPreferPatternsOnRoot:
-				TEMPLATE_POST_TYPE === getEditedPostType( state ),
-		};
-
-		const canUserCreateMedia = getCanUserCreateMedia( state );
-		if ( ! canUserCreateMedia ) {
-			return settings;
-		}
-
-		settings.mediaUpload = ( { onError, ...rest } ) => {
-			uploadMedia( {
-				wpAllowedMimeTypes: state.settings.allowedMimeTypes,
-				onError: ( { message } ) => onError( message ),
-				...rest,
-			} );
-		};
-		return settings;
-	},
-	( state ) => [
-		getCanUserCreateMedia( state ),
-		state.settings,
-		__unstableGetPreference( state, 'focusMode' ),
-		__unstableGetPreference( state, 'distractionFree' ),
-		__unstableGetPreference( state, 'fixedToolbar' ),
-		__unstableGetPreference( state, 'keepCaretInsideBlock' ),
-		__unstableGetPreference( state, 'showIconLabels' ),
-		getReusableBlocks( state ),
-		getEditedPostType( state ),
-	]
-);
+export function getSettings( state ) {
+	// It is important that we don't inject anything into these settings locally.
+	// The reason for this is that we have an effect in place that calls setSettings based on the previous value of getSettings.
+	// If we add computed settings here, we'll be adding these computed settings to the state which is very unexpected.
+	return state.settings;
+}
 
 /**
  * @deprecated
@@ -317,9 +257,9 @@ export const getCurrentTemplateTemplateParts = createRegistrySelector(
  *
  * @return {string} Editing mode.
  */
-export function getEditorMode( state ) {
-	return __unstableGetPreference( state, 'editorMode' );
-}
+export const getEditorMode = createRegistrySelector( ( select ) => () => {
+	return select( preferencesStore ).get( 'core/edit-site', 'editorMode' );
+} );
 
 /**
  * @deprecated

package/src/store/test/actions.js

@@ -1,7 +1,6 @@
 /**
  * WordPress dependencies
  */
-import apiFetch from '@wordpress/api-fetch';
 import { store as blockEditorStore } from '@wordpress/block-editor';
 import { store as coreStore } from '@wordpress/core-data';
 import { createRegistry } from '@wordpress/data';
@@ -15,18 +14,6 @@ import { store as preferencesStore } from '@wordpress/preferences';
 import { store as editSiteStore } from '..';
 import { setHasPageContentFocus } from '../actions';
 
-const ENTITY_TYPES = {
-	wp_template: {
-		description: 'Templates to include in your theme.',
-		hierarchical: false,
-		name: 'Templates',
-		rest_base: 'templates',
-		rest_namespace: 'wp/v2',
-		slug: 'wp_template',
-		taxonomies: [],
-	},
-};
-
 function createRegistryWithStores() {
 	// create a registry
 	const registry = createRegistry();
@@ -47,21 +34,27 @@ describe( 'actions', () => {
 		it( 'should toggle a feature flag', () => {
 			const registry = createRegistryWithStores();
 
-			// Should default to false.
+			// Should start as undefined.
 			expect(
-				registry.select( editSiteStore ).isFeatureActive( 'name' )
-			).toBe( false );
+				registry
+					.select( preferencesStore )
+					.get( 'core/edit-site', 'name' )
+			).toBe( undefined );
 
 			// Toggle on.
 			registry.dispatch( editSiteStore ).toggleFeature( 'name' );
 			expect(
-				registry.select( editSiteStore ).isFeatureActive( 'name' )
+				registry
+					.select( preferencesStore )
+					.get( 'core/edit-site', 'name' )
 			).toBe( true );
 
 			// Toggle off again.
 			registry.dispatch( editSiteStore ).toggleFeature( 'name' );
 			expect(
-				registry.select( editSiteStore ).isFeatureActive( 'name' )
+				registry
+					.select( preferencesStore )
+					.get( 'core/edit-site', 'name' )
 			).toBe( false );
 
 			// Expect a deprecation warning.
@@ -69,86 +62,6 @@ describe( 'actions', () => {
 		} );
 	} );
 
-	describe( 'setTemplate', () => {
-		const ID = 1;
-		const SLUG = 'archive';
-
-		it( 'should set the template when slug is provided', async () => {
-			const registry = createRegistryWithStores();
-
-			await registry.dispatch( editSiteStore ).setTemplate( ID, SLUG );
-
-			const select = registry.select( editSiteStore );
-			expect( select.getEditedPostId() ).toBe( ID );
-			expect( select.getEditedPostContext().templateSlug ).toBe( SLUG );
-		} );
-
-		it( 'should set the template by fetching the template slug', async () => {
-			const registry = createRegistryWithStores();
-
-			apiFetch.setFetchHandler( async ( options ) => {
-				const { method = 'GET', path } = options;
-				if ( method === 'GET' ) {
-					if ( path.startsWith( '/wp/v2/types' ) ) {
-						return ENTITY_TYPES;
-					}
-
-					if ( path.startsWith( `/wp/v2/templates/${ ID }` ) ) {
-						return { id: ID, slug: SLUG };
-					}
-				}
-
-				throw {
-					code: 'unknown_path',
-					message: `Unknown path: ${ method } ${ path }`,
-				};
-			} );
-
-			await registry.dispatch( editSiteStore ).setTemplate( ID );
-
-			const select = registry.select( editSiteStore );
-			expect( select.getEditedPostId() ).toBe( ID );
-			expect( select.getEditedPostContext().templateSlug ).toBe( SLUG );
-		} );
-	} );
-
-	describe( 'addTemplate', () => {
-		it( 'should issue a REST request to create the template and then set it', async () => {
-			const registry = createRegistryWithStores();
-
-			const ID = 1;
-			const SLUG = 'index';
-
-			apiFetch.setFetchHandler( async ( options ) => {
-				const { method = 'GET', path, data } = options;
-
-				if ( method === 'GET' && path.startsWith( '/wp/v2/types' ) ) {
-					return ENTITY_TYPES;
-				}
-
-				if (
-					method === 'POST' &&
-					path.startsWith( '/wp/v2/templates' )
-				) {
-					return { id: ID, slug: data.slug };
-				}
-
-				throw {
-					code: 'unknown_path',
-					message: `Unknown path: ${ method } ${ path }`,
-				};
-			} );
-
-			await registry
-				.dispatch( editSiteStore )
-				.addTemplate( { slug: SLUG } );
-
-			const select = registry.select( editSiteStore );
-			expect( select.getEditedPostId() ).toBe( ID );
-			expect( select.getEditedPostContext().templateSlug ).toBe( SLUG );
-		} );
-	} );
-
 	describe( 'setTemplatePart', () => {
 		it( 'should set template part', () => {
 			const registry = createRegistryWithStores();
@@ -162,45 +75,6 @@ describe( 'actions', () => {
 		} );
 	} );
 
-	describe( 'setPage', () => {
-		it( 'should find the template and then set the page', async () => {
-			const registry = createRegistryWithStores();
-
-			const ID = 'emptytheme//single';
-			const SLUG = 'single';
-
-			apiFetch.setFetchHandler( async ( options ) => {
-				const { method = 'GET', path, url } = options;
-
-				// Called with url arg in `__experimentalGetTemplateForLink`
-				if ( url ) {
-					return { data: { id: ID, slug: SLUG } };
-				}
-
-				if ( method === 'GET' ) {
-					if ( path.startsWith( '/wp/v2/types' ) ) {
-						return ENTITY_TYPES;
-					}
-
-					if ( path.startsWith( `/wp/v2/templates/${ ID }` ) ) {
-						return { id: ID, slug: SLUG };
-					}
-				}
-
-				throw {
-					code: 'unknown_path',
-					message: `Unknown path: ${ method } ${ path }`,
-				};
-			} );
-
-			await registry.dispatch( editSiteStore ).setPage( { path: '/' } );
-
-			const select = registry.select( editSiteStore );
-			expect( select.getEditedPostId() ).toBe( 'emptytheme//single' );
-			expect( select.getEditedPostType() ).toBe( 'wp_template' );
-		} );
-	} );
-
 	describe( 'setIsListViewOpened', () => {
 		it( 'should set the list view opened state', () => {
 			const registry = createRegistryWithStores();

package/src/store/test/selectors.js

@@ -8,30 +8,19 @@ import { store as coreDataStore } from '@wordpress/core-data';
  */
 import {
 	getCanUserCreateMedia,
-	getSettings,
 	getEditedPostType,
 	getEditedPostId,
-	getReusableBlocks,
 	isInserterOpened,
 	isListViewOpened,
-	__unstableGetPreference,
 	isPage,
 	hasPageContentFocus,
 } from '../selectors';
 
 describe( 'selectors', () => {
 	const canUser = jest.fn( () => true );
-	const getEntityRecords = jest.fn( () => [] );
-	const get = jest.fn();
 	getCanUserCreateMedia.registry = {
 		select: jest.fn( () => ( { canUser } ) ),
 	};
-	getReusableBlocks.registry = {
-		select: jest.fn( () => ( { getEntityRecords } ) ),
-	};
-	__unstableGetPreference.registry = {
-		select: jest.fn( () => ( { get } ) ),
-	};
 
 	describe( 'getCanUserCreateMedia', () => {
 		it( "selects `canUser( 'create', 'media' )` from the core store", () => {
@@ -43,77 +32,6 @@ describe( 'selectors', () => {
 		} );
 	} );
 
-	describe( 'getReusableBlocks', () => {
-		it( "selects `getEntityRecords( 'postType', 'wp_block' )` from the core store", () => {
-			expect( getReusableBlocks() ).toEqual( [] );
-			expect( getReusableBlocks.registry.select ).toHaveBeenCalledWith(
-				coreDataStore
-			);
-			expect( getEntityRecords ).toHaveBeenCalledWith(
-				'postType',
-				'wp_block',
-				{
-					per_page: -1,
-				}
-			);
-		} );
-	} );
-
-	describe( 'getSettings', () => {
-		it( "returns the settings when the user can't create media", () => {
-			canUser.mockReturnValueOnce( false );
-			canUser.mockReturnValueOnce( false );
-			get.mockImplementation( ( scope, name ) => {
-				if ( name === 'focusMode' ) return false;
-				if ( name === 'fixedToolbar' ) return false;
-			} );
-			const state = {
-				settings: {},
-				preferences: {},
-				editedPost: { postType: 'wp_template' },
-			};
-			const setInserterOpened = () => {};
-			expect( getSettings( state, setInserterOpened ) ).toEqual( {
-				outlineMode: true,
-				focusMode: false,
-				hasFixedToolbar: false,
-				isDistractionFree: false,
-				keepCaretInsideBlock: false,
-				showIconLabels: false,
-				__experimentalSetIsInserterOpened: setInserterOpened,
-				__experimentalReusableBlocks: [],
-				__experimentalPreferPatternsOnRoot: true,
-			} );
-		} );
-
-		it( 'returns the extended settings when the user can create media', () => {
-			get.mockImplementation( ( scope, name ) => {
-				if ( name === 'focusMode' ) return true;
-				if ( name === 'fixedToolbar' ) return true;
-			} );
-
-			const state = {
-				settings: { key: 'value' },
-				editedPost: { postType: 'wp_template_part' },
-			};
-			const setInserterOpened = () => {};
-
-			expect( getSettings( state, setInserterOpened ) ).toEqual( {
-				outlineMode: true,
-				key: 'value',
-				focusMode: true,
-				hasFixedToolbar: true,
-				isDistractionFree: false,
-				keepCaretInsideBlock: false,
-				showIconLabels: false,
-				__experimentalSetIsInserterOpened: setInserterOpened,
-				__experimentalReusableBlocks: [],
-				mediaUpload: expect.any( Function ),
-				__experimentalPreferPatternsOnRoot: false,
-			} );
-		} );
-	} );
-
 	describe( 'getEditedPostId', () => {
 		it( 'returns the template ID', () => {
 			const state = { editedPost: { id: 10 } };

package/src/style.scss

@@ -39,6 +39,7 @@
 @import "./components/sidebar-navigation-screen-pattern/style.scss";
 @import "./components/sidebar-navigation-screen-patterns/style.scss";
 @import "./components/sidebar-navigation-screen-template/style.scss";
+@import "./components/sidebar-dataviews/style.scss";
 @import "./components/site-hub/style.scss";
 @import "./components/sidebar-navigation-screen-navigation-menus/style.scss";
 @import "./components/site-icon/style.scss";

package/src/utils/constants.js

@@ -27,7 +27,7 @@ export const {
 	PATTERN_TYPES,
 	PATTERN_DEFAULT_CATEGORY,
 	PATTERN_USER_CATEGORY,
-	PATTERN_CORE_SOURCES,
+	EXCLUDED_PATTERN_SOURCES,
 	PATTERN_SYNC_TYPES,
 } = unlock( patternPrivateApis );