@ukhomeoffice/cop-react-form-renderer 2.7.4 → 2.8.4

package/dist/json/group.json

@@ -0,0 +1,418 @@
+{
+  "id": "userProfile",
+  "version": "1",
+  "name": "userProfile",
+  "title": "Your profile",
+  "type": "hub-and-spoke",
+  "components": [
+    {
+      "id": "firstName",
+      "fieldId": "firstName",
+      "label": "First name",
+      "type": "input",
+      "readonly": true,
+      "groupId": "addressDetails",
+      "source": {
+        "field": "currentUser.givenName"
+      }
+    },
+    {
+      "id": "surname",
+      "fieldId": "surname",
+      "label": "Last name",
+      "type": "text",
+      "readonly": true,
+      "groupId": "addressDetails",
+      "source": {
+        "field": "currentUser.familyName"
+      }
+    },
+    {
+      "id": "areYouACivilServant",
+      "fieldId": "areYouACivilServant",
+      "label": "Are you a civil servant?",
+      "type": "radios",
+      "required": true,
+      "groupId": "addressDetails",
+      "data": {
+        "url": "${urls.refData}/areYouACivilServant"
+      }
+    },
+    {
+      "id": "staffGradeId",
+      "fieldId": "staffGradeId",
+      "label": "Grade",
+      "hint": "We use this to assign you tasks",
+      "type": "radios",
+      "required": true,
+      "data": {
+        "url": "${urls.refData}/grade"
+      },
+      "source": {
+        "field": "userDetails.gradeid"
+      },
+      "show_when": {
+        "field": "areYouACivilServant",
+        "op": "eq",
+        "value": "yes"
+      }
+    },
+    {
+      "id": "team",
+      "fieldId": "team",
+      "label": "Team",
+      "hint": "We use this to assign you tasks",
+      "type": "autocomplete",
+      "required": true,
+      "item": {
+        "value": "id",
+        "label": "name"
+      },
+      "data": {
+        "url": "${urls.refData}/team"
+      },
+      "displayMenu": "inline",
+      "source": {
+        "field": "userDetails.defaultteam"
+      }
+    },
+    {
+      "id": "linemanagerEmail",
+      "fieldId": "linemanagerEmail",
+      "label": "Line manager email",
+      "hint": "Must be a homeoffice.gov.uk or digital.homeoffice.gov.uk address",
+      "type": "email",
+      "format": {
+        "type": "lowercase",
+        "on": "submit"
+      },
+      "required": true,
+      "source": {
+        "field": "userDetails.linemanagerEmail"
+      }
+    },
+    {
+      "id": "delegateEmails",
+      "fieldId": "delegateEmails",
+      "label": "Delegate email",
+      "hint": "Must be a homeoffice.gov.uk or digital.homeoffice.gov.uk address",
+      "type": "email",
+      "format": {
+        "type": "lowercase",
+        "on": "submit"
+      },
+      "required": true,
+      "source": {
+        "field": "userDetails.delegateEmails"
+      },
+      "show_when": [
+        {
+          "field": "areYouACivilServant",
+          "op": "eq",
+          "value": "yes"
+        },
+        {
+          "field": "staffGradeId",
+          "op": "in",
+          "values": [
+            "373979c1-2360-46be-b712-0409ac068059",
+            "36c80dfe-0aae-455b-9445-2e1c09dcafdc",
+            "1b041cda-b151-4769-b76a-d42d67b0b960",
+            "172de41d-f7b0-4be9-b7e8-0cf4f1a1342f",
+            "39e18b45-0358-4a45-83ec-5a70b74641e8"
+          ]
+        }
+      ]
+    },
+    {
+      "id": "firstLineOfTheAddress",
+      "fieldId": "firstLineOfTheAddress",
+      "label": "Address",
+      "type": "text",
+      "required": true,
+      "groupId": "addressDetails",
+      "custom_errors": [
+        {
+          "type": "required",
+          "message": "Please enter first line of the the address"
+        }
+      ],
+      "source": {
+        "field": "addressDetails.firstLineOfTheAddress"
+      }
+    },
+    {
+      "id": "city",
+      "fieldId": "city",
+      "label": "City",
+      "type": "text",
+      "required": true,
+      "groupId": "addressDetails",
+      "custom_errors": [
+        {
+          "type": "required",
+          "message": "Please enter city"
+        }
+      ],
+      "source": {
+        "field": "addressDetails.city"
+      }
+    },
+    {
+      "id": "town",
+      "fieldId": "town",
+      "label": "Town",
+      "type": "text",
+      "required": true,
+
+      "custom_errors": [
+        {
+          "type": "required",
+          "message": "Please enter Town"
+        }
+      ],
+      "source": {
+        "field": "addressDetails.town"
+      }
+    },
+    {
+      "id": "postCode",
+      "fieldId": "postCode",
+      "label": "Postcode",
+      "type": "text",
+      "required": true,
+      "groupId": "addressDetails",
+      "custom_errors": [
+        {
+          "type": "required",
+          "message": "Please enter postcode"
+        }
+      ],
+      "source": {
+        "field": "addressDetails.postCode"
+      }
+    },
+    {
+      "id": "postCode",
+      "fieldId": "postCode",
+      "label": "Postcode",
+      "type": "text",
+      "required": true,
+      "groupId": "addressDetails",
+      "custom_errors": [
+        {
+          "type": "required",
+          "message": "Please enter postcode"
+        }
+      ],
+      "source": {
+        "field": "addressDetails.postCode"
+      }
+    }
+  ],
+  "pages": [
+    {
+      "id": "names",
+      "name": "names",
+      "components": [
+        {
+          "use": "firstName"
+        },
+        {
+          "use": "surname"
+        }
+      ]
+    },
+    {
+      "id": "civil-servant-status",
+      "name": "civil-servant-status",
+      "title": "Are you a civil servant?",
+      "components": [
+        {
+          "use": "areYouACivilServant",
+          "label": ""
+        }
+      ],
+      "actions": ["submit"],
+      "cya_link": {
+        "page": "civil-servant-status",
+        "aria_suffix": "civil servant status"
+      }
+    },
+    {
+      "id": "grade",
+      "name": "grade",
+      "title": "What's your grade?",
+      "components": [
+        {
+          "use": "staffGradeId",
+          "label": ""
+        }
+      ],
+      "actions": ["submit"],
+      "cya_link": {
+        "page": "grade",
+        "aria_suffix": "grade"
+      }
+    },
+    {
+      "id": "team-name",
+      "name": "team-name",
+      "title": "What's your team name?",
+      "components": [
+        {
+          "use": "team",
+          "label": ""
+        }
+      ],
+      "actions": ["submit"],
+      "cya_link": {
+        "page": "team-name",
+        "aria_suffix": "teams"
+      }
+    },
+    {
+      "id": "add-or-change-line-manager",
+      "name": "add-or-change-line-manager",
+      "title": "Add or change a line manager",
+      "components": [
+        "Your line manager will need to review some of your forms. It’s important to keep their details up-to-date.",
+        "An email will be sent to your line manager to ask if they want to approve your request to add them.",
+        {
+          "type": "inset-text",
+          "content": "The changes will show in your profile when they approve your request."
+        },
+        {
+          "type": "heading",
+          "size": "m",
+          "content": "Mandatory declarations"
+        },
+        "Mandatory declarations will not go to your line manager until they have approved your request."
+      ],
+      "actions": [
+        {
+          "type": "navigate",
+          "page": "line-manager-email"
+        }
+      ],
+      "show_on_cya": false
+    },
+    {
+      "id": "line-manager-email",
+      "name": "line-manager-email",
+      "title": "What’s your line manager’s email address?",
+      "components": [
+        {
+          "use": "linemanagerEmail"
+        }
+      ],
+      "actions": ["submit"],
+      "cya_link": {
+        "page": "add-or-change-line-manager",
+        "aria_suffix": "line manager email address"
+      }
+    },
+    {
+      "id": "add-or-change-delegate",
+      "name": "add-or-change-delegate",
+      "title": "Add or change a delegate",
+      "components": [
+        "A delegate can review a mandatory declaration on your behalf.",
+        "An email will be sent to the delegate to ask if they want to approve your request.",
+        {
+          "type": "inset-text",
+          "content": "The changes will show in your profile when they approve your request."
+        }
+      ],
+      "actions": [
+        {
+          "type": "navigate",
+          "page": "delegate-email"
+        }
+      ],
+      "show_on_cya": false
+    },
+    {
+      "id": "delegate-email",
+      "name": "delegate-email",
+      "title": "What’s your delegate's email address?",
+      "components": [
+        {
+          "use": "delegateEmails",
+          "label": "Delegate email address"
+        },
+        {
+          "use": "delegateEmails",
+          "label": "Delegate email address"
+        }
+      ],
+      "actions": ["submit"],
+      "cya_link": {
+        "page": "add-or-change-delegate"
+      },
+      "show_when": [
+        {
+          "field": "areYouACivilServant",
+          "op": "eq",
+          "value": "yes"
+        },
+        {
+          "field": "staffGradeId",
+          "op": "in",
+          "values": [
+            "373979c1-2360-46be-b712-0409ac068059",
+            "36c80dfe-0aae-455b-9445-2e1c09dcafdc",
+            "1b041cda-b151-4769-b76a-d42d67b0b960",
+            "172de41d-f7b0-4be9-b7e8-0cf4f1a1342f",
+            "39e18b45-0358-4a45-83ec-5a70b74641e8"
+          ]
+        }
+      ]
+    },
+
+    {
+      "id": "address-details",
+      "groupLabel": "UK address",
+      "fieldId": "UK address",
+      "groups": [
+        {
+          "id": "address",
+          "label": "Address details",
+          "components": ["firstLineOfTheAddress", "town", "city", "postCode"]
+        }
+      ],
+      "name": "address-details",
+      "title": "Address details",
+      "components": [
+        {
+          "use": "firstLineOfTheAddress",
+          "label": "Address"
+        },
+        {
+          "use": "town",
+          "label": "Town"
+        },
+        {
+          "use": "city",
+          "label": "City"
+        },
+        {
+          "use": "postCode",
+          "label": "Postcode"
+        }
+      ],
+      "actions": ["saveAndContinue", "saveAndReturn"],
+      "cya_link": {
+        "url": "/address-details",
+        "aria_suffix": "address details"
+      }
+    }
+  ],
+  "hub": {
+    "format": "CYA"
+  },
+  "cya": {
+    "hide_page_titles": true,
+    "hide_actions": true
+  }
+}

