@wordpress/edit-post 8.32.0 → 8.32.1-next.ff1cebbba.0

package/build-module/store/selectors.js

@@ -1,109 +1,49 @@
-/**
- * WordPress dependencies
- */
-import { createSelector, createRegistrySelector } from '@wordpress/data';
-import { store as preferencesStore } from '@wordpress/preferences';
-import { store as coreStore } from '@wordpress/core-data';
-import { store as editorStore, privateApis as editorPrivateApis } from '@wordpress/editor';
-import deprecated from '@wordpress/deprecated';
-
-/**
- * Internal dependencies
- */
-import { unlock } from '../lock-unlock';
-const {
-  interfaceStore
-} = unlock(editorPrivateApis);
+import { createSelector, createRegistrySelector } from "@wordpress/data";
+import { store as preferencesStore } from "@wordpress/preferences";
+import { store as coreStore } from "@wordpress/core-data";
+import {
+  store as editorStore,
+  privateApis as editorPrivateApis
+} from "@wordpress/editor";
+import deprecated from "@wordpress/deprecated";
+import { unlock } from "../lock-unlock";
+const { interfaceStore } = unlock(editorPrivateApis);
 const EMPTY_ARRAY = [];
 const EMPTY_OBJECT = {};
-
-/**
- * Returns the current editing mode.
- *
- * @param {Object} state Global application state.
- *
- * @return {string} Editing mode.
- */
-export const getEditorMode = createRegistrySelector(select => () => {
-  var _select$get;
-  return (_select$get = select(preferencesStore).get('core', 'editorMode')) !== null && _select$get !== void 0 ? _select$get : 'visual';
-});
-
-/**
- * Returns true if the editor sidebar is opened.
- *
- * @param {Object} state Global application state
- *
- * @return {boolean} Whether the editor sidebar is opened.
- */
-export const isEditorSidebarOpened = createRegistrySelector(select => () => {
-  const activeGeneralSidebar = select(interfaceStore).getActiveComplementaryArea('core');
-  return ['edit-post/document', 'edit-post/block'].includes(activeGeneralSidebar);
-});
-
-/**
- * Returns true if the plugin sidebar is opened.
- *
- * @param {Object} state Global application state.
- *
- * @return {boolean} Whether the plugin sidebar is opened.
- */
-export const isPluginSidebarOpened = createRegistrySelector(select => () => {
-  const activeGeneralSidebar = select(interfaceStore).getActiveComplementaryArea('core');
-  return !!activeGeneralSidebar && !['edit-post/document', 'edit-post/block'].includes(activeGeneralSidebar);
-});
-
-/**
- * Returns the current active general sidebar name, or null if there is no
- * general sidebar active. The active general sidebar is a unique name to
- * identify either an editor or plugin sidebar.
- *
- * Examples:
- *
- *  - `edit-post/document`
- *  - `my-plugin/insert-image-sidebar`
- *
- * @param {Object} state Global application state.
- *
- * @return {?string} Active general sidebar name.
- */
-export const getActiveGeneralSidebarName = createRegistrySelector(select => () => {
-  return select(interfaceStore).getActiveComplementaryArea('core');
-});
-
-/**
- * Converts panels from the new preferences store format to the old format
- * that the post editor previously used.
- *
- * The resultant converted data should look like this:
- * {
- *     panelName: {
- *         enabled: false,
- *         opened: true,
- *     },
- *     anotherPanelName: {
- *         opened: true
- *     },
- * }
- *
- * @param {string[] | undefined} inactivePanels An array of inactive panel names.
- * @param {string[] | undefined} openPanels     An array of open panel names.
- *
- * @return {Object} The converted panel data.
- */
+const getEditorMode = createRegistrySelector(
+  (select) => () => select(preferencesStore).get("core", "editorMode") ?? "visual"
+);
+const isEditorSidebarOpened = createRegistrySelector(
+  (select) => () => {
+    const activeGeneralSidebar = select(interfaceStore).getActiveComplementaryArea("core");
+    return ["edit-post/document", "edit-post/block"].includes(
+      activeGeneralSidebar
+    );
+  }
+);
+const isPluginSidebarOpened = createRegistrySelector(
+  (select) => () => {
+    const activeGeneralSidebar = select(interfaceStore).getActiveComplementaryArea("core");
+    return !!activeGeneralSidebar && !["edit-post/document", "edit-post/block"].includes(
+      activeGeneralSidebar
+    );
+  }
+);
+const getActiveGeneralSidebarName = createRegistrySelector(
+  (select) => () => {
+    return select(interfaceStore).getActiveComplementaryArea("core");
+  }
+);
 function convertPanelsToOldFormat(inactivePanels, openPanels) {
-  var _ref;
-  // First reduce the inactive panels.
-  const panelsWithEnabledState = inactivePanels?.reduce((accumulatedPanels, panelName) => ({
-    ...accumulatedPanels,
-    [panelName]: {
-      enabled: false
-    }
-  }), {});
-
-  // Then reduce the open panels, passing in the result of the previous
-  // reduction as the initial value so that both open and inactive
-  // panel state is combined.
+  const panelsWithEnabledState = inactivePanels?.reduce(
+    (accumulatedPanels, panelName) => ({
+      ...accumulatedPanels,
+      [panelName]: {
+        enabled: false
+      }
+    }),
+    {}
+  );
   const panels = openPanels?.reduce((accumulatedPanels, panelName) => {
     const currentPanelState = accumulatedPanels?.[panelName];
     return {
@@ -113,385 +53,235 @@ function convertPanelsToOldFormat(inactivePanels, openPanels) {
         opened: true
       }
     };
-  }, panelsWithEnabledState !== null && panelsWithEnabledState !== void 0 ? panelsWithEnabledState : {});
-
-  // The panels variable will only be set if openPanels wasn't `undefined`.
-  // If it isn't set just return `panelsWithEnabledState`, and if that isn't
-  // set return an empty object.
-  return (_ref = panels !== null && panels !== void 0 ? panels : panelsWithEnabledState) !== null && _ref !== void 0 ? _ref : EMPTY_OBJECT;
+  }, panelsWithEnabledState ?? {});
+  return panels ?? panelsWithEnabledState ?? EMPTY_OBJECT;
 }
