@wordpress/core-data 4.0.1-next.253d9b6e21.0 → 4.0.3

package/README.md

@@ -12,7 +12,7 @@ Install the module
 npm install @wordpress/core-data --save
 ```
 
-_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for ES2015+ such as IE browsers then using [core-js](https://github.com/zloirock/core-js) will add polyfills for these methods._
+_This package assumes that your code will run in an **ES2015+** environment. If you're using an environment that has limited or no support for such language features and APIs, you should include [the polyfill shipped in `@wordpress/babel-preset-default`](https://github.com/WordPress/gutenberg/tree/HEAD/packages/babel-preset-default#polyfill) in your code._
 
 ## Example
 
@@ -69,7 +69,7 @@ _Parameters_
 -   _recordId_ `string`: Record ID of the deleted entity.
 -   _query_ `?Object`: Special query parameters for the DELETE API call.
 -   _options_ `[Object]`: Delete options.
--   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a control descriptor.
+-   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a promise.
 
 ### editEntityRecord
 
@@ -214,6 +214,10 @@ _Returns_
 Action triggered to redo the last undoed
 edit to an entity record, if any.
 
+_Returns_
+
+-   `undefined`:
+
 ### saveEditedEntityRecord
 
 Action triggered to save an entity record's edits.
@@ -236,13 +240,17 @@ _Parameters_
 -   _record_ `Object`: Record to be saved.
 -   _options_ `Object`: Saving options.
 -   _options.isAutosave_ `[boolean]`: Whether this is an autosave.
--   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a control descriptor.
+-   _options.\_\_unstableFetch_ `[Function]`: Internal use only. Function to call instead of `apiFetch()`. Must return a promise.
 
 ### undo
 
 Action triggered to undo the last edit to
 an entity record, if any.
 
+_Returns_
+
+-   `undefined`:
+
 <!-- END TOKEN(Autogenerated actions|src/actions.js) -->
 
 ## Selectors

package/build/actions.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
@@ -10,26 +12,17 @@ exports.receiveEntityRecords = receiveEntityRecords;
 exports.receiveCurrentTheme = receiveCurrentTheme;
 exports.receiveThemeSupports = receiveThemeSupports;
 exports.receiveEmbedPreview = receiveEmbedPreview;
-exports.deleteEntityRecord = deleteEntityRecord;
-exports.editEntityRecord = editEntityRecord;
-exports.undo = undo;
-exports.redo = redo;
 exports.__unstableCreateUndoLevel = __unstableCreateUndoLevel;
-exports.saveEntityRecord = saveEntityRecord;
-exports.__experimentalBatch = __experimentalBatch;
-exports.saveEditedEntityRecord = saveEditedEntityRecord;
-exports.__experimentalSaveSpecifiedEntityEdits = __experimentalSaveSpecifiedEntityEdits;
 exports.receiveUploadPermissions = receiveUploadPermissions;
 exports.receiveUserPermission = receiveUserPermission;
 exports.receiveAutosaves = receiveAutosaves;
+exports.__experimentalSaveSpecifiedEntityEdits = exports.saveEditedEntityRecord = exports.__experimentalBatch = exports.saveEntityRecord = exports.redo = exports.undo = exports.editEntityRecord = exports.deleteEntityRecord = void 0;
 
 var _lodash = require("lodash");
 
 var _uuid = require("uuid");
 
-var _data = require("@wordpress/data");
-
-var _dataControls = require("@wordpress/data-controls");
+var _apiFetch = _interopRequireDefault(require("@wordpress/api-fetch"));
 
 var _url = require("@wordpress/url");
 
@@ -37,12 +30,8 @@ var _queriedData = require("./queried-data");
 
 var _entities = require("./entities");
 
-var _locks = require("./locks");
-
 var _batch = require("./batch");
 
-var _controls = require("./controls");
-
 var _name = require("./name");
 
 /**
@@ -197,14 +186,16 @@ function receiveEmbedPreview(url, preview) {
  * @param {Object}   [options]                 Delete options.
  * @param {Function} [options.__unstableFetch] Internal use only. Function to
  *                                             call instead of `apiFetch()`.
- *                                             Must return a control descriptor.
+ *                                             Must return a promise.
  */
 
 
-function* deleteEntityRecord(kind, name, recordId, query, {
-  __unstableFetch = null
-} = {}) {
-  const entities = yield (0, _entities.getKindEntities)(kind);
+const deleteEntityRecord = (kind, name, recordId, query, {
+  __unstableFetch = _apiFetch.default
+} = {}) => async ({
+  dispatch
+}) => {
+  const entities = await dispatch((0, _entities.getKindEntities)(kind));
   const entity = (0, _lodash.find)(entities, {
     kind,
     name
@@ -212,21 +203,21 @@ function* deleteEntityRecord(kind, name, recordId, query, {
   let error;
   let deletedRecord = false;
 
-  if (!entity) {
+  if (!entity || entity !== null && entity !== void 0 && entity.__experimentalNoFetch) {
     return;
   }
 
-  const lock = yield* (0, _locks.__unstableAcquireStoreLock)(_name.STORE_NAME, ['entities', 'data', kind, name, recordId], {
+  const lock = await dispatch.__unstableAcquireStoreLock(_name.STORE_NAME, ['entities', 'data', kind, name, recordId], {
     exclusive: true
   });
 
   try {
-    yield {
+    dispatch({
       type: 'DELETE_ENTITY_RECORD_START',
       kind,
       name,
       recordId
-    };
+    });
 
     try {
       let path = `${entity.baseURL}/${recordId}`;
@@ -235,34 +226,27 @@ function* deleteEntityRecord(kind, name, recordId, query, {
         path = (0, _url.addQueryArgs)(path, query);
       }
 
-      const options = {
+      deletedRecord = await __unstableFetch({
         path,
         method: 'DELETE'
-      };
-
-      if (__unstableFetch) {
-        deletedRecord = yield (0, _dataControls.__unstableAwaitPromise)(__unstableFetch(options));
-      } else {
-        deletedRecord = yield (0, _dataControls.apiFetch)(options);
-      }
-
-      yield (0, _queriedData.removeItems)(kind, name, recordId, true);
+      });
+      await dispatch((0, _queriedData.removeItems)(kind, name, recordId, true));
     } catch (_error) {
       error = _error;
     }
 
-    yield {
+    dispatch({
       type: 'DELETE_ENTITY_RECORD_FINISH',
       kind,
       name,
       recordId,
       error
-    };
+    });
     return deletedRecord;
   } finally {
-    yield* (0, _locks.__unstableReleaseStoreLock)(lock);
+    dispatch.__unstableReleaseStoreLock(lock);
   }
-}
+};
 /**
  * Returns an action object that triggers an
  * edit to an entity record.
@@ -278,8 +262,13 @@ function* deleteEntityRecord(kind, name, recordId, query, {
  */
 
 
-function* editEntityRecord(kind, name, recordId, edits, options = {}) {
-  const entity = yield _data.controls.select(_name.STORE_NAME, 'getEntity', kind, name);
+exports.deleteEntityRecord = deleteEntityRecord;
+
+const editEntityRecord = (kind, name, recordId, edits, options = {}) => ({
+  select,
+  dispatch
+}) => {
+  const entity = select.getEntity(kind, name);
 
   if (!entity) {
     throw new Error(`The entity being edited (${kind}, ${name}) does not have a loaded config.`);
@@ -289,8 +278,8 @@ function* editEntityRecord(kind, name, recordId, edits, options = {}) {
     transientEdits = {},
     mergedEdits = {}
   } = entity;
-  const record = yield _data.controls.select(_name.STORE_NAME, 'getRawEntityRecord', kind, name, recordId);
-  const editedRecord = yield _data.controls.select(_name.STORE_NAME, 'getEditedEntityRecord', kind, name, recordId);
+  const record = select.getRawEntityRecord(kind, name, recordId);
+  const editedRecord = select.getEditedEntityRecord(kind, name, recordId);
   const edit = {
     kind,
     name,
@@ -308,7 +297,7 @@ function* editEntityRecord(kind, name, recordId, edits, options = {}) {
     }, {}),
     transientEdits
   };
-  return {
+  dispatch({
     type: 'EDIT_ENTITY_RECORD',
     ...edit,
     meta: {
@@ -320,50 +309,64 @@ function* editEntityRecord(kind, name, recordId, edits, options = {}) {
         }, {})
       }
     }
-  };
-}
+  });
+};
 /**
  * Action triggered to undo the last edit to
  * an entity record, if any.
+ *
+ * @return {undefined}
  */
 
 
-function* undo() {
-  const undoEdit = yield _data.controls.select(_name.STORE_NAME, 'getUndoEdit');
+exports.editEntityRecord = editEntityRecord;
+
+const undo = () => ({
+  select,
+  dispatch
+}) => {
+  const undoEdit = select.getUndoEdit();
 
   if (!undoEdit) {
     return;
   }
 
-  yield {
+  dispatch({
     type: 'EDIT_ENTITY_RECORD',
     ...undoEdit,
     meta: {
       isUndo: true
     }
-  };
-}
+  });
+};
 /**
  * Action triggered to redo the last undoed
  * edit to an entity record, if any.
+ *
+ * @return {undefined}
  */
 
 
-function* redo() {
-  const redoEdit = yield _data.controls.select(_name.STORE_NAME, 'getRedoEdit');
+exports.undo = undo;
+
+const redo = () => ({
+  select,
+  dispatch
+}) => {
+  const redoEdit = select.getRedoEdit();
 
   if (!redoEdit) {
     return;
   }
 
-  yield {
+  dispatch({
     type: 'EDIT_ENTITY_RECORD',
     ...redoEdit,
     meta: {
       isRedo: true
     }
-  };
-}
+  });
+};
 /**
  * Forces the creation of a new undo level.
  *
@@ -371,6 +374,8 @@ function* redo() {
  */
 
 
+exports.redo = redo;
+
 function __unstableCreateUndoLevel() {
   return {
     type: 'CREATE_UNDO_LEVEL'
@@ -386,28 +391,31 @@ function __unstableCreateUndoLevel() {
  * @param {boolean}  [options.isAutosave=false] Whether this is an autosave.
  * @param {Function} [options.__unstableFetch]  Internal use only. Function to
  *                                              call instead of `apiFetch()`.
- *                                              Must return a control
- *                                              descriptor.
+ *                                              Must return a promise.
  */
 
 
-function* saveEntityRecord(kind, name, record, {
+const saveEntityRecord = (kind, name, record, {
   isAutosave = false,
-  __unstableFetch = null
-} = {}) {
-  const entities = yield (0, _entities.getKindEntities)(kind);
+  __unstableFetch = _apiFetch.default
+} = {}) => async ({
+  select,
+  resolveSelect,
+  dispatch
+}) => {
+  const entities = await dispatch((0, _entities.getKindEntities)(kind));
   const entity = (0, _lodash.find)(entities, {
     kind,
     name
   });
 
-  if (!entity) {
+  if (!entity || entity !== null && entity !== void 0 && entity.__experimentalNoFetch) {
     return;
   }
 
   const entityIdKey = entity.key || _entities.DEFAULT_ENTITY_KEY;
   const recordId = record[entityIdKey];
-  const lock = yield* (0, _locks.__unstableAcquireStoreLock)(_name.STORE_NAME, ['entities', 'data', kind, name, recordId || (0, _uuid.v4)()], {
+  const lock = await dispatch.__unstableAcquireStoreLock(_name.STORE_NAME, ['entities', 'data', kind, name, recordId || (0, _uuid.v4)()], {
     exclusive: true
   });
 
@@ -416,8 +424,8 @@ function* saveEntityRecord(kind, name, record, {
     // (Function edits that should be evaluated on save to avoid expensive computations on every edit.)
     for (const [key, value] of Object.entries(record)) {
       if (typeof value === 'function') {
-        const evaluatedValue = value(yield _data.controls.select(_name.STORE_NAME, 'getEditedEntityRecord', kind, name, recordId));
-        yield editEntityRecord(kind, name, recordId, {
+        const evaluatedValue = value(select.getEditedEntityRecord(kind, name, recordId));
+        dispatch.editEntityRecord(kind, name, recordId, {
           [key]: evaluatedValue
         }, {
           undoIgnore: true
@@ -426,28 +434,28 @@ function* saveEntityRecord(kind, name, record, {
       }
     }
 
-    yield {
+    dispatch({
       type: 'SAVE_ENTITY_RECORD_START',
       kind,
       name,
       recordId,
       isAutosave
-    };
+    });
     let updatedRecord;
     let error;
 
     try {
       const path = `${entity.baseURL}${recordId ? '/' + recordId : ''}`;
-      const persistedRecord = yield _data.controls.select(_name.STORE_NAME, 'getRawEntityRecord', kind, name, recordId);
+      const persistedRecord = select.getRawEntityRecord(kind, name, recordId);
 
       if (isAutosave) {
         // Most of this autosave logic is very specific to posts.
         // This is fine for now as it is the only supported autosave,
         // but ideally this should all be handled in the back end,
         // so the client just sends and receives objects.
-        const currentUser = yield _data.controls.select(_name.STORE_NAME, 'getCurrentUser');
+        const currentUser = select.getCurrentUser();
         const currentUserId = currentUser ? currentUser.id : undefined;
-        const autosavePost = yield _data.controls.select(_name.STORE_NAME, 'getAutosave', persistedRecord.type, persistedRecord.id, currentUserId); // Autosaves need all expected fields to be present.
+        const autosavePost = resolveSelect.getAutosave(persistedRecord.type, persistedRecord.id, currentUserId); // Autosaves need all expected fields to be present.
         // So we fallback to the previous autosave and then
         // to the actual persisted entity if the edits don't
         // have a value.
@@ -458,29 +466,21 @@ function* saveEntityRecord(kind, name, record, {
         };
         data = Object.keys(data).reduce((acc, key) => {
           if (['title', 'excerpt', 'content'].includes(key)) {
-            // Edits should be the "raw" attribute values.
-            acc[key] = (0, _lodash.get)(data[key], 'raw', data[key]);
+            acc[key] = data[key];
           }
 
           return acc;
         }, {
           status: data.status === 'auto-draft' ? 'draft' : data.status
         });
-        const options = {
+        updatedRecord = await __unstableFetch({
           path: `${path}/autosaves`,
           method: 'POST',
           data
-        };
-
-        if (__unstableFetch) {
-          updatedRecord = yield (0, _dataControls.__unstableAwaitPromise)(__unstableFetch(options));
-        } else {
-          updatedRecord = yield (0, _dataControls.apiFetch)(options);
-        } // An autosave may be processed by the server as a regular save
+        }); // An autosave may be processed by the server as a regular save
         // when its update is requested by the author and the post had
         // draft or auto-draft status.
 
-
         if (persistedRecord.id === updatedRecord.id) {
           let newRecord = { ...persistedRecord,
             ...data,
@@ -489,22 +489,21 @@ function* saveEntityRecord(kind, name, record, {
           newRecord = Object.keys(newRecord).reduce((acc, key) => {
             // These properties are persisted in autosaves.
             if (['title', 'excerpt', 'content'].includes(key)) {
-              // Edits should be the "raw" attribute values.
-              acc[key] = (0, _lodash.get)(newRecord[key], 'raw', newRecord[key]);
+              acc[key] = newRecord[key];
             } else if (key === 'status') {
               // Status is only persisted in autosaves when going from
               // "auto-draft" to "draft".
               acc[key] = persistedRecord.status === 'auto-draft' && newRecord.status === 'draft' ? newRecord.status : persistedRecord.status;
             } else {
               // These properties are not persisted in autosaves.
-              acc[key] = (0, _lodash.get)(persistedRecord[key], 'raw', persistedRecord[key]);
+              acc[key] = persistedRecord[key];
             }
 
             return acc;
           }, {});
-          yield receiveEntityRecords(kind, name, newRecord, undefined, true);
+          dispatch.receiveEntityRecords(kind, name, newRecord, undefined, true);
         } else {
-          yield receiveAutosaves(persistedRecord.id, updatedRecord);
+          dispatch.receiveAutosaves(persistedRecord.id, updatedRecord);
         }
       } else {
         let edits = record;
@@ -515,37 +514,30 @@ function* saveEntityRecord(kind, name, record, {
           };
         }
 
-        const options = {
+        updatedRecord = await __unstableFetch({
           path,
           method: recordId ? 'PUT' : 'POST',
           data: edits
-        };
-
-        if (__unstableFetch) {
-          updatedRecord = yield (0, _dataControls.__unstableAwaitPromise)(__unstableFetch(options));
-        } else {
-          updatedRecord = yield (0, _dataControls.apiFetch)(options);
-        }
-
-        yield receiveEntityRecords(kind, name, updatedRecord, undefined, true, edits);
+        });
+        dispatch.receiveEntityRecords(kind, name, updatedRecord, undefined, true, edits);
       }
     } catch (_error) {
       error = _error;
     }
 
-    yield {
+    dispatch({
       type: 'SAVE_ENTITY_RECORD_FINISH',
       kind,
       name,
       recordId,
       error,
       isAutosave
-    };
+    });
     return updatedRecord;
   } finally {
-    yield* (0, _locks.__unstableReleaseStoreLock)(lock);
+    dispatch.__unstableReleaseStoreLock(lock);
   }
-}
+};
 /**
  * Runs multiple core-data actions at the same time using one API request.
  *
@@ -570,33 +562,36 @@ function* saveEntityRecord(kind, name, record, {
  */
 
 
-function* __experimentalBatch(requests) {
+exports.saveEntityRecord = saveEntityRecord;
+
+const __experimentalBatch = requests => async ({
+  dispatch
+}) => {
   const batch = (0, _batch.createBatch)();
-  const dispatch = yield (0, _controls.getDispatch)();
   const api = {
     saveEntityRecord(kind, name, record, options) {
-      return batch.add(add => dispatch(_name.STORE_NAME).saveEntityRecord(kind, name, record, { ...options,
+      return batch.add(add => dispatch.saveEntityRecord(kind, name, record, { ...options,
         __unstableFetch: add
       }));
     },
 
     saveEditedEntityRecord(kind, name, recordId, options) {
-      return batch.add(add => dispatch(_name.STORE_NAME).saveEditedEntityRecord(kind, name, recordId, { ...options,
+      return batch.add(add => dispatch.saveEditedEntityRecord(kind, name, recordId, { ...options,
         __unstableFetch: add
       }));
     },
 
     deleteEntityRecord(kind, name, recordId, query, options) {
-      return batch.add(add => dispatch(_name.STORE_NAME).deleteEntityRecord(kind, name, recordId, query, { ...options,
+      return batch.add(add => dispatch.deleteEntityRecord(kind, name, recordId, query, { ...options,
         __unstableFetch: add
       }));
     }
 
   };
   const resultPromises = requests.map(request => request(api));
-  const [, ...results] = yield (0, _dataControls.__unstableAwaitPromise)(Promise.all([batch.run(), ...resultPromises]));
+  const [, ...results] = await Promise.all([batch.run(), ...resultPromises]);
   return results;
-}
+};
 /**
  * Action triggered to save an entity record's edits.
  *
@@ -607,18 +602,23 @@ function* __experimentalBatch(requests) {
  */
 
 
-function* saveEditedEntityRecord(kind, name, recordId, options) {
-  if (!(yield _data.controls.select(_name.STORE_NAME, 'hasEditsForEntityRecord', kind, name, recordId))) {
+exports.__experimentalBatch = __experimentalBatch;
+
+const saveEditedEntityRecord = (kind, name, recordId, options) => async ({
+  select,
+  dispatch
+}) => {
+  if (!select.hasEditsForEntityRecord(kind, name, recordId)) {
     return;
   }
 
-  const edits = yield _data.controls.select(_name.STORE_NAME, 'getEntityRecordNonTransientEdits', kind, name, recordId);
+  const edits = select.getEntityRecordNonTransientEdits(kind, name, recordId);
   const record = {
     id: recordId,
     ...edits
   };
-  return yield* saveEntityRecord(kind, name, record, options);
-}
+  return await dispatch.saveEntityRecord(kind, name, record, options);
+};
 /**
  * Action triggered to save only specified properties for the entity.
  *
@@ -630,12 +630,17 @@ function* saveEditedEntityRecord(kind, name, recordId, options) {
  */
 
 
-function* __experimentalSaveSpecifiedEntityEdits(kind, name, recordId, itemsToSave, options) {
-  if (!(yield _data.controls.select(_name.STORE_NAME, 'hasEditsForEntityRecord', kind, name, recordId))) {
+exports.saveEditedEntityRecord = saveEditedEntityRecord;
+
+const __experimentalSaveSpecifiedEntityEdits = (kind, name, recordId, itemsToSave, options) => async ({
+  select,
+  dispatch
+}) => {
+  if (!select.hasEditsForEntityRecord(kind, name, recordId)) {
     return;
   }
 
-  const edits = yield _data.controls.select(_name.STORE_NAME, 'getEntityRecordNonTransientEdits', kind, name, recordId);
+  const edits = select.getEntityRecordNonTransientEdits(kind, name, recordId);
   const editsToSave = {};
 
   for (const edit in edits) {
@@ -644,8 +649,8 @@ function* __experimentalSaveSpecifiedEntityEdits(kind, name, recordId, itemsToSa
     }
   }
 
-  return yield* saveEntityRecord(kind, name, editsToSave, options);
-}
+  return await dispatch.saveEntityRecord(kind, name, editsToSave, options);
+};
 /**
  * Returns an action object used in signalling that Upload permissions have been received.
  *
@@ -655,6 +660,8 @@ function* __experimentalSaveSpecifiedEntityEdits(kind, name, recordId, itemsToSa
  */
 
 
+exports.__experimentalSaveSpecifiedEntityEdits = __experimentalSaveSpecifiedEntityEdits;
+
 function receiveUploadPermissions(hasUploadPermissions) {
   return {
     type: 'RECEIVE_USER_PERMISSION',