@ukhomeoffice/cop-react-form-renderer 4.46.0 → 4.48.0

package/dist/components/FormRenderer/FormRenderer.js

@@ -311,7 +311,10 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     if (action.type === _models.PageAction.TYPES.CANCEL) {
       hooks.onCancel();
       return;
-    } // Re-apply the patch to the page's formData.
+    } // Save a copy of data in case submit errors and we need to revert
+
+
+    var preSubmitData = _objectSpread({}, data); // Re-apply the patch to the page's formData.
     // This should normally have no effect but will prevent issues 
     // with validation if formData happens to have been wiped.
 
@@ -419,6 +422,8 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
           pageUpdate(sData);
         }, function (errors) {
           _handlers.default.submissionError(errors, addErrors);
+
+          setData(_objectSpread({}, preSubmitData));
         }, changedFieldName, changedFieldValue);
       }
     }

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

@@ -262,12 +262,14 @@ describe('components', function () {
             case 0:
               ON_SUBMIT_CALLS = [];
 
-              ON_SUBMIT = function ON_SUBMIT(type, payload, onSuccess, onError) {
+              ON_SUBMIT = function ON_SUBMIT(type, payload, onSuccess, onError, fieldName, fieldValue) {
                 ON_SUBMIT_CALLS.push({
                   type: type,
                   payload: payload,
                   onSuccess: onSuccess,
-                  onError: onError
+                  onError: onError,
+                  fieldName: fieldName,
+                  fieldValue: fieldValue
                 });
                 onSuccess();
               };
@@ -283,7 +285,8 @@ describe('components', function () {
                       case 0:
                         (0, _reactDom.render)( /*#__PURE__*/_react2.default.createElement(_FormRenderer.default, _extends({}, _userProfile.default, {
                           data: _userProfileData.default,
-                          hooks: HOOKS
+                          hooks: HOOKS,
+                          type: _models.FormTypes.HUB
                         })), container);
 
                       case 1:
@@ -302,9 +305,12 @@ describe('components', function () {
               _hub$childNodes2 = _slicedToArray(hub.childNodes, 3), civilServantList = _hub$childNodes2[2];
               link = getChangeLink(civilServantList);
 
-              _react.fireEvent.click(link, {}); // Should already be answered "Yes", so simply click "Continue".
+              _react.fireEvent.click(link, {}); // Should already be answered "Yes", but select "No, I'm a contractor" option to generate patch
+              // and then click "Continue".
 
 
+              _react.fireEvent.click(_react.screen.getByText("No, I'm a contractor"));
+
               page = form.childNodes[0];
               continueButton = getContinueButton(page);
               expect(ON_SUBMIT_CALLS.length).toEqual(0);
@@ -313,7 +319,9 @@ describe('components', function () {
 
               expect(ON_SUBMIT_CALLS.length).toEqual(1);
               expect(ON_SUBMIT_CALLS[0].type).toEqual(_models.PageAction.TYPES.SUBMIT);
-              expect(ON_SUBMIT_CALLS[0].payload.areYouACivilServant).toEqual('yes'); // And we should be back on the hub.
+              expect(ON_SUBMIT_CALLS[0].payload.areYouACivilServant).toEqual('no-contractor');
+              expect(ON_SUBMIT_CALLS[0].fieldName).toEqual('Are you a civil servant?');
+              expect(ON_SUBMIT_CALLS[0].fieldValue).toEqual("No, I'm a contractor"); // And we should be back on the hub.
 
               expect(form.childNodes.length).toEqual(2); // Title + Hub page (= CYA)
 
@@ -321,7 +329,7 @@ describe('components', function () {
               expect(title.tagName).toEqual('H1');
               expect(title.textContent).toEqual(_userProfile.default.title);
 
-            case 21:
+            case 24:
             case "end":
               return _context8.stop();
           }

package/dist/utils/CheckYourAnswers/getCYARowsForCollectionPage.js

@@ -109,12 +109,19 @@ var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onA
   }
 
   (_page$formData = page.formData) === null || _page$formData === void 0 ? void 0 : (_page$formData$page$c = _page$formData[page.collection.name]) === null || _page$formData$page$c === void 0 ? void 0 : _page$formData$page$c.forEach(function (item, index) {
+    var _page$collection2;
+
     var labelCount = index + 1;
+    var actionPosition = ((_page$collection2 = page.collection) === null || _page$collection2 === void 0 ? void 0 : _page$collection2.actionPosition) || 'top';
     var full_path = "".concat(page.collection.name, "[").concat(index, "]");
     var titleRow = getTitleRowForItem(page, item, page.id, labelCount, full_path);
     var actionRows = getActionRows(page, item, onAction, labelCount);
     rows = rows.concat(titleRow);
-    rows = rows.concat(actionRows);
+
+    if (actionPosition === 'top') {
+      rows = rows.concat(actionRows);
+    }
+
     page.collectionPages.forEach(function (p) {
       if (p.collection.route) {
         var pageWithRoute = (0, _addShowWhen.default)(p, p.collection.route);
@@ -132,6 +139,10 @@ var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onA
         rows = rows.concat(containerRows);
       }
     });
+
+    if (actionPosition === 'bottom') {
+      rows = rows.concat(actionRows);
+    }
   });
   return rows.filter(function (row) {
     return !!row;

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

@@ -331,4 +331,61 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
       size: 's'
     });
   });
+  it('should position actions under the title if actionPosition flag is not specified', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA
+    });
+
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[2].action.label).toEqual('Change');
+    expect(ROWS[3].action.label).toEqual('custom remove label');
+    expect(ROWS[4].action.label).toEqual('custom change label');
+  });
+  it('should position actions under the title if actionPosition flag is top', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        actionPosition: 'top'
+      }),
+      formData: FORM_DATA
+    });
+
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[2].action.label).toEqual('Change');
+    expect(ROWS[3].action.label).toEqual('custom remove label');
+    expect(ROWS[4].action.label).toEqual('custom change label');
+  });
+  it('should position actions under all other rows if actionPosition flag is bottom', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        actionPosition: 'bottom'
+      }),
+      formData: FORM_DATA
+    });
+
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    expect(ROWS[ROWS.length - 3].action.label).toEqual('Change');
+    expect(ROWS[ROWS.length - 2].action.label).toEqual('custom remove label');
+    expect(ROWS[ROWS.length - 1].action.label).toEqual('custom change label');
+  });
 });

