@ukhomeoffice/cop-react-form-renderer 5.86.0 → 5.87.0

package/dist/components/FormPage/FormPage.js

@@ -62,13 +62,25 @@ var FormPage = function FormPage(_ref) {
   var onPageChange = function onPageChange(_ref2) {
     var target = _ref2.target;
     var formPage = page;
-    formPage.formData[target.name] = target.value;
-    setPatch(function (prev) {
-      return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, target.name, target.value));
-    });
-    setPatchLabel(function (prev) {
-      return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, target.component, target.label));
-    });
+    if (target.value == null) {
+      delete formPage.formData[target.name];
+      setPatch(function (prev) {
+        var data = prev;
+        return delete data[target.name];
+      });
+      setPatchLabel(function (prev) {
+        var data = prev;
+        return delete data[target.component];
+      });
+    } else {
+      formPage.formData[target.name] = target.value;
+      setPatch(function (prev) {
+        return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, target.name, target.value));
+      });
+      setPatchLabel(function (prev) {
+        return _objectSpread(_objectSpread({}, prev), {}, _defineProperty({}, target.component, target.label));
+      });
+    }
     if (typeof onChange === 'function') {
       onChange(page.formData);
     }

package/dist/components/FormRenderer/onPageAction.js

@@ -100,7 +100,11 @@ var onPageAction = function onPageAction(action, patch, patchLabel, hooks, data,
           break;
       }
       ;
