@wordpress/editor 13.32.0 → 13.34.0

package/build-module/components/post-actions/actions.js

@@ -7,17 +7,25 @@ import { addQueryArgs } from '@wordpress/url';
 import { useDispatch } from '@wordpress/data';
 import { decodeEntities } from '@wordpress/html-entities';
 import { store as coreStore } from '@wordpress/core-data';
-import { __, _n, sprintf } from '@wordpress/i18n';
+import { __, _n, sprintf, _x } from '@wordpress/i18n';
 import { store as noticesStore } from '@wordpress/notices';
 import { useMemo, useState } from '@wordpress/element';
 import { Button, TextControl, __experimentalText as Text, __experimentalHStack as HStack, __experimentalVStack as VStack } from '@wordpress/components';
+
+/**
+ * Internal dependencies
+ */
+import { TEMPLATE_ORIGINS, TEMPLATE_POST_TYPE } from '../../store/constants';
+import { store as editorStore } from '../../store';
+import { unlock } from '../../lock-unlock';
+import isTemplateRevertable from '../../store/utils/is-template-revertable';
 function getItemTitle(item) {
   if (typeof item.title === 'string') {
     return decodeEntities(item.title);
   }
   return decodeEntities(item.title?.rendered || '');
 }
-export const trashPostAction = {
+const trashPostAction = {
   id: 'move-to-trash',
   label: __('Move to Trash'),
   isPrimary: true,
@@ -73,7 +81,7 @@ export const trashPostAction = {
           }
           createSuccessNotice(successMessage, {
             type: 'snackbar',
-            id: 'edit-site-page-trashed'
+            id: 'trash-post-action'
           });
         } else {
           // If there was at lease one failure.
@@ -105,10 +113,10 @@ export const trashPostAction = {
               errorMessage = sprintf( /* translators: %s: a list of comma separated error messages */
               __('Some errors occurred while moving the pages to the trash: %s'), [...errorMessages].join(','));
             }
-            createErrorNotice(errorMessage, {
-              type: 'snackbar'
-            });
           }
+          createErrorNotice(errorMessage, {
+            type: 'snackbar'
+          });
         }
         if (onActionPerformed) {
           onActionPerformed(posts);
@@ -118,7 +126,7 @@ export const trashPostAction = {
     }, __('Delete'))));
   }
 };
-export function usePermanentlyDeletePostAction() {
+function usePermanentlyDeletePostAction() {
   const {
     createSuccessNotice,
     createErrorNotice
@@ -156,7 +164,7 @@ export function usePermanentlyDeletePostAction() {
         }
         createSuccessNotice(successMessage, {
           type: 'snackbar',
-          id: 'edit-site-post-permanently-deleted'
+          id: 'permanently-delete-post-action'
         });
         if (onActionPerformed) {
           onActionPerformed(posts);
@@ -191,15 +199,15 @@ export function usePermanentlyDeletePostAction() {
             errorMessage = sprintf( /* translators: %s: a list of comma separated error messages */
             __('Some errors occurred while permanently deleting the posts: %s'), [...errorMessages].join(','));
           }
-          createErrorNotice(errorMessage, {
-            type: 'snackbar'
-          });
         }
+        createErrorNotice(errorMessage, {
+          type: 'snackbar'
+        });
       }
     }
   }), [createSuccessNotice, createErrorNotice, deleteEntityRecord]);
 }
-export function useRestorePostAction() {
+function useRestorePostAction() {
   const {
     createSuccessNotice,
     createErrorNotice
@@ -233,7 +241,7 @@ export function useRestorePostAction() {
         __('%d posts have been restored.'), posts.length) : sprintf( /* translators: The number of posts. */
         __('"%s" has been restored.'), getItemTitle(posts[0])), {
           type: 'snackbar',
-          id: 'edit-site-post-restored'
+          id: 'restore-post-action'
         });
         if (onActionPerformed) {
           onActionPerformed(posts);
@@ -254,7 +262,7 @@ export function useRestorePostAction() {
     }
   }), [createSuccessNotice, createErrorNotice, editEntityRecord, saveEditedEntityRecord]);
 }
