@wordpress/edit-site 5.15.0 → 5.17.0

package/build/components/add-new-template/utils.js

@@ -8,21 +8,13 @@ exports.useAuthorMenuItem = useAuthorMenuItem;
 exports.useExistingTemplates = exports.useDefaultTemplateTypes = void 0;
 exports.usePostTypeArchiveMenuItems = usePostTypeArchiveMenuItems;
 exports.useTaxonomiesMenuItems = exports.usePostTypeMenuItems = void 0;
-
 var _data = require("@wordpress/data");
-
 var _coreData = require("@wordpress/core-data");
-
 var _editor = require("@wordpress/editor");
-
 var _htmlEntities = require("@wordpress/html-entities");
-
 var _element = require("@wordpress/element");
-
 var _i18n = require("@wordpress/i18n");
-
 var _icons = require("@wordpress/icons");
-
 /**
  * WordPress dependencies
  */
@@ -32,6 +24,7 @@ var _icons = require("@wordpress/icons");
  * @property {string|number} id   The entity's id.
  * @property {string}        name The entity's name.
  */
+
 const getValueFromObjectPath = (object, path) => {
   let value = object;
   path.split('.').forEach(fieldName => {
@@ -39,6 +32,7 @@ const getValueFromObjectPath = (object, path) => {
   });
   return value;
 };
+
 /**
  * Helper util to map records to add a `name` prop from a
  * provided path, in order to handle all entities in the same
@@ -48,36 +42,29 @@ const getValueFromObjectPath = (object, path) => {
  * @param {string}   path     The path to map a `name` property from the entity.
  * @return {IHasNameAndId[]} An array of enitities that now implement the `IHasNameAndId` interface.
  */
-
-
 const mapToIHasNameAndId = (entities, path) => {
-  return (entities || []).map(entity => ({ ...entity,
+  return (entities || []).map(entity => ({
+    ...entity,
     name: (0, _htmlEntities.decodeEntities)(getValueFromObjectPath(entity, path))
   }));
 };
+
 /**
  * @typedef {Object} EntitiesInfo
  * @property {boolean}  hasEntities         If an entity has available records(posts, terms, etc..).
  * @property {number[]} existingEntitiesIds An array of the existing entities ids.
  */
-
-
 exports.mapToIHasNameAndId = mapToIHasNameAndId;
-
 const useExistingTemplates = () => {
   return (0, _data.useSelect)(select => select(_coreData.store).getEntityRecords('postType', 'wp_template', {
     per_page: -1
   }), []);
 };
-
 exports.useExistingTemplates = useExistingTemplates;
-
 const useDefaultTemplateTypes = () => {
   return (0, _data.useSelect)(select => select(_editor.store).__experimentalGetDefaultTemplateTypes(), []);
 };
-
 exports.useDefaultTemplateTypes = useDefaultTemplateTypes;
-
 const usePublicPostTypes = () => {
   const postTypes = (0, _data.useSelect)(select => select(_coreData.store).getPostTypes({
     per_page: -1
@@ -90,7 +77,6 @@ const usePublicPostTypes = () => {
     }) => viewable && !excludedPostTypes.includes(slug));
   }, [postTypes]);
 };
-
 const usePublicTaxonomies = () => {
   const taxonomies = (0, _data.useSelect)(select => select(_coreData.store).getTaxonomies({
     per_page: -1
@@ -101,7 +87,6 @@ const usePublicTaxonomies = () => {
     }) => visibility?.publicly_queryable);
   }, [taxonomies]);
 };
-
 function usePostTypeNeedsUniqueIdentifier(publicPostTypes) {
   const postTypeLabels = (0, _element.useMemo)(() => publicPostTypes?.reduce((accumulator, {
     labels
@@ -118,7 +103,6 @@ function usePostTypeNeedsUniqueIdentifier(publicPostTypes) {
     return postTypeLabels[singularName] > 1 && singularName !== slug;
   }, [postTypeLabels]);
 }
-
 function usePostTypeArchiveMenuItems() {
   const publicPostTypes = usePublicPostTypes();
   const postTypesWithArchives = (0, _element.useMemo)(() => publicPostTypes?.filter(postType => postType.has_archive), [publicPostTypes]);
@@ -126,18 +110,19 @@ function usePostTypeArchiveMenuItems() {
   const needsUniqueIdentifier = usePostTypeNeedsUniqueIdentifier(postTypesWithArchives);
   return (0, _element.useMemo)(() => postTypesWithArchives?.filter(postType => !(existingTemplates || []).some(existingTemplate => existingTemplate.slug === 'archive-' + postType.slug)).map(postType => {
     let title;
-
     if (needsUniqueIdentifier(postType)) {
-      title = (0, _i18n.sprintf)( // translators: %1s: Name of the post type e.g: "Post"; %2s: Slug of the post type e.g: "book".
+      title = (0, _i18n.sprintf)(
+      // translators: %1s: Name of the post type e.g: "Post"; %2s: Slug of the post type e.g: "book".
       (0, _i18n.__)('Archive: %1$s (%2$s)'), postType.labels.singular_name, postType.slug);
     } else {
-      title = (0, _i18n.sprintf)( // translators: %s: Name of the post type e.g: "Post".
+      title = (0, _i18n.sprintf)(
+      // translators: %s: Name of the post type e.g: "Post".
       (0, _i18n.__)('Archive: %s'), postType.labels.singular_name);
     }
-
     return {
       slug: 'archive-' + postType.slug,
-      description: (0, _i18n.sprintf)( // translators: %s: Name of the post type e.g: "Post".
+      description: (0, _i18n.sprintf)(
+      // translators: %s: Name of the post type e.g: "Post".
       (0, _i18n.__)('Displays an archive with the latest posts of type: %s.'), postType.labels.singular_name),
       title,
       // `icon` is the `menu_icon` property of a post type. We
@@ -148,22 +133,19 @@ function usePostTypeArchiveMenuItems() {
     };
   }) || [], [postTypesWithArchives, existingTemplates, needsUniqueIdentifier]);
 }
-
 const usePostTypeMenuItems = onClickMenuItem => {
   const publicPostTypes = usePublicPostTypes();
   const existingTemplates = useExistingTemplates();
   const defaultTemplateTypes = useDefaultTemplateTypes();
-  const needsUniqueIdentifier = usePostTypeNeedsUniqueIdentifier(publicPostTypes); // `page`is a special case in template hierarchy.
-
+  const needsUniqueIdentifier = usePostTypeNeedsUniqueIdentifier(publicPostTypes);
+  // `page`is a special case in template hierarchy.
   const templatePrefixes = (0, _element.useMemo)(() => publicPostTypes?.reduce((accumulator, {
     slug
   }) => {
     let suffix = slug;
-
     if (slug !== 'page') {
       suffix = `single-${suffix}`;
     }
-
     accumulator[slug] = suffix;
     return accumulator;
   }, {}), [publicPostTypes]);
@@ -176,32 +158,32 @@ const usePostTypeMenuItems = onClickMenuItem => {
       slug,
       labels,
       icon
-    } = postType; // We need to check if the general template is part of the
+    } = postType;
+    // We need to check if the general template is part of the
     // defaultTemplateTypes. If it is, just use that info and
     // augment it with the specific template functionality.
-
     const generalTemplateSlug = templatePrefixes[slug];
     const defaultTemplateType = defaultTemplateTypes?.find(({
       slug: _slug
     }) => _slug === generalTemplateSlug);
     const hasGeneralTemplate = existingTemplateSlugs?.includes(generalTemplateSlug);
-
     const _needsUniqueIdentifier = needsUniqueIdentifier(postType);
-
-    let menuItemTitle = (0, _i18n.sprintf)( // translators: %s: Name of the post type e.g: "Post".
+    let menuItemTitle = (0, _i18n.sprintf)(
+    // translators: %s: Name of the post type e.g: "Post".
     (0, _i18n.__)('Single item: %s'), labels.singular_name);
-
     if (_needsUniqueIdentifier) {
-      menuItemTitle = (0, _i18n.sprintf)( // translators: %1s: Name of the post type e.g: "Post"; %2s: Slug of the post type e.g: "book".
+      menuItemTitle = (0, _i18n.sprintf)(
+      // translators: %1s: Name of the post type e.g: "Post"; %2s: Slug of the post type e.g: "book".
       (0, _i18n.__)('Single item: %1$s (%2$s)'), labels.singular_name, slug);
     }
-
-    const menuItem = defaultTemplateType ? { ...defaultTemplateType,
+    const menuItem = defaultTemplateType ? {
+      ...defaultTemplateType,
       templatePrefix: templatePrefixes[slug]
     } : {
       slug: generalTemplateSlug,
       title: menuItemTitle,
-      description: (0, _i18n.sprintf)( // translators: %s: Name of the post type e.g: "Post".
+      description: (0, _i18n.sprintf)(
+      // translators: %s: Name of the post type e.g: "Post".
       (0, _i18n.__)('Displays a single item: %s.'), labels.singular_name),
       // `icon` is the `menu_icon` property of a post type. We
       // only handle `dashicons` for now, even if the `menu_icon`
@@ -209,8 +191,8 @@ const usePostTypeMenuItems = onClickMenuItem => {
       icon: icon?.startsWith('dashicons-') ? icon.slice(10) : _icons.post,
       templatePrefix: templatePrefixes[slug]
     };
-    const hasEntities = postTypesInfo?.[slug]?.hasEntities; // We have a different template creation flow only if they have entities.
-
+    const hasEntities = postTypesInfo?.[slug]?.hasEntities;
+    // We have a different template creation flow only if they have entities.
     if (hasEntities) {
       menuItem.onClick = template => {
         onClickMenuItem({
@@ -241,28 +223,24 @@ const usePostTypeMenuItems = onClickMenuItem => {
           template
         });
       };
-    } // We don't need to add the menu item if there are no
+    }
+    // We don't need to add the menu item if there are no
     // entities and the general template exists.
-
-
     if (!hasGeneralTemplate || hasEntities) {
       accumulator.push(menuItem);
     }
-
     return accumulator;
-  }, []); // Split menu items into two groups: one for the default post types
+  }, []);
+  // Split menu items into two groups: one for the default post types
   // and one for the rest.
-
   const postTypesMenuItems = (0, _element.useMemo)(() => menuItems.reduce((accumulator, postType) => {
     const {
       slug
     } = postType;
     let key = 'postTypesMenuItems';
-
     if (slug === 'page') {
       key = 'defaultPostTypesMenuItems';
     }
-
     accumulator[key].push(postType);
     return accumulator;
   }, {
@@ -271,32 +249,27 @@ const usePostTypeMenuItems = onClickMenuItem => {
   }), [menuItems]);
   return postTypesMenuItems;
 };
-
 exports.usePostTypeMenuItems = usePostTypeMenuItems;
-
 const useTaxonomiesMenuItems = onClickMenuItem => {
   const publicTaxonomies = usePublicTaxonomies();
   const existingTemplates = useExistingTemplates();
-  const defaultTemplateTypes = useDefaultTemplateTypes(); // `category` and `post_tag` are special cases in template hierarchy.
-
+  const defaultTemplateTypes = useDefaultTemplateTypes();
+  // `category` and `post_tag` are special cases in template hierarchy.
   const templatePrefixes = (0, _element.useMemo)(() => publicTaxonomies?.reduce((accumulator, {
     slug
   }) => {
     let suffix = slug;
-
     if (!['category', 'post_tag'].includes(slug)) {
       suffix = `taxonomy-${suffix}`;
     }
-
     if (slug === 'post_tag') {
       suffix = `tag`;
     }
-
     accumulator[slug] = suffix;
     return accumulator;
-  }, {}), [publicTaxonomies]); // We need to keep track of naming conflicts. If a conflict
+  }, {}), [publicTaxonomies]);
+  // We need to keep track of naming conflicts. If a conflict
   // occurs, we need to add slug.
-
   const taxonomyLabels = publicTaxonomies?.reduce((accumulator, {
     labels
   }) => {
@@ -304,16 +277,13 @@ const useTaxonomiesMenuItems = onClickMenuItem => {
     accumulator[singularName] = (accumulator[singularName] || 0) + 1;
     return accumulator;
   }, {});
-
   const needsUniqueIdentifier = (labels, slug) => {
     if (['category', 'post_tag'].includes(slug)) {
       return false;
     }
-
     const singularName = labels.singular_name.toLowerCase();
     return taxonomyLabels[singularName] > 1 && singularName !== slug;
   };
-
   const taxonomiesInfo = useEntitiesInfo('taxonomy', templatePrefixes);
   const existingTemplateSlugs = (existingTemplates || []).map(({
     slug
@@ -322,37 +292,36 @@ const useTaxonomiesMenuItems = onClickMenuItem => {
     const {
       slug,
       labels
-    } = taxonomy; // We need to check if the general template is part of the
+    } = taxonomy;
+    // We need to check if the general template is part of the
     // defaultTemplateTypes. If it is, just use that info and
     // augment it with the specific template functionality.
-
     const generalTemplateSlug = templatePrefixes[slug];
     const defaultTemplateType = defaultTemplateTypes?.find(({
       slug: _slug
     }) => _slug === generalTemplateSlug);
     const hasGeneralTemplate = existingTemplateSlugs?.includes(generalTemplateSlug);
-
     const _needsUniqueIdentifier = needsUniqueIdentifier(labels, slug);
-
     let menuItemTitle = labels.singular_name;
-
     if (_needsUniqueIdentifier) {
-      menuItemTitle = (0, _i18n.sprintf)( // translators: %1s: Name of the taxonomy e.g: "Category"; %2s: Slug of the taxonomy e.g: "product_cat".
+      menuItemTitle = (0, _i18n.sprintf)(
+      // translators: %1s: Name of the taxonomy e.g: "Category"; %2s: Slug of the taxonomy e.g: "product_cat".
       (0, _i18n.__)('%1$s (%2$s)'), labels.singular_name, slug);
     }
-
-    const menuItem = defaultTemplateType ? { ...defaultTemplateType,
+    const menuItem = defaultTemplateType ? {
+      ...defaultTemplateType,
       templatePrefix: templatePrefixes[slug]
     } : {
       slug: generalTemplateSlug,
       title: menuItemTitle,
-      description: (0, _i18n.sprintf)( // translators: %s: Name of the taxonomy e.g: "Product Categories".
+      description: (0, _i18n.sprintf)(
+      // translators: %s: Name of the taxonomy e.g: "Product Categories".
       (0, _i18n.__)('Displays taxonomy: %s.'), labels.singular_name),
       icon: _icons.blockMeta,
       templatePrefix: templatePrefixes[slug]
     };
-    const hasEntities = taxonomiesInfo?.[slug]?.hasEntities; // We have a different template creation flow only if they have entities.
-
+    const hasEntities = taxonomiesInfo?.[slug]?.hasEntities;
+    // We have a different template creation flow only if they have entities.
     if (hasEntities) {
       menuItem.onClick = template => {
         onClickMenuItem({
@@ -382,28 +351,24 @@ const useTaxonomiesMenuItems = onClickMenuItem => {
           template
         });
       };
-    } // We don't need to add the menu item if there are no
+    }
+    // We don't need to add the menu item if there are no
     // entities and the general template exists.
-
-
     if (!hasGeneralTemplate || hasEntities) {
       accumulator.push(menuItem);
     }
-
     return accumulator;
-  }, []); // Split menu items into two groups: one for the default taxonomies
+  }, []);
+  // Split menu items into two groups: one for the default taxonomies
   // and one for the rest.
-
   const taxonomiesMenuItems = (0, _element.useMemo)(() => menuItems.reduce((accumulator, taxonomy) => {
     const {
       slug
     } = taxonomy;
     let key = 'taxonomiesMenuItems';
-
     if (['category', 'tag'].includes(slug)) {
       key = 'defaultTaxonomiesMenuItems';
     }
-
     accumulator[key].push(taxonomy);
     return accumulator;
   }, {
@@ -412,7 +377,6 @@ const useTaxonomiesMenuItems = onClickMenuItem => {
   }), [menuItems]);
   return taxonomiesMenuItems;
 };
-
 exports.useTaxonomiesMenuItems = useTaxonomiesMenuItems;
 const USE_AUTHOR_MENU_ITEM_TEMPLATE_PREFIX = {
   user: 'author'
@@ -422,7 +386,6 @@ const USE_AUTHOR_MENU_ITEM_QUERY_PARAMETERS = {
     who: 'authors'
   }
 };
-
 function useAuthorMenuItem(onClickMenuItem) {
   const existingTemplates = useExistingTemplates();
   const defaultTemplateTypes = useDefaultTemplateTypes();
@@ -430,7 +393,6 @@ function useAuthorMenuItem(onClickMenuItem) {
   let authorMenuItem = defaultTemplateTypes?.find(({
     slug
   }) => slug === 'author');
-
   if (!authorMenuItem) {
     authorMenuItem = {
       description: (0, _i18n.__)('Displays latest posts written by a single author.'),
@@ -438,16 +400,14 @@ function useAuthorMenuItem(onClickMenuItem) {
       title: 'Author'
     };
   }
-
   const hasGeneralTemplate = !!existingTemplates?.find(({
     slug
   }) => slug === 'author');
-
   if (authorInfo.user?.hasEntities) {
-    authorMenuItem = { ...authorMenuItem,
+    authorMenuItem = {
+      ...authorMenuItem,
       templatePrefix: 'author'
     };
-
     authorMenuItem.onClick = template => {
       onClickMenuItem({
         type: 'root',
@@ -483,11 +443,11 @@ function useAuthorMenuItem(onClickMenuItem) {
       });
     };
   }
-
   if (!hasGeneralTemplate || authorInfo.user?.hasEntities) {
     return authorMenuItem;
   }
 }
+
 /**
  * Helper hook that filters all the existing templates by the given
  * object with the entity's slug as key and the template prefix as value.
@@ -502,31 +462,26 @@ function useAuthorMenuItem(onClickMenuItem) {
  * @param {Record<string,string>} templatePrefixes An object with the entity's slug as key and the template prefix as value.
  * @return {Record<string,string[]>} An object with the entity's slug as key and an array with the existing template slugs as value.
  */
-
-
 const useExistingTemplateSlugs = templatePrefixes => {
   const existingTemplates = useExistingTemplates();
   const existingSlugs = (0, _element.useMemo)(() => {
     return Object.entries(templatePrefixes || {}).reduce((accumulator, [slug, prefix]) => {
       const slugsWithTemplates = (existingTemplates || []).reduce((_accumulator, existingTemplate) => {
         const _prefix = `${prefix}-`;
-
         if (existingTemplate.slug.startsWith(_prefix)) {
           _accumulator.push(existingTemplate.slug.substring(_prefix.length));
         }
-
         return _accumulator;
       }, []);
-
       if (slugsWithTemplates.length) {
         accumulator[slug] = slugsWithTemplates;
       }
-
       return accumulator;
     }, {});
   }, [templatePrefixes, existingTemplates]);
   return existingSlugs;
 };
+
 /**
  * Helper hook that finds the existing records with an associated template,
  * as they need to be excluded from the template suggestions.
@@ -536,8 +491,6 @@ const useExistingTemplateSlugs = templatePrefixes => {
  * @param {Record<string,Object>} additionalQueryParameters An object with the entity's slug as key and additional query parameters as value.
  * @return {Record<string,EntitiesInfo>} An object with the entity's slug as key and the existing records as value.
  */
-
-
 const useTemplatesToExclude = (entityName, templatePrefixes, additionalQueryParameters = {}) => {
   const slugsToExcludePerEntity = useExistingTemplateSlugs(templatePrefixes);
   const recordsToExcludePerEntity = (0, _data.useSelect)(select => {
@@ -548,16 +501,15 @@ const useTemplatesToExclude = (entityName, templatePrefixes, additionalQueryPara
         slug: slugsWithTemplates,
         ...additionalQueryParameters[slug]
       });
-
       if (entitiesWithTemplates?.length) {
         accumulator[slug] = entitiesWithTemplates;
       }
-
       return accumulator;
     }, {});
   }, [slugsToExcludePerEntity]);
   return recordsToExcludePerEntity;
 };
+
 /**
  * Helper hook that returns information about an entity having
  * records that we can create a specific template for.
@@ -573,8 +525,6 @@ const useTemplatesToExclude = (entityName, templatePrefixes, additionalQueryPara
  * @param {Record<string,Object>} additionalQueryParameters An object with the entity's slug as key and additional query parameters as value.
  * @return {Record<string,EntitiesInfo>} An object with the entity's slug as key and the EntitiesInfo as value.
  */
-
-
 const useEntitiesInfo = (entityName, templatePrefixes, additionalQueryParameters = {}) => {
   const recordsToExcludePerEntity = useTemplatesToExclude(entityName, templatePrefixes, additionalQueryParameters);
   const entitiesInfo = (0, _data.useSelect)(select => {