-
-/**
- * Returns the preferences (these preferences are persisted locally).
- *
- * @param {Object} state Global application state.
- *
- * @return {Object} Preferences Object.
- */
-export const getPreferences = createRegistrySelector(select => () => {
+const getPreferences = createRegistrySelector((select) => () => {
   deprecated(`select( 'core/edit-post' ).getPreferences`, {
-    since: '6.0',
+    since: "6.0",
     alternative: `select( 'core/preferences' ).get`
   });
-  const corePreferences = ['editorMode', 'hiddenBlockTypes'].reduce((accumulatedPrefs, preferenceKey) => {
-    const value = select(preferencesStore).get('core', preferenceKey);
-    return {
-      ...accumulatedPrefs,
-      [preferenceKey]: value
-    };
-  }, {});
-
-  // Panels were a preference, but the data structure changed when the state
-  // was migrated to the preferences store. They need to be converted from
-  // the new preferences store format to old format to ensure no breaking
-  // changes for plugins.
-  const inactivePanels = select(preferencesStore).get('core', 'inactivePanels');
-  const openPanels = select(preferencesStore).get('core', 'openPanels');
+  const corePreferences = ["editorMode", "hiddenBlockTypes"].reduce(
+    (accumulatedPrefs, preferenceKey) => {
+      const value = select(preferencesStore).get(
+        "core",
+        preferenceKey
+      );
+      return {
+        ...accumulatedPrefs,
+        [preferenceKey]: value
+      };
+    },
+    {}
+  );
+  const inactivePanels = select(preferencesStore).get(
+    "core",
+    "inactivePanels"
+  );
+  const openPanels = select(preferencesStore).get("core", "openPanels");
   const panels = convertPanelsToOldFormat(inactivePanels, openPanels);
   return {
     ...corePreferences,
     panels
   };
 });
-
-/**
- *
- * @param {Object} state         Global application state.
- * @param {string} preferenceKey Preference Key.
- * @param {*}      defaultValue  Default Value.
- *
- * @return {*} Preference Value.
- */
-export function getPreference(state, preferenceKey, defaultValue) {
+function getPreference(state, preferenceKey, defaultValue) {
   deprecated(`select( 'core/edit-post' ).getPreference`, {
-    since: '6.0',
+    since: "6.0",
     alternative: `select( 'core/preferences' ).get`
   });
-
-  // Avoid using the `getPreferences` registry selector where possible.
   const preferences = getPreferences(state);
   const value = preferences[preferenceKey];
-  return value === undefined ? defaultValue : value;
+  return value === void 0 ? defaultValue : value;
 }
-
-/**
- * Returns an array of blocks that are hidden.
- *
- * @return {Array} A list of the hidden block types
- */
-export const getHiddenBlockTypes = createRegistrySelector(select => () => {
-  var _select$get2;
-  return (_select$get2 = select(preferencesStore).get('core', 'hiddenBlockTypes')) !== null && _select$get2 !== void 0 ? _select$get2 : EMPTY_ARRAY;
-});
-
-/**
- * Returns true if the publish sidebar is opened.
- *
- * @deprecated
- *
- * @param {Object} state Global application state
- *
- * @return {boolean} Whether the publish sidebar is open.
- */
-export const isPublishSidebarOpened = createRegistrySelector(select => () => {
-  deprecated(`select( 'core/edit-post' ).isPublishSidebarOpened`, {
-    since: '6.6',
-    alternative: `select( 'core/editor' ).isPublishSidebarOpened`
-  });
-  return select(editorStore).isPublishSidebarOpened();
-});
-
-/**
- * Returns true if the given panel was programmatically removed, or false otherwise.
- * All panels are not removed by default.
- *
- * @deprecated
- *
- * @param {Object} state     Global application state.
- * @param {string} panelName A string that identifies the panel.
- *
- * @return {boolean} Whether or not the panel is removed.
- */
-export const isEditorPanelRemoved = createRegistrySelector(select => (state, panelName) => {
-  deprecated(`select( 'core/edit-post' ).isEditorPanelRemoved`, {
-    since: '6.5',
-    alternative: `select( 'core/editor' ).isEditorPanelRemoved`
-  });
-  return select(editorStore).isEditorPanelRemoved(panelName);
-});
-
-/**
- * Returns true if the given panel is enabled, or false otherwise. Panels are
- * enabled by default.
- *
- * @deprecated
- *
- * @param {Object} state     Global application state.
- * @param {string} panelName A string that identifies the panel.
- *
- * @return {boolean} Whether or not the panel is enabled.
- */
-export const isEditorPanelEnabled = createRegistrySelector(select => (state, panelName) => {
-  deprecated(`select( 'core/edit-post' ).isEditorPanelEnabled`, {
-    since: '6.5',
-    alternative: `select( 'core/editor' ).isEditorPanelEnabled`
-  });
-  return select(editorStore).isEditorPanelEnabled(panelName);
-});
-
-/**
- * Returns true if the given panel is open, or false otherwise. Panels are
- * closed by default.
- *
- * @deprecated
- *
- * @param {Object} state     Global application state.
- * @param {string} panelName A string that identifies the panel.
- *
- * @return {boolean} Whether or not the panel is open.
- */
-export const isEditorPanelOpened = createRegistrySelector(select => (state, panelName) => {
-  deprecated(`select( 'core/edit-post' ).isEditorPanelOpened`, {
-    since: '6.5',
-    alternative: `select( 'core/editor' ).isEditorPanelOpened`
-  });
-  return select(editorStore).isEditorPanelOpened(panelName);
-});
-
-/**
- * Returns true if a modal is active, or false otherwise.
- *
- * @deprecated since WP 6.3 use `core/interface` store's selector with the same name instead.
- *
- * @param {Object} state     Global application state.
- * @param {string} modalName A string that uniquely identifies the modal.
- *
- * @return {boolean} Whether the modal is active.
- */
-export const isModalActive = createRegistrySelector(select => (state, modalName) => {
-  deprecated(`select( 'core/edit-post' ).isModalActive`, {
-    since: '6.3',
-    alternative: `select( 'core/interface' ).isModalActive`
-  });
-  return !!select(interfaceStore).isModalActive(modalName);
+const getHiddenBlockTypes = createRegistrySelector((select) => () => {
+  return select(preferencesStore).get("core", "hiddenBlockTypes") ?? EMPTY_ARRAY;
 });
-
-/**
- * Returns whether the given feature is enabled or not.
- *
- * @param {Object} state   Global application state.
- * @param {string} feature Feature slug.
- *
- * @return {boolean} Is active.
- */
-export const isFeatureActive = createRegistrySelector(select => (state, feature) => {
-  return !!select(preferencesStore).get('core/edit-post', feature);
-});
-
-/**
- * Returns true if the plugin item is pinned to the header.
- * When the value is not set it defaults to true.
- *
- * @param {Object} state      Global application state.
- * @param {string} pluginName Plugin item name.
- *
- * @return {boolean} Whether the plugin item is pinned.
- */
-export const isPluginItemPinned = createRegistrySelector(select => (state, pluginName) => {
-  return select(interfaceStore).isItemPinned('core', pluginName);
-});
-
-/**
- * Returns an array of active meta box locations.
- *
- * @param {Object} state Post editor state.
- *
- * @return {string[]} Active meta box locations.
- */
-export const getActiveMetaBoxLocations = createSelector(state => {
-  return Object.keys(state.metaBoxes.locations).filter(location => isMetaBoxLocationActive(state, location));
-}, state => [state.metaBoxes.locations]);
-
-/**
- * Returns true if a metabox location is active and visible
- *
- * @param {Object} state    Post editor state.
- * @param {string} location Meta box location to test.
- *
- * @return {boolean} Whether the meta box location is active and visible.
- */
-export const isMetaBoxLocationVisible = createRegistrySelector(select => (state, location) => {
-  return isMetaBoxLocationActive(state, location) && getMetaBoxesPerLocation(state, location)?.some(({
-    id
-  }) => {
-    return select(editorStore).isEditorPanelEnabled(`meta-box-${id}`);
-  });
-});
-
-/**
- * Returns true if there is an active meta box in the given location, or false
- * otherwise.
- *
- * @param {Object} state    Post editor state.
- * @param {string} location Meta box location to test.
- *
- * @return {boolean} Whether the meta box location is active.
- */
-export function isMetaBoxLocationActive(state, location) {
+const isPublishSidebarOpened = createRegistrySelector(
+  (select) => () => {
+    deprecated(`select( 'core/edit-post' ).isPublishSidebarOpened`, {
+      since: "6.6",
+      alternative: `select( 'core/editor' ).isPublishSidebarOpened`
+    });
+    return select(editorStore).isPublishSidebarOpened();
+  }
+);
+const isEditorPanelRemoved = createRegistrySelector(
+  (select) => (state, panelName) => {
+    deprecated(`select( 'core/edit-post' ).isEditorPanelRemoved`, {
+      since: "6.5",
+      alternative: `select( 'core/editor' ).isEditorPanelRemoved`
+    });
+    return select(editorStore).isEditorPanelRemoved(panelName);
+  }
+);
+const isEditorPanelEnabled = createRegistrySelector(
+  (select) => (state, panelName) => {
+    deprecated(`select( 'core/edit-post' ).isEditorPanelEnabled`, {
+      since: "6.5",
+      alternative: `select( 'core/editor' ).isEditorPanelEnabled`
+    });
+    return select(editorStore).isEditorPanelEnabled(panelName);
+  }
+);
+const isEditorPanelOpened = createRegistrySelector(
+  (select) => (state, panelName) => {
+    deprecated(`select( 'core/edit-post' ).isEditorPanelOpened`, {
+      since: "6.5",
+      alternative: `select( 'core/editor' ).isEditorPanelOpened`
+    });
+    return select(editorStore).isEditorPanelOpened(panelName);
+  }
+);
+const isModalActive = createRegistrySelector(
+  (select) => (state, modalName) => {
+    deprecated(`select( 'core/edit-post' ).isModalActive`, {
+      since: "6.3",
+      alternative: `select( 'core/interface' ).isModalActive`
+    });
+    return !!select(interfaceStore).isModalActive(modalName);
+  }
+);
+const isFeatureActive = createRegistrySelector(
+  (select) => (state, feature) => {
+    return !!select(preferencesStore).get("core/edit-post", feature);
+  }
+);
+const isPluginItemPinned = createRegistrySelector(
+  (select) => (state, pluginName) => {
+    return select(interfaceStore).isItemPinned("core", pluginName);
+  }
+);
+const getActiveMetaBoxLocations = createSelector(
+  (state) => {
+    return Object.keys(state.metaBoxes.locations).filter(
+      (location) => isMetaBoxLocationActive(state, location)
+    );
+  },
+  (state) => [state.metaBoxes.locations]
+);
+const isMetaBoxLocationVisible = createRegistrySelector(
+  (select) => (state, location) => {
+    return isMetaBoxLocationActive(state, location) && getMetaBoxesPerLocation(state, location)?.some(({ id }) => {
+      return select(editorStore).isEditorPanelEnabled(
+        `meta-box-${id}`
+      );
+    });
+  }
+);
+function isMetaBoxLocationActive(state, location) {
   const metaBoxes = getMetaBoxesPerLocation(state, location);
   return !!metaBoxes && metaBoxes.length !== 0;
 }
-
-/**
- * Returns the list of all the available meta boxes for a given location.
- *
- * @param {Object} state    Global application state.
- * @param {string} location Meta box location to test.
- *
- * @return {?Array} List of meta boxes.
- */
-export function getMetaBoxesPerLocation(state, location) {
+function getMetaBoxesPerLocation(state, location) {
   return state.metaBoxes.locations[location];
 }
-
-/**
- * Returns the list of all the available meta boxes.
- *
- * @param {Object} state Global application state.
- *
- * @return {Array} List of meta boxes.
- */
-export const getAllMetaBoxes = createSelector(state => {
-  return Object.values(state.metaBoxes.locations).flat();
-}, state => [state.metaBoxes.locations]);
-
-/**
- * Returns true if the post is using Meta Boxes
- *
- * @param {Object} state Global application state
- *
- * @return {boolean} Whether there are metaboxes or not.
- */
-export function hasMetaBoxes(state) {
+const getAllMetaBoxes = createSelector(
+  (state) => {
+    return Object.values(state.metaBoxes.locations).flat();
+  },
+  (state) => [state.metaBoxes.locations]
+);
+function hasMetaBoxes(state) {
   return getActiveMetaBoxLocations(state).length > 0;
 }
-
-/**
- * Returns true if the Meta Boxes are being saved.
- *
- * @param {Object} state Global application state.
- *
- * @return {boolean} Whether the metaboxes are being saved.
- */
-export function isSavingMetaBoxes(state) {
+function isSavingMetaBoxes(state) {
   return state.metaBoxes.isSaving;
 }
-
-/**
- * Returns the current editing canvas device type.
- *
- * @deprecated
- *
- * @param {Object} state Global application state.
- *
- * @return {string} Device type.
- */
-export const __experimentalGetPreviewDeviceType = createRegistrySelector(select => () => {
-  deprecated(`select( 'core/edit-site' ).__experimentalGetPreviewDeviceType`, {
-    since: '6.5',
-    version: '6.7',
-    alternative: `select( 'core/editor' ).getDeviceType`
-  });
-  return select(editorStore).getDeviceType();
-});
-
-/**
- * Returns true if the inserter is opened.
- *
- * @deprecated
- *
- * @param {Object} state Global application state.
- *
- * @return {boolean} Whether the inserter is opened.
- */
-export const isInserterOpened = createRegistrySelector(select => () => {
+const __experimentalGetPreviewDeviceType = createRegistrySelector(
+  (select) => () => {
+    deprecated(
+      `select( 'core/edit-site' ).__experimentalGetPreviewDeviceType`,
+      {
+        since: "6.5",
+        version: "6.7",
+        alternative: `select( 'core/editor' ).getDeviceType`
+      }
+    );
+    return select(editorStore).getDeviceType();
+  }
+);
+const isInserterOpened = createRegistrySelector((select) => () => {
   deprecated(`select( 'core/edit-post' ).isInserterOpened`, {
-    since: '6.5',
+    since: "6.5",
     alternative: `select( 'core/editor' ).isInserterOpened`
   });
   return select(editorStore).isInserterOpened();
 });
-
-/**
- * Get the insertion point for the inserter.
- *
- * @deprecated
- *
- * @param {Object} state Global application state.
- *
- * @return {Object} The root client ID, index to insert at and starting filter value.
- */
-export const __experimentalGetInsertionPoint = createRegistrySelector(select => () => {
-  deprecated(`select( 'core/edit-post' ).__experimentalGetInsertionPoint`, {
-    since: '6.5',
-    version: '6.7'
-  });
-  return unlock(select(editorStore)).getInserter();
-});
-
-/**
- * Returns true if the list view is opened.
- *
- * @param {Object} state Global application state.
- *
- * @return {boolean} Whether the list view is opened.
- */
-export const isListViewOpened = createRegistrySelector(select => () => {
+const __experimentalGetInsertionPoint = createRegistrySelector(
+  (select) => () => {
+    deprecated(
+      `select( 'core/edit-post' ).__experimentalGetInsertionPoint`,
+      {
+        since: "6.5",
+        version: "6.7"
+      }
+    );
+    return unlock(select(editorStore)).getInserter();
+  }
+);
+const isListViewOpened = createRegistrySelector((select) => () => {
   deprecated(`select( 'core/edit-post' ).isListViewOpened`, {
-    since: '6.5',
+    since: "6.5",
     alternative: `select( 'core/editor' ).isListViewOpened`
   });
   return select(editorStore).isListViewOpened();
 });
-
-/**
- * Returns true if the template editing mode is enabled.
- *
- * @deprecated
- */
-export const isEditingTemplate = createRegistrySelector(select => () => {
+const isEditingTemplate = createRegistrySelector((select) => () => {
   deprecated(`select( 'core/edit-post' ).isEditingTemplate`, {
-    since: '6.5',
+    since: "6.5",
     alternative: `select( 'core/editor' ).getRenderingMode`
   });
-  return select(editorStore).getCurrentPostType() === 'wp_template';
+  return select(editorStore).getCurrentPostType() === "wp_template";
 });
-
-/**
- * Returns true if meta boxes are initialized.
- *
- * @param {Object} state Global application state.
- *
- * @return {boolean} Whether meta boxes are initialized.
- */
-export function areMetaBoxesInitialized(state) {
+function areMetaBoxesInitialized(state) {
   return state.metaBoxes.initialized;
 }
-
-/**
- * Retrieves the template of the currently edited post.
- *
- * @return {?Object} Post Template.
- */
-export const getEditedPostTemplate = createRegistrySelector(select => () => {
-  const {
-    id: postId,
-    type: postType
-  } = select(editorStore).getCurrentPost();
-  const templateId = unlock(select(coreStore)).getTemplateId(postType, postId);
-  if (!templateId) {
-    return undefined;
+const getEditedPostTemplate = createRegistrySelector(
+  (select) => () => {
+    const { id: postId, type: postType } = select(editorStore).getCurrentPost();
+    const templateId = unlock(select(coreStore)).getTemplateId(
+      postType,
+      postId
+    );
+    if (!templateId) {
+      return void 0;
+    }
+    return select(coreStore).getEditedEntityRecord(
+      "postType",
+      "wp_template",
+      templateId
+    );
   }
-  return select(coreStore).getEditedEntityRecord('postType', 'wp_template', templateId);
-});
-//# sourceMappingURL=selectors.js.map
+);
+export {
+  __experimentalGetInsertionPoint,
+  __experimentalGetPreviewDeviceType,
+  areMetaBoxesInitialized,
+  getActiveGeneralSidebarName,
+  getActiveMetaBoxLocations,
+  getAllMetaBoxes,
+  getEditedPostTemplate,
+  getEditorMode,
+  getHiddenBlockTypes,
+  getMetaBoxesPerLocation,
+  getPreference,
+  getPreferences,
+  hasMetaBoxes,
+  isEditingTemplate,
+  isEditorPanelEnabled,
+  isEditorPanelOpened,
+  isEditorPanelRemoved,
+  isEditorSidebarOpened,
+  isFeatureActive,
+  isInserterOpened,
+  isListViewOpened,
+  isMetaBoxLocationActive,
+  isMetaBoxLocationVisible,
+  isModalActive,
+  isPluginItemPinned,
+  isPluginSidebarOpened,
+  isPublishSidebarOpened,
+  isSavingMetaBoxes
+};
+//# sourceMappingURL=selectors.js.map