package/dist/utils/Validate/validateComponent.js

@@ -41,7 +41,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
  * @returns The first encountered error with the component.
  */
 var validateComponent = function validateComponent(component, outerData, formData) {
-  var _fd$keycloakContext, _component$data$optio;
+  var _component$data$optio;
 
   var fd = formData || outerData;
 
@@ -68,8 +68,7 @@ var validateComponent = function validateComponent(component, outerData, formDat
         return (0, _validateCollection.default)(component, value, fd);
 
       case _models.ComponentTypes.EMAIL:
-        var userEmail = fd === null ? '' : (_fd$keycloakContext = fd.keycloakContext) === null || _fd$keycloakContext === void 0 ? void 0 : _fd$keycloakContext.email;
-        error = (0, _validateEmail.default)(value, component.label, userEmail, component.custom_errors);
+        error = (0, _validateEmail.default)(value, component.label, component.custom_errors);
         break;
 
       case _models.ComponentTypes.DATE:

package/dist/utils/Validate/validateEmail.js

@@ -15,24 +15,18 @@ var HODS_EMAIL_REGEX = /^[a-z0-9._-]+@(digital\.)?homeoffice.gov.uk$/i;
  * validateRequired (Validate.required) for that sort of validation.
  * @param {*} value The value to validate.
  * @param {string} label The label to use in any error message.
- * @param {string} userEmail The user email to use for validation.
+ * @param {array} customErrors The array of custom errors to use for format message.
  * @returns An error if the email address is invalid.
  */
 
 var validateEmail = function validateEmail(value) {
   var label = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
-  var userEmail = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '';
-  var customErrors = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
+  var customErrors = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : [];
 
   if (!!value) {
     var name = label ? label.toLowerCase() : 'email address';
 
     if (typeof value === 'string') {
-      // The following is an interim fix pending a mechanism for validating against specific values
-      if (['Line manager email', 'Delegate email address'].includes(label) && value.toLowerCase() === userEmail) {
-        return "".concat(label, " cannot be your own email");
-      }
-
       if (HODS_EMAIL_REGEX.test(value)) {
         return undefined;
       }

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

@@ -58,15 +58,15 @@ describe('utils', function () {
           'message': 'Enter email address in the correct format'
         }];
         var CUSTOM_ERROR = 'Enter email address in the correct format';
-        expect((0, _validateEmail.default)('bob', '', '', customErrors)).toEqual(CUSTOM_ERROR);
+        expect((0, _validateEmail.default)('bob', '', customErrors)).toEqual(CUSTOM_ERROR);
       });
-      it('should return an error when line manager email is same as user email', function () {
-        var USER_EMAIL_ERROR = 'Line manager email cannot be your own email';
-        expect((0, _validateEmail.default)('joe.bloggs@digital.homeoffice.gov.uk', 'Line manager email', 'joe.bloggs@digital.homeoffice.gov.uk')).toEqual(USER_EMAIL_ERROR);
-      });
-      it('should return an error when delegate email is same as user email', function () {
-        var USER_EMAIL_ERROR = 'Delegate email address cannot be your own email';
-        expect((0, _validateEmail.default)('joe.bloggs@digital.homeoffice.gov.uk', 'Delegate email address', 'joe.bloggs@digital.homeoffice.gov.uk')).toEqual(USER_EMAIL_ERROR);
+      it('should use the default format error message when custom errors is not an array', function () {
+        var DEFAULT_ERROR = 'Enter email address in the correct format, like jane.doe@homeoffice.gov.uk';
+        var customErrors = {
+          'type': 'format',
+          'message': 'Enter email address in the correct format'
+        };
+        expect((0, _validateEmail.default)('bob', '', customErrors)).toEqual(DEFAULT_ERROR);
       });
     });
   });

package/package.json

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