@commercetools/sync-actions 6.0.0 → 6.1.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/sync-actions
 
+## 6.1.0
+
+### Minor Changes
+
+- [#1921](https://github.com/commercetools/nodejs/pull/1921) [`c9d23e86`](https://github.com/commercetools/nodejs/commit/c9d23e86a6013aafb6a3c296121e1c5995d9eab6) Thanks [@kafis](https://github.com/kafis)! - Introducing configuration to control the behaviour regarding generation of UpdateActions in respect to unsetting fields
+
 ## 6.0.0
 
 ### Major Changes

package/dist/sync-actions.cjs.js

@@ -2967,6 +2967,11 @@ var createIsEmptyValue = function createIsEmptyValue(emptyValues) {
   };
 };
 
+/* actions that start with 'set' can generate undefined valued */
+var isOptionalField = function isOptionalField(action) {
+  return action.startsWith('set');
+};
+
 /**
  * Builds actions for simple object properties, given a list of actions
  * E.g. [{ action: `changeName`, key: 'name' }]
@@ -2977,13 +2982,17 @@ var createIsEmptyValue = function createIsEmptyValue(emptyValues) {
  * @param  {Object} options.oldObj - the object that needs to be updated
  * @param  {Object} options.newObj - the new representation of the object
  * @param {Boolean} options.shouldOmitEmptyString - a flag to determine if we should treat an empty string a NON-value
+ * @param {Boolean} options.shouldUnsetOmittedProperties - a flag to determine if we should unset fields which are omitted in the newObj
+ * @param {Boolean} options.shouldPreventUnsettingRequiredFields - a flag to determine if required fields should be unset
  */
 function buildBaseAttributesActions(_ref) {
   var actions = _ref.actions,
     diff = _ref.diff,
     oldObj = _ref.oldObj,
     newObj = _ref.newObj,
-    shouldOmitEmptyString = _ref.shouldOmitEmptyString;
+    shouldOmitEmptyString = _ref.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties = _ref.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields = _ref.shouldPreventUnsettingRequiredFields;
   var isEmptyValue = createIsEmptyValue(shouldOmitEmptyString ? [undefined, null, ''] : [undefined, null]);
   return actions.map(function (item) {
     var key = item.key; // e.g.: name, description, ...
@@ -2993,7 +3002,9 @@ function buildBaseAttributesActions(_ref) {
     var now = newObj[key];
     var isNotDefinedBefore = isEmptyValue(oldObj[key]);
     var isNotDefinedNow = isEmptyValue(newObj[key]);
+    var isOmitted = !Object.keys(newObj).includes(key);
     if (!delta) return undefined;
+    if (isNotDefinedNow && !isOptionalField(item.action) && shouldPreventUnsettingRequiredFields) return undefined;
     if (isNotDefinedNow && isNotDefinedBefore) return undefined;
     if (!isNotDefinedNow && isNotDefinedBefore)
       // no value previously set
@@ -3002,8 +3013,8 @@ function buildBaseAttributesActions(_ref) {
       }, actionKey, now);
 
     /* no new value */
-    if (isNotDefinedNow && !{}.hasOwnProperty.call(newObj, key)) return undefined;
-    if (isNotDefinedNow && {}.hasOwnProperty.call(newObj, key))
+    if (isNotDefinedNow && isOmitted && !shouldUnsetOmittedProperties) return undefined;
+    if (isNotDefinedNow)
       // value unset
       return {
         action: item.action
@@ -3113,7 +3124,9 @@ function actionsMapBase$k(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapReferences$3(diff, oldObj, newObj) {
@@ -3315,7 +3328,9 @@ function actionsMapBase$j(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapSetDefaultBase(diff, oldObj, newObj) {
@@ -3325,7 +3340,9 @@ function actionsMapSetDefaultBase(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapReferences$2(diff, oldObj, newObj) {
@@ -3521,7 +3538,9 @@ function actionsMapBase$i(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapReferences$1(diff, oldObj, newObj) {
@@ -4038,15 +4057,19 @@ function actionsMapBase$h(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties
   });
 }
 function actionsMapMeta(diff, oldObj, newObj) {
+  var config = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   return buildBaseAttributesActions({
     actions: metaActionsList,
     diff: diff,
     oldObj: oldObj,
-    newObj: newObj
+    newObj: newObj,
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties
   });
 }
 function actionsMapAddVariants(diff, oldObj, newObj) {
@@ -4356,7 +4379,9 @@ function actionsMapBase$g(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapDeliveries(diff, oldObj, newObj) {
@@ -4575,7 +4600,9 @@ function actionsMapBase$f(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -4663,7 +4690,9 @@ function actionsMapBase$e(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -4714,7 +4743,9 @@ function actionsMapBase$d(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -4784,7 +4815,9 @@ function actionsMapBase$c(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -5132,7 +5165,9 @@ function actionsMapBase$b(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapRates(diff, oldObj, newObj) {
@@ -5220,7 +5255,9 @@ function actionsMapBase$a(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapLocations(diff, oldObj, newObj) {
@@ -5325,7 +5362,9 @@ function actionsMapBase$9(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 var addShippingRates = function addShippingRates(newZoneRate) {
@@ -5448,7 +5487,8 @@ function actionsMapBase$8(diff, previous, next) {
     actions: baseActionsList$8,
     oldObj: previous,
     newObj: next,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties
   });
 }
 
@@ -5705,7 +5745,9 @@ function actionsMapBase$7(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapRoles(diff, oldObj, newObj) {
@@ -5791,7 +5833,9 @@ function actionsMapBase$6(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -5842,7 +5886,9 @@ function actionsMapBase$5(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapEnums(fieldName, attributeType, attributeDiff, previous, next) {
@@ -6037,6 +6083,7 @@ function actionsMapBase$4(diff, oldObj, newObj) {
   });
 }
 var actionsMapBusinessUnit = function actionsMapBusinessUnit(diff, oldObj, newObj) {
+  var config = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   var businessUnits = diff.businessUnits;
   if (!businessUnits) {
     return [];
@@ -6045,10 +6092,13 @@ var actionsMapBusinessUnit = function actionsMapBusinessUnit(diff, oldObj, newOb
     actions: myBusinessUnitActionsList,
     diff: businessUnits,
     oldObj: oldObj.businessUnits,
-    newObj: newObj.businessUnits
+    newObj: newObj.businessUnits,
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties
   });
 };
 function actionsMapSearchIndexingConfiguration(diff, oldObj, newObj) {
+  var config = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   var searchIndexing = diff.searchIndexing;
   if (!searchIndexing) {
     return [];
@@ -6061,7 +6111,10 @@ function actionsMapSearchIndexingConfiguration(diff, oldObj, newObj) {
     actions: customerSearchActionsList,
     diff: diff.searchIndexing.customers,
     oldObj: oldObj.searchIndexing.customers,
-    newObj: newObj.searchIndexing.customers
+    newObj: newObj.searchIndexing.customers,
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -6104,11 +6157,15 @@ var baseActionsList$3 = [{
   key: 'supplyChannels'
 }];
 function actionsMapBase$3(diff, oldObj, newObj) {
+  var config = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   return buildBaseAttributesActions({
     actions: baseActionsList$3,
     diff: diff,
     oldObj: oldObj,
-    newObj: newObj
+    newObj: newObj,
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -6125,10 +6182,11 @@ function createStoresMapActions(mapActionGroup) {
   };
 }
 var stores = (function (actionGroupList) {
+  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
   var mapActionGroup = createMapActionGroup(actionGroupList);
   var doMapActions = createStoresMapActions(mapActionGroup);
   var onBeforeApplyingDiff = null;
-  var buildActions = createBuildActions(diff, doMapActions, onBeforeApplyingDiff);
+  var buildActions = createBuildActions(diff, doMapActions, onBeforeApplyingDiff, options);
   return {
     buildActions: buildActions
   };
@@ -6142,11 +6200,15 @@ var baseActionsList$2 = [{
   key: 'key'
 }];
 function actionsMapBase$2(diff, oldObj, newObj) {
+  var config = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
   return buildBaseAttributesActions({
     actions: baseActionsList$2,
     diff: diff,
     oldObj: oldObj,
-    newObj: newObj
+    newObj: newObj,
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -6203,7 +6265,9 @@ function actionsMapBase$1(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 
@@ -6249,7 +6313,9 @@ function actionsMapBase(diff, oldObj, newObj) {
     diff: diff,
     oldObj: oldObj,
     newObj: newObj,
-    shouldOmitEmptyString: config.shouldOmitEmptyString
+    shouldOmitEmptyString: config.shouldOmitEmptyString,
+    shouldUnsetOmittedProperties: config.shouldUnsetOmittedProperties,
+    shouldPreventUnsettingRequiredFields: config.shouldPreventUnsettingRequiredFields
   });
 }
 function actionsMapAttributes(diff, oldObj, newObj) {