@wordpress/editor 12.2.1 → 12.4.0-next.e230fbab09.0

package/build-module/store/actions.js

@@ -6,9 +6,8 @@ import { has } from 'lodash';
  * WordPress dependencies
  */
 
+import apiFetch from '@wordpress/api-fetch';
 import deprecated from '@wordpress/deprecated';
-import { controls } from '@wordpress/data';
-import { apiFetch } from '@wordpress/data-controls';
 import { parse, synchronizeBlocksWithTemplate, __unstableSerializeAndClean } from '@wordpress/blocks';
 import { store as noticesStore } from '@wordpress/notices';
 import { store as coreStore } from '@wordpress/core-data';
@@ -17,7 +16,8 @@ import { store as blockEditorStore } from '@wordpress/block-editor';
  * Internal dependencies
  */
 
-import { STORE_NAME, TRASH_POST_NOTICE_ID } from './constants';
+import { TRASH_POST_NOTICE_ID } from './constants';
+import { localAutosaveSet } from './local-autosave';
 import { getNotificationArgumentsForSaveSuccess, getNotificationArgumentsForSaveFail, getNotificationArgumentsForTrashFail } from './utils/notice-builder';
 /**
  * Returns an action generator used in signalling that editor has initialized with
@@ -28,15 +28,11 @@ import { getNotificationArgumentsForSaveSuccess, getNotificationArgumentsForSave
  * @param {Array?} template Block Template.
  */
 