package/dist/json/userProfile.data.json

@@ -11,5 +11,11 @@
     "linemanagerEmail": "line.manager@digital.homeoffice.gov.uk",
     "delegateEmails": "del.egate@digital.homeoffice.gov.uk"
   },
+  "addressDetails": {
+    "firstLineOfTheAddress": "10 Downing Street",
+    "city": "London",
+    "town": "City of Westminster",
+    "postCode": "SW1A 2AA"
+  },
   "businessKey": "123456789"
 }

package/dist/utils/CheckYourAnswers/getCYARow.js

@@ -31,6 +31,7 @@ var getCYARow = function getCYARow(page, component, onAction) {
 
   return {
     pageId: page.id,
+    id: component.id,
     fieldId: component.fieldId,
     key: component.label || component.cya_label,
     component: _Component.default.editable(component) ? component : undefined,

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

@@ -58,6 +58,7 @@ describe('utils', function () {
 
         expect((0, _getCYARow.default)(PAGE, COMPONENT, ON_ACTION)).toEqual({
           pageId: PAGE.id,
+          id: COMPONENT.id,
           fieldId: COMPONENT.fieldId,
           key: COMPONENT.label,
           value: '',
@@ -84,6 +85,7 @@ describe('utils', function () {
 
         expect((0, _getCYARow.default)(PAGE, COMPONENT, ON_ACTION)).toEqual({
           pageId: PAGE.id,
+          id: COMPONENT.id,
           fieldId: COMPONENT.fieldId,
           key: COMPONENT.label,
           value: 'BLAH',

package/dist/utils/CheckYourAnswers/getCYARowForGroup.js

@@ -0,0 +1,82 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _FormComponent = _interopRequireDefault(require("../../components/FormComponent"));
+
+var _getCYAAction = _interopRequireDefault(require("./getCYAAction"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+var getRowValue = function getRowValue(row) {
+  if (!row.value) {
+    return null;
+  }
+
+  if (!row.component) {
+    return row.value;
+  }
+
+  return /*#__PURE__*/_react.default.createElement("div", {
+    key: row.id
+  }, /*#__PURE__*/_react.default.createElement(_FormComponent.default, {
+    component: _objectSpread(_objectSpread({}, row.component), {}, {
+      readonly: true
+    }),
+    wrap: false,
+    value: row.value
+  }));
+};
+
+var getGroupValue = function getGroupValue(group, rows) {
+  var firstComponentIndex = -1;
+
+  var value = /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, group.components.map(function (componentId) {
+    var rowIndex = rows.findIndex(function (r) {
+      return r.id === componentId;
+    });
+
+    if (firstComponentIndex < 0) {
+      firstComponentIndex = rowIndex;
+    }
+
+    return rowIndex > -1 ? getRowValue(rows[rowIndex]) : null;
+  }));
+
+  return {
+    value: value,
+    firstComponentIndex: firstComponentIndex
+  };
+};
+
+var getCYARowForGroup = function getCYARowForGroup(page, group, rows, onAction) {
+  var _getGroupValue = getGroupValue(group, rows),
+      value = _getGroupValue.value,
+      firstComponentIndex = _getGroupValue.firstComponentIndex;
+
+  var row = {
+    pageId: page.id,
+    fieldId: group.id,
+    key: group.label,
+    value: value,
+    action: (0, _getCYAAction.default)(false, page, onAction)
+  };
+  return {
+    row: row,
+    insertAt: firstComponentIndex
+  };
+};
+
+var _default = getCYARowForGroup;
+exports.default = _default;

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

@@ -0,0 +1,78 @@
+"use strict";
+
+var _react = require("@testing-library/react");
+
+var _getCYARowForGroup = _interopRequireDefault(require("./getCYARowForGroup"));
+
+var _getCYARow = _interopRequireDefault(require("./getCYARow"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Global imports
+//local imports 
+describe('utils', function () {
+  describe('CheckYourAnswers', function () {
+    describe('getCYARowsForGroup', function () {
+      it('should check address values block', function () {
+        var COMPONENT_ADDRESS = {
+          id: 'firstLineOfTheAddress',
+          fieldId: 'firstLineOfTheAddress',
+          label: 'address',
+          type: 'text'
+        };
+        var COMPONENT_TOWN = {
+          id: 'town',
+          fieldId: 'town',
+          label: 'Town',
+          type: 'text'
+        };
+        var COMPONENT_CITY = {
+          id: 'city',
+          fieldId: 'city',
+          label: 'City',
+          type: 'text'
+        };
+        var COMPONENT_POSTCODE = {
+          id: 'postCode',
+          fieldId: 'postCode',
+          label: 'postCode',
+          type: 'text'
+        };
+        var PAGE = {
+          components: [COMPONENT_ADDRESS, COMPONENT_TOWN, COMPONENT_CITY, COMPONENT_POSTCODE],
+          id: 'addressDetails',
+          fieldId: 'UK address',
+          groups: [{
+            id: 'address',
+            label: 'Address details',
+            components: ['firstLineOfTheAddress', 'town', 'city', 'postCode']
+          }],
+          name: 'address-details',
+          title: 'Address details',
+          formData: {
+            firstLineOfTheAddress: '10 Downing Street',
+            town: 'City of Westminster',
+            city: 'London',
+            postCode: 'SW1A 2AA'
+          }
+        };
+
+        var ON_ACTION = function ON_ACTION() {};
+
+        var rows = PAGE.components.map(function (component) {
+          return (0, _getCYARow.default)(PAGE, component, ON_ACTION);
+        });
+
+        var _render = (0, _react.render)((0, _getCYARowForGroup.default)(PAGE, PAGE.groups[0], rows, ON_ACTION).row.value),
+            container = _render.container;
+
+        expect(container.childNodes.length).toEqual(4);
+        var addressValues = container.childNodes;
+        expect(addressValues[0].childNodes[0].textContent).toEqual('10 Downing Street');
+        expect(addressValues[1].childNodes[0].textContent).toEqual('City of Westminster');
+        expect(addressValues[2].childNodes[0].textContent).toEqual('London');
+        expect(addressValues[3].childNodes[0].textContent).toEqual('SW1A 2AA');
+      });
+    });
+  });
+});

package/dist/utils/CheckYourAnswers/getCYARowsForPage.js

@@ -11,6 +11,8 @@ var _FormPage = _interopRequireDefault(require("../FormPage"));
 
 var _getCYARow = _interopRequireDefault(require("./getCYARow"));
 
+var _getCYARowForGroup2 = _interopRequireDefault(require("./getCYARowForGroup"));
+
 var _getCYARowsForContainer = _interopRequireDefault(require("./getCYARowsForContainer"));
 
 var _showComponentCYA = _interopRequireDefault(require("./showComponentCYA"));
@@ -21,15 +23,17 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 /**
  * Gets an array of row objects, each configured appropriately for a Check your answers component.
- * 
+ *
  * @param {object} page The page to show components for.
  * @param {Function} onAction A function to invoke if the change link on any row is clicked.
- * 
+ *
  * @returns An array of configuration objects for Check your answers rows.
  */
 var getCYARowsForPage = function getCYARowsForPage(page, onAction) {
   if (_FormPage.default.show(page, page.formData)) {
-    return page.components.filter(function (c) {
+    var _page$groups;
+
+    var rows = page.components.filter(function (c) {
       return (0, _showComponentCYA.default)(c, page.formData);
     }).flatMap(function (component) {
       if (component.type === _models.ComponentTypes.CONTAINER) {
@@ -38,6 +42,28 @@ var getCYARowsForPage = function getCYARowsForPage(page, onAction) {
 
       return (0, _getCYARow.default)(page, component, onAction);
     });
+
+    if (((_page$groups = page.groups) === null || _page$groups === void 0 ? void 0 : _page$groups.length) > 0) {
+      page.groups.forEach(function (group) {
+        var _getCYARowForGroup = (0, _getCYARowForGroup2.default)(page, group, rows, onAction),
+            row = _getCYARowForGroup.row,
+            insertAt = _getCYARowForGroup.insertAt;
+
+        if (insertAt > -1) {
+          rows.splice(insertAt, 0, row);
+        } else {
+          rows.push(row);
+        }
+      });
+      var allReplacedIds = page.groups.flatMap(function (g) {
+        return g.components;
+      });
+      return rows.filter(function (r) {
+        return !allReplacedIds.includes(r.id);
+      });
+    }
+
+    return rows;
   }
 
   return [];