@wordpress/core-data 6.16.0 → 6.17.0

package/build-module/actions.js

@@ -3,21 +3,23 @@
  */
 import fastDeepEqual from 'fast-deep-equal/es6';
 import { v4 as uuid } from 'uuid';
+
 /**
  * WordPress dependencies
  */
-
 import apiFetch from '@wordpress/api-fetch';
 import { addQueryArgs } from '@wordpress/url';
 import deprecated from '@wordpress/deprecated';
+
 /**
  * Internal dependencies
  */
-
 import { receiveItems, removeItems, receiveQueriedItems } from './queried-data';
 import { getOrLoadEntitiesConfig, DEFAULT_ENTITY_KEY } from './entities';
 import { createBatch } from './batch';
 import { STORE_NAME } from './name';
+import { getSyncProvider } from './sync';
+
 /**
  * Returns an action object used in signalling that authors have been received.
  * Ignored from documentation as it's internal to the data store.
@@ -29,7 +31,6 @@ import { STORE_NAME } from './name';
  *
  * @return {Object} Action object.
  */
-
 export function receiveUserQuery(queryID, users) {
   return {
     type: 'RECEIVE_USER_QUERY',
@@ -37,6 +38,7 @@ export function receiveUserQuery(queryID, users) {
     queryID
   };
 }
+
 /**
  * Returns an action used in signalling that the current user has been received.
  * Ignored from documentation as it's internal to the data store.
@@ -47,13 +49,13 @@ export function receiveUserQuery(queryID, users) {
  *
  * @return {Object} Action object.
  */
-
 export function receiveCurrentUser(currentUser) {
   return {
     type: 'RECEIVE_CURRENT_USER',
     currentUser
   };
 }
+
 /**
  * Returns an action object used in adding new entities.
  *
@@ -61,13 +63,13 @@ export function receiveCurrentUser(currentUser) {
  *
  * @return {Object} Action object.
  */
-
 export function addEntities(entities) {
   return {
     type: 'ADD_ENTITIES',
     entities
   };
 }
+
 /**
  * Returns an action object used in signalling that entity records have been received.
  *
@@ -79,30 +81,29 @@ export function addEntities(entities) {
  * @param {?Object}      edits           Edits to reset.
  * @return {Object} Action object.
  */
-
 export function receiveEntityRecords(kind, name, records, query, invalidateCache = false, edits) {
   // Auto drafts should not have titles, but some plugins rely on them so we can't filter this
   // on the server.
   if (kind === 'postType') {
-    records = (Array.isArray(records) ? records : [records]).map(record => record.status === 'auto-draft' ? { ...record,
+    records = (Array.isArray(records) ? records : [records]).map(record => record.status === 'auto-draft' ? {
+      ...record,
       title: ''
     } : record);
   }
-
   let action;
-
   if (query) {
     action = receiveQueriedItems(records, query, edits);
   } else {
     action = receiveItems(records, edits);
   }
-
-  return { ...action,
+  return {
+    ...action,
     kind,
     name,
     invalidateCache
   };
 }
+
 /**
  * Returns an action object used in signalling that the current theme has been received.
  * Ignored from documentation as it's internal to the data store.
@@ -113,13 +114,13 @@ export function receiveEntityRecords(kind, name, records, query, invalidateCache
  *
  * @return {Object} Action object.
  */
-
 export function receiveCurrentTheme(currentTheme) {
   return {
     type: 'RECEIVE_CURRENT_THEME',
     currentTheme
   };
 }
+
 /**
  * Returns an action object used in signalling that the current global styles id has been received.
  * Ignored from documentation as it's internal to the data store.
@@ -130,13 +131,13 @@ export function receiveCurrentTheme(currentTheme) {
  *
  * @return {Object} Action object.
  */
-
 export function __experimentalReceiveCurrentGlobalStylesId(currentGlobalStylesId) {
   return {
     type: 'RECEIVE_CURRENT_GLOBAL_STYLES_ID',
     id: currentGlobalStylesId
   };
 }
+
 /**
  * Returns an action object used in signalling that the theme base global styles have been received
  * Ignored from documentation as it's internal to the data store.
@@ -148,7 +149,6 @@ export function __experimentalReceiveCurrentGlobalStylesId(currentGlobalStylesId
  *
  * @return {Object} Action object.
  */
-
 export function __experimentalReceiveThemeBaseGlobalStyles(stylesheet, globalStyles) {
   return {
     type: 'RECEIVE_THEME_GLOBAL_STYLES',
@@ -156,6 +156,7 @@ export function __experimentalReceiveThemeBaseGlobalStyles(stylesheet, globalSty
     globalStyles
   };
 }
+
 /**
  * Returns an action object used in signalling that the theme global styles variations have been received.
  * Ignored from documentation as it's internal to the data store.
@@ -167,7 +168,6 @@ export function __experimentalReceiveThemeBaseGlobalStyles(stylesheet, globalSty
  *
  * @return {Object} Action object.
  */
-
 export function __experimentalReceiveThemeGlobalStyleVariations(stylesheet, variations) {
   return {
     type: 'RECEIVE_THEME_GLOBAL_STYLE_VARIATIONS',
@@ -175,6 +175,7 @@ export function __experimentalReceiveThemeGlobalStyleVariations(stylesheet, vari
     variations
   };
 }
+
 /**
  * Returns an action object used in signalling that the index has been received.
  *
@@ -182,7 +183,6 @@ export function __experimentalReceiveThemeGlobalStyleVariations(stylesheet, vari
  *
  * @return {Object} Action object.
  */
-
 export function receiveThemeSupports() {
   deprecated("wp.data.dispatch( 'core' ).receiveThemeSupports", {
     since: '5.9'
@@ -191,6 +191,7 @@ export function receiveThemeSupports() {
     type: 'DO_NOTHING'
   };
 }
+
 /**
  * Returns an action object used in signalling that the theme global styles CPT post revisions have been received.
  * Ignored from documentation as it's internal to the data store.
@@ -202,7 +203,6 @@ export function receiveThemeSupports() {
  *
  * @return {Object} Action object.
  */
-
 export function receiveThemeGlobalStyleRevisions(currentId, revisions) {
   return {
     type: 'RECEIVE_THEME_GLOBAL_STYLE_REVISIONS',
@@ -210,6 +210,7 @@ export function receiveThemeGlobalStyleRevisions(currentId, revisions) {
     revisions
   };
 }
+
 /**
  * Returns an action object used in signalling that the preview data for
  * a given URl has been received.
@@ -222,7 +223,6 @@ export function receiveThemeGlobalStyleRevisions(currentId, revisions) {
  *
  * @return {Object} Action object.
  */
-
 export function receiveEmbedPreview(url, preview) {
   return {
     type: 'RECEIVE_EMBED_PREVIEW',
@@ -230,6 +230,7 @@ export function receiveEmbedPreview(url, preview) {
     preview
   };
 }
+
 /**
  * Action triggered to delete an entity record.
  *
@@ -245,7 +246,6 @@ export function receiveEmbedPreview(url, preview) {
  * @param {boolean}  [options.throwOnError=false] If false, this action suppresses all
  *                                                the exceptions. Defaults to false.
  */
-
 export const deleteEntityRecord = (kind, name, recordId, query, {
   __unstableFetch = apiFetch,
   throwOnError = false
@@ -256,15 +256,12 @@ export const deleteEntityRecord = (kind, name, recordId, query, {
   const entityConfig = configs.find(config => config.kind === kind && config.name === name);
   let error;
   let deletedRecord = false;
-
   if (!entityConfig || entityConfig?.__experimentalNoFetch) {
     return;
   }
-
   const lock = await dispatch.__unstableAcquireStoreLock(STORE_NAME, ['entities', 'records', kind, name, recordId], {
     exclusive: true
   });
-
   try {
     dispatch({
       type: 'DELETE_ENTITY_RECORD_START',
@@ -273,14 +270,11 @@ export const deleteEntityRecord = (kind, name, recordId, query, {
       recordId
     });
     let hasError = false;
-
     try {
       let path = `${entityConfig.baseURL}/${recordId}`;
-
       if (query) {
         path = addQueryArgs(path, query);
       }
-
       deletedRecord = await __unstableFetch({
         path,
         method: 'DELETE'
@@ -290,7 +284,6 @@ export const deleteEntityRecord = (kind, name, recordId, query, {
       hasError = true;
       error = _error;
     }
-
     dispatch({
       type: 'DELETE_ENTITY_RECORD_FINISH',
       kind,
@@ -298,16 +291,15 @@ export const deleteEntityRecord = (kind, name, recordId, query, {
       recordId,
       error
     });
-
     if (hasError && throwOnError) {
       throw error;
     }
-
     return deletedRecord;
   } finally {
     dispatch.__unstableReleaseStoreLock(lock);
   }
 };
+
 /**
  * Returns an action object that triggers an
  * edit to an entity record.
@@ -321,17 +313,14 @@ export const deleteEntityRecord = (kind, name, recordId, query, {
  *
  * @return {Object} Action object.
  */
-
 export const editEntityRecord = (kind, name, recordId, edits, options = {}) => ({
   select,
   dispatch
 }) => {
   const entityConfig = select.getEntityConfig(kind, name);
-
   if (!entityConfig) {
     throw new Error(`The entity being edited (${kind}, ${name}) does not have a loaded config.`);
   }
-
   const {
     mergedEdits = {}
   } = entityConfig;
@@ -346,79 +335,83 @@ export const editEntityRecord = (kind, name, recordId, edits, options = {}) => (
     edits: Object.keys(edits).reduce((acc, key) => {
       const recordValue = record[key];
       const editedRecordValue = editedRecord[key];
-      const value = mergedEdits[key] ? { ...editedRecordValue,
+      const value = mergedEdits[key] ? {
+        ...editedRecordValue,
         ...edits[key]
       } : edits[key];
       acc[key] = fastDeepEqual(recordValue, value) ? undefined : value;
       return acc;
     }, {})
   };
-  dispatch({
-    type: 'EDIT_ENTITY_RECORD',
-    ...edit,
-    meta: {
-      undo: !options.undoIgnore && { ...edit,
-        // Send the current values for things like the first undo stack entry.
-        edits: Object.keys(edits).reduce((acc, key) => {
-          acc[key] = editedRecord[key];
-          return acc;
-        }, {}),
-        isCached: options.isCached
+  if (window.__experimentalEnableSync && entityConfig.syncConfig) {
+    const objectId = entityConfig.getSyncObjectId(recordId);
+    getSyncProvider().update(entityConfig.syncObjectType + '--edit', objectId, edit.edits);
+  } else {
+    dispatch({
+      type: 'EDIT_ENTITY_RECORD',
+      ...edit,
+      meta: {
+        undo: !options.undoIgnore && {
+          ...edit,
+          // Send the current values for things like the first undo stack entry.
+          edits: Object.keys(edits).reduce((acc, key) => {
+            acc[key] = editedRecord[key];
+            return acc;
+          }, {}),
+          isCached: options.isCached
+        }
       }
-    }
-  });
+    });
+  }
 };
+
 /**
  * Action triggered to undo the last edit to
  * an entity record, if any.
  */
-
 export const undo = () => ({
   select,
   dispatch
 }) => {
   const undoEdit = select.getUndoEdits();
-
   if (!undoEdit) {
     return;
   }
-
   dispatch({
     type: 'UNDO',
     stackedEdits: undoEdit
   });
 };
+
 /**
  * Action triggered to redo the last undoed
  * edit to an entity record, if any.
  */
-
 export const redo = () => ({
   select,
   dispatch
 }) => {
   const redoEdit = select.getRedoEdits();
-
   if (!redoEdit) {
     return;
   }
-
   dispatch({
     type: 'REDO',
     stackedEdits: redoEdit
   });
 };
+
 /**
  * Forces the creation of a new undo level.
  *
  * @return {Object} Action object.
  */
-
 export function __unstableCreateUndoLevel() {
   return {
     type: 'CREATE_UNDO_LEVEL'
   };
 }
+
 /**
  * Action triggered to save an entity record.
  *
@@ -433,7 +426,6 @@ export function __unstableCreateUndoLevel() {
  * @param {boolean}  [options.throwOnError=false] If false, this action suppresses all
  *                                                the exceptions. Defaults to false.
  */
-
 export const saveEntityRecord = (kind, name, record, {
   isAutosave = false,
   __unstableFetch = apiFetch,
@@ -445,17 +437,14 @@ export const saveEntityRecord = (kind, name, record, {
 }) => {
   const configs = await dispatch(getOrLoadEntitiesConfig(kind));
   const entityConfig = configs.find(config => config.kind === kind && config.name === name);
-
   if (!entityConfig || entityConfig?.__experimentalNoFetch) {
     return;
   }
-
   const entityIdKey = entityConfig.key || DEFAULT_ENTITY_KEY;
   const recordId = record[entityIdKey];
   const lock = await dispatch.__unstableAcquireStoreLock(STORE_NAME, ['entities', 'records', kind, name, recordId || uuid()], {
     exclusive: true
   });
-
   try {
     // Evaluate optimized edits.
     // (Function edits that should be evaluated on save to avoid expensive computations on every edit.)
@@ -470,7 +459,6 @@ export const saveEntityRecord = (kind, name, record, {
         record[key] = evaluatedValue;
       }
     }
-
     dispatch({
       type: 'SAVE_ENTITY_RECORD_START',
       kind,
@@ -481,11 +469,9 @@ export const saveEntityRecord = (kind, name, record, {
     let updatedRecord;
     let error;
     let hasError = false;
-
     try {
       const path = `${entityConfig.baseURL}${recordId ? '/' + 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,
@@ -493,12 +479,13 @@ export const saveEntityRecord = (kind, name, record, {
         // so the client just sends and receives objects.
         const currentUser = select.getCurrentUser();
         const currentUserId = currentUser ? currentUser.id : undefined;
-        const autosavePost = await resolveSelect.getAutosave(persistedRecord.type, persistedRecord.id, currentUserId); // Autosaves need all expected fields to be present.
+        const autosavePost = await 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.
-
-        let data = { ...persistedRecord,
+        let data = {
+          ...persistedRecord,
           ...autosavePost,
           ...record
         };
@@ -506,7 +493,6 @@ export const saveEntityRecord = (kind, name, record, {
           if (['title', 'excerpt', 'content', 'meta'].includes(key)) {
             acc[key] = data[key];
           }
-
           return acc;
         }, {
           status: data.status === 'auto-draft' ? 'draft' : data.status
@@ -515,12 +501,14 @@ export const saveEntityRecord = (kind, name, record, {
           path: `${path}/autosaves`,
           method: 'POST',
           data
-        }); // 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,
+          let newRecord = {
+            ...persistedRecord,
             ...data,
             ...updatedRecord
           };
@@ -536,7 +524,6 @@ export const saveEntityRecord = (kind, name, record, {
               // These properties are not persisted in autosaves.
               acc[key] = persistedRecord[key];
             }
-
             return acc;
           }, {});
           dispatch.receiveEntityRecords(kind, name, newRecord, undefined, true);
@@ -545,13 +532,12 @@ export const saveEntityRecord = (kind, name, record, {
         }
       } else {
         let edits = record;
-
         if (entityConfig.__unstablePrePersist) {
-          edits = { ...edits,
+          edits = {
+            ...edits,
             ...entityConfig.__unstablePrePersist(persistedRecord, edits)
           };
         }
-
         updatedRecord = await __unstableFetch({
           path,
           method: recordId ? 'PUT' : 'POST',
@@ -563,7 +549,6 @@ export const saveEntityRecord = (kind, name, record, {
       hasError = true;
       error = _error;
     }
-
     dispatch({
       type: 'SAVE_ENTITY_RECORD_FINISH',
       kind,
@@ -572,16 +557,15 @@ export const saveEntityRecord = (kind, name, record, {
       error,
       isAutosave
     });
-
     if (hasError && throwOnError) {
       throw error;
     }
-
     return updatedRecord;
   } finally {
     dispatch.__unstableReleaseStoreLock(lock);
   }
 };
+
 /**
  * Runs multiple core-data actions at the same time using one API request.
  *
@@ -604,35 +588,35 @@ export const saveEntityRecord = (kind, name, record, {
  * @return {(thunkArgs: Object) => Promise} A promise that resolves to an array containing the return
  *                                          values of each function given in `requests`.
  */
-
 export const __experimentalBatch = requests => async ({
   dispatch
 }) => {
   const batch = createBatch();
   const api = {
     saveEntityRecord(kind, name, record, options) {
-      return batch.add(add => dispatch.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.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.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] = await Promise.all([batch.run(), ...resultPromises]);
   return results;
 };
+
 /**
  * Action triggered to save an entity record's edits.
  *
@@ -641,7 +625,6 @@ export const __experimentalBatch = requests => async ({
  * @param {Object} recordId ID of the record.
  * @param {Object} options  Saving options.
  */
-
 export const saveEditedEntityRecord = (kind, name, recordId, options) => async ({
   select,
   dispatch
@@ -649,14 +632,11 @@ export const saveEditedEntityRecord = (kind, name, recordId, options) => async (
   if (!select.hasEditsForEntityRecord(kind, name, recordId)) {
     return;
   }
-
   const configs = await dispatch(getOrLoadEntitiesConfig(kind));
   const entityConfig = configs.find(config => config.kind === kind && config.name === name);
-
   if (!entityConfig) {
     return;
   }
-
   const entityIdKey = entityConfig.key || DEFAULT_ENTITY_KEY;
   const edits = select.getEntityRecordNonTransientEdits(kind, name, recordId);
   const record = {
@@ -665,6 +645,7 @@ export const saveEditedEntityRecord = (kind, name, recordId, options) => async (
   };
   return await dispatch.saveEntityRecord(kind, name, record, options);
 };
+
 /**
  * Action triggered to save only specified properties for the entity.
  *
@@ -674,7 +655,6 @@ export const saveEditedEntityRecord = (kind, name, recordId, options) => async (
  * @param {Array}  itemsToSave List of entity properties to save.
  * @param {Object} options     Saving options.
  */
-
 export const __experimentalSaveSpecifiedEntityEdits = (kind, name, recordId, itemsToSave, options) => async ({
   select,
   dispatch
@@ -682,29 +662,27 @@ export const __experimentalSaveSpecifiedEntityEdits = (kind, name, recordId, ite
   if (!select.hasEditsForEntityRecord(kind, name, recordId)) {
     return;
   }
-
   const edits = select.getEntityRecordNonTransientEdits(kind, name, recordId);
   const editsToSave = {};
-
   for (const edit in edits) {
     if (itemsToSave.some(item => item === edit)) {
       editsToSave[edit] = edits[edit];
     }
   }
-
   const configs = await dispatch(getOrLoadEntitiesConfig(kind));
   const entityConfig = configs.find(config => config.kind === kind && config.name === name);
-  const entityIdKey = entityConfig?.key || DEFAULT_ENTITY_KEY; // If a record key is provided then update the existing record.
+  const entityIdKey = entityConfig?.key || DEFAULT_ENTITY_KEY;
+
+  // If a record key is provided then update the existing record.
   // This necessitates providing `recordKey` to saveEntityRecord as part of the
   // `record` argument (here called `editsToSave`) to stop that action creating
   // a new record and instead cause it to update the existing record.
-
   if (recordId) {
     editsToSave[entityIdKey] = recordId;
   }
-
   return await dispatch.saveEntityRecord(kind, name, editsToSave, options);
 };
+
 /**
  * Returns an action object used in signalling that Upload permissions have been received.
  *
@@ -714,7 +692,6 @@ export const __experimentalSaveSpecifiedEntityEdits = (kind, name, recordId, ite
  *
  * @return {Object} Action object.
  */
-
 export function receiveUploadPermissions(hasUploadPermissions) {
   deprecated("wp.data.dispatch( 'core' ).receiveUploadPermissions", {
     since: '5.9',
@@ -722,6 +699,7 @@ export function receiveUploadPermissions(hasUploadPermissions) {
   });
   return receiveUserPermission('create/media', hasUploadPermissions);
 }
+
 /**
  * Returns an action object used in signalling that the current user has
  * permission to perform an action on a REST resource.
@@ -734,7 +712,6 @@ export function receiveUploadPermissions(hasUploadPermissions) {
  *
  * @return {Object} Action object.
  */
-
 export function receiveUserPermission(key, isAllowed) {
   return {
     type: 'RECEIVE_USER_PERMISSION',
@@ -742,6 +719,7 @@ export function receiveUserPermission(key, isAllowed) {
     isAllowed
   };
 }
+
 /**
  * Returns an action object used in signalling that the autosaves for a
  * post have been received.
@@ -754,7 +732,6 @@ export function receiveUserPermission(key, isAllowed) {
  *
  * @return {Object} Action object.
  */
-
 export function receiveAutosaves(postId, autosaves) {
   return {
     type: 'RECEIVE_AUTOSAVES',
@@ -762,6 +739,7 @@ export function receiveAutosaves(postId, autosaves) {
     autosaves: Array.isArray(autosaves) ? autosaves : [autosaves]
   };
 }
+
 /**
  * Returns an action object signalling that the fallback Navigation
  * Menu id has been received.
@@ -769,7 +747,6 @@ export function receiveAutosaves(postId, autosaves) {
  * @param {integer} fallbackId the id of the fallback Navigation Menu
  * @return {Object} Action object.
  */
-
 export function receiveNavigationFallbackId(fallbackId) {
   return {
     type: 'RECEIVE_NAVIGATION_FALLBACK_ID',