@ukhomeoffice/cop-react-form-renderer 4.68.1 → 4.69.0

package/dist/components/FormRenderer/helpers/cleanHiddenNestedData.js

@@ -4,13 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _optionIsSelected = _interopRequireDefault(require("../../../utils/Component/optionIsSelected"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
 function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
-var parentComponents = ['radios'];
+var parentComponents = ['radios', 'checkboxes'];
 var cleanHiddenNestedData = function cleanHiddenNestedData(patch, page) {
   page.components.forEach(function (component) {
     if (!parentComponents.includes(component.type)) {
@@ -22,10 +24,12 @@ var cleanHiddenNestedData = function cleanHiddenNestedData(patch, page) {
     });
   });
   if (page.collection && patch[page.collection.name]) {
+    var _page$formData;
+    var activeId = patch["".concat(page.collection.name, "ActiveId")] || ((_page$formData = page.formData) === null || _page$formData === void 0 ? void 0 : _page$formData["".concat(page.collection.name, "ActiveId")]);
     patch[page.collection.name] = patch[page.collection.name].map(function (entry) {
-      return cleanHiddenNestedData(entry, _objectSpread(_objectSpread({}, page), {}, {
+      return entry.id === activeId ? cleanHiddenNestedData(entry, _objectSpread(_objectSpread({}, page), {}, {
         collection: undefined
-      }));
+      })) : entry;
     });
   }
   return patch;
@@ -34,7 +38,7 @@ function getIdsToDelete(component, selectedValue) {
   var _component$data, _component$data$optio;
   var idsToDelete = [];
   component === null || component === void 0 ? void 0 : (_component$data = component.data) === null || _component$data === void 0 ? void 0 : (_component$data$optio = _component$data.options) === null || _component$data$optio === void 0 ? void 0 : _component$data$optio.forEach(function (option) {
-    if (option.value !== selectedValue && option.nested) {
+    if (!(0, _optionIsSelected.default)(selectedValue, option) && option.nested) {
       option.nested.forEach(function (nested) {
         idsToDelete.push(nested.id);
       });

package/dist/components/FormRenderer/helpers/cleanHiddenNestedData.test.js

@@ -8,13 +8,13 @@ describe('components', function () {
   describe('FormRenderer', function () {
     describe('helpers', function () {
       describe('cleanHiddenNestedData', function () {
-        it('remove data corresponding to hidden nested components', function () {
-          var patch = {
+        it('should remove data corresponding to hidden nested components in radios', function () {
+          var patchRadios = {
             parent: 'option2',
             nested1: 'should not be included',
             nested2: 'should be included'
           };
-          var page = {
+          var pageRadios = {
             id: 'page',
             name: 'page',
             title: 'Page',
@@ -39,17 +39,55 @@ describe('components', function () {
               }
             }]
           };
-          var updatedPatch = (0, _cleanHiddenNestedData.default)(patch, page);
-          expect(updatedPatch['nested1']).toBeFalsy();
-          expect(updatedPatch['nested2']).toBeTruthy();
+          var updatedPatchRadios = (0, _cleanHiddenNestedData.default)(patchRadios, pageRadios);
+          expect(updatedPatchRadios['nested1']).toBeFalsy();
+          expect(updatedPatchRadios['nested2']).toBeTruthy();
         });
-        it('remove data corresponding to hidden nested components within a collection', function () {
+        it('should remove data corresponding to hidden nested components in checkboxes', function () {
+          var patchCheckboxes = {
+            parent: ['option2'],
+            nested1: 'should not be included',
+            nested2: 'should be included'
+          };
+          var pageCheckboxes = {
+            id: 'page',
+            name: 'page',
+            title: 'Page',
+            components: [{
+              id: 'parent',
+              fieldId: 'parent',
+              type: 'checkboxes',
+              data: {
+                options: [{
+                  value: 'option1',
+                  nested: [{
+                    id: 'nested1',
+                    fieldId: 'nested1'
+                  }]
+                }, {
+                  value: 'option2',
+                  nested: [{
+                    id: 'nested2',
+                    fieldId: 'nested2'
+                  }]
+                }]
+              }
+            }]
+          };
+          var updatedPatchCheckboxes = (0, _cleanHiddenNestedData.default)(patchCheckboxes, pageCheckboxes);
+          expect(updatedPatchCheckboxes['nested1']).toBeFalsy();
+          expect(updatedPatchCheckboxes['nested2']).toBeTruthy();
+        });
+        it('remove data corresponding to hidden nested components within the active collection entry', function () {
           var patch = {
+            collectionNameActiveId: '456',
             collectionName: [{
+              id: '123',
               parent: 'option1',
               nested1: 'should be included',
-              nested2: 'should not be included'
+              nested2: 'should be included'
             }, {
+              id: '456',
               parent: 'option2',
               nested1: 'should not be included',
               nested2: 'should be included'
@@ -84,7 +122,7 @@ describe('components', function () {
           };
           var updatedPatch = (0, _cleanHiddenNestedData.default)(patch, page);
           expect(updatedPatch['collectionName'][0]['nested1']).toBeTruthy();
-          expect(updatedPatch['collectionName'][0]['nested2']).toBeFalsy();
+          expect(updatedPatch['collectionName'][0]['nested2']).toBeTruthy();
           expect(updatedPatch['collectionName'][1]['nested1']).toBeFalsy();
           expect(updatedPatch['collectionName'][1]['nested2']).toBeTruthy();
         });

package/dist/utils/CheckYourAnswers/getCYARow.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _Component = _interopRequireDefault(require("../Component"));
+var _optionIsSelected = _interopRequireDefault(require("../Component/optionIsSelected"));
 var _getCYAAction = _interopRequireDefault(require("./getCYAAction"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // Global imports
@@ -43,7 +44,7 @@ var setNestedValue = function setNestedValue(component, page) {
   var _component$data, _component$data$optio;
   (_component$data = component.data) === null || _component$data === void 0 ? void 0 : (_component$data$optio = _component$data.options) === null || _component$data$optio === void 0 ? void 0 : _component$data$optio.forEach(function (option) {
     //check if option is selected and has nested component
-    if (Array.isArray(option.nested) && page.formData[component.id] === option.value) {
+    if (Array.isArray(option.nested) && (0, _optionIsSelected.default)(page.formData[component.id], option)) {
       option.nested.forEach(function (child) {
         child.value = page.formData[child.id];
       });

package/dist/utils/CheckYourAnswers/getCYARow.test.js

@@ -134,7 +134,7 @@ describe('utils', function () {
           onAction: ON_ACTION
         });
       });
-      it('should update any nested components with corresponding values from the stored formdata', function () {
+      it('should update any nested components in radios with corresponding values from the stored formdata', function () {
         var SELECTED_VALUE = 'selectedValue';
         var NESTED_ID = 'nestedId';
         var NESTED_VALUE = 'nestedValue';
@@ -161,7 +161,7 @@ describe('utils', function () {
         var ROW = (0, _getCYARow.default)(PAGE, COMPONENT, function () {});
         expect(ROW.component.data.options[0].nested[0].value).toEqual(NESTED_VALUE);
       });
-      it('should handle an undefined formData when attempting to set nested values', function () {
+      it('should handle an undefined formData when attempting to set nested values in radios', function () {
         var SELECTED_VALUE = 'selectedValue';
         var NESTED_ID = 'nestedId';
         var PAGE = {
@@ -184,6 +184,56 @@ describe('utils', function () {
         var ROW = (0, _getCYARow.default)(PAGE, COMPONENT, function () {});
         expect(ROW.component.data.options[0].nested[0].value).toBeUndefined();
       });
+      it('should update any nested components in checkboxes with corresponding values from the stored formdata', function () {
+        var SELECTED_VALUE = 'selectedValue';
+        var NESTED_ID = 'nestedId';
+        var NESTED_VALUE = 'nestedValue';
+        var PAGE = {
+          id: 'page',
+          formData: _defineProperty({
+            a: [SELECTED_VALUE]
+          }, NESTED_ID, NESTED_VALUE),
+          cya_link: {}
+        };
+        var COMPONENT = {
+          type: 'checkboxes',
+          id: 'a',
+          fieldId: 'a',
+          data: {
+            options: [{
+              value: SELECTED_VALUE,
+              nested: [{
+                id: NESTED_ID
+              }]
+            }]
+          }
+        };
+        var ROW = (0, _getCYARow.default)(PAGE, COMPONENT, function () {});
+        expect(ROW.component.data.options[0].nested[0].value).toEqual(NESTED_VALUE);
+      });
+      it('should handle an undefined formData when attempting to set nested values in checkboxes', function () {
+        var SELECTED_VALUE = 'selectedValue';
+        var NESTED_ID = 'nestedId';
+        var PAGE = {
+          id: 'page',
+          cya_link: {}
+        };
+        var COMPONENT = {
+          type: 'checkboxes',
+          id: 'a',
+          fieldId: 'a',
+          data: {
+            options: [{
+              value: SELECTED_VALUE,
+              nested: [{
+                id: NESTED_ID
+              }]
+            }]
+          }
+        };
+        var ROW = (0, _getCYARow.default)(PAGE, COMPONENT, function () {});
+        expect(ROW.component.data.options[0].nested[0].value).toBeUndefined();
+      });
       it('should get an appropriate row for a readonly text component with no value and interpolated label', function () {
         var PAGE = {
           id: 'page',

package/dist/utils/Component/getComponent.js

@@ -51,6 +51,12 @@ var getCheckboxes = function getCheckboxes(config) {
   _Data.default.getOptions(config, function (val) {
     options = val;
   });
+  options.forEach(function (option) {
+    if (!Array.isArray(option.nested)) {
+      return;
+    }
+    option.children = getChildrenJsx(config, option.nested);
+  });
   var attrs = (0, _cleanAttributes.default)(config);
   return /*#__PURE__*/_react.default.createElement(_copReactComponents.Checkboxes, _extends({}, attrs, {
     options: options

package/dist/utils/Component/optionIsSelected.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Checks whether an option for a component has been selected.
+ * 
+ * @param {object} componentValue The option's value selected for that component.
+ * @param {object} option The option of the component being tested.
+ * 
+ * @returns A boolean of whether the option is selected.
+ */
+var optionIsSelected = function optionIsSelected(componentValue, option) {
+  if (Array.isArray(componentValue)) {
+    return componentValue.includes(option.value);
+  }
+  return componentValue === option.value;
+};
+var _default = optionIsSelected;
+exports.default = _default;

package/dist/utils/Component/optionIsSelected.test.js

@@ -0,0 +1,42 @@
+"use strict";
+
+var _optionIsSelected = _interopRequireDefault(require("./optionIsSelected"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Local imports
+
+describe('utils.Component.isSelected', function () {
+  var SELECTED_VALUE = 'selectedValue';
+  var NOT_SELECTED_VALUE = 'notSelectedValue';
+  var OPTIONS = [{
+    value: SELECTED_VALUE
+  }, {
+    value: NOT_SELECTED_VALUE
+  }];
+  var COMPONENT = {
+    id: 'a',
+    fieldId: 'a',
+    data: {
+      options: OPTIONS
+    }
+  };
+  it('should properly identify which option is selected for checkboxes', function () {
+    var PAGE = {
+      formData: {
+        a: [SELECTED_VALUE]
+      }
+    };
+    COMPONENT.type = 'checkboxes';
+    expect((0, _optionIsSelected.default)(PAGE.formData[COMPONENT.id], OPTIONS[0])).toEqual(true);
+    expect((0, _optionIsSelected.default)(PAGE.formData[COMPONENT.id], OPTIONS[1])).toEqual(false);
+  });
+  it('should properly identify which option is selected for radios', function () {
+    var PAGE = {
+      formData: {
+        a: SELECTED_VALUE
+      }
+    };
+    COMPONENT.type = 'radios';
+    expect((0, _optionIsSelected.default)(PAGE.formData[COMPONENT.id], OPTIONS[0])).toEqual(true);
+    expect((0, _optionIsSelected.default)(PAGE.formData[COMPONENT.id], OPTIONS[1])).toEqual(false);
+  });
+});

package/dist/utils/Validate/validateComponent.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _models = require("../../models");
+var _optionIsSelected = _interopRequireDefault(require("../Component/optionIsSelected"));
 var _showComponent = _interopRequireDefault(require("../Component/showComponent"));
 var _additional = _interopRequireDefault(require("./additional"));
 var _validateCollection = _interopRequireDefault(require("./validateCollection"));
@@ -57,10 +58,11 @@ var validateComponent = function validateComponent(component, outerData, formDat
         properties = propsInError;
         error = message;
         break;
+      case _models.ComponentTypes.CHECKBOXES:
       case _models.ComponentTypes.RADIOS:
         var nestedErrors = [];
         (_component$data$optio = component.data.options) === null || _component$data$optio === void 0 ? void 0 : _component$data$optio.forEach(function (option) {
-          if (option.nested && formData[component.id] === option.value) {
+          if (option.nested && (0, _optionIsSelected.default)(formData[component.id], option)) {
             nestedErrors = nestedErrors.concat((0, _validateContainer.default)({
               components: option.nested
             }, formData));

package/dist/utils/Validate/validateComponent.test.js

@@ -245,5 +245,121 @@ describe('utils.Validate.Component', function () {
       };
       expect((0, _validateComponent.default)(COMPONENT, undefined, {})).toBeUndefined();
     });
+    it('should return no error when the checkbox component contains nested components without errors', function () {
+      var NESTED_ID = 'nestedId';
+      var NESTED_VALUE = 'nestedValue';
+      var FORMDATA = _defineProperty({}, NESTED_ID, NESTED_VALUE);
+      var COMPONENT = {
+        type: 'checkboxes',
+        id: 'a',
+        data: {
+          options: [{
+            nested: [{
+              type: 'text',
+              fieldId: NESTED_ID,
+              id: NESTED_ID,
+              required: true
+            }]
+          }]
+        }
+      };
+      expect((0, _validateComponent.default)(COMPONENT, undefined, FORMDATA)).toBeUndefined();
+    });
+    it('should return an error when the checkbox component contains nested components with errors', function () {
+      var NESTED_ID = 'nestedId';
+      var OPTION_VALUE = 'optionValue';
+      var FORMDATA = {
+        'a': [OPTION_VALUE]
+      };
+      var COMPONENT = {
+        type: 'checkboxes',
+        id: 'a',
+        data: {
+          options: [{
+            value: OPTION_VALUE,
+            nested: [{
+              type: 'text',
+              fieldId: NESTED_ID,
+              id: NESTED_ID,
+              required: true
+            }]
+          }]
+        }
+      };
+      expect((0, _validateComponent.default)(COMPONENT, undefined, FORMDATA)).toEqual([{
+        id: NESTED_ID,
+        error: "Field is required"
+      }]);
+    });
+    it('should return no error when a non selected checkbox component contains nested components with errors', function () {
+      var NESTED_ID_NOT_SELECTED = 'nestedIdNotSelected';
+      var NESTED_ID_SELECTED = 'nestedIdSelected';
+      var NESTED_VALUE_SELECTED = 'nestedValueSelected';
+      var FORMDATA = _defineProperty({
+        'a': ['optionValueSelected']
+      }, NESTED_ID_SELECTED, NESTED_VALUE_SELECTED);
+      var COMPONENT = {
+        type: 'checkboxes',
+        id: 'a',
+        data: {
+          options: [{
+            id: 'optionIdNotSelected',
+            value: 'optionValueNotSelected',
+            nested: [{
+              type: 'text',
+              fieldId: NESTED_ID_NOT_SELECTED,
+              id: NESTED_ID_NOT_SELECTED,
+              required: true
+            }]
+          }, {
+            id: 'optionIdSelected',
+            value: 'optionValueSelected',
+            nested: [{
+              type: 'text',
+              fieldId: NESTED_ID_SELECTED,
+              id: NESTED_ID_SELECTED,
+              required: true
+            }]
+          }]
+        }
+      };
+      expect((0, _validateComponent.default)(COMPONENT, undefined, FORMDATA)).toBeUndefined();
+    });
+    it('should return no error when all selected checkbox components contains nested components without errors', function () {
+      var _FORMDATA4;
+      var NESTED_ID_SELECTED_1 = 'nestedIdSelected1';
+      var NESTED_ID_SELECTED_2 = 'nestedIdSelected2';
+      var NESTED_VALUE_SELECTED_1 = 'nestedValueSelected1';
+      var NESTED_VALUE_SELECTED_2 = 'nestedValueSelected2';
+      var FORMDATA = (_FORMDATA4 = {
+        'a': ['optionValueSelected1', 'optionValueSelected2']
+      }, _defineProperty(_FORMDATA4, NESTED_ID_SELECTED_1, NESTED_VALUE_SELECTED_1), _defineProperty(_FORMDATA4, NESTED_ID_SELECTED_2, NESTED_VALUE_SELECTED_2), _FORMDATA4);
+      var COMPONENT = {
+        type: 'checkboxes',
+        id: 'a',
+        data: {
+          options: [{
+            id: 'optionIdSelected1',
+            value: 'optionValueSelected1',
+            nested: [{
+              type: 'text',
+              fieldId: NESTED_ID_SELECTED_1,
+              id: NESTED_ID_SELECTED_1,
+              required: true
+            }]
+          }, {
+            id: 'optionIdSelected2',
+            value: 'optionValueSelected2',
+            nested: [{
+              type: 'text',
+              fieldId: NESTED_ID_SELECTED_2,
+              id: NESTED_ID_SELECTED_2,
+              required: true
+            }]
+          }]
+        }
+      };
+      expect((0, _validateComponent.default)(COMPONENT, undefined, FORMDATA)).toBeUndefined();
+    });
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "4.68.1",
+  "version": "4.69.0",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "^2.12.0-alpha",
+    "@ukhomeoffice/cop-react-components": "^2.14.1",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",