@ukhomeoffice/cop-react-form-renderer 3.21.0 → 3.23.2

package/dist/components/FormRenderer/FormRenderer.js

@@ -101,6 +101,8 @@ var DEFAULT_CLASS = 'hods-form';
 exports.DEFAULT_CLASS = DEFAULT_CLASS;
 
 var InternalFormRenderer = function InternalFormRenderer(_ref2) {
+  var _formState$page2;
+
   var title = _ref2.title,
       type = _ref2.type,
       components = _ref2.components,
@@ -414,6 +416,12 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
       }
     }
 
+    if (action.type === _models.PageAction.TYPES.NAVIGATE) {
+      var _formState$page;
+
+      onPageChange(_helpers.default.getNextPageId(type, pages, pageId, action, (_formState$page = formState.page) === null || _formState$page === void 0 ? void 0 : _formState$page.formData));
+    }
+
     if (action.type === _models.PageAction.TYPES.CANCEL) {
       hooks.onCancel();
     }
@@ -428,8 +436,10 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
   return /*#__PURE__*/_react.default.createElement("div", {
     className: classes()
   }, title && !hide_title && pageId === _models.FormPages.HUB && /*#__PURE__*/_react.default.createElement(_copReactComponents.LargeHeading, null, title), formState.cya && /*#__PURE__*/_react.default.createElement(_CheckYourAnswers.default, _extends({
-    pages: currentTask.fullPages ? currentTask.fullPages : pages
-  }, cya, formState.cya, {
+    pages: _helpers.default.getRelevantPages(formState, pages, currentTask.fullPages)
+  }, cya, ((_formState$page2 = formState.page) === null || _formState$page2 === void 0 ? void 0 : _formState$page2.type) === _models.FormPages.PARTIAL_CYA && {
+    actions: formState.page.actions
+  }, formState.cya, {
     onAction: onCYAAction,
     onRowAction: onCYARowAction,
     summaryListClassModifiers: summaryListClassModifiers,
@@ -442,7 +452,7 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     refNumber: data['businessKey'],
     refTitle: _hub.refTitle,
     onTaskAction: onTaskAction
-  }), formState.page && /*#__PURE__*/_react.default.createElement(_FormPage.default, {
+  }), formState.page && !formState.cya && /*#__PURE__*/_react.default.createElement(_FormPage.default, {
     page: formState.page,
     onAction: onPageAction
   }));

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

@@ -15,7 +15,7 @@ var _models = require("../../../models");
  * @param {object} hub The hub, if there is one.
  * @returns A configuration object for the Check your answers screen.
  */
-var getCYA = function getCYA(pageId, hub) {
+var getCYA = function getCYA(pageId, pages, hub) {
   if (pageId === _models.FormPages.HUB && hub === _models.HubFormats.CYA) {
     return {
       title: ''
@@ -24,6 +24,16 @@ var getCYA = function getCYA(pageId, hub) {
     return {};
   }
 
+  var currentPage = pages === null || pages === void 0 ? void 0 : pages.find(function (p) {
+    return p.id === pageId;
+  });
+
+  if ((currentPage === null || currentPage === void 0 ? void 0 : currentPage.type) === _models.FormPages.PARTIAL_CYA) {
+    return {
+      title: currentPage.title
+    };
+  }
+
   return undefined;
 };
 

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

@@ -19,18 +19,27 @@ describe('components', function () {
           expect((0, _getCYA.default)(_models.FormPages.CYA)).toEqual({});
         });
         it('should give an object with a blank title if the pageId is "hub" and the hub is the CYA', function () {
-          expect((0, _getCYA.default)(_models.FormPages.HUB, _models.HubFormats.CYA)).toEqual({
+          expect((0, _getCYA.default)(_models.FormPages.HUB, [], _models.HubFormats.CYA)).toEqual({
             title: ''
           });
         });
         it('should give undefined if pageId is "hub" and the hub is NOT the CYA', function () {
-          expect((0, _getCYA.default)(_models.FormPages.HUB, HUB)).toBeUndefined();
+          expect((0, _getCYA.default)(_models.FormPages.HUB, [], HUB)).toBeUndefined();
         });
         it('should give undefined if pageId is NOT "hub" and the hub is NOT the CYA', function () {
-          expect((0, _getCYA.default)(_models.FormPages.HUB, HUB)).toBeUndefined();
+          expect((0, _getCYA.default)(_models.FormPages.HUB, [], HUB)).toBeUndefined();
         });
         it('should give undefined if pageId is NOT "hub" and the hub is the CYA', function () {
-          expect((0, _getCYA.default)('bob', _models.HubFormats.CYA)).toBeUndefined();
+          expect((0, _getCYA.default)('bob', [], _models.HubFormats.CYA)).toBeUndefined();
+        });
+        it('should return an object with a title if the current page has type partial-cya', function () {
+          expect((0, _getCYA.default)('pageId', [{
+            id: 'pageId',
+            type: 'partial-cya',
+            title: 'page title'
+          }], _models.HubFormats.CYA)).toEqual({
+            title: 'page title'
+          });
         });
       });
     });

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

@@ -23,7 +23,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 var getFormState = function getFormState(pageId, pages, hub) {
   return {
     pageId: pageId,
-    cya: (0, _getCYA.default)(pageId, hub),
+    cya: (0, _getCYA.default)(pageId, pages, hub),
     page: (0, _getPage.default)(pageId, pages, hub)
   };
 };

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

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _models = require("../../../models");
+
+var slicePages = function slicePages(pages, currentPageId) {
+  return pages.slice(0, pages.findIndex(function (p) {
+    return p.pageId === currentPageId;
+  }));
+};
+
+var getRelevantPages = function getRelevantPages(formState, pages, currentTaskPages) {
+  var _formState$page;
+
+  if (((_formState$page = formState.page) === null || _formState$page === void 0 ? void 0 : _formState$page.type) === _models.FormPages.PARTIAL_CYA) {
+    return currentTaskPages ? slicePages(currentTaskPages, formState.pageId) : slicePages(pages, formState.pageId);
+  }
+
+  return currentTaskPages ? currentTaskPages : pages;
+};
+
+var _default = getRelevantPages;
+exports.default = _default;

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

@@ -0,0 +1,71 @@
+"use strict";
+
+var _models = require("../../../models");
+
+var _getRelevantPages = _interopRequireDefault(require("../helpers/getRelevantPages"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('components', function () {
+  describe('FormRenderer', function () {
+    describe('helpers', function () {
+      describe('getRelevantPages', function () {
+        var pages = [{
+          pageId: 'page1'
+        }, {
+          pageId: 'page2'
+        }, {
+          pageId: 'page3'
+        }, {
+          pageId: 'page4'
+        }, {
+          pageId: 'page5'
+        }];
+        var taskListPages = [{
+          pageId: 'taskPage1'
+        }, {
+          pageId: 'taskPage2'
+        }, {
+          pageId: 'taskPage3'
+        }, {
+          pageId: 'taskPage4'
+        }, {
+          pageId: 'taskPage5'
+        }];
+        it('return all pages from the start of the given list to the current page outside of a task when the page type is partial-cya', function () {
+          var formState = {
+            page: {
+              type: _models.FormPages.PARTIAL_CYA
+            },
+            pageId: 'page3'
+          };
+          expect((0, _getRelevantPages.default)(formState, pages, undefined)).toEqual(pages.slice(0, 2));
+        });
+        it('return all pages from the start of the given list to the current page in a task when the page type is partial-cya', function () {
+          var formState = {
+            page: {
+              type: _models.FormPages.PARTIAL_CYA
+            },
+            pageId: 'taskPage4'
+          };
+          expect((0, _getRelevantPages.default)(formState, pages, taskListPages)).toEqual(taskListPages.slice(0, 3));
+        });
+        it('return all pages when the page type is not partial-cya', function () {
+          var formState = {
+            page: {},
+            pageId: 'page2'
+          };
+          expect((0, _getRelevantPages.default)(formState, pages, undefined)).toEqual(pages);
+        });
+        it('return all task pages when the page type is not partial-cya', function () {
+          var formState = {
+            page: {},
+            pageId: 'taskPage2'
+          };
+          expect((0, _getRelevantPages.default)(formState, pages, taskListPages)).toEqual(taskListPages);
+        });
+      });
+    });
+  });
+});

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

@@ -13,6 +13,8 @@ var _cleanHiddenNestedData = _interopRequireDefault(require("./cleanHiddenNested
 
 var _getFormState = _interopRequireDefault(require("./getFormState"));
 
+var _getRelevantPages = _interopRequireDefault(require("./getRelevantPages"));
+
 var _getNextPageId = _interopRequireDefault(require("./getNextPageId"));
 
 var _getPage = _interopRequireDefault(require("./getPage"));
@@ -29,6 +31,7 @@ var helpers = {
   canCYASubmit: _canCYASubmit.default,
   cleanHiddenNestedData: _cleanHiddenNestedData.default,
   getFormState: _getFormState.default,
+  getRelevantPages: _getRelevantPages.default,
   getNextPageId: _getNextPageId.default,
   getPage: _getPage.default,
   getSubmissionStatus: _getSubmissionStatus.default,

package/dist/components/SummaryList/RowAction.js

@@ -21,6 +21,8 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+function _extends() { _extends = Object.assign ? Object.assign.bind() : function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -34,7 +36,8 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 var RowAction = function RowAction(_ref) {
-  var row = _ref.row;
+  var row = _ref.row,
+      onClick = _ref.onClick;
 
   var _useState = (0, _react.useState)({}),
       _useState2 = _slicedToArray(_useState, 2),
@@ -49,7 +52,14 @@ var RowAction = function RowAction(_ref) {
     return null;
   }
 
-  return /*#__PURE__*/_react.default.createElement(_copReactComponents.Link, attrs, row.action.label, row.action.aria_suffix && /*#__PURE__*/_react.default.createElement(_copReactComponents.VisuallyHidden, null, " ", row.action.aria_suffix));
+  return /*#__PURE__*/_react.default.createElement(_copReactComponents.Link, _extends({}, attrs, {
+    onKeyPress: function onKeyPress(event) {
+      if (event.key === 'Enter') {
+        row.action.onAction(row);
+      }
+    },
+    tabIndex: "0"
+  }), row.action.label, row.action.aria_suffix && /*#__PURE__*/_react.default.createElement(_copReactComponents.VisuallyHidden, null, " ", row.action.aria_suffix));
 };
 
 RowAction.propTypes = {

package/dist/models/FormPages.js

@@ -6,9 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var PAGE_CYA = 'cya';
 var PAGE_HUB = 'hub';
+var PAGE_PARTIAL_CYA = 'partial-cya';
 var FormPages = {
   CYA: PAGE_CYA,
-  HUB: PAGE_HUB
+  HUB: PAGE_HUB,
+  PARTIAL_CYA: PAGE_PARTIAL_CYA
 };
 var _default = FormPages;
 exports.default = _default;

package/dist/utils/CheckYourAnswers/getCYARowsForCollection.js

@@ -22,9 +22,11 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 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 getEntryToCollectionRow = function getEntryToCollectionRow(page, onAction) {
+  var _page$components$0$la;
+
   return [{
     pageId: page.id,
-    key: page.components[0].labels.empty || 'Nothing entered',
+    key: ((_page$components$0$la = page.components[0].labels) === null || _page$components$0$la === void 0 ? void 0 : _page$components$0$la.empty) || 'Nothing entered',
     required: page.required,
     action: {
       page: page.id,

package/dist/utils/CheckYourAnswers/getCYARowsForPage.js

@@ -32,7 +32,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @returns An array of configuration objects for Check your answers rows.
  */
 var getCYARowsForPage = function getCYARowsForPage(page, onAction) {
-  if (_FormPage.default.show(page, page.formData)) {
+  if (_FormPage.default.showCYA(page, page.formData)) {
     var _page$groups;
 
     var rows = page.components.filter(function (c) {

package/dist/utils/FormPage/index.js

@@ -11,12 +11,15 @@ var _getFormPages = _interopRequireDefault(require("./getFormPages"));
 
 var _showFormPage = _interopRequireDefault(require("./showFormPage"));
 
+var _showFormPageCYA = _interopRequireDefault(require("./showFormPageCYA"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var FormPage = {
   get: _getFormPage.default,
   getAll: _getFormPages.default,
-  show: _showFormPage.default
+  show: _showFormPage.default,
+  showCYA: _showFormPageCYA.default
 };
 var _default = FormPage;
 exports.default = _default;

package/dist/utils/FormPage/showFormPageCYA.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _showFormPage = _interopRequireDefault(require("./showFormPage"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Indicates whether or not a page should be shown on the CYA screen.
+ * @param {object} page The page to consider.
+ * @param {object} data The top-level form data.
+ * @returns Boolean true if the page should be shown; false if not.
+ */
+var showFormPageCYA = function showFormPageCYA(page, data) {
+  if (page !== null && page !== void 0 && page.hasOwnProperty('show_on_cya') && !page.show_on_cya) {
+    return false;
+  }
+
+  return (0, _showFormPage.default)(page, data);
+};
+
+var _default = showFormPageCYA;
+exports.default = _default;

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

@@ -0,0 +1,30 @@
+"use strict";
+
+var _showFormPageCYA = _interopRequireDefault(require("./showFormPageCYA"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('utils.FormPage.showFormPageCYA', function () {
+  var DATA = {
+    alpha: 'Alpha',
+    bravo: 'Bravo'
+  };
+  it('should NOT be shown when the page is null', function () {
+    expect((0, _showFormPageCYA.default)(null, DATA)).toEqual(false);
+  });
+  it('should NOT be shown if the show_on_cya flag is false', function () {
+    var PAGE = {
+      show_on_cya: false
+    };
+    expect((0, _showFormPageCYA.default)(PAGE, DATA)).toEqual(false);
+  });
+  it('SHOULD be shown if the show_on_cya flag is true', function () {
+    var PAGE = {
+      show_on_cya: true
+    };
+    expect((0, _showFormPageCYA.default)(PAGE, DATA)).toEqual(true);
+  });
+  it('SHOULD be shown if the show_on_cya flag is missing', function () {
+    expect((0, _showFormPageCYA.default)({}, DATA)).toEqual(true);
+  });
+});

package/package.json

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