-export const viewPostAction = {
+const viewPostAction = {
   id: 'view-post',
   label: __('View'),
   isPrimary: true,
@@ -270,7 +278,7 @@ export const viewPostAction = {
     }
   }
 };
-export const editPostAction = {
+const editPostAction = {
   id: 'edit-post',
   label: __('Edit'),
   isPrimary: true,
@@ -286,7 +294,7 @@ export const editPostAction = {
     }
   }
 };
-export const postRevisionsAction = {
+const postRevisionsAction = {
   id: 'view-post-revisions',
   label: __('View revisions'),
   isPrimary: false,
@@ -310,7 +318,7 @@ export const postRevisionsAction = {
     }
   }
 };
-export const renamePostAction = {
+const renamePostAction = {
   id: 'rename-post',
   label: __('Rename'),
   isEligible(post) {
@@ -318,7 +326,8 @@ export const renamePostAction = {
   },
   RenderModal: ({
     items,
-    closeModal
+    closeModal,
+    onActionPerformed
   }) => {
     const [item] = items;
     const originalTitle = decodeEntities(typeof item.title === 'string' ? item.title : item.title.rendered);
@@ -347,6 +356,7 @@ export const renamePostAction = {
         createSuccessNotice(__('Name updated'), {
           type: 'snackbar'
         });
+        onActionPerformed?.(items);
       } catch (error) {
         const errorMessage = error.message && error.code !== 'unknown_error' ? error.message : __('An error occurred while updating the name');
         createErrorNotice(errorMessage, {
@@ -380,12 +390,300 @@ export const renamePostAction = {
     }, __('Save')))));
   }
 };
+export const duplicatePostAction = {
+  id: 'duplicate-post',
+  label: _x('Duplicate', 'action label'),
+  isEligible({
+    status
+  }) {
+    return status !== 'trash';
+  },
+  RenderModal: ({
+    items,
+    closeModal,
+    onActionPerformed
+  }) => {
+    const [item] = items;
+    const [isCreatingPage, setIsCreatingPage] = useState(false);
+    const [title, setTitle] = useState(sprintf( /* translators: %s: Existing item title */
+    __('%s (Copy)'), getItemTitle(item)));
+    const {
+      saveEntityRecord
+    } = useDispatch(coreStore);
+    const {
+      createSuccessNotice,
+      createErrorNotice
+    } = useDispatch(noticesStore);
+    async function createPage(event) {
+      event.preventDefault();
+      if (isCreatingPage) {
+        return;
+      }
+      setIsCreatingPage(true);
+      try {
+        const newItem = await saveEntityRecord('postType', item.type, {
+          status: 'draft',
+          title,
+          slug: title || __('No title'),
+          author: item.author,
+          comment_status: item.comment_status,
+          content: typeof item.content === 'string' ? item.content : item.content.raw,
+          excerpt: item.excerpt.raw,
+          meta: item.meta,
+          parent: item.parent,
+          password: item.password,
+          template: item.template,
+          format: item.format,
+          featured_media: item.featured_media,
+          menu_order: item.menu_order,
+          ping_status: item.ping_status,
+          categories: item.categories,
+          tags: item.tags
+        }, {
+          throwOnError: true
+        });
+        createSuccessNotice(sprintf(
+        // translators: %s: Title of the created template e.g: "Category".
+        __('"%s" successfully created.'), newItem.title?.rendered || title), {
+          id: 'duplicate-post-action',
+          type: 'snackbar'
+        });
+        if (onActionPerformed) {
+          onActionPerformed([newItem]);
+        }
+      } catch (error) {
+        const errorMessage = error.message && error.code !== 'unknown_error' ? error.message : __('An error occurred while duplicating the page.');
+        createErrorNotice(errorMessage, {
+          type: 'snackbar'
+        });
+      } finally {
+        setIsCreatingPage(false);
+        closeModal();
+      }
+    }
+    return createElement("form", {
+      onSubmit: createPage
+    }, createElement(VStack, {
+      spacing: 3
+    }, createElement(TextControl, {
+      label: __('Title'),
+      onChange: setTitle,
+      placeholder: __('No title'),
+      value: title
+    }), createElement(HStack, {
+      spacing: 2,
+      justify: "end"
+    }, createElement(Button, {
+      variant: "tertiary",
+      onClick: closeModal
+    }, __('Cancel')), createElement(Button, {
+      variant: "primary",
+      type: "submit",
+      isBusy: isCreatingPage,
+      "aria-disabled": isCreatingPage
+    }, _x('Duplicate', 'action label')))));
+  }
+};
+const resetTemplateAction = {
+  id: 'reset-template',
+  label: __('Reset'),
+  isEligible: isTemplateRevertable,
+  supportsBulk: true,
+  hideModalHeader: true,
+  RenderModal: ({
+    items,
+    closeModal,
+    onActionPerformed
+  }) => {
+    const {
+      revertTemplate
+    } = unlock(useDispatch(editorStore));
+    const {
+      saveEditedEntityRecord
+    } = useDispatch(coreStore);
+    const {
+      createSuccessNotice,
+      createErrorNotice
+    } = useDispatch(noticesStore);
+    const onConfirm = async () => {
+      try {
+        for (const template of items) {
+          await revertTemplate(template, {
+            allowUndo: false
+          });
+          await saveEditedEntityRecord('postType', template.type, template.id);
+        }
+        createSuccessNotice(items.length > 1 ? sprintf( /* translators: The number of items. */
+        __('%s items reset.'), items.length) : sprintf( /* translators: The template/part's name. */
+        __('"%s" reset.'), decodeEntities(items[0].title.rendered)), {
+          type: 'snackbar',
+          id: 'revert-template-action'
+        });
+      } catch (error) {
+        let fallbackErrorMessage;
+        if (items[0].type === TEMPLATE_POST_TYPE) {
+          fallbackErrorMessage = items.length === 1 ? __('An error occurred while reverting the template.') : __('An error occurred while reverting the templates.');
+        } else {
+          fallbackErrorMessage = items.length === 1 ? __('An error occurred while reverting the template part.') : __('An error occurred while reverting the template parts.');
+        }
+        const errorMessage = error.message && error.code !== 'unknown_error' ? error.message : fallbackErrorMessage;
+        createErrorNotice(errorMessage, {
+          type: 'snackbar'
+        });
+      }
+    };
+    return createElement(VStack, {
+      spacing: "5"
+    }, createElement(Text, null, __('Reset to default and clear all customizations?')), createElement(HStack, {
+      justify: "right"
+    }, createElement(Button, {
+      variant: "tertiary",
+      onClick: closeModal
+    }, __('Cancel')), createElement(Button, {
+      variant: "primary",
+      onClick: async () => {
+        await onConfirm(items);
+        onActionPerformed?.(items);
+        closeModal();
+      }
+    }, __('Reset'))));
+  }
+};
+
+/**
+ * Check if a template is removable.
+ * Copy from packages/edit-site/src/utils/is-template-removable.js.
+ *
+ * @param {Object} template The template entity to check.
+ * @return {boolean} Whether the template is revertable.
+ */
+function isTemplateRemovable(template) {
+  if (!template) {
+    return false;
+  }
+  return template.source === TEMPLATE_ORIGINS.custom && !template.has_theme_file;
+}
+const deleteTemplateAction = {
+  id: 'delete-template',
+  label: __('Delete'),
+  isEligible: isTemplateRemovable,
+  supportsBulk: true,
+  hideModalHeader: true,
+  RenderModal: ({
+    items: templates,
+    closeModal,
+    onActionPerformed
+  }) => {
+    const {
+      removeTemplates
+    } = unlock(useDispatch(editorStore));
+    return createElement(VStack, {
+      spacing: "5"
+    }, createElement(Text, null, templates.length > 1 ? sprintf(
+    // translators: %d: number of items to delete.
+    _n('Delete %d item?', 'Delete %d items?', templates.length), templates.length) : sprintf(
+    // translators: %s: The template or template part's titles
+    __('Delete "%s"?'), decodeEntities(templates?.[0]?.title?.rendered))), createElement(HStack, {
+      justify: "right"
+    }, createElement(Button, {
+      variant: "tertiary",
+      onClick: closeModal
+    }, __('Cancel')), createElement(Button, {
+      variant: "primary",
+      onClick: async () => {
+        await removeTemplates(templates, {
+          allowUndo: false
+        });
+        onActionPerformed?.(templates);
+        closeModal();
+      }
+    }, __('Delete'))));
+  }
+};
+const renameTemplateAction = {
+  id: 'rename-template',
+  label: __('Rename'),
+  isEligible: template => {
+    // We can only remove templates or template parts that can be removed.
+    // Additionally in the case of templates, we can only remove custom templates.
+    if (!isTemplateRemovable(template) || template.type === TEMPLATE_POST_TYPE && !template.is_custom) {
+      return false;
+    }
+    return true;
+  },
+  RenderModal: ({
+    items: templates,
+    closeModal,
+    onActionPerformed
+  }) => {
+    const template = templates[0];
+    const title = decodeEntities(template.title.rendered);
+    const [editedTitle, setEditedTitle] = useState(title);
+    const {
+      editEntityRecord,
+      __experimentalSaveSpecifiedEntityEdits: saveSpecifiedEntityEdits
+    } = useDispatch(coreStore);
+    const {
+      createSuccessNotice,
+      createErrorNotice
+    } = useDispatch(noticesStore);
+    async function onTemplateRename(event) {
+      event.preventDefault();
+      try {
+        await editEntityRecord('postType', template.type, template.id, {
+          title: editedTitle
+        });
+        // Update state before saving rerenders the list.
+        setEditedTitle('');
+        closeModal();
+        // Persist edited entity.
+        await saveSpecifiedEntityEdits('postType', template.type, template.id, ['title'],
+        // Only save title to avoid persisting other edits.
+        {
+          throwOnError: true
+        });
+        createSuccessNotice(template.type === TEMPLATE_POST_TYPE ? __('Template renamed.') : __('Template part renamed.'), {
+          type: 'snackbar'
+        });
+        onActionPerformed?.(templates);
+      } catch (error) {
+        const fallbackErrorMessage = template.type === TEMPLATE_POST_TYPE ? __('An error occurred while renaming the template.') : __('An error occurred while renaming the template part.');
+        const errorMessage = error.message && error.code !== 'unknown_error' ? error.message : fallbackErrorMessage;
+        createErrorNotice(errorMessage, {
+          type: 'snackbar'
+        });
+      }
+    }
+    return createElement("form", {
+      onSubmit: onTemplateRename
+    }, createElement(VStack, {
+      spacing: "5"
+    }, createElement(TextControl, {
+      __nextHasNoMarginBottom: true,
+      __next40pxDefaultSize: true,
+      label: __('Name'),
+      value: editedTitle,
+      onChange: setEditedTitle,
+      required: true
+    }), createElement(HStack, {
+      justify: "right"
+    }, createElement(Button, {
+      variant: "tertiary",
+      onClick: closeModal,
+      __next40pxDefaultSize: true
+    }, __('Cancel')), createElement(Button, {
+      variant: "primary",
+      type: "submit",
+      __next40pxDefaultSize: true
+    }, __('Save')))));
+  }
+};
 export function usePostActions(onActionPerformed, actionIds = null) {
   const permanentlyDeletePostAction = usePermanentlyDeletePostAction();
   const restorePostAction = useRestorePostAction();
   return useMemo(() => {
     // By default, return all actions...
-    const defaultActions = [editPostAction, viewPostAction, restorePostAction, permanentlyDeletePostAction, postRevisionsAction, renamePostAction, trashPostAction];
+    const defaultActions = [editPostAction, resetTemplateAction, viewPostAction, restorePostAction, deleteTemplateAction, permanentlyDeletePostAction, postRevisionsAction, duplicatePostAction, renamePostAction, renameTemplateAction, trashPostAction];
 
     // ... unless `actionIds` was specified, in which case we find the
     // actions matching the given IDs.