-export function* setupEditor(post, edits, template) {
-  yield resetPost(post);
-  yield {
-    type: 'SETUP_EDITOR',
-    post,
-    edits,
-    template
-  };
-  yield setupEditorState(post); // Apply a template for new posts only, if exists.
+export const setupEditor = (post, edits, template) => _ref => {
+  let {
+    dispatch
+  } = _ref;
+  dispatch.setupEditorState(post); // Apply a template for new posts only, if exists.
 
   const isNewPost = post.status === 'auto-draft';
 
@@ -54,15 +50,20 @@ export function* setupEditor(post, edits, template) {
 
     let blocks = parse(content);
     blocks = synchronizeBlocksWithTemplate(blocks, template);
-    yield resetEditorBlocks(blocks, {
+    dispatch.resetEditorBlocks(blocks, {
       __unstableShouldCreateUndoLevel: false
     });
   }
 
-  if (edits && Object.keys(edits).some(key => edits[key] !== (has(post, [key, 'raw']) ? post[key].raw : post[key]))) {
-    yield editPost(edits);
+  if (edits && Object.values(edits).some(_ref2 => {
+    var _post$key$raw, _post$key;
+
+    let [key, edit] = _ref2;
+    return edit !== ((_post$key$raw = (_post$key = post[key]) === null || _post$key === void 0 ? void 0 : _post$key.raw) !== null && _post$key$raw !== void 0 ? _post$key$raw : post[key]);
+  })) {
+    dispatch.editPost(edits);
   }
-}
+};
 /**
  * Returns an action object signalling that the editor is being destroyed and
  * that any necessary state or side-effect cleanup should occur.
@@ -79,45 +80,17 @@ export function __experimentalTearDownEditor() {
  * Returns an action object used in signalling that the latest version of the
  * post has been received, either by initialization or save.
  *
- * @param {Object} post Post object.
- *
- * @return {Object} Action object.
- */
-
-export function resetPost(post) {
-  return {
-    type: 'RESET_POST',
-    post
-  };
-}
-/**
- * Action for dispatching that a post update request has started.
- *
- * @param {Object} options
- *
- * @return {Object} An action object
- */
-
-export function __experimentalRequestPostUpdateStart() {
-  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  return {
-    type: 'REQUEST_POST_UPDATE_START',
-    options
-  };
-}
-/**
- * Action for dispatching that a post update request has finished.
- *
- * @param {Object} options
- *
- * @return {Object} An action object
+ * @deprecated Since WordPress 6.0.
  */
 
-export function __experimentalRequestPostUpdateFinish() {
-  let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+export function resetPost() {
+  deprecated("wp.data.dispatch( 'core/editor' ).resetPost", {
+    since: '6.0',
+    version: '6.3',
+    alternative: 'Initialize the editor with the setupEditorState action'
+  });
   return {
-    type: 'REQUEST_POST_UPDATE_FINISH',
-    options
+    type: 'DO_NOTHING'
   };
 }
 /**
@@ -158,81 +131,96 @@ export function setupEditorState(post) {
  *
  * @param {Object} edits   Post attributes to edit.
  * @param {Object} options Options for the edit.
- *
- * @yield {Object} Action object or control.
  */
 
-export function* editPost(edits, options) {
+export const editPost = (edits, options) => _ref3 => {
+  let {
+    select,
+    registry
+  } = _ref3;
   const {
     id,
     type
-  } = yield controls.select(STORE_NAME, 'getCurrentPost');
-  yield controls.dispatch(coreStore, 'editEntityRecord', 'postType', type, id, edits, options);
-}
+  } = select.getCurrentPost();
+  registry.dispatch(coreStore).editEntityRecord('postType', type, id, edits, options);
+};
 /**
- * Action generator for saving the current post in the editor.
+ * Action for saving the current post in the editor.
  *
  * @param {Object} options
  */
 
-export function* savePost() {
+export const savePost = function () {
   let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  return async _ref4 => {
+    let {
+      select,
+      dispatch,
+      registry
+    } = _ref4;
+
+    if (!select.isEditedPostSaveable()) {
+      return;
+    }
 
-  if (!(yield controls.select(STORE_NAME, 'isEditedPostSaveable'))) {
-    return;
-  }
-
-  let edits = {
-    content: yield controls.select(STORE_NAME, 'getEditedPostContent')
-  };
+    const content = select.getEditedPostContent();
 
-  if (!options.isAutosave) {
-    yield controls.dispatch(STORE_NAME, 'editPost', edits, {
-      undoIgnore: true
-    });
-  }
+    if (!options.isAutosave) {
+      dispatch.editPost({
+        content
+      }, {
+        undoIgnore: true
+      });
+    }
 
-  yield __experimentalRequestPostUpdateStart(options);
-  const previousRecord = yield controls.select(STORE_NAME, 'getCurrentPost');
-  edits = {
-    id: previousRecord.id,
-    ...(yield controls.select(coreStore, 'getEntityRecordNonTransientEdits', 'postType', previousRecord.type, previousRecord.id)),
-    ...edits
-  };
-  yield controls.dispatch(coreStore, 'saveEntityRecord', 'postType', previousRecord.type, edits, options);
-  yield __experimentalRequestPostUpdateFinish(options);
-  const error = yield controls.select(coreStore, 'getLastEntitySaveError', 'postType', previousRecord.type, previousRecord.id);
-
-  if (error) {
-    const args = getNotificationArgumentsForSaveFail({
-      post: previousRecord,
-      edits,
-      error
+    const previousRecord = select.getCurrentPost();
+    const edits = {
+      id: previousRecord.id,
+      ...registry.select(coreStore).getEntityRecordNonTransientEdits('postType', previousRecord.type, previousRecord.id),
+      content
+    };
+    dispatch({
+      type: 'REQUEST_POST_UPDATE_START',
+      options
     });
-
-    if (args.length) {
-      yield controls.dispatch(noticesStore, 'createErrorNotice', ...args);
-    }
-  } else {
-    const updatedRecord = yield controls.select(STORE_NAME, 'getCurrentPost');
-    const args = getNotificationArgumentsForSaveSuccess({
-      previousPost: previousRecord,
-      post: updatedRecord,
-      postType: yield controls.resolveSelect(coreStore, 'getPostType', updatedRecord.type),
+    await registry.dispatch(coreStore).saveEntityRecord('postType', previousRecord.type, edits, options);
+    dispatch({
+      type: 'REQUEST_POST_UPDATE_FINISH',
       options
     });
-
-    if (args.length) {
-      yield controls.dispatch(noticesStore, 'createSuccessNotice', ...args);
-    } // Make sure that any edits after saving create an undo level and are
-    // considered for change detection.
-
-
-    if (!options.isAutosave) {
-      yield controls.dispatch(blockEditorStore, '__unstableMarkLastChangeAsPersistent');
+    const error = registry.select(coreStore).getLastEntitySaveError('postType', previousRecord.type, previousRecord.id);
+
+    if (error) {
+      const args = getNotificationArgumentsForSaveFail({
+        post: previousRecord,
+        edits,
+        error
+      });
+
+      if (args.length) {
+        registry.dispatch(noticesStore).createErrorNotice(...args);
+      }
+    } else {
+      const updatedRecord = select.getCurrentPost();
+      const args = getNotificationArgumentsForSaveSuccess({
+        previousPost: previousRecord,
+        post: updatedRecord,
+        postType: await registry.resolveSelect(coreStore).getPostType(updatedRecord.type),
+        options
+      });
+
+      if (args.length) {
+        registry.dispatch(noticesStore).createSuccessNotice(...args);
+      } // Make sure that any edits after saving create an undo level and are
+      // considered for change detection.
+
+
+      if (!options.isAutosave) {
+        registry.dispatch(blockEditorStore).__unstableMarkLastChangeAsPersistent();
+      }
     }
-  }
-}
+  };
+};
 /**
  * Action for refreshing the current post.
  *
@@ -250,29 +238,34 @@ export function refreshPost() {
   };
 }
 /**
- * Action generator for trashing the current post in the editor.
+ * Action for trashing the current post in the editor.
  */
 
-export function* trashPost() {
-  const postTypeSlug = yield controls.select(STORE_NAME, 'getCurrentPostType');
-  const postType = yield controls.resolveSelect(coreStore, 'getPostType', postTypeSlug);
-  yield controls.dispatch(noticesStore, 'removeNotice', TRASH_POST_NOTICE_ID);
+export const trashPost = () => async _ref5 => {
+  let {
+    select,
+    dispatch,
+    registry
+  } = _ref5;
+  const postTypeSlug = select.getCurrentPostType();
+  const postType = await registry.resolveSelect(coreStore).getPostType(postTypeSlug);
+  registry.dispatch(noticesStore).removeNotice(TRASH_POST_NOTICE_ID);
 
   try {
-    const post = yield controls.select(STORE_NAME, 'getCurrentPost');
-    yield apiFetch({
+    const post = select.getCurrentPost();
+    await apiFetch({
       path: `/wp/v2/${postType.rest_base}/${post.id}`,
       method: 'DELETE'
     });
-    yield controls.dispatch(STORE_NAME, 'savePost');
+    await dispatch.savePost();
   } catch (error) {
-    yield controls.dispatch(noticesStore, 'createErrorNotice', ...getNotificationArgumentsForTrashFail({
+    registry.dispatch(noticesStore).createErrorNotice(...getNotificationArgumentsForTrashFail({
       error
     }));
   }
-}
+};
 /**
- * Action generator used in signalling that the post should autosave.  This
+ * Action that autosaves the current post.  This
  * includes server-side autosaving (default) and client-side (a.k.a. local)
  * autosaving (e.g. on the Web, the post might be committed to Session
  * Storage).
@@ -280,52 +273,52 @@ export function* trashPost() {
  * @param {Object?} options Extra flags to identify the autosave.
  */
 
-export function* autosave() {
+export const autosave = function () {
   let {
     local = false,
     ...options
   } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-
-  if (local) {
-    const post = yield controls.select(STORE_NAME, 'getCurrentPost');
-    const isPostNew = yield controls.select(STORE_NAME, 'isEditedPostNew');
-    const title = yield controls.select(STORE_NAME, 'getEditedPostAttribute', 'title');
-    const content = yield controls.select(STORE_NAME, 'getEditedPostAttribute', 'content');
-    const excerpt = yield controls.select(STORE_NAME, 'getEditedPostAttribute', 'excerpt');
-    yield {
-      type: 'LOCAL_AUTOSAVE_SET',
-      postId: post.id,
-      isPostNew,
-      title,
-      content,
-      excerpt
-    };
-  } else {
-    yield controls.dispatch(STORE_NAME, 'savePost', {
-      isAutosave: true,
-      ...options
-    });
-  }
-}
+  return async _ref6 => {
+    let {
+      select,
+      dispatch
+    } = _ref6;
+
+    if (local) {
+      const post = select.getCurrentPost();
+      const isPostNew = select.isEditedPostNew();
+      const title = select.getEditedPostAttribute('title');
+      const content = select.getEditedPostAttribute('content');
+      const excerpt = select.getEditedPostAttribute('excerpt');
+      localAutosaveSet(post.id, isPostNew, title, content, excerpt);
+    } else {
+      await dispatch.savePost({
+        isAutosave: true,
+        ...options
+      });
+    }
+  };
+};
 /**
- * Returns an action object used in signalling that undo history should
- * restore last popped state.
- *
- * @yield {Object} Action object.
+ * Action that restores last popped state in undo history.
  */
 
-export function* redo() {
-  yield controls.dispatch(coreStore, 'redo');
-}
+export const redo = () => _ref7 => {
+  let {
+    registry
+  } = _ref7;
+  registry.dispatch(coreStore).redo();
+};
 /**
- * Returns an action object used in signalling that undo history should pop.
- *
- * @yield {Object} Action object.
+ * Action that pops a record from undo history and undoes the edit.
  */
 
-export function* undo() {
-  yield controls.dispatch(coreStore, 'undo');
-}
+export const undo = () => _ref8 => {
+  let {
+    registry
+  } = _ref8;
+  registry.dispatch(coreStore).undo();
+};
 /**
  * Action that creates an undo history record.
  *
@@ -343,10 +336,9 @@ export function createUndoLevel() {
   };
 }
 /**
- * Returns an action object used to lock the editor.
+ * Action that locks the editor.
  *
  * @param {Object} lock Details about the post lock status, user, and nonce.
- *
  * @return {Object} Action object.
  */
 
@@ -357,8 +349,7 @@ export function updatePostLock(lock) {
   };
 }
 /**
- * Returns an action object used in signalling that the user has enabled the
- * publish sidebar.
+ * Action that enables the publish sidebar.
  *
  * @return {Object} Action object
  */
@@ -369,8 +360,7 @@ export function enablePublishSidebar() {
   };
 }
 /**
- * Returns an action object used in signalling that the user has disabled the
- * publish sidebar.
+ * Action that disables the publish sidebar.
  *
  * @return {Object} Action object
  */
@@ -381,7 +371,7 @@ export function disablePublishSidebar() {
   };
 }
 /**
- * Returns an action object used to signal that post saving is locked.
+ * Action that locks post saving.
  *
  * @param {string} lockName The lock name.
  *
@@ -431,7 +421,7 @@ export function lockPostSaving(lockName) {
   };
 }
 /**
- * Returns an action object used to signal that post saving is unlocked.
+ * Action that unlocks post saving.
  *
  * @param {string} lockName The lock name.
  *
@@ -451,7 +441,7 @@ export function unlockPostSaving(lockName) {
   };
 }
 /**
- * Returns an action object used to signal that post autosaving is locked.
+ * Action that locks post autosaving.
  *
  * @param {string} lockName The lock name.
  *
@@ -471,7 +461,7 @@ export function lockPostAutosaving(lockName) {
   };
 }
 /**
- * Returns an action object used to signal that post autosaving is unlocked.
+ * Action that unlocks post autosaving.
  *
  * @param {string} lockName The lock name.
  *
@@ -495,45 +485,52 @@ export function unlockPostAutosaving(lockName) {
  *
  * @param {Array}   blocks  Block Array.
  * @param {?Object} options Optional options.
- *
- * @yield {Object} Action object
  */
 
-export function* resetEditorBlocks(blocks) {
+export const resetEditorBlocks = function (blocks) {
   let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  const {
-    __unstableShouldCreateUndoLevel,
-    selection
-  } = options;
-  const edits = {
-    blocks,
-    selection
-  };
-
-  if (__unstableShouldCreateUndoLevel !== false) {
+  return _ref9 => {
+    let {
+      select,
+      dispatch,
+      registry
+    } = _ref9;
     const {
-      id,
-      type
-    } = yield controls.select(STORE_NAME, 'getCurrentPost');
-    const noChange = (yield controls.select(coreStore, 'getEditedEntityRecord', 'postType', type, id)).blocks === edits.blocks;
-
-    if (noChange) {
-      return yield controls.dispatch(coreStore, '__unstableCreateUndoLevel', 'postType', type, id);
-    } // We create a new function here on every persistent edit
-    // to make sure the edit makes the post dirty and creates
-    // a new undo level.
-
-
-    edits.content = _ref => {
-      let {
-        blocks: blocksForSerialization = []
-      } = _ref;
-      return __unstableSerializeAndClean(blocksForSerialization);
+      __unstableShouldCreateUndoLevel,
+      selection
+    } = options;
+    const edits = {
+      blocks,
+      selection
     };
-  }
 
-  yield* editPost(edits);
-}
+    if (__unstableShouldCreateUndoLevel !== false) {
+      const {
+        id,
+        type
+      } = select.getCurrentPost();
+      const noChange = registry.select(coreStore).getEditedEntityRecord('postType', type, id).blocks === edits.blocks;
+
+      if (noChange) {
+        registry.dispatch(coreStore).__unstableCreateUndoLevel('postType', type, id);
+
+        return;
+      } // We create a new function here on every persistent edit
+      // to make sure the edit makes the post dirty and creates
+      // a new undo level.
+
+
+      edits.content = _ref10 => {
+        let {
+          blocks: blocksForSerialization = []
+        } = _ref10;
+        return __unstableSerializeAndClean(blocksForSerialization);
+      };
+    }
+
+    dispatch.editPost(edits);
+  };
+};
 /*
  * Returns an action object used in signalling that the post editor settings have been updated.
  *
@@ -552,18 +549,22 @@ export function updateEditorSettings(settings) {
  * Backward compatibility
  */
 
-const getBlockEditorAction = name => function* () {
-  deprecated("`wp.data.dispatch( 'core/editor' )." + name + '`', {
-    since: '5.3',
-    alternative: "`wp.data.dispatch( 'core/block-editor' )." + name + '`',
-    version: '6.2'
-  });
-
+const getBlockEditorAction = name => function () {
   for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
     args[_key] = arguments[_key];
   }
 
-  yield controls.dispatch(blockEditorStore, name, ...args);
+  return _ref11 => {
+    let {
+      registry
+    } = _ref11;
+    deprecated("`wp.data.dispatch( 'core/editor' )." + name + '`', {
+      since: '5.3',
+      alternative: "`wp.data.dispatch( 'core/block-editor' )." + name + '`',
+      version: '6.2'
+    });
+    registry.dispatch(blockEditorStore)[name](...args);
+  };
 };
 /**
  * @see resetBlocks in core/block-editor store.