@ukhomeoffice/cop-react-form-renderer 5.37.0 → 5.39.1

package/dist/components/FormComponent/FormComponent.js

@@ -113,13 +113,13 @@ var FormComponent = function FormComponent(_ref) {
     }));
   }
   if (component.type === _models.ComponentTypes.COLLECTION_SUMMARY) {
-    return /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, _extends({}, attrs, {
+    return (0, _wrapInFormGroup.default)(_objectSpread(_objectSpread({}, component), (0, _helpers.getComponentError)(component, validation === null || validation === void 0 ? void 0 : validation.errors)), /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, _extends({}, attrs, {
       config: component,
       formData: formData,
       onAction: onAction,
       onChange: onChange,
       pages: pages
-    }));
+    })));
   }
   var changeMetaDocuments = function changeMetaDocuments(document) {
     var componentPath = component.full_path || component.fieldId;

package/dist/components/FormComponent/helpers/getComponentFieldSet.js

@@ -7,10 +7,6 @@ exports.default = void 0;
 var _models = require("../../../models");
 var SHOULD_HAVE_FIELDSET = [_models.ComponentTypes.RADIOS, _models.ComponentTypes.CHECKBOXES, _models.ComponentTypes.DATE];
 var _default = function _default(component) {
-  // Check to see if this is explicitly set first, as this is efficient.
-  if (component.fieldset === true) {
-    return true;
-  }
-  return SHOULD_HAVE_FIELDSET.includes(component.type);
+  return component.fieldset || SHOULD_HAVE_FIELDSET.includes(component.type);
 };
 exports.default = _default;

package/dist/components/FormRenderer/onCYAAction.js

@@ -82,15 +82,32 @@ var onCYAAction = function onCYAAction(setPagePoint, action, pages, validate, co
         });
       }
     }