-      /* eslint-enable no-case-declarations */
+
+      // If a value has been deleted from formData,
+      // also delete it from data before doing object spread,
+      // or else it will reappear in submissionData.
+      _utils.default.Data.deleteValues(data, formState.page.formData);
 
       // Save draft or submit.
       var submissionData = _utils.default.Format.form({

package/dist/utils/CheckYourAnswers/showComponentCYA.js

@@ -33,7 +33,7 @@ var showComponentCYA = function showComponentCYA(options, data) {
   }
   if (options.hideOnCyaWhenEmpty) {
     if (options.type === _models.ComponentTypes.COLLECTION) {
-      var itemCollectionsData = (0, _getSourceData.default)(data, options.full_path);
+      var itemCollectionsData = (0, _getSourceData.default)(data, options.full_path || options.fieldId);
       if (!(itemCollectionsData !== null && itemCollectionsData !== void 0 && itemCollectionsData.length)) {
         return false;
       }

package/dist/utils/Data/deleteValues.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Find values in data not in formData
+ * and delete them from data.
+ * @param {object} data The page's data.
+ * @param {object} formData The page's formData.
+ */
+var deleteValues = function deleteValues(data, formData) {
+  var deletedValues = Object.keys(data).filter(function (k) {
+    return !(k in formData);
+  });
+  var node = data;
+  deletedValues.forEach(function (i) {
+    return delete node[i];
+  });
+};
+var _default = exports.default = deleteValues;

package/dist/utils/Data/deleteValues.test.js

@@ -0,0 +1,57 @@
+"use strict";
+
+var _deleteValues = _interopRequireDefault(require("./deleteValues"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('Utils.Data.deleteValues', function () {
+  it('Should delete values from data', function () {
+    var DATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    var FORMDATA = {
+      a: '1'
+    };
+    (0, _deleteValues.default)(DATA, FORMDATA);
+    expect(DATA).toEqual({
+      a: '1'
+    });
+  });
+  it('Should leave data unchanged if no differences', function () {
+    var DATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    var FORMDATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    (0, _deleteValues.default)(DATA, FORMDATA);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2',
+      c: '3'
+    });
+  });
+  it('Should leave data unchanged if form data has additional fields', function () {
+    var DATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    var FORMDATA = {
+      a: '1',
+      b: '2',
+      c: '3',
+      d: '4'
+    };
+    (0, _deleteValues.default)(DATA, FORMDATA);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2',
+      c: '3'
+    });
+  });
+});

package/dist/utils/Data/index.js

@@ -10,6 +10,7 @@ var _getDataPath = _interopRequireDefault(require("./getDataPath"));
 var _getOptions = _interopRequireDefault(require("./getOptions"));
 var _getSourceData = _interopRequireDefault(require("./getSourceData"));
 var _refDataToOptions = _interopRequireDefault(require("./refDataToOptions"));
+var _deleteValues = _interopRequireDefault(require("./deleteValues"));
 var _setDataItem = _interopRequireDefault(require("./setDataItem"));
 var _setupFormData = _interopRequireDefault(require("./setupFormData"));
 var _setupRefDataUrlForComponent = _interopRequireDefault(require("./setupRefDataUrlForComponent"));
@@ -26,6 +27,7 @@ var Data = {
     setupUrl: _setupRefDataUrlForComponent.default,
     toOptions: _refDataToOptions.default
   },
+  deleteValues: _deleteValues.default,
   setDataItem: _setDataItem.default,
   setupForm: _setupFormData.default
 };

package/dist/utils/Operate/deleteValueInFormData.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Simple operation to delete a value in the form data.
+ * @param {object} config The operation config.
+ * @param {object} data The page's formData.
+ * @param {function} onChange The page's onChange handler.
+ */
+var deleteValueInFormData = function deleteValueInFormData(config, data, onChange) {
+  var node = data;
+  if (config !== null && config !== void 0 && config.field && config !== null && config !== void 0 && config.component) {
+    delete node[config.field];
+    onChange({
+      target: {
+        name: config.field,
+        value: null,
+        component: config.component
+      }
+    });
+  }
+};
+var _default = exports.default = deleteValueInFormData;

package/dist/utils/Operate/deleteValueInFormData.test.js

@@ -0,0 +1,60 @@
+"use strict";
+
+var _deleteValueInFormData = _interopRequireDefault(require("./deleteValueInFormData"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('Utils.Operate.deleteValueInFormData', function () {
+  var ON_CHANGE = function ON_CHANGE() {};
+  it('Should delete value from data', function () {
+    var CONFIG = {
+      field: 'a',
+      component: 'A'
+    };
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      b: '2'
+    });
+  });
+  it('Should do nothing if value is absent', function () {
+    var CONFIG = {
+      field: 'c',
+      component: 'C'
+    };
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2'
+    });
+  });
+  it('Should do nothing if config is null', function () {
+    var CONFIG = null;
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2'
+    });
+  });
+  it('Should do nothing if config is empty', function () {
+    var CONFIG = {};
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2'
+    });
+  });
+});

package/dist/utils/Operate/runPageOperations.js

@@ -9,6 +9,7 @@ var _checkValueIsTruthy = _interopRequireDefault(require("./checkValueIsTruthy")
 var _getIndexOfMatchingValueIn = _interopRequireDefault(require("./getIndexOfMatchingValueIn"));
 var _persistValueInFormData = _interopRequireDefault(require("./persistValueInFormData"));
 var _setValueInFormData = _interopRequireDefault(require("./setValueInFormData"));
+var _deleteValueInFormData = _interopRequireDefault(require("./deleteValueInFormData"));
 var _shouldRun = _interopRequireDefault(require("./shouldRun"));
 var _setDataItem = _interopRequireDefault(require("../Data/setDataItem"));
 var _getFirstOf = _interopRequireDefault(require("./getFirstOf"));
@@ -23,6 +24,7 @@ var functions = {
   getIndexOfMatchingValueIn: _getIndexOfMatchingValueIn.default,
   persistValueInFormData: _persistValueInFormData.default,
   setValueInFormData: _setValueInFormData.default,
+  deleteValueInFormData: _deleteValueInFormData.default,
   getLength: _getLength.default,
   getFirstOf: _getFirstOf.default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "5.86.0",
+  "version": "5.87.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",