@wordpress/block-editor 12.22.0 → 12.24.0

package/build-module/store/selectors.js

@@ -1,8 +1,3 @@
-/**
- * External dependencies
- */
-import createSelector from 'rememo';
-
 /**
  * WordPress dependencies
  */
@@ -12,15 +7,16 @@ import { applyFilters } from '@wordpress/hooks';
 import { symbol } from '@wordpress/icons';
 import { create, remove, toHTMLString } from '@wordpress/rich-text';
 import deprecated from '@wordpress/deprecated';
-import { createRegistrySelector } from '@wordpress/data';
+import { createSelector, createRegistrySelector } from '@wordpress/data';
 
 /**
  * Internal dependencies
  */
-import { checkAllowListRecursive, checkAllowList, getAllPatternsDependants } from './utils';
+import { checkAllowListRecursive, checkAllowList, getAllPatternsDependants, getInsertBlockTypeDependants } from './utils';
 import { orderBy } from '../utils/sorting';
 import { STORE_NAME } from './constants';
 import { unlock } from '../lock-unlock';
+import { getContentLockingParent, getTemporarilyEditingAsBlocks, getTemporarilyEditingFocusModeToRevert } from './private-selectors';
 
 /**
  * A block selection object.
@@ -1064,7 +1060,17 @@ export function isBlockSelected(state, clientId) {
  * @return {boolean} Whether the block has an inner block selected
  */
 export function hasSelectedInnerBlock(state, clientId, deep = false) {
-  return getBlockOrder(state, clientId).some(innerClientId => isBlockSelected(state, innerClientId) || isBlockMultiSelected(state, innerClientId) || deep && hasSelectedInnerBlock(state, innerClientId, deep));
+  const selectedBlockClientIds = getSelectedBlockClientIds(state);
+  if (!selectedBlockClientIds.length) {
+    return false;
+  }
+  if (deep) {
+    return selectedBlockClientIds.some(id =>
+    // Pass true because we don't care about order and it's more
+    // performant.
+    getBlockParents(state, id, true).includes(clientId));
+  }
+  return selectedBlockClientIds.some(id => getBlockRootClientId(state, id) === clientId);
 }
 
 /**
@@ -1427,7 +1433,7 @@ const canInsertBlockTypeUnmemoized = (state, blockName, rootClientId = null) =>
  *
  * @return {boolean} Whether the given block type is allowed to be inserted.
  */
-export const canInsertBlockType = createSelector(canInsertBlockTypeUnmemoized, (state, blockName, rootClientId) => [state.blockListSettings[rootClientId], state.blocks.byClientId.get(rootClientId), state.settings.allowedBlockTypes, state.settings.templateLock, state.blockEditingModes]);
+export const canInsertBlockType = createSelector(canInsertBlockTypeUnmemoized, (state, blockName, rootClientId) => getInsertBlockTypeDependants(state, rootClientId));
 
 /**
  * Determines if the given blocks are allowed to be inserted into the block
@@ -1721,7 +1727,7 @@ const buildBlockTypeItem = (state, {
  *                                        this item.
  * @property {number}   frecency          Heuristic that combines frequency and recency.
  */