-    if (action.type === _models.PageAction.TYPES.SAVE_AND_RETURN) {
+    if (action.type === _models.PageAction.TYPES.SAVE_AND_NAVIGATE) {
       if (canSubmit) {
         var _submissionData3 = _utils.default.Format.form({
           pages: pages,
           components: components
         }, _objectSpread({}, data), _models.EventTypes.SUBMIT);
-        _submissionData3.formStatus = _helpers.default.getSubmissionStatus(type, pages, pageId, action, _submissionData3, currentTask, false);
+        _submissionData3.formStatus = _helpers.default.getSubmissionStatus(type, pages, pageId, action, _submissionData3, currentTask, true);
         setData(_submissionData3);
         hooks.onSubmit(action.type, _submissionData3, function () {
+          setSubmitting(false);
+          onPageChange(action.page);
+        }, function (errors) {
+          setSubmitting(false);
+          _handlers.default.submissionError(errors, addErrors);
+        });
+      }
+    }
+    if (action.type === _models.PageAction.TYPES.SAVE_AND_RETURN) {
+      if (canSubmit) {
+        var _submissionData4 = _utils.default.Format.form({
+          pages: pages,
+          components: components
+        }, _objectSpread({}, data), _models.EventTypes.SUBMIT);
+        _submissionData4.formStatus = _helpers.default.getSubmissionStatus(type, pages, pageId, action, _submissionData4, currentTask, false);
+        setData(_submissionData4);
+        hooks.onSubmit(action.type, _submissionData4, function () {
           if (type === _models.FormTypes.TASK) {
             onPageChange(undefined);
           } else {

package/dist/components/FormRenderer/onCYAAction.test.js

@@ -447,6 +447,123 @@ describe('components.FormRenderer.onCYAAction', function () {
       expect(addErrorsArgs[0]).toEqual(['an example error']);
     });
   });
+  describe('with a page action of PageAction.TYPES.SAVE_AND_NAVIGATE', function () {
+    it('should validate if action.validate is not defined', function () {
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        action: {
+          type: _models.PageAction.TYPES.SAVE_AND_NAVIGATE,
+          page: 'testPage'
+        },
+        hub: _models.HubFormats.TASK
+      });
+      _onCYAAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      expect(_helpers.default.canCYASubmitCalls).toEqual(1); // Validating.
+      expect(_utils.default.Format.formCalls).toEqual(1);
+      expect(_helpers.default.getSubmissionStatusCalls).toEqual(1);
+      expect(setDataCalls).toEqual(1);
+      expect(setDataArgs[0]).toEqual({
+        id: 'formId',
+        formStatus: 'Good to go!'
+      });
+      expect(MOCK_HOOKS.onSubmitCalls).toEqual(1);
+      expect(MOCK_HOOKS.onSubmitArgs[0]).toEqual({
+        type: CUSTOM_ARGS.action.type,
+        payload: {
+          id: 'formId',
+          formStatus: 'Good to go!'
+        }
+      });
+
+      // Checking the onSuccess branch.
+      expect(onPageChangeCalls).toEqual(1);
+      expect(onPageChangeArgs[0]).toEqual('testPage');
+
+      // Checking the onError branch.
+      expect(_handlers.default.submissionErrorCalls).toEqual(1);
+      expect(_handlers.default.submissionErrorArgs[0]).toEqual(['an example error']);
+      expect(addErrorsCalls).toEqual(1);
+      expect(addErrorsArgs[0]).toEqual(['an example error']);
+    });
+    it('should validate if action.validate is true', function () {
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        action: {
+          type: _models.PageAction.TYPES.SAVE_AND_NAVIGATE,
+          page: 'testPage',
+          validate: true
+        },
+        hub: _models.HubFormats.TASK
+      });
+      _onCYAAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+      expect(_helpers.default.canCYASubmitCalls).toEqual(1); // Validating.
+      expect(_utils.default.Format.formCalls).toEqual(1);
+      expect(_helpers.default.getSubmissionStatusCalls).toEqual(1);
+      expect(setDataCalls).toEqual(1);
+      expect(setDataArgs[0]).toEqual({
+        id: 'formId',
+        formStatus: 'Good to go!'
+      });
+      expect(MOCK_HOOKS.onSubmitCalls).toEqual(1);
+      expect(MOCK_HOOKS.onSubmitArgs[0]).toEqual({
+        type: CUSTOM_ARGS.action.type,
+        payload: {
+          id: 'formId',
+          formStatus: 'Good to go!'
+        }
+      });
+
+      // Checking the onSuccess branch.
+      expect(onPageChangeCalls).toEqual(1);
+      expect(onPageChangeArgs[0]).toEqual('testPage');
+
+      // Checking the onError branch.
+      expect(_handlers.default.submissionErrorCalls).toEqual(1);
+      expect(_handlers.default.submissionErrorArgs[0]).toEqual(['an example error']);
+      expect(addErrorsCalls).toEqual(1);
+      expect(addErrorsArgs[0]).toEqual(['an example error']);
+    });
+    it('should not validate if action.validate is false', function () {
+      var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {
+        action: {
+          type: _models.PageAction.TYPES.SAVE_AND_NAVIGATE,
+          page: 'testPage',
+          validate: false
+        },
+        hub: _models.HubFormats.TASK
+      });
+      _onCYAAction.default.apply(void 0, Object.values(CUSTOM_ARGS));
+
+      // Validation.
+      expect(_helpers.default.canCYASubmitCalls).toEqual(0);
+
+      // Everything after this point should be normal, we just
+      // haven't validated this time round.
+      expect(_utils.default.Format.formCalls).toEqual(1);
+      expect(_helpers.default.getSubmissionStatusCalls).toEqual(1);
+      expect(setDataCalls).toEqual(1);
+      expect(setDataArgs[0]).toEqual({
+        id: 'formId',
+        formStatus: 'Good to go!'
+      });
+      expect(MOCK_HOOKS.onSubmitCalls).toEqual(1);
+      expect(MOCK_HOOKS.onSubmitArgs[0]).toEqual({
+        type: CUSTOM_ARGS.action.type,
+        payload: {
+          id: 'formId',
+          formStatus: 'Good to go!'
+        }
+      });
+
+      // Checking the onSuccess branch.
+      expect(onPageChangeCalls).toEqual(1);
+      expect(onPageChangeArgs[0]).toEqual('testPage');
+
+      // Checking the onError branch.
+      expect(_handlers.default.submissionErrorCalls).toEqual(1);
+      expect(_handlers.default.submissionErrorArgs[0]).toEqual(['an example error']);
+      expect(addErrorsCalls).toEqual(1);
+      expect(addErrorsArgs[0]).toEqual(['an example error']);
+    });
+  });
   describe('with an action type of PageAction.TYPES.SAVE_AND_RETURN', function () {
     it('should validate if action.validate is not defined', function () {
       var CUSTOM_ARGS = _objectSpread(_objectSpread({}, ARGS), {}, {

package/dist/utils/FormPage/useComponent.js

@@ -45,12 +45,11 @@ var getComponentToUse = function getComponentToUse(toUse, formComponents) {
     _loop();
   }
   if (component) {
-    component = _objectSpread(_objectSpread(_objectSpread({}, component), toUse), {}, {
-      cya_label: toUse.cya_label || component.cya_label || component.label,
-      fieldId: toUse.fieldId || component.fieldId
-    });
+    component = _objectSpread(_objectSpread({
+      cya_label: component.label
+    }, component), toUse);
     if (parent && parent.id !== component.id) {
-      parent.components[0] = component;
+      parent.components = [component];
     } else {
       wrapper = component;
     }

package/dist/utils/Validate/validateComponent.js

@@ -5,6 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _models = require("../../models");
+var _getCollectionPageData = _interopRequireDefault(require("../CollectionPage/getCollectionPageData"));
 var _optionIsSelected = _interopRequireDefault(require("../Component/optionIsSelected"));
 var _showComponent = _interopRequireDefault(require("../Component/showComponent"));
 var _additional = _interopRequireDefault(require("./additional"));
@@ -38,6 +39,9 @@ var validateComponent = function validateComponent(component, outerData, formDat
   var properties;
   var data = outerData && _typeof(outerData) === 'object' ? outerData : {};
   var value = data[component.fieldId];
+  if (component.type === _models.ComponentTypes.COLLECTION_SUMMARY) {
+    value = (0, _getCollectionPageData.default)(component.collectionName, fd);
+  }
   if (component.required) {
     error = (0, _validateRequired.default)(value, component.label, component.custom_errors);
   }

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

@@ -4,6 +4,8 @@ var _models = require("../../models");
 var _validateComponent = _interopRequireDefault(require("./validateComponent"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 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); } // Local imports
@@ -46,6 +48,17 @@ describe('utils.Validate.Component', function () {
         error: "".concat(LABEL, " is required")
       });
     });
+    it('should return a required error when the component is required and of type collection summary', function () {
+      var ID = 'field';
+      var LABEL = 'Field';
+      var COMPONENT = _objectSpread(_objectSpread({}, setup(ID, _models.ComponentTypes.COLLECTION_SUMMARY, LABEL, true)), {}, {
+        collectionName: 'testCollection'
+      });
+      expect((0, _validateComponent.default)(COMPONENT, {})).toEqual({
+        id: ID,
+        error: "".concat(LABEL, " is required")
+      });
+    });
     it('should return no error when the component is of type email but not required', function () {
       var ID = 'field';
       var LABEL = 'Field';

package/package.json

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