@ukhomeoffice/cop-react-form-renderer 4.53.0 → 4.54.0

package/dist/components/CheckYourAnswers/CheckYourAnswers.js

@@ -67,6 +67,7 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
       hide_title = _ref.hide_title,
       summaryListClassModifiers = _ref.summaryListClassModifiers,
       noChangeAction = _ref.noChangeAction,
+      noGroupAction = _ref.noGroupAction,
       groups = _ref.groups,
       sections = _ref.sections,
       type = _ref.type;
@@ -170,6 +171,7 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
           rows: page.rows,
           classModifiers: summaryListClassModifiers,
           noChangeAction: hideActionButtons,
+          noGroupAction: noGroupAction,
           isGroup: isGroup(page.id)
         }));
       }));
@@ -190,6 +192,7 @@ var CheckYourAnswers = function CheckYourAnswers(_ref) {
       rows: page.rows,
       classModifiers: summaryListClassModifiers,
       noChangeAction: hideActionButtons,
+      noGroupAction: noGroupAction,
       isGroup: isGroup(page.id)
     }));
   }), !hide_actions && /*#__PURE__*/_react.default.createElement(_PageActions.default, {
@@ -211,6 +214,7 @@ CheckYourAnswers.propTypes = {
   hide_title: _propTypes.default.bool,
   summaryListClassModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
   noChangeAction: _propTypes.default.bool,
+  noGroupAction: _propTypes.default.bool,
   sections: _propTypes.default.arrayOf(_propTypes.default.shape({
     name: _propTypes.default.string.isRequired,
     tasks: _propTypes.default.arrayOf(_propTypes.default.shape({

package/dist/components/FormRenderer/FormRenderer.js

@@ -103,7 +103,7 @@ var DEFAULT_CLASS = 'hods-form';
 exports.DEFAULT_CLASS = DEFAULT_CLASS;
 
 var InternalFormRenderer = function InternalFormRenderer(_ref2) {
-  var _formState$page5, _formState$page$actio;
+  var _formState$page5, _formState$page$actio, _formState$cya$hideCh, _formState$cya$hideGr;
 
   var title = _ref2.title,
       type = _ref2.type,
@@ -613,7 +613,8 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     onRowAction: onCYARowAction,
     summaryListClassModifiers: summaryListClassModifiers,
     hide_title: hide_title,
-    noChangeAction: noChangeAction,
+    noChangeAction: (_formState$cya$hideCh = formState.cya.hideChangeActions) !== null && _formState$cya$hideCh !== void 0 ? _formState$cya$hideCh : noChangeAction,
+    noGroupAction: (_formState$cya$hideGr = formState.cya.hideGroupActions) !== null && _formState$cya$hideGr !== void 0 ? _formState$cya$hideGr : false,
     sections: typeof hubDetails !== 'undefined' ? hubDetails.sections : [],
     type: type
   })), hub === _models.HubFormats.TASK && formState.pageId === _models.FormPages.HUB && /*#__PURE__*/_react.default.createElement(_TaskList.default, _extends({}, hubDetails, {

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

@@ -7,6 +7,10 @@ exports.default = void 0;
 
 var _models = require("../../../models");
 
+var _utils = _interopRequireDefault(require("../../../utils"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 // Local imports
 
 /**
@@ -29,8 +33,12 @@ var getCYA = function getCYA(pageId, pages, hub) {
   });
 
   if ((currentPage === null || currentPage === void 0 ? void 0 : currentPage.type) === _models.FormPages.PARTIAL_CYA) {
+    var pageWithConditionals = _utils.default.FormPage.applyConditionalProperties(currentPage);
+
     return {
-      title: currentPage.title
+      title: pageWithConditionals.title,
+      hideChangeActions: pageWithConditionals.hideChangeActions,
+      hideGroupActions: pageWithConditionals.hideGroupActions
     };
   }
 

package/dist/components/SummaryList/SummaryList.js

@@ -21,7 +21,7 @@ var _SummaryListTitleRow = _interopRequireDefault(require("./SummaryListTitleRow
 
 require("./SummaryList.scss");
 
-var _excluded = ["rows", "noChangeAction", "isGroup", "classBlock", "classModifiers", "className"];
+var _excluded = ["rows", "noChangeAction", "noGroupAction", "isGroup", "classBlock", "classModifiers", "className"];
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -37,6 +37,7 @@ exports.DEFAULT_CLASS = DEFAULT_CLASS;
 var SummaryList = function SummaryList(_ref) {
   var rows = _ref.rows,
       noChangeAction = _ref.noChangeAction,
+      noGroupAction = _ref.noGroupAction,
       isGroup = _ref.isGroup,
       classBlock = _ref.classBlock,
       classModifiers = _ref.classModifiers,
@@ -79,7 +80,7 @@ var SummaryList = function SummaryList(_ref) {
     }
 
     if (row.type === 'action') {
-      return /*#__PURE__*/_react.default.createElement("div", {
+      return noChangeAction ? null : /*#__PURE__*/_react.default.createElement("div", {
         key: "".concat(key, "-actions")
       }, /*#__PURE__*/_react.default.createElement(_GroupAction.default, {
         group: row
@@ -92,7 +93,9 @@ var SummaryList = function SummaryList(_ref) {
       classes: classes,
       showAction: !noChangeAction
     });
-  }), isGroup && /*#__PURE__*/_react.default.createElement("div", {
+  }).filter(function (r) {
+    return !!r;
+  }), isGroup && !noGroupAction && /*#__PURE__*/_react.default.createElement("div", {
     className: "change-group-button"
   }, /*#__PURE__*/_react.default.createElement(_GroupAction.default, {
     group: groupActionRow

package/dist/components/SummaryList/SummaryList.test.js

@@ -49,6 +49,14 @@ describe('components', function () {
       return heading;
     };
 
+    var checkActionRow = function checkActionRow(summaryList, index) {
+      var row = summaryList.childNodes[index];
+      expect(row.tagName).toEqual('DIV');
+      expect(row.childNodes.length).toEqual(1);
+      var link = row.childNodes[0];
+      return link;
+    };
+
     var checkRow = function checkRow(summaryList, index) {
       var row = summaryList.childNodes[index];
       expect(row.tagName).toEqual('DIV');
@@ -185,6 +193,84 @@ describe('components', function () {
         }
       });
     });
+    it('should handle action rows', function () {
+      var ID = 'test-id';
+      var ROWS = [{
+        pageId: 'p1',
+        fieldId: 'a',
+        type: 'action',
+        action: {
+          label: 'Do action'
+        }
+      }, {
+        pageId: 'p2',
+        fieldId: 'b',
+        type: 'action',
+        action: {
+          label: 'Do action'
+        }
+      }, {
+        pageId: 'p3',
+        fieldId: 'c',
+        type: 'action',
+        action: {
+          label: 'Do action'
+        }
+      }];
+
+      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+        "data-testid": ID,
+        rows: ROWS
+      })),
+          container = _render4.container;
+
+      var summaryList = checkSummaryList(container, ID);
+      expect(summaryList.childNodes.length).toEqual(ROWS.length);
+
+      var assessActionRow = function assessActionRow(row, index) {
+        var link = checkActionRow(summaryList, index);
+        expect(link.textContent).toEqual(row.action.label);
+      };
+
+      ROWS.forEach(function (row, index) {
+        assessActionRow(row, index);
+      });
+    });
+    it('should hide actions rows if flag is given', function () {
+      var ID = 'test-id';
+      var ROWS = [{
+        pageId: 'p1',
+        fieldId: 'a',
+        type: 'action',
+        action: {
+          label: 'Do action'
+        }
+      }, {
+        pageId: 'p2',
+        fieldId: 'b',
+        type: 'action',
+        action: {
+          label: 'Do action'
+        }
+      }, {
+        pageId: 'p3',
+        fieldId: 'c',
+        type: 'action',
+        action: {
+          label: 'Do action'
+        }
+      }];
+
+      var _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+        "data-testid": ID,
+        rows: ROWS,
+        noChangeAction: true
+      })),
+          container = _render5.container;
+
+      var summaryList = checkSummaryList(container, ID);
+      expect(summaryList.childNodes.length).toEqual(0);
+    });
     it('should handle rows with no actions and component values', function () {
       var ID = 'test-id';
       var VALUES = ['Alpha component value', 'Bravo component value'];
@@ -200,11 +286,11 @@ describe('components', function () {
         value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[1])
       }];
 
-      var _render4 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+      var _render6 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
         "data-testid": ID,
         rows: ROWS
       })),
-          container = _render4.container;
+          container = _render6.container;
 
       var summaryList = checkSummaryList(container, ID);
       expect(summaryList.childNodes.length).toEqual(ROWS.length);
@@ -251,11 +337,11 @@ describe('components', function () {
         }
       }];
 
-      var _render5 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+      var _render7 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
         "data-testid": ID,
         rows: ROWS
       })),
-          container = _render5.container;
+          container = _render7.container;
 
       var summaryList = checkSummaryList(container, ID);
       expect(summaryList.childNodes.length).toEqual(ROWS.length);
@@ -292,12 +378,12 @@ describe('components', function () {
         value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[1])
       }];
 
-      var _render6 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+      var _render8 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
         "data-testid": ID,
         rows: ROWS,
         noChangeAction: true
       })),
