@wordpress/core-data 6.10.0 → 6.12.0

package/build-module/reducer.js

@@ -30,10 +30,7 @@ import { rootEntitiesConfig, DEFAULT_ENTITY_KEY } from './entities';
  * @return {Object} Updated state.
  */
 
-export function terms() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function terms(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_TERMS':
       return { ...state,
@@ -52,13 +49,10 @@ export function terms() {
  * @return {Object} Updated state.
  */
 
-export function users() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {
-    byId: {},
-    queries: {}
-  };
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function users(state = {
+  byId: {},
+  queries: {}
+}, action) {
   switch (action.type) {
     case 'RECEIVE_USER_QUERY':
       return {
@@ -85,10 +79,7 @@ export function users() {
  * @return {Object} Updated state.
  */
 
-export function currentUser() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function currentUser(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_CURRENT_USER':
       return action.currentUser;
@@ -105,10 +96,7 @@ export function currentUser() {
  * @return {Object} Updated state.
  */
 
-export function taxonomies() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function taxonomies(state = [], action) {
   switch (action.type) {
     case 'RECEIVE_TAXONOMIES':
       return action.taxonomies;
@@ -125,10 +113,7 @@ export function taxonomies() {
  * @return {string|undefined} Updated state.
  */
 
-export function currentTheme() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : undefined;
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function currentTheme(state = undefined, action) {
   switch (action.type) {
     case 'RECEIVE_CURRENT_THEME':
       return action.currentTheme.stylesheet;
@@ -145,10 +130,7 @@ export function currentTheme() {
  * @return {string|undefined} Updated state.
  */
 
-export function currentGlobalStylesId() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : undefined;
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function currentGlobalStylesId(state = undefined, action) {
   switch (action.type) {
     case 'RECEIVE_CURRENT_GLOBAL_STYLES_ID':
       return action.id;
@@ -165,10 +147,7 @@ export function currentGlobalStylesId() {
  * @return {Record<string, object>} Updated state.
  */
 
-export function themeBaseGlobalStyles() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function themeBaseGlobalStyles(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_THEME_GLOBAL_STYLES':
       return { ...state,
@@ -187,10 +166,7 @@ export function themeBaseGlobalStyles() {
  * @return {Record<string, object>} Updated state.
  */
 
-export function themeGlobalStyleVariations() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function themeGlobalStyleVariations(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_THEME_GLOBAL_STYLE_VARIATIONS':
       return { ...state,
@@ -200,6 +176,36 @@ export function themeGlobalStyleVariations() {
 
   return state;
 }
+
+const withMultiEntityRecordEdits = reducer => (state, action) => {
+  if (action.type === 'UNDO' || action.type === 'REDO') {
+    const {
+      stackedEdits
+    } = action;
+    let newState = state;
+    stackedEdits.forEach(({
+      kind,
+      name,
+      recordId,
+      property,
+      from,
+      to
+    }) => {
+      newState = reducer(newState, {
+        type: 'EDIT_ENTITY_RECORD',
+        kind,
+        name,
+        recordId,
+        edits: {
+          [property]: action.type === 'UNDO' ? from : to
+        }
+      });
+    });
+    return newState;
+  }
+
+  return reducer(state, action);
+};
 /**
  * Higher Order Reducer for a given entity config. It supports:
  *
@@ -212,8 +218,9 @@ export function themeGlobalStyleVariations() {
  * @return {AnyFunction} Reducer.
  */
 
+
 function entity(entityConfig) {
-  return compose([// Limit to matching action type so we don't attempt to replace action on
+  return compose([withMultiEntityRecordEdits, // Limit to matching action type so we don't attempt to replace action on
   // an unhandled action.
   ifMatchingAction(action => action.name && action.kind && action.name === entityConfig.name && action.kind === entityConfig.kind), // Inject the entity config into the action.
   replaceAction(action => {
@@ -222,15 +229,12 @@ function entity(entityConfig) {
     };
   })])(combineReducers({
     queriedData: queriedDataReducer,
-    edits: function () {
-      var _action$query$context, _action$query;
-
-      let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      let action = arguments.length > 1 ? arguments[1] : undefined;
+    edits: (state = {}, action) => {
+      var _action$query$context;
 
       switch (action.type) {
         case 'RECEIVE_ITEMS':
-          const context = (_action$query$context = action === null || action === void 0 ? void 0 : (_action$query = action.query) === null || _action$query === void 0 ? void 0 : _action$query.context) !== null && _action$query$context !== void 0 ? _action$query$context : 'default';
+          const context = (_action$query$context = action?.query?.context) !== null && _action$query$context !== void 0 ? _action$query$context : 'default';
 
           if (context !== 'default') {
             return state;
@@ -248,14 +252,14 @@ function entity(entityConfig) {
             }
 
             const nextEdits = Object.keys(edits).reduce((acc, key) => {
-              var _record$key$raw, _record$key;
+              var _record$key$raw;
 
               // If the edited value is still different to the persisted value,
               // keep the edited value in edits.
               if ( // Edits are the "raw" attribute values, but records may have
               // objects with more properties, so we use `get` here for the
               // comparison.
-              !fastDeepEqual(edits[key], (_record$key$raw = (_record$key = record[key]) === null || _record$key === void 0 ? void 0 : _record$key.raw) !== null && _record$key$raw !== void 0 ? _record$key$raw : record[key]) && ( // Sometimes the server alters the sent value which means
+              !fastDeepEqual(edits[key], (_record$key$raw = record[key]?.raw) !== null && _record$key$raw !== void 0 ? _record$key$raw : record[key]) && ( // Sometimes the server alters the sent value which means
               // we need to also remove the edits before the api request.
               !action.persistedEdits || !fastDeepEqual(edits[key], action.persistedEdits[key]))) {
                 acc[key] = edits[key];
@@ -291,10 +295,7 @@ function entity(entityConfig) {
 
       return state;
     },
-    saving: function () {
-      let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      let action = arguments.length > 1 ? arguments[1] : undefined;
-
+    saving: (state = {}, action) => {
       switch (action.type) {
         case 'SAVE_ENTITY_RECORD_START':
         case 'SAVE_ENTITY_RECORD_FINISH':
@@ -309,10 +310,7 @@ function entity(entityConfig) {
 
       return state;
     },
-    deleting: function () {
-      let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-      let action = arguments.length > 1 ? arguments[1] : undefined;
-
+    deleting: (state = {}, action) => {
       switch (action.type) {
         case 'DELETE_ENTITY_RECORD_START':
         case 'DELETE_ENTITY_RECORD_FINISH':
@@ -338,10 +336,7 @@ function entity(entityConfig) {
  */
 
 
-export function entitiesConfig() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : rootEntitiesConfig;
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function entitiesConfig(state = rootEntitiesConfig, action) {
   switch (action.type) {
     case 'ADD_ENTITIES':
       return [...state, ...action.entities];
@@ -358,9 +353,7 @@ export function entitiesConfig() {
  * @return {Object} Updated state.
  */
 
-export const entities = function () {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
+export const entities = (state = {}, action) => {
   const newConfig = entitiesConfig(state.config, action); // Generates a dynamic reducer for the entities.
 
   let entitiesDataReducer = state.reducer;
@@ -378,8 +371,7 @@ export const entities = function () {
       acc[kind].push(record);
       return acc;
     }, {});
-    entitiesDataReducer = combineReducers(Object.entries(entitiesByKind).reduce((memo, _ref) => {
-      let [kind, subEntities] = _ref;
+    entitiesDataReducer = combineReducers(Object.entries(entitiesByKind).reduce((memo, [kind, subEntities]) => {
       const kindReducer = combineReducers(subEntities.reduce((kindMemo, entityConfig) => ({ ...kindMemo,
         [entityConfig.name]: entity(entityConfig)
       }), {}));
@@ -403,8 +395,9 @@ export const entities = function () {
 /**
  * @typedef {Object} UndoStateMeta
  *
- * @property {number} offset          Where in the undo stack we are.
- * @property {Object} [flattenedUndo] Flattened form of undo stack.
+ * @property {number} list   The undo stack.
+ * @property {number} offset Where in the undo stack we are.
+ * @property {Object} cache  Cache of unpersisted transient edits.
  */
 
 /** @typedef {Array<Object> & UndoStateMeta} UndoState */
@@ -415,12 +408,10 @@ export const entities = function () {
  * @todo Given how we use this we might want to make a custom class for it.
  */
 
-const UNDO_INITIAL_STATE = Object.assign([], {
+const UNDO_INITIAL_STATE = {
+  list: [],
   offset: 0
-});
-/** @type {Object} */
-
-let lastEditAction;
+};
 /**
  * Reducer keeping track of entity edit undo history.
  *
@@ -430,117 +421,121 @@ let lastEditAction;
  * @return {UndoState} Updated state.
  */
 
-export function undo() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : UNDO_INITIAL_STATE;
-  let action = arguments.length > 1 ? arguments[1] : undefined;
+export function undo(state = UNDO_INITIAL_STATE, action) {
+  const omitPendingRedos = currentState => {
+    return { ...currentState,
+      list: currentState.list.slice(0, currentState.offset || undefined),
+      offset: 0
+    };
+  };
 
-  switch (action.type) {
-    case 'EDIT_ENTITY_RECORD':
-    case 'CREATE_UNDO_LEVEL':
-      let isCreateUndoLevel = action.type === 'CREATE_UNDO_LEVEL';
-      const isUndoOrRedo = !isCreateUndoLevel && (action.meta.isUndo || action.meta.isRedo);
-
-      if (isCreateUndoLevel) {
-        action = lastEditAction;
-      } else if (!isUndoOrRedo) {
-        // Don't lose the last edit cache if the new one only has transient edits.
-        // Transient edits don't create new levels so updating the cache would make
-        // us skip an edit later when creating levels explicitly.
-        if (Object.keys(action.edits).some(key => !action.transientEdits[key])) {
-          lastEditAction = action;
-        } else {
-          lastEditAction = { ...action,
-            edits: { ...(lastEditAction && lastEditAction.edits),
-              ...action.edits
-            }
-          };
-        }
-      }
-      /** @type {UndoState} */
-
-
-      let nextState;
-
-      if (isUndoOrRedo) {
-        // @ts-ignore we might consider using Object.assign({}, state)
-        nextState = [...state];
-        nextState.offset = state.offset + (action.meta.isUndo ? -1 : 1);
-
-        if (state.flattenedUndo) {
-          // The first undo in a sequence of undos might happen while we have
-          // flattened undos in state. If this is the case, we want execution
-          // to continue as if we were creating an explicit undo level. This
-          // will result in an extra undo level being appended with the flattened
-          // undo values.
-          // We also have to take into account if the `lastEditAction` had opted out
-          // of being tracked in undo history, like the action that persists the latest
-          // content right before saving. In that case we have to update the `lastEditAction`
-          // to avoid returning early before applying the existing flattened undos.
-          isCreateUndoLevel = true;
-
-          if (!lastEditAction.meta.undo) {
-            lastEditAction.meta.undo = {
-              edits: {}
-            };
-          }
+  const appendCachedEditsToLastUndo = currentState => {
+    if (!currentState.cache) {
+      return currentState;
+    }
 
-          action = lastEditAction;
-        } else {
-          return nextState;
-        }
-      }
+    let nextState = { ...currentState,
+      list: [...currentState.list]
+    };
+    nextState = omitPendingRedos(nextState);
+    const previousUndoState = nextState.list.pop();
+    const updatedUndoState = currentState.cache.reduce(appendEditToStack, previousUndoState);
+    nextState.list.push(updatedUndoState);
+    return { ...nextState,
+      cache: undefined
+    };
+  };
 
-      if (!action.meta.undo) {
-        return state;
-      } // Transient edits don't create an undo level, but are
-      // reachable in the next meaningful edit to which they
-      // are merged. They are defined in the entity's config.
+  const appendEditToStack = (stack = [], {
+    kind,
+    name,
+    recordId,
+    property,
+    from,
+    to
+  }) => {
+    const existingEditIndex = stack?.findIndex(({
+      kind: k,
+      name: n,
+      recordId: r,
+      property: p
+    }) => {
+      return k === kind && n === name && r === recordId && p === property;
+    });
+    const nextStack = [...stack];
+
+    if (existingEditIndex !== -1) {
+      // If the edit is already in the stack leave the initial "from" value.
+      nextStack[existingEditIndex] = { ...nextStack[existingEditIndex],
+        to
+      };
+    } else {
+      nextStack.push({
+        kind,
+        name,
+        recordId,
+        property,
+        from,
+        to
+      });
+    }
 
+    return nextStack;
+  };
 
-      if (!isCreateUndoLevel && !Object.keys(action.edits).some(key => !action.transientEdits[key])) {
-        // @ts-ignore we might consider using Object.assign({}, state)
-        nextState = [...state];
-        nextState.flattenedUndo = { ...state.flattenedUndo,
-          ...action.edits
+  switch (action.type) {
+    case 'CREATE_UNDO_LEVEL':
+      return appendCachedEditsToLastUndo(state);
+
+    case 'UNDO':
+    case 'REDO':
+      {
+        const nextState = appendCachedEditsToLastUndo(state);
+        return { ...nextState,
+          offset: state.offset + (action.type === 'UNDO' ? -1 : 1)
         };
-        nextState.offset = state.offset;
-        return nextState;
-      } // Clear potential redos, because this only supports linear history.
-
+      }
 
-      nextState = // @ts-ignore this needs additional cleanup, probably involving code-level changes
-      nextState || state.slice(0, state.offset || undefined);
-      nextState.offset = nextState.offset || 0;
-      nextState.pop();
+    case 'EDIT_ENTITY_RECORD':
+      {
+        if (!action.meta.undo) {
+          return state;
+        }
 
-      if (!isCreateUndoLevel) {
-        nextState.push({
-          kind: action.meta.undo.kind,
-          name: action.meta.undo.name,
-          recordId: action.meta.undo.recordId,
-          edits: { ...state.flattenedUndo,
-            ...action.meta.undo.edits
-          }
+        const isCachedChange = Object.keys(action.edits).every(key => action.transientEdits[key]);
+        const edits = Object.keys(action.edits).map(key => {
+          return {
+            kind: action.kind,
+            name: action.name,
+            recordId: action.recordId,
+            property: key,
+            from: action.meta.undo.edits[key],
+            to: action.edits[key]
+          };
         });
-      } // When an edit is a function it's an optimization to avoid running some expensive operation.
-      // We can't rely on the function references being the same so we opt out of comparing them here.
 
+        if (isCachedChange) {
+          return { ...state,
+            cache: edits.reduce(appendEditToStack, state.cache)
+          };
+        }
 
-      const comparisonUndoEdits = Object.values(action.meta.undo.edits).filter(edit => typeof edit !== 'function');
-      const comparisonEdits = Object.values(action.edits).filter(edit => typeof edit !== 'function');
+        let nextState = omitPendingRedos(state);
+        nextState = appendCachedEditsToLastUndo(nextState);
+        nextState = { ...nextState,
+          list: [...nextState.list]
+        }; // When an edit is a function it's an optimization to avoid running some expensive operation.
+        // We can't rely on the function references being the same so we opt out of comparing them here.
 
-      if (!isShallowEqual(comparisonUndoEdits, comparisonEdits)) {
-        nextState.push({
-          kind: action.kind,
-          name: action.name,
-          recordId: action.recordId,
-          edits: isCreateUndoLevel ? { ...state.flattenedUndo,
-            ...action.edits
-          } : action.edits
-        });
-      }
+        const comparisonUndoEdits = Object.values(action.meta.undo.edits).filter(edit => typeof edit !== 'function');
+        const comparisonEdits = Object.values(action.edits).filter(edit => typeof edit !== 'function');
+
+        if (!isShallowEqual(comparisonUndoEdits, comparisonEdits)) {
+          nextState.list.push(edits);
+        }
 
-      return nextState;
+        return nextState;
+      }
   }
 
   return state;
@@ -554,10 +549,7 @@ export function undo() {
  * @return {Object} Updated state.
  */
 
-export function embedPreviews() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function embedPreviews(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_EMBED_PREVIEW':
       const {
@@ -581,10 +573,7 @@ export function embedPreviews() {
  * @return {Object} Updated state.
  */
 
-export function userPermissions() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function userPermissions(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_USER_PERMISSION':
       return { ...state,
@@ -603,10 +592,7 @@ export function userPermissions() {
  * @return {Object} Updated state.
  */
 
-export function autosaves() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function autosaves(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_AUTOSAVES':
       const {
@@ -620,10 +606,7 @@ export function autosaves() {
 
   return state;
 }
-export function blockPatterns() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function blockPatterns(state = [], action) {
   switch (action.type) {
     case 'RECEIVE_BLOCK_PATTERNS':
       return action.patterns;
@@ -631,10 +614,7 @@ export function blockPatterns() {
 
   return state;
 }
-export function blockPatternCategories() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function blockPatternCategories(state = [], action) {
   switch (action.type) {
     case 'RECEIVE_BLOCK_PATTERN_CATEGORIES':
       return action.categories;
@@ -642,10 +622,7 @@ export function blockPatternCategories() {
 
   return state;
 }
-export function navigationFallbackId() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function navigationFallbackId(state = null, action) {
   switch (action.type) {
     case 'RECEIVE_NAVIGATION_FALLBACK_ID':
       return action.fallbackId;
@@ -662,10 +639,7 @@ export function navigationFallbackId() {
  * @return {Record<string, object>} Updated state.
  */
 
-export function themeGlobalStyleRevisions() {
-  let state = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-  let action = arguments.length > 1 ? arguments[1] : undefined;
-
+export function themeGlobalStyleRevisions(state = {}, action) {
   switch (action.type) {
     case 'RECEIVE_THEME_GLOBAL_STYLE_REVISIONS':
       return { ...state,