-export const getInserterItems = createSelector((state, rootClientId = null) => {
+export const getInserterItems = createRegistrySelector(select => createSelector((state, rootClientId = null) => {
   const buildReusableBlockInserterItem = reusableBlock => {
     const icon = !reusableBlock.wp_pattern_sync_status ? {
       src: symbol,
@@ -1751,7 +1757,7 @@ export const getInserterItems = createSelector((state, rootClientId = null) => {
       syncStatus: reusableBlock.wp_pattern_sync_status
     };
   };
-  const syncedPatternInserterItems = canInsertBlockTypeUnmemoized(state, 'core/block', rootClientId) ? getReusableBlocks(state).map(buildReusableBlockInserterItem) : [];
+  const syncedPatternInserterItems = canInsertBlockTypeUnmemoized(state, 'core/block', rootClientId) ? unlock(select(STORE_NAME)).getReusableBlocks().map(buildReusableBlockInserterItem) : [];
   const buildBlockTypeInserterItem = buildBlockTypeItem(state, {
     buildScope: 'inserter'
   });
@@ -1796,7 +1802,7 @@ export const getInserterItems = createSelector((state, rootClientId = null) => {
   });
   const sortedBlockTypes = [...coreItems, ...nonCoreItems];
   return [...sortedBlockTypes, ...syncedPatternInserterItems];
-}, (state, rootClientId) => [state.blockListSettings[rootClientId], state.blocks.byClientId.get(rootClientId), state.blocks.order, state.preferences.insertUsage, state.settings.allowedBlockTypes, state.settings.templateLock, getReusableBlocks(state), getBlockTypes()]);
+}, (state, rootClientId) => [getBlockTypes(), unlock(select(STORE_NAME)).getReusableBlocks(), state.blocks.order, state.preferences.insertUsage, ...getInsertBlockTypeDependants(state, rootClientId)]));
 
 /**
  * Determines the items that appear in the available block transforms list.
@@ -1838,7 +1844,7 @@ export const getBlockTransformItems = createSelector((state, blocks, rootClientI
     return accumulator;
   }, []);
   return orderBy(possibleTransforms, block => itemsByName[block.name].frecency, 'desc');
-}, (state, blocks, rootClientId) => [state.blockListSettings[rootClientId], state.blocks.byClientId.get(rootClientId), state.preferences.insertUsage, state.settings.allowedBlockTypes, state.settings.templateLock, getBlockTypes()]);
+}, (state, blocks, rootClientId) => [getBlockTypes(), state.preferences.insertUsage, ...getInsertBlockTypeDependants(state, rootClientId)]);
 
 /**
  * Determines whether there are items to show in the inserter.
@@ -1848,14 +1854,14 @@ export const getBlockTransformItems = createSelector((state, blocks, rootClientI
  *
  * @return {boolean} Items that appear in inserter.
  */
-export const hasInserterItems = createSelector((state, rootClientId = null) => {
+export const hasInserterItems = createRegistrySelector(select => (state, rootClientId = null) => {
   const hasBlockType = getBlockTypes().some(blockType => canIncludeBlockTypeInInserter(state, blockType, rootClientId));
   if (hasBlockType) {
     return true;
   }
-  const hasReusableBlock = canInsertBlockTypeUnmemoized(state, 'core/block', rootClientId) && getReusableBlocks(state).length > 0;
+  const hasReusableBlock = canInsertBlockTypeUnmemoized(state, 'core/block', rootClientId) && unlock(select(STORE_NAME)).getReusableBlocks().length > 0;
   return hasReusableBlock;
-}, (state, rootClientId) => [state.blockListSettings[rootClientId], state.blocks.byClientId.get(rootClientId), state.settings.allowedBlockTypes, state.settings.templateLock, getReusableBlocks(state), getBlockTypes()]);
+});
 
 /**
  * Returns the list of allowed inserter blocks for inner blocks children.
@@ -1865,17 +1871,17 @@ export const hasInserterItems = createSelector((state, rootClientId = null) => {
  *
  * @return {Array?} The list of allowed block types.
  */
-export const getAllowedBlocks = createSelector((state, rootClientId = null) => {
+export const getAllowedBlocks = createRegistrySelector(select => createSelector((state, rootClientId = null) => {
   if (!rootClientId) {
     return;
   }
   const blockTypes = getBlockTypes().filter(blockType => canIncludeBlockTypeInInserter(state, blockType, rootClientId));
-  const hasReusableBlock = canInsertBlockTypeUnmemoized(state, 'core/block', rootClientId) && getReusableBlocks(state).length > 0;
+  const hasReusableBlock = canInsertBlockTypeUnmemoized(state, 'core/block', rootClientId) && unlock(select(STORE_NAME)).getReusableBlocks().length > 0;
   if (hasReusableBlock) {
     blockTypes.push('core/block');
   }
   return blockTypes;
-}, (state, rootClientId) => [state.blockListSettings[rootClientId], state.blocks.byClientId.get(rootClientId), state.settings.allowedBlockTypes, state.settings.templateLock, getReusableBlocks(state), getBlockTypes()]);
+}, (state, rootClientId) => [getBlockTypes(), unlock(select(STORE_NAME)).getReusableBlocks(), ...getInsertBlockTypeDependants(state, rootClientId)]));
 export const __experimentalGetAllowedBlocks = createSelector((state, rootClientId = null) => {
   deprecated('wp.data.select( "core/block-editor" ).__experimentalGetAllowedBlocks', {
     alternative: 'wp.data.select( "core/block-editor" ).getAllowedBlocks',
@@ -1883,7 +1889,7 @@ export const __experimentalGetAllowedBlocks = createSelector((state, rootClientI
     version: '6.4'
   });
   return getAllowedBlocks(state, rootClientId);
-}, (state, rootClientId) => [...getAllowedBlocks.getDependants(state, rootClientId)]);
+}, (state, rootClientId) => getAllowedBlocks.getDependants(state, rootClientId));
 
 /**
  * Returns the block to be directly inserted by the block appender.
@@ -1921,13 +1927,7 @@ export function __experimentalGetDirectInsertBlock(state, rootClientId = null) {
   return getDirectInsertBlock(state, rootClientId);
 }
 export const __experimentalGetParsedPattern = createRegistrySelector(select => createSelector((state, patternName) => {
-  const {
-    getAllPatterns
-  } = unlock(select(STORE_NAME));
-  const patterns = getAllPatterns();
-  const pattern = patterns.find(({
-    name
-  }) => name === patternName);
+  const pattern = unlock(select(STORE_NAME)).getPatternBySlug(patternName);
   if (!pattern) {
     return null;
   }
@@ -1939,7 +1939,9 @@ export const __experimentalGetParsedPattern = createRegistrySelector(select => c
       ...blocks[0].attributes,
       metadata: {
         ...(blocks[0].attributes.metadata || {}),
-        categories: pattern.categories
+        categories: pattern.categories,
+        patternName: pattern.name,
+        name: blocks[0].attributes.metadata?.name || pattern.title
       }
     };
   }
@@ -1947,10 +1949,8 @@ export const __experimentalGetParsedPattern = createRegistrySelector(select => c
     ...pattern,
     blocks
   };
-}, getAllPatternsDependants(select)));
-const getAllowedPatternsDependants = select => (state, rootClientId) => {
-  return [...getAllPatternsDependants(select)(state), state.settings.allowedBlockTypes, state.settings.templateLock, state.blockListSettings[rootClientId], state.blocks.byClientId.get(rootClientId)];
-};
+}, (state, patternName) => [unlock(select(STORE_NAME)).getPatternBySlug(patternName)]));
+const getAllowedPatternsDependants = select => (state, rootClientId) => [...getAllPatternsDependants(select)(state), ...getInsertBlockTypeDependants(state, rootClientId)];
 
 /**
  * Returns the list of allowed patterns for inner blocks children.
@@ -2130,13 +2130,17 @@ export const __experimentalGetBlockListSettingsForBlocks = createSelector((state
  *
  * @return {string} The reusable block saved title.
  */
-export const __experimentalGetReusableBlockTitle = createSelector((state, ref) => {
-  const reusableBlock = getReusableBlocks(state).find(block => block.id === ref);
+export const __experimentalGetReusableBlockTitle = createRegistrySelector(select => createSelector((state, ref) => {
+  deprecated("wp.data.select( 'core/block-editor' ).__experimentalGetReusableBlockTitle", {
+    since: '6.6',
+    version: '6.8'
+  });
+  const reusableBlock = unlock(select(STORE_NAME)).getReusableBlocks().find(block => block.id === ref);
   if (!reusableBlock) {
     return null;
   }
   return reusableBlock.title?.raw;
-}, state => [getReusableBlocks(state)]);
+}, () => [unlock(select(STORE_NAME)).getReusableBlocks()]));
 
 /**
  * Returns true if the most recent block change is be considered ignored, or
@@ -2169,18 +2173,6 @@ export function __experimentalGetLastBlockAttributeChanges(state) {
   return state.lastBlockAttributesChange;
 }
 
-/**
- * Returns the available reusable blocks
- *
- * @param {Object} state Global application state.
- *
- * @return {Array} Reusable blocks
- */
-function getReusableBlocks(state) {
-  var _state$settings$__exp;
-  return (_state$settings$__exp = state.settings.__experimentalReusableBlocks) !== null && _state$settings$__exp !== void 0 ? _state$settings$__exp : EMPTY_ARRAY;
-}
-
 /**
  * Returns whether the navigation mode is enabled.
  *
@@ -2318,44 +2310,6 @@ export const __unstableGetVisibleBlocks = createSelector(state => {
   }
   return visibleBlocks;
 }, state => [state.blockVisibility]);
-
-/**
- * DO-NOT-USE in production.
- * This selector is created for internal/experimental only usage and may be
- * removed anytime without any warning, causing breakage on any plugin or theme invoking it.
- */
-export const __unstableGetContentLockingParent = createSelector((state, clientId) => {
-  let current = clientId;
-  let result;
-  while (current = state.blocks.parents.get(current)) {
-    if (getBlockName(state, current) === 'core/block' || getTemplateLock(state, current) === 'contentOnly') {
-      result = current;
-    }
-  }
-  return result;
-}, state => [state.blocks.parents, state.blockListSettings]);
-
-/**
- * DO-NOT-USE in production.
- * This selector is created for internal/experimental only usage and may be
- * removed anytime without any warning, causing breakage on any plugin or theme invoking it.
- *
- * @param {Object} state Global application state.
- */
-export function __unstableGetTemporarilyEditingAsBlocks(state) {
-  return state.temporarilyEditingAsBlocks;
-}
-
-/**
- * DO-NOT-USE in production.
- * This selector is created for internal/experimental only usage and may be
- * removed anytime without any warning, causing breakage on any plugin or theme invoking it.
- *
- * @param {Object} state Global application state.
- */
-export function __unstableGetTemporarilyEditingFocusModeToRevert(state) {
-  return state.temporarilyEditingFocusModeRevert;
-}
 export function __unstableHasActiveBlockOverlayActive(state, clientId) {
   // Prevent overlay on blocks with a non-default editing mode. If the mdoe is
   // 'disabled' then the overlay is redundant since the block can't be
@@ -2371,9 +2325,19 @@ export function __unstableHasActiveBlockOverlayActive(state, clientId) {
   }
   const editorMode = __unstableGetEditorMode(state);
 
-  // In zoom-out mode, the block overlay is always active for top level blocks.
-  if (editorMode === 'zoom-out' && clientId && !getBlockRootClientId(state, clientId)) {
-    return true;
+  // In zoom-out mode, the block overlay is always active for section level blocks.
+  if (editorMode === 'zoom-out') {
+    const {
+      sectionRootClientId
+    } = unlock(getSettings(state));
+    if (sectionRootClientId) {
+      const sectionClientIds = getBlockOrder(state, sectionRootClientId);
+      if (sectionClientIds?.includes(clientId)) {
+        return true;
+      }
+    } else if (clientId && !getBlockRootClientId(state, clientId)) {
+      return true;
+    }
   }
 
   // In navigation mode, the block overlay is active when the block is not
@@ -2429,6 +2393,30 @@ export function __unstableIsWithinBlockOverlay(state, clientId) {
  *                            `'contentOnly'`, or `'default'`.
  */
 export const getBlockEditingMode = createRegistrySelector(select => (state, clientId = '') => {
+  // Some selectors that call this provide `null` as the default
+  // rootClientId, but the default rootClientId is actually `''`.
+  if (clientId === null) {
+    clientId = '';
+  }
+  // In zoom-out mode, override the behavior set by
+  // __unstableSetBlockEditingMode to only allow editing the top-level
+  // sections.
+  const editorMode = __unstableGetEditorMode(state);
+  if (editorMode === 'zoom-out') {
+    const {
+      sectionRootClientId
+    } = unlock(getSettings(state));
+    if (clientId === '' /* ROOT_CONTAINER_CLIENT_ID */) {
+      return sectionRootClientId ? 'disabled' : 'contentOnly';
+    }
+    if (clientId === sectionRootClientId) {
+      return 'contentOnly';
+    }
+    const sectionsClientIds = getBlockOrder(state, sectionRootClientId);
+    if (!sectionsClientIds?.includes(clientId)) {
+      return 'disabled';
+    }
+  }
   const blockEditingMode = state.blockEditingModes.get(clientId);
   if (blockEditingMode) {
     return blockEditingMode;
@@ -2493,4 +2481,58 @@ export const isGroupable = createRegistrySelector(select => (state, clientIds =
   const _isGroupable = groupingBlockAvailable && _clientIds.length;
   return _isGroupable && canRemoveBlocks(state, _clientIds, rootClientId);
 });
+
+/**
+ * DO-NOT-USE in production.
+ * This selector is created for internal/experimental only usage and may be
+ * removed anytime without any warning, causing breakage on any plugin or theme invoking it.
+ *
+ * @deprecated
+ *
+ * @param {Object} state    Global application state.
+ * @param {Object} clientId Client Id of the block.
+ *
+ * @return {?string} Client ID of the ancestor block that is content locking the block.
+ */
+export const __unstableGetContentLockingParent = (state, clientId) => {
+  deprecated("wp.data.select( 'core/block-editor' ).__unstableGetContentLockingParent", {
+    since: '6.1',
+    version: '6.7'
+  });
+  return getContentLockingParent(state, clientId);
+};
+
+/**
+ * DO-NOT-USE in production.
+ * This selector is created for internal/experimental only usage and may be
+ * removed anytime without any warning, causing breakage on any plugin or theme invoking it.
+ *
+ * @deprecated
+ *
+ * @param {Object} state Global application state.
+ */
+export function __unstableGetTemporarilyEditingAsBlocks(state) {
+  deprecated("wp.data.select( 'core/block-editor' ).__unstableGetTemporarilyEditingAsBlocks", {
+    since: '6.1',
+    version: '6.7'
+  });
+  return getTemporarilyEditingAsBlocks(state);
+}
+
+/**
+ * DO-NOT-USE in production.
+ * This selector is created for internal/experimental only usage and may be
+ * removed anytime without any warning, causing breakage on any plugin or theme invoking it.
+ *
+ * @deprecated
+ *
+ * @param {Object} state Global application state.
+ */
+export function __unstableGetTemporarilyEditingFocusModeToRevert(state) {
+  deprecated("wp.data.select( 'core/block-editor' ).__unstableGetTemporarilyEditingFocusModeToRevert", {
+    since: '6.5',
+    version: '6.7'
+  });
+  return getTemporarilyEditingFocusModeToRevert(state);
+}
 //# sourceMappingURL=selectors.js.map