-          container = _render6.container;
+          container = _render8.container;
 
       var summaryList = checkSummaryList(container, ID);
       expect(summaryList.childNodes.length).toEqual(ROWS.length);
@@ -335,12 +421,12 @@ describe('components', function () {
         value: /*#__PURE__*/_react2.default.createElement("div", null, VALUES[2])
       }];
 
-      var _render7 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
+      var _render9 = (0, _react.render)( /*#__PURE__*/_react2.default.createElement(_SummaryList.default, {
         "data-testid": ID,
         rows: ROWS,
         isGroup: ISGROUP
       })),
-          container = _render7.container;
+          container = _render9.container;
 
       var summaryList = checkSummaryList(container, ID);
       expect(summaryList.childNodes.length).toEqual(ROWS.length + 1);

package/dist/utils/FormPage/applyConditionalProperties.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _ = _interopRequireDefault(require(".."));
+
+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); 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) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+/**
+ * Apply properties to a page based on whether certain conditions are met.
+ * @param {object} page The page object.
+ * @returns A copy of the page object with any passing conditional 
+ * properties applied.
+ */
+var applyConditionalProperties = function applyConditionalProperties(page) {
+  if (!page.conditionalProperties) {
+    return page;
+  }
+
+  var pageWithProperties = _objectSpread({}, page);
+
+  page.conditionalProperties.forEach(function (entry) {
+    if (_.default.Condition.met(entry.condition, page.formData[entry.condition.field])) {
+      pageWithProperties = Object.assign(pageWithProperties, entry.properties);
+    }
+
+    ;
+  });
+  return pageWithProperties;
+};
+
+var _default = applyConditionalProperties;
+exports.default = _default;

