@ukhomeoffice/cop-react-form-renderer 5.23.2 → 5.24.0

package/dist/utils/CheckYourAnswers/getCYACollectionChangeAction.js

@@ -1,19 +1,37 @@
 "use strict";
 
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _models = require("../../models");
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(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) { 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); } // Global imports
+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); }
+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."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; } // Global imports
 // Local imports
+/**
+ * Gets an action object that triggers editing of an entry in a page collection.
+ * 
+ * @param {object} page The page that the action belongs to.
+ * @param {object} item The item in the collection that is to be edited.
+ * @param {function} onAction The onAction callback passed in to the CYA page from FormRenderer.
+ * @param {string} labelCount The item's index in the collection plus one (for displaying to the user).
+ * @param {object} action The action's config from the form definition.
+ * @param {array} activeIds A list of active Ids that must be set to make Item the active entry.
+ * @returns The resulting action object.
+ */
 var getCYACollectionChangeAction = function getCYACollectionChangeAction(page, item, _onAction, labelCount, action) {
+  var activeIds = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : {};
   var label = (action === null || action === void 0 ? void 0 : action.label) || _models.CollectionLabels.change;
   return {
     pageId: page.id,
@@ -24,16 +42,19 @@ var getCYACollectionChangeAction = function getCYACollectionChangeAction(page, i
       onAction: function onAction(row) {
         var changeCallback = function changeCallback(cyaData) {
           var data = cyaData;
-          data["".concat(page.collection.name, "ActiveId")] = item.id;
+          // Apply the activeIds to make sure we're editing the right item.
+          // Not using the spread syntax as data could be a huge object.
+          Object.entries(activeIds).forEach(function (entry) {
+            var _entry = _slicedToArray(entry, 2),
+              activeIdKey = _entry[0],
+              activeId = _entry[1];
+            data[activeIdKey] = activeId;
+          });
           return data;
         };
-        var nextPage = row;
-        if (action.page) {
-          nextPage = {
-            pageId: action.page
-          };
-        }
-        _onAction(nextPage, changeCallback);
+        _onAction(action.page ? {
+          pageId: action.page
+        } : row, changeCallback);
       },
       label: _copReactComponents.Utils.interpolateString(label, _objectSpread(_objectSpread({}, item), {}, {
         index: labelCount

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

@@ -36,13 +36,102 @@ describe('utils', function () {
           expect(row.id).toEqual(2);
           TEST_DATA = callback(TEST_DATA);
         };
-        var action = (0, _getCYACollectionChangeAction.default)(PAGE, ITEM, ON_ACTION, 0, {});
+        var action = (0, _getCYACollectionChangeAction.default)(PAGE, ITEM, ON_ACTION, 0, {}, {
+          collectionNameActiveId: 2
+        });
         action.action.onAction(PAGE);
         expect(TEST_DATA.collectionNameActiveId).toEqual(2);
       });
+      it('should change all necessary activeIds when moving to edit a nested collection entry', function () {
+        var NESTED_COLLECTION_PAGE = {
+          id: 'pageid',
+          collection: {
+            name: 'parent.child.grandchild'
+          }
+        };
+        var NESTED_ITEM = {
+          id: '001'
+        };
+        var NESTED_TEST_DATA = {
+          parentActiveId: '000',
+          childActiveId: '000',
+          grandchildActiveId: '000',
+          parent: [{
+            id: '000'
+          }, {
+            id: '001',
+            child: [{
+              id: '000'
+            }, {
+              id: '001',
+              grandchild: [{
+                id: '000'
+              }, {
+                id: '001'
+              }]
+            }]
+          }]
+        };
+        var ACTIVE_IDS = {
+          parentActiveId: '001',
+          childActiveId: '001',
+          grandchildActiveId: '001'
+        };
+        var ON_ACTION = function ON_ACTION(row, callback) {
+          expect(row.id).toEqual(2);
+          NESTED_TEST_DATA = callback(NESTED_TEST_DATA);
+        };
+        var action = (0, _getCYACollectionChangeAction.default)(NESTED_COLLECTION_PAGE, NESTED_ITEM, ON_ACTION, 0, {}, ACTIVE_IDS);
+        action.action.onAction(PAGE);
+        expect(NESTED_TEST_DATA.parentActiveId).toEqual('001');
+        expect(NESTED_TEST_DATA.childActiveId).toEqual('001');
+        expect(NESTED_TEST_DATA.grandchildActiveId).toEqual('001');
+      });
+      it('should not change any active IDs if they are not provided', function () {
+        var NESTED_COLLECTION_PAGE = {
+          id: 'pageid',
+          collection: {
+            name: 'parent.child.grandchild'
+          }
+        };
+        var NESTED_ITEM = {
+          id: '001'
+        };
+        var NESTED_TEST_DATA = {
+          parentActiveId: '000',
+          childActiveId: '000',
+          grandchildActiveId: '000',
+          parent: [{
+            id: '000'
+          }, {
+            id: '001',
+            child: [{
+              id: '000'
+            }, {
+              id: '001',
+              grandchild: [{
+                id: '000'
+              }, {
+                id: '001'
+              }]
+            }]
+          }]
+        };
+        var ON_ACTION = function ON_ACTION(row, callback) {
+          expect(row.id).toEqual(2);
+          NESTED_TEST_DATA = callback(NESTED_TEST_DATA);
+        };
+        var action = (0, _getCYACollectionChangeAction.default)(NESTED_COLLECTION_PAGE, NESTED_ITEM, ON_ACTION, 0, {});
+        action.action.onAction(PAGE);
+        expect(NESTED_TEST_DATA.parentActiveId).toEqual('000');
+        expect(NESTED_TEST_DATA.childActiveId).toEqual('000');
+        expect(NESTED_TEST_DATA.grandchildActiveId).toEqual('000');
+      });
       it('should get label to custom value', function () {
         var action = (0, _getCYACollectionChangeAction.default)(PAGE, ITEM, function () {}, 0, {
           label: 'customName'
+        }, {
+          collectionNameActiveId: 2
         });
         expect(action.action.label).toEqual('customName');
       });
@@ -62,7 +151,9 @@ describe('utils', function () {
           expect(page.pageId).toEqual('confirmDelete');
           TEST_DATA = callback(TEST_DATA);
         };
-        var action = (0, _getCYACollectionChangeAction.default)(PAGE_WITH_CUSTOM_DESTINATION, ITEM, ON_ACTION, 0, PAGE_WITH_CUSTOM_DESTINATION.collection.actions[0]);
+        var action = (0, _getCYACollectionChangeAction.default)(PAGE_WITH_CUSTOM_DESTINATION, ITEM, ON_ACTION, 0, PAGE_WITH_CUSTOM_DESTINATION.collection.actions[0], {
+          collectionNameActiveId: 2
+        });
         action.action.onAction({});
         expect(TEST_DATA.collectionNameActiveId).toEqual(2);
       });

package/dist/utils/CheckYourAnswers/getCYACollectionDeleteAction.js

@@ -1,19 +1,42 @@
 "use strict";
 
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+var _CollectionPage = _interopRequireDefault(require("../CollectionPage"));
 var _models = require("../../models");
-function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+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) { 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); } // Global imports
+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); }
+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."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; } // Global imports
 // Local imports
-var getCYACollectionDeleteAction = function getCYACollectionDeleteAction(page, item, _onAction, labelCount, action) {
+var isValidIndex = function isValidIndex(value) {
+  return typeof value === 'number' && value >= 0;
+};
+
+/**
+ * Gets an action object that triggers the removal of an item from a page Collection.
+ * 
+ * @param {object} page The page that the action belongs to.
+ * @param {object} item The item in the collection that is being removed.
+ * @param {function} onAction The onAction callback passed in to the CYA page from FormRenderer.
+ * @param {string} labelCount The item's index in the collection plus one (for displaying to the user).
+ * @param {object} action The action's config from the form definition.
+ * @param {array} activeIds A list of active Ids that must be set to make Item the active entry.
+ * @returns The resulting action object.
+ */
+var getCYACollectionDeleteAction = function getCYACollectionDeleteAction(page, item, _onAction, labelCount, action, activeIds) {
   var label = (action === null || action === void 0 ? void 0 : action.label) || _models.CollectionLabels.remove;
   return {
     pageId: page.id,
@@ -24,9 +47,24 @@ var getCYACollectionDeleteAction = function getCYACollectionDeleteAction(page, i
       onAction: function onAction() {
         var deleteCallback = function deleteCallback(cyaData) {
           var data = cyaData;
-          data["".concat(page.collection.name)] = data["".concat(page.collection.name)].filter(function (i) {
-            return i.id !== item.id;
+          if (!activeIds) {
+            return data;
+          }
+          // Apply the activeIds to make sure we're deleting the right item.
+          // Not using the spread syntax as data could be a huge object.
+          Object.entries(activeIds).forEach(function (entry) {
+            var _entry = _slicedToArray(entry, 2),
+              activeIdKey = _entry[0],
+              activeId = _entry[1];
+            data[activeIdKey] = activeId;
+          });
+          var collectionData = _CollectionPage.default.getData(page.collection.name, data);
+          var indexToDelete = collectionData === null || collectionData === void 0 ? void 0 : collectionData.findIndex(function (entry) {
+            return entry.id === item.id;
           });
+          if (isValidIndex(indexToDelete)) {
+            collectionData.splice(indexToDelete, 1);
+          }
           return data;
         };
         _onAction(null, deleteCallback);

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

@@ -11,43 +11,186 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
 describe('utils', function () {
   describe('CheckYourAnswers', function () {
     describe('getCYACollectionDeleteAction', function () {
-      var PAGE = {
-        id: 'pageid',
-        collection: {
-          name: 'collectionName',
-          labels: {
-            remove: 'customName'
+      it('should remove selected item from the form data', function () {
+        var PAGE = {
+          id: 'pageid',
+          collection: {
+            name: 'collectionName',
+            labels: {
+              remove: 'customName'
+            }
           }
-        }
-      };
-      var ITEM = {
-        id: 2
-      };
-      var TEST_DATA = {
-        page: _objectSpread({}, PAGE),
-        collectionName: [{
-          id: 1
-        }, {
+        };
+        var ITEM = {
           id: 2
-        }, {
-          id: 3
-        }]
-      };
-      it('should remove selected item from the form data', function () {
+        };
+        var TEST_DATA = {
+          page: _objectSpread({}, PAGE),
+          collectionName: [{
+            id: 1
+          }, {
+            id: 2
+          }, {
+            id: 3
+          }]
+        };
         var data = null;
         var ON_ACTION = function ON_ACTION(_, callback) {
           data = callback(TEST_DATA);
         };
-        var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, ON_ACTION, 0, {});
+        var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, ON_ACTION, 0, {}, {});
         action.action.onAction();
         expect(data.collectionName.length).toEqual(2);
         expect(data.collectionName[0].id).toEqual(1);
         expect(data.collectionName[1].id).toEqual(3);
       });
+      it('should remove nested item from the form data', function () {
+        var PAGE = {
+          id: 'pageid',
+          collection: {
+            name: 'parent.child.grandchild'
+          }
+        };
+        var ITEM = {
+          id: '001'
+        };
+        var TEST_DATA = {
+          parentActiveId: '000',
+          childActiveId: '000',
+          grandchildActiveId: '000',
+          parent: [{
+            id: '000'
+          }, {
+            id: '001',
+            child: [{
+              id: '000'
+            }, {
+              id: '001',
+              grandchild: [{
+                id: '000'
+              }, {
+                id: '001'
+              }]
+            }]
+          }]
+        };
+        var ACTIVE_IDS = {
+          parentActiveId: '001',
+          childActiveId: '001',
+          grandchildActiveId: '001'
+        };
+        var data = null;
+        var ON_ACTION = function ON_ACTION(_, callback) {
+          data = callback(TEST_DATA);
+        };
+        var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, ON_ACTION, 0, {}, ACTIVE_IDS);
+        action.action.onAction();
+        expect(data.parentActiveId).toEqual('001');
+        expect(data.childActiveId).toEqual('001');
+        expect(data.grandchildActiveId).toEqual('001');
+        expect(data.parent[1].child[1].grandchild.length).toEqual(1);
+        expect(data.parent[1].child[1].grandchild[0].id).toEqual('000');
+      });
+      it('should do nothing if activeIds are not provided', function () {
+        var PAGE = {
+          id: 'pageid',
+          collection: {
+            name: 'parent.child.grandchild'
+          }
+        };
+        var ITEM = {
+          id: '001'
+        };
+        var TEST_DATA = {
+          parentActiveId: '000',
+          childActiveId: '000',
+          grandchildActiveId: '000',
+          parent: [{
+            id: '000'
+          }, {
+            id: '001',
+            child: [{
+              id: '000'
+            }, {
+              id: '001',
+              grandchild: [{
+                id: '000'
+              }, {
+                id: '001'
+              }]
+            }]
+          }]
+        };
+        var data = null;
+        var ON_ACTION = function ON_ACTION(_, callback) {
+          data = callback(TEST_DATA);
+        };
+        var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, ON_ACTION, 0, {});
+        action.action.onAction();
+        expect(data.parentActiveId).toEqual('000');
+        expect(data.childActiveId).toEqual('000');
+        expect(data.grandchildActiveId).toEqual('000');
+        expect(data.parent[1].child[1].grandchild.length).toEqual(2);
+      });
+      it('should do nothing if the activeIds point to an non-existant entry', function () {
+        var PAGE = {
+          id: 'pageid',
+          collection: {
+            name: 'parent.child.grandchild'
+          }
+        };
+        var ITEM = {
+          id: '001'
+        };
+        var TEST_DATA = {
+          parentActiveId: '000',
+          childActiveId: '000',
+          grandchildActiveId: '000',
+          parent: [{
+            id: '000'
+          }, {
+            id: '001',
+            child: [{
+              id: '000'
+            }, {
+              id: '001',
+              grandchild: [{
+                id: '000'
+              }, {
+                id: '001'
+              }]
+            }]
+          }]
+        };
+        var ACTIVE_IDS = {
+          parentActiveId: 'wrong',
+          childActiveId: 'bad',
+          grandchildActiveId: 'no'
+        };
+        var data = null;
+        var ON_ACTION = function ON_ACTION(_, callback) {
+          data = callback(TEST_DATA);
+        };
+        var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, ON_ACTION, 0, {}, ACTIVE_IDS);
+        action.action.onAction();
+        expect(data.parent[1].child[1].grandchild.length).toEqual(2);
+      });
       it('should get label to custom value', function () {
+        var PAGE = {
+          id: 'pageid',
+          collection: {
+            name: 'collectionName',
+            labels: {
+              remove: 'customName'
+            }
+          }
+        };
+        var ITEM = {
+          id: 2
+        };
         var action = (0, _getCYACollectionDeleteAction.default)(PAGE, ITEM, function () {}, 0, {
           label: "customName"
-        });
+        }, {});
         expect(action.action.label).toEqual('customName');
       });
     });

package/dist/utils/CheckYourAnswers/getCYARowsForCollectionPage.js

@@ -13,6 +13,12 @@ var _getCYACollectionChangeAction = _interopRequireDefault(require("./getCYAColl
 var _getCYARowsForContainer = _interopRequireDefault(require("./getCYARowsForContainer"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+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."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 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) { 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; }
@@ -62,14 +68,25 @@ var getHeadingRow = function getHeadingRow(config, pageId, labelCount) {
     size: config.size || 's'
   };
 };
+var getCollectionNameHeading = function getCollectionNameHeading(page, titleName) {
+  return {
+    pageId: page.id,
+    fieldId: "".concat(page.collection.name, "Title"),
+    full_path: "".concat(page.collection.name, "Title"),
+    key: titleName.charAt(0).toUpperCase() + titleName.slice(1),
+    type: 'heading',
+    size: 'm'
+  };
+};
 var getActionRows = function getActionRows(page, item, onAction, labelCount) {
   var _page$collection;
+  var activeIds = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
   return (_page$collection = page.collection) === null || _page$collection === void 0 || (_page$collection = _page$collection.actions) === null || _page$collection === void 0 ? void 0 : _page$collection.map(function (action) {
     if (action.type === 'remove') {
-      return (0, _getCYACollectionDeleteAction.default)(page, item, onAction, labelCount, action);
+      return (0, _getCYACollectionDeleteAction.default)(page, item, onAction, labelCount, action, activeIds);
     }
     if (action.type === 'change') {
-      return (0, _getCYACollectionChangeAction.default)(page, item, onAction, labelCount, action);
+      return (0, _getCYACollectionChangeAction.default)(page, item, onAction, labelCount, action, activeIds);
     }
     return null;
   }).filter(function (action) {
@@ -78,11 +95,20 @@ var getActionRows = function getActionRows(page, item, onAction, labelCount) {
 };
 
 // eslint-disable-next-line arrow-body-style
-var getChangeActionForPage = function getChangeActionForPage(page, item, onAction) {
+var getChangeActionForPage = function getChangeActionForPage(page, onAction) {
+  var activeIds = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
   return function () {
     var changeCallback = function changeCallback(changeData) {
       var data = changeData;
-      data["".concat(page.collection.name, "ActiveId")] = item.id;
+      // Looping over the keys here as applying the changes
+      // as 'let data = { ...data, ...activeIds }' seemed wasteful,
+      // data could be a huge object.
+      Object.entries(activeIds).forEach(function (entry) {
+        var _entry = _slicedToArray(entry, 2),
+          activeIdKey = _entry[0],
+          activeId = _entry[1];
+        data[activeIdKey] = activeId;
+      });
       return data;
     };
     onAction({
@@ -90,50 +116,93 @@ var getChangeActionForPage = function getChangeActionForPage(page, item, onActio
     }, changeCallback);
   };
 };
-var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onAction, fnOverride) {
-  var _page$formData, _page$formData2;
-  if (!((_page$formData = page.formData) !== null && _page$formData !== void 0 && (_page$formData = _page$formData[page.collection.name]) !== null && _page$formData !== void 0 && _page$formData.length)) {
+
+/**
+ * Gets the rows for all pages in an array of child pages. This array of pages
+ * should come from a collection's master page.
+ * 
+ * @param {Array} childPages The array of child page objects.
+ * @param {Object} item The data for the current item in the collection.
+ * @param {Function} onAction The onAction callback passed in from FormRenderer.
+ * @param {Function} fnOverride Function used to override the creation of container rows.
+ * @param {String} labelCount The index of the current item in the collection, plus one.
+ * @param {String} fullPath The full path to the current item in the collection, written as 'COLLECTION_NAME[INDEX]'.
+ * @param {Object} activeIds The active IDs that must be set for the current item to be active.
+ * @returns An array of CYA rows for all child pages.
+ */
+var getCYARowsForChildPages = function getCYARowsForChildPages(childPages, item, onAction, fnOverride, labelCount, fullPath, activeIds) {
+  var rows = [];
+  childPages.forEach(function (p) {
+    var childPage = p;
+    // If the child page is itself a master page, then we should produce the
+    // rows for it and it's children.
+    if (childPage.collection.masterPage) {
+      // eslint-disable-next-line no-use-before-define
+      rows = rows.concat(getCYARowsForCollectionPage(childPage, onAction, fnOverride, item, activeIds));
+    } else {
+      // Routes were an old way of adding show_when functionality to collection
+      // pages. Regular show_whens can now be used and this code should be removed
+      // at some point.
+      if (childPage.collection.route) {
+        var pageWithRoute = (0, _addShowWhen.default)(childPage, childPage.collection.route);
+        childPage = pageWithRoute || childPage;
+      }
+      // Check that the child page was actually shown to the user. This has
+      // to be done here as the show_when checks could rely upon item-level
+      // data.
+      if ((0, _showFormPageCYA.default)(childPage, _objectSpread(_objectSpread({}, childPage.formData), item))) {
+        if (childPage.collection.heading) {
+          var headingRow = getHeadingRow(childPage.collection.heading, childPage.id, labelCount);
+          rows = rows.concat(headingRow);
+        }
+        var container = getContainerForPage(childPage, item, labelCount, fullPath);
+        var rowChangeAction = getChangeActionForPage(childPage, item, onAction, activeIds);
+        var containerRows = (0, _getCYARowsForContainer.default)(childPage, container, item, rowChangeAction, fnOverride);
+        rows = rows.concat(containerRows);
+      }
+    }
+  });
+  return rows;
+};
+
+/**
+ * Get the CYA rows for a collection's master page.
+ * 
+ * @param {Object} page The master page object.
+ * @param {Object} data The data at this master page's level.
+ * @param {Function} onAction The onAction callback passed in from FormRenderer.
+ * @param {Function} fnOverride Function used to override the creation of container rows.
+ * @param {Object} activeIds The active IDs that must be set for the current item to be active.
+ * @returns An array of CYA rows.
+ */
+var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onAction, fnOverride, data) {
+  var activeIds = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
+  var collectionName = page.collection.name.split('.').pop();
+  var collectionData = data[collectionName] || null;
+  if (!collectionData || collectionData.length === 0) {
     return [];
   }
   var rows = [];
   if (!page.collection.hideNameFromCYA) {
-    rows.push({
-      pageId: page.id,
-      fieldId: "".concat(page.collection.name, "Title"),
-      full_path: "".concat(page.collection.name, "Title"),
-      key: page.collection.name.charAt(0).toUpperCase() + page.collection.name.slice(1),
-      type: 'heading',
-      size: 'm'
-    });
+    rows.push(getCollectionNameHeading(page, collectionName));
   }
-  (_page$formData2 = page.formData) === null || _page$formData2 === void 0 || (_page$formData2 = _page$formData2[page.collection.name]) === null || _page$formData2 === void 0 ? void 0 : _page$formData2.forEach(function (item, index) {
+  collectionData.forEach(function (item, index) {
     var _page$collection2;
+    // Keep track of the active entry in each collection.
+    // This helps us make sure the right entry is being affected
+    // by change/remove links.
+    // eslint-disable-next-line no-param-reassign
+    activeIds = _objectSpread(_objectSpread({}, activeIds), {}, _defineProperty({}, "".concat(collectionName, "ActiveId"), item.id));
     var labelCount = index + 1;
     var actionPosition = ((_page$collection2 = page.collection) === null || _page$collection2 === void 0 ? void 0 : _page$collection2.actionPosition) || 'top';
     var fullPath = "".concat(page.collection.name, "[").concat(index, "]");
     var titleRow = getTitleRowForItem(page, item, page.id, labelCount, fullPath);
-    var actionRows = getActionRows(page, item, onAction, labelCount);
+    var actionRows = getActionRows(page, item, onAction, labelCount, activeIds);
     rows = rows.concat(titleRow);
     if (actionPosition === 'top') {
       rows = rows.concat(actionRows);
     }
-    page.collectionPages.forEach(function (p) {
-      var collectionPage = p;
-      if (collectionPage.collection.route) {
-        var pageWithRoute = (0, _addShowWhen.default)(collectionPage, p.collection.route);
-        collectionPage = pageWithRoute || collectionPage;
-      }
-      if ((0, _showFormPageCYA.default)(collectionPage, _objectSpread(_objectSpread({}, collectionPage.formData), item))) {
-        if (collectionPage.collection.heading) {
-          var headingRow = getHeadingRow(collectionPage.collection.heading, collectionPage.id, labelCount);
-          rows = rows.concat(headingRow);
-        }
-        var container = getContainerForPage(collectionPage, item, labelCount, fullPath);
-        var rowChangeAction = getChangeActionForPage(collectionPage, item, onAction);
-        var containerRows = (0, _getCYARowsForContainer.default)(collectionPage, container, item, rowChangeAction, fnOverride);
-        rows = rows.concat(containerRows);
-      }
-    });
+    rows = rows.concat(getCYARowsForChildPages(page.childPages, item, onAction, fnOverride, labelCount, fullPath, activeIds));
     if (actionPosition === 'bottom') {
       rows = rows.concat(actionRows);
     }

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

@@ -53,14 +53,14 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
         page: 'confirmDelete'
       }]
     },
-    collectionPages: PAGES
+    childPages: PAGES
   };
   it('should return no rows for a collection if it does not exist in formData', function () {
     var FORM_DATA = {};
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS.length).toEqual(0);
   });
   it('should return no rows for a collection if it has no entries', function () {
@@ -70,7 +70,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS.length).toEqual(0);
   });
   it('should accept the hideNameFromCYA collection flag', function () {
@@ -86,7 +86,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
       })
     });
     var TITLE_FIELD_ID = "".concat(PAGE.collection.name, "Title");
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS[0].fieldId).not.toEqual(TITLE_FIELD_ID);
   });
   it('should format titles correctly when collection.labels.item is specified', function () {
@@ -99,7 +99,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
     expect(ROWS[1].key).toEqual('Collection entry 1');
   });
@@ -116,7 +116,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
       }),
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
     expect(ROWS[1].key).toEqual('Item 1');
   });
@@ -133,7 +133,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS.length).toEqual(13); // Title row + component row for each item
     expect(ROWS[0]).toMatchObject({
       type: 'heading',
@@ -187,7 +187,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
         name: 'collection'
       },
       formData: FD,
-      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+      childPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
         components: [{
           id: 'testText',
           fieldId: 'testText',
@@ -201,7 +201,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
         }]
       })]
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FD);
     expect(ROWS.length).toEqual(4);
     expect(ROWS[0]).toMatchObject({
       type: 'heading',
@@ -233,7 +233,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
         name: 'collection'
       },
       formData: FD,
-      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+      childPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
         show_when: {
           field: "otherField",
           op: "!=",
@@ -241,7 +241,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
         }
       }), PAGES[1]]
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FD);
     expect(ROWS.length).toEqual(3); // Missing the page with the text component on.
     expect(ROWS[0]).toMatchObject({
       type: 'heading',
@@ -265,7 +265,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     };
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA,
-      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+      childPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
         collection: _objectSpread(_objectSpread({}, PAGES[0].collection), {}, {
           heading: {
             size: 'm',
@@ -274,7 +274,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
         })
       })]
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS.length).toEqual(7);
     expect(ROWS[0]).toMatchObject({
       type: 'heading',
@@ -306,7 +306,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     };
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA,
-      collectionPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
+      childPages: [_objectSpread(_objectSpread({}, PAGES[0]), {}, {
         collection: _objectSpread(_objectSpread({}, PAGES[0].collection), {}, {
           heading: {
             text: 'Custom page heading'
@@ -314,7 +314,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
         })
       })]
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     expect(ROWS[5]).toMatchObject({
       type: 'heading',
       key: 'Custom page heading',
@@ -331,7 +331,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     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');
@@ -349,7 +349,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
       }),
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     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');
@@ -367,7 +367,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
       }),
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
     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');
@@ -384,7 +384,7 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     });
     var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, function () {
       return null;
-    });
+    }, FORM_DATA);
     expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
     expect(ROWS[5].key).toEqual("Test text");
   });
@@ -407,8 +407,91 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
       formData: FORM_DATA
     });
-    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, OVERRIDE);
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, OVERRIDE, FORM_DATA);
     expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
     expect(ROWS[5].key).toEqual("CustomRowFor".concat(TEXT_COMP.label));
   });
+  it('should create rows for nested collections correctly', function () {
+    var CUSTOM_FORM_DATA = {
+      parentActiveId: '001',
+      childActiveId: '001',
+      parent: [{
+        id: '001',
+        testText: 'alpha',
+        child: [{
+          id: '001',
+          testText: 'bravo'
+        }]
+      }]
+    };
+    var CHILD_MASTER_PAGE = {
+      id: 'childPage',
+      collection: {
+        name: 'parent.child',
+        masterPage: true,
+        labels: {
+          // eslint-disable-next-line no-template-curly-in-string
+          item: 'Child number ${index}'
+        },
+        actions: [{
+          type: 'change'
+        }, {
+          type: 'remove',
+          label: 'custom remove label'
+        }]
+      },
+      childPages: [{
+        id: 'childPage',
+        collection: {
+          name: 'parent.child'
+        },
+        components: [TEXT_COMP]
+      }]
+    };
+    var PARENT_MASTER_PAGE = {
+      id: 'parentPage',
+      collection: {
+        name: 'parent',
+        masterPage: true
+      },
+      childPages: [{
+        id: 'parentPage',
+        collection: {
+          name: 'parent'
+        },
+        components: [TEXT_COMP]
+      }, CHILD_MASTER_PAGE]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, PARENT_MASTER_PAGE), {}, {
+      formData: CUSTOM_FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, CUSTOM_FORM_DATA);
+    expect(ROWS.length).toEqual(8);
+    expect(ROWS[0]).toMatchObject({
+      type: 'heading',
+      key: 'Parent'
+    });
+    expect(ROWS[1]).toMatchObject({
+      type: 'heading',
+      key: 'Item 1'
+    });
+    expect(ROWS[2]).toMatchObject({
+      value: 'alpha',
+      key: 'Test text'
+    });
+    expect(ROWS[3]).toMatchObject({
+      type: 'heading',
+      key: 'Child'
+    });
+    expect(ROWS[4]).toMatchObject({
+      type: 'heading',
+      key: 'Child number 1'
+    });
+    expect(ROWS[5].action.label).toEqual('Change');
+    expect(ROWS[6].action.label).toEqual('custom remove label');
+    expect(ROWS[7]).toMatchObject({
+      value: 'bravo',
+      key: 'Test text'
+    });
+  });
 });

package/dist/utils/CheckYourAnswers/getCYARowsForPage.js

@@ -30,7 +30,7 @@ var getCYARowsForPage = function getCYARowsForPage(page, onAction) {
   if (_FormPage.default.showCYA(page, page.formData)) {
     var _page$groups;
     if (page.collection) {
-      return (0, _getCYARowsForCollectionPage.default)(page, onAction, fnOverride);
+      return (0, _getCYARowsForCollectionPage.default)(page, onAction, fnOverride, page.formData);
     }
     var allComponents = (0, _elevateNestedComponents.default)(page.components, page.formData);
     var rows = allComponents.filter(function (c) {

package/dist/utils/CollectionPage/mergeCollectionPages.js

@@ -12,6 +12,22 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 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); }
 /* eslint-disable no-param-reassign */
 
+/*
+* Why is a master page needed?
+*
+* When creating CYA rows for a collection, we need to know what pages
+* belong to that collection. In the case of nested collections, we also
+* need to know the same information for them.
+*
+* What does a master page look like?
+*
+* A master page is a wrapper for all the pages that make up a collection.
+* These pages are stored in the 'childPages' property of a master page and
+* can be one of either:
+* - A regular form page.
+* - The master page for a child collection, with its own array of child pages.
+*/
+
 var createMasterPage = function createMasterPage(page) {
   return {
     id: page.id,
@@ -20,13 +36,39 @@ var createMasterPage = function createMasterPage(page) {
       masterPage: true
     }, page.collection),
     formData: _objectSpread({}, page.formData),
-    collectionPages: [page]
+    childPages: [page]
   };
 };
 var mergeIntoMasterPage = function mergeIntoMasterPage(page, masterPage) {
   masterPage.collection = _objectSpread(_objectSpread({}, masterPage.collection), page.collection);
   masterPage.formData = _objectSpread(_objectSpread({}, masterPage.formData), page.formData);
-  masterPage.collectionPages = [].concat(masterPage.collectionPages, [page]);
+  masterPage.childPages = [].concat(masterPage.childPages, [page]);
+};
+
+/**
+ * Tries to nest page under the master page belonging to it's parent.
+ * 
+ * @param {Object} page The child page..
+ * @param {Array} masterPages An array of existing master page objects.
+ * @returns true if page belonged to a child collection and was successfully
+ *   nested. false if it isn't in a child collection or failed to be nested.
+ */
+var nestUnderParent = function nestUnderParent(childPage, masterPages) {
+  var names = childPage.collection.name.split('.');
+  if (names.length === 1) {
+    return false;
+  }
+  names.pop();
+  var parentName = names.join('.');
+  var parentPage = masterPages[parentName] || null;
+  if (!parentPage) {
+    // Something had gone wrong if we're here - parent collection pages
+    // should always be defined before their children, so the parent master 
+    // page should always exist...
+    return false;
+  }
+  parentPage.childPages.push(childPage);
+  return true;
 };
 
 /**
@@ -48,8 +90,12 @@ var mergeCollectionPages = function mergeCollectionPages(pages) {
       if (!masterPages[page.collection.name]) {
         // If no master page exists for this collection.name, then
         // we kick one off using this page as a template.
-        masterPages[page.collection.name] = createMasterPage(page);
-        return masterPages[page.collection.name];
+        var newMasterPage = createMasterPage(page);
+        masterPages[page.collection.name] = newMasterPage;
+        // We check if the new master page belongs to a child collection,
+        // if so then nest it under the parent master page and remove from
+        // the pages array. If not then treat it as a top-level collection.
+        return nestUnderParent(newMasterPage, masterPages) ? null : newMasterPage;
       }
       // If a master page already exists for this collection.name
       // then we just merge this page into it and remove this page

package/dist/utils/CollectionPage/mergeCollectionPages.test.js

@@ -46,7 +46,53 @@ describe('utils.CollectionPage.mergeCollectionPages', function () {
         masterPage: true
       },
       formData: {},
-      collectionPages: PAGES
+      childPages: PAGES
+    });
+  });
+  it('should correctly merge and nested child collection pages under their parents', function () {
+    var PAGES = [{
+      id: 'page1',
+      collection: {
+        name: 'parent'
+      },
+      components: [TEXT_COMP]
+    }, {
+      id: 'page2',
+      collection: {
+        name: 'parent'
+      },
+      components: [DATE_COMP]
+    }, {
+      id: 'page3',
+      collection: {
+        name: 'parent.child'
+      },
+      components: [DATE_COMP]
+    }, {
+      id: 'page4',
+      collection: {
+        name: 'parent.child'
+      },
+      components: [DATE_COMP]
+    }];
+    var RESULT = (0, _mergeCollectionPages.default)(PAGES);
+    expect(RESULT.length).toEqual(1);
+    expect(RESULT[0]).toMatchObject({
+      id: 'page1',
+      collection: {
+        name: 'parent',
+        masterPage: true
+      },
+      formData: {},
+      childPages: [PAGES[0], PAGES[1], {
+        id: 'page3',
+        collection: {
+          name: 'parent.child',
+          masterPage: true
+        },
+        formData: {},
+        childPages: [PAGES[2], PAGES[3]]
+      }]
     });
   });
   it('should leave non-collection pages unaffected', function () {
@@ -74,7 +120,7 @@ describe('utils.CollectionPage.mergeCollectionPages', function () {
         masterPage: true
       },
       formData: {},
-      collectionPages: [PAGES[0], PAGES[1]]
+      childPages: [PAGES[0], PAGES[1]]
     });
     expect(RESULT[1]).toEqual({
       id: 'page3'
@@ -115,7 +161,7 @@ describe('utils.CollectionPage.mergeCollectionPages', function () {
         masterPage: true
       },
       formData: {},
-      collectionPages: [PAGES[0], PAGES[1]]
+      childPages: [PAGES[0], PAGES[1]]
     });
     expect(RESULT[1]).toEqual({
       id: 'page3',
@@ -124,7 +170,7 @@ describe('utils.CollectionPage.mergeCollectionPages', function () {
         masterPage: true
       },
       formData: {},
-      collectionPages: [PAGES[2], PAGES[3]]
+      childPages: [PAGES[2], PAGES[3]]
     });
   });
 });

package/package.json

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