package/dist/utils/FormPage/applyConditionalProperties.test.js

@@ -0,0 +1,63 @@
+"use strict";
+
+var _applyConditionalProperties = _interopRequireDefault(require("./applyConditionalProperties"));
+
+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); 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) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+describe('utils.FormPage.applyConditionalProperties', function () {
+  it('should not change the page if there are no conditional properties', function () {
+    var PAGE = {
+      id: 'testPage'
+    };
+    var result = (0, _applyConditionalProperties.default)(PAGE);
+    expect(result).toEqual(PAGE);
+  });
+  it('should not apply properties with conditions that have not been met', function () {
+    var PAGE = {
+      id: 'testPage',
+      conditionalProperties: [{
+        condition: {
+          field: 'alpha',
+          op: '=',
+          value: '123'
+        },
+        properties: {
+          beta: '456'
+        }
+      }],
+      formData: {
+        alpha: '012'
+      }
+    };
+    var result = (0, _applyConditionalProperties.default)(PAGE);
+    expect(result).toEqual(PAGE);
+  });
+  it('should apply properties with conditions that have been met', function () {
+    var PAGE = {
+      id: 'testPage',
+      conditionalProperties: [{
+        condition: {
+          field: 'alpha',
+          op: '=',
+          value: '123'
+        },
+        properties: {
+          beta: '456'
+        }
+      }],
+      formData: {
+        alpha: '123'
+      }
+    };
+    var result = (0, _applyConditionalProperties.default)(PAGE);
+    expect(result).toEqual(_objectSpread(_objectSpread({}, PAGE), {}, {
+      beta: '456'
+    }));
+  });
+});

package/dist/utils/FormPage/index.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _applyConditionalProperties = _interopRequireDefault(require("./applyConditionalProperties"));
+
 var _getFormPage = _interopRequireDefault(require("./getFormPage"));
 
 var _getFormPages = _interopRequireDefault(require("./getFormPages"));
@@ -16,6 +18,7 @@ var _showFormPageCYA = _interopRequireDefault(require("./showFormPageCYA"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var FormPage = {
+  applyConditionalProperties: _applyConditionalProperties.default,
   get: _getFormPage.default,
   getAll: _getFormPages.default,
   show: _showFormPage.default,

package/package.json

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