@ukhomeoffice/cop-react-form-renderer 5.71.3 → 5.71.4

package/dist/components/CollectionSummary/CollectionSummary.js

@@ -10,6 +10,7 @@ var _react = _interopRequireWildcard(require("react"));
 var _hooks = require("../../hooks");
 var _PageAction = require("../../models/PageAction");
 var _elevateNestedComponents = _interopRequireDefault(require("../../utils/Component/elevateNestedComponents"));
+var _getErrorsForCollection = _interopRequireDefault(require("../../utils/CollectionPage/getErrorsForCollection"));
 var _utils = _interopRequireDefault(require("../../utils"));
 var _getCYARow = _interopRequireDefault(require("../../utils/CheckYourAnswers/getCYARow"));
 var _Answer = _interopRequireDefault(require("../CheckYourAnswers/Answer"));
@@ -115,38 +116,8 @@ var CollectionSummary = function CollectionSummary(_ref) {
         return e.raisedBy === config.id;
       });
     }
-    var allErrors = [];
-    data.forEach(function (entry) {
-      // Validation of a collection page uses the data from the
-      // active entry, so here we have to set the active ID before
-      // validating.
-      var childPages = masterPage === null || masterPage === void 0 ? void 0 : masterPage.childPages.map(function (page) {
-        return _objectSpread(_objectSpread({}, page), {}, {
-          formData: _objectSpread(_objectSpread({}, formData), {}, _defineProperty({}, "".concat(config.collectionName.split('.').pop(), "ActiveId"), entry.id))
-        });
-      });
-      var allPagesErrors = (childPages === null || childPages === void 0 ? void 0 : childPages.flatMap(function (page) {
-        // Handle nested collections
-        if (page.childPages) {
-          return page.childPages.flatMap(function (nestedCollectionPage) {
-            var pageErrors = _utils.default.Validate.page(nestedCollectionPage);
-            return hooks.onValidate(nestedCollectionPage, pageErrors);
-          });
-        }
-        var pageErrors = _utils.default.Validate.page(page);
-        return hooks.onValidate(page, pageErrors);
-      })) || [];
-      // For each error we found, add the entryId so we know what Summary Card
-      // we have to pass it to.
-      var entryErrors = allPagesErrors.map(function (e) {
-        return _objectSpread(_objectSpread({}, e), {}, {
-          entryId: entry.id,
-          showFor: config.id,
-          raisedBy: config.id
-        });
-      });
-      allErrors = allErrors.concat(entryErrors);
-    });
+    var allErrors = (0, _getErrorsForCollection.default)(config, masterPage, formData, hooks);
+
     // We only queue allErrors if it's not empty to avoid
     // triggering a race condition with the 'data' memo 
     // above.

package/dist/components/CollectionSummary/CollectionSummary.test.js

@@ -92,65 +92,13 @@ describe('components.CollectionSummary.CollectionSummary', function () {
     expect(errorChecker.textContent).toContain('queuedErrors is an array of length 1');
     expect(errorChecker.textContent).toContain('testText is required');
   });
-  it('should correctly queue errors found when validating entries with nested collections', function () {
-    var FORM_DATA_NESTED = {
-      testCollection: [{
-        testDate: 'hello',
-        child: [{
-          randomField: 'hello'
-        }]
-      }]
-    };
-    var PAGES_NESTED = [{
-      id: 'page1',
-      collection: {
-        name: 'testCollection'
-      },
-      components: [{
-        id: 'testDate',
-        fieldId: 'testDate',
-        type: 'date'
-      }],
-      formData: FORM_DATA_NESTED
-    }, {
-      id: 'page2',
-      collection: {
-        name: 'testCollection.child'
-      },
-      components: [{
-        id: 'testText',
-        label: 'Nested Field',
-        fieldId: 'testText',
-        type: 'text',
-        required: true
-      }],
-      formData: FORM_DATA_NESTED
-    }];
-    var ErrorCheckComponent = function ErrorCheckComponent() {
-      var _useValidation2 = (0, _hooks.useValidation)(),
-        queuedErrors = _useValidation2.queuedErrors;
-      return /*#__PURE__*/_react.default.createElement("div", null, Array.isArray(queuedErrors) && "queuedErrors is an array of length ".concat(queuedErrors.length), (queuedErrors === null || queuedErrors === void 0 ? void 0 : queuedErrors.length) > 0 && queuedErrors.map(function (e) {
-        return e.error;
-      }));
-    };
-    var _renderWithValidation3 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(ErrorCheckComponent, null), /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
-        config: CONFIG,
-        formData: FORM_DATA_NESTED,
-        onAction: ON_ACTION,
-        pages: PAGES_NESTED
-      }))),
-      container = _renderWithValidation3.container;
-    var errorChecker = container.children[0];
-    expect(errorChecker.textContent).toContain('queuedErrors is an array of length 1');
-    expect(errorChecker.textContent).toContain('Nested Field is required');
-  });
   it('should render a confirmation when a SummaryCard\'s delete button is pressed', function () {
-    var _renderWithValidation4 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+    var _renderWithValidation3 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
         config: CONFIG,
         formData: FORM_DATA,
         onAction: ON_ACTION
       })),
-      container = _renderWithValidation4.container;
+      container = _renderWithValidation3.container;
     var summary = checkSetup(container);
     expect(summary.children.length).toEqual(2);
     var card = summary.children[0];
@@ -174,12 +122,12 @@ describe('components.CollectionSummary.CollectionSummary', function () {
           title: 'Title'
         }
       };
-      var _renderWithValidation5 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+      var _renderWithValidation4 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
           config: CONFIG_WITH_BUTTON,
           formData: FORM_DATA,
           onAction: ON_ACTION
         })),
-        container = _renderWithValidation5.container;
+        container = _renderWithValidation4.container;
       var summary = checkSetup(container);
       expect(summary.children.length).toEqual(3); // The button and a card for each item.
       expect(summary.children[0].id).toEqual("".concat(CONFIG_WITH_BUTTON.fieldId, ".addButton"));
@@ -198,12 +146,12 @@ describe('components.CollectionSummary.CollectionSummary', function () {
           title: 'Title'
         }
       };
-      var _renderWithValidation6 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+      var _renderWithValidation5 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
           config: CONFIG_WITH_BUTTON,
           formData: FORM_DATA,
           onAction: ON_ACTION
         })),
-        container = _renderWithValidation6.container;
+        container = _renderWithValidation5.container;
       var summary = checkSetup(container);
       expect(summary.children.length).toEqual(3); // The button and a card for each item.
       expect(summary.children[0].id).toEqual("".concat(CONFIG_WITH_BUTTON.fieldId, ".addButton"));
@@ -211,12 +159,12 @@ describe('components.CollectionSummary.CollectionSummary', function () {
       expect(summary.children[0].tagName).toEqual('BUTTON');
     });
     it('should apply the expected class name to the summary card when delete button is pressed', function () {
-      var _renderWithValidation7 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+      var _renderWithValidation6 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
           config: CONFIG,
           formData: FORM_DATA,
           onAction: ON_ACTION
         })),
-        container = _renderWithValidation7.container;
+        container = _renderWithValidation6.container;
       var summary = checkSetup(container);
       expect(summary.children.length).toEqual(2);
       var card = summary.children[0];
@@ -227,12 +175,12 @@ describe('components.CollectionSummary.CollectionSummary', function () {
       expect(card.className).toContain('deleting-summary-card');
     });
     it('should focus on the delete button in the confirmation panel', function () {
-      var _renderWithValidation8 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+      var _renderWithValidation7 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
           config: CONFIG,
           formData: FORM_DATA,
           onAction: ON_ACTION
         })),
-        container = _renderWithValidation8.container;
+        container = _renderWithValidation7.container;
       var summary = checkSetup(container);
       expect(summary.children.length).toEqual(2);
       var card = summary.children[0];
@@ -243,12 +191,12 @@ describe('components.CollectionSummary.CollectionSummary', function () {
       expect(document.activeElement).toEqual(confirmButton);
     });
     it('should have the role "alert" in the confirmation panel', function () {
-      var _renderWithValidation9 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+      var _renderWithValidation8 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
           config: CONFIG,
           formData: FORM_DATA,
           onAction: ON_ACTION
         })),
-        container = _renderWithValidation9.container;
+        container = _renderWithValidation8.container;
       var summary = checkSetup(container);
       expect(summary.children.length).toEqual(2);
       var card = summary.children[0];
@@ -268,14 +216,14 @@ describe('components.CollectionSummary.CollectionSummary', function () {
           displayFields: ['testText']
         }
       });
-      var _renderWithValidation10 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+      var _renderWithValidation9 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
           config: listViewConfig,
           formData: FORM_DATA,
           onAction: ON_ACTION,
           pages: PAGES
         })),
-        container = _renderWithValidation10.container,
-        getByText = _renderWithValidation10.getByText;
+        container = _renderWithValidation9.container,
+        getByText = _renderWithValidation9.getByText;
       var summary = checkSetup(container);
       expect(summary.children.length).toEqual(2);
       var card = summary.children[0];
@@ -300,14 +248,14 @@ describe('components.CollectionSummary.CollectionSummary', function () {
           message: 'Test confirmation message with index number ${index}'
         }
       });
-      var _renderWithValidation11 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
+      var _renderWithValidation10 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react.default.createElement(_CollectionSummary.default, {
           config: listViewConfig,
           formData: FORM_DATA,
           onAction: ON_ACTION,
           pages: PAGES
         })),
-        container = _renderWithValidation11.container,
-        getByText = _renderWithValidation11.getByText;
+        container = _renderWithValidation10.container,
+        getByText = _renderWithValidation10.getByText;
       var summary = checkSetup(container);
       expect(summary.children.length).toEqual(2);
       var card = summary.children[0];

package/dist/utils/CollectionPage/getErrorsForCollection.js

@@ -0,0 +1,55 @@
+"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 _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+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); }
+var getErrorsForCollection = function getErrorsForCollection(config, masterPage, formData, hooks) {
+  var activeIds = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
+  if (!masterPage) {
+    return [];
+  }
+  // Get data for current collection
+  var collectionData = _.default.CollectionPage.getData(masterPage.collection.name, masterPage.formData) || [];
+  var allErrors = [];
+
+  // Loop over each entry in the collection data
+  collectionData.forEach(function (entry) {
+    var _masterPage$childPage;
+    // eslint-disable-next-line no-param-reassign
+    activeIds = _objectSpread(_objectSpread({}, activeIds), {}, _defineProperty({}, "".concat(masterPage.collection.name.split('.').pop(), "ActiveId"), entry.id));
+
+    // Loop over child pages and validate each one
+    var allPagesErrors = (_masterPage$childPage = masterPage.childPages) === null || _masterPage$childPage === void 0 ? void 0 : _masterPage$childPage.flatMap(function (page) {
+      var pageWithIds = _objectSpread(_objectSpread({}, page), {}, {
+        formData: _objectSpread(_objectSpread({}, formData), activeIds)
+      });
+
+      // Handle nested collections
+      if (page.childPages) {
+        return getErrorsForCollection(config, pageWithIds, formData, hooks, activeIds);
+      }
+      var pageErrors = _.default.Validate.page(pageWithIds);
+      return hooks.onValidate(pageWithIds, pageErrors);
+    });
+
+    // For each error add the entryId so we know what Summary Card we have to pass it to.
+    allErrors = allErrors.concat(allPagesErrors.map(function (e) {
+      return _objectSpread(_objectSpread({}, e), {}, {
+        entryId: entry.id,
+        showFor: config.id,
+        raisedBy: config.id
+      });
+    }));
+  });
+  return allErrors;
+};
+var _default = exports.default = getErrorsForCollection;

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

@@ -0,0 +1,155 @@
+"use strict";
+
+var _getErrorsForCollection = _interopRequireDefault(require("./getErrorsForCollection"));
+var _models = require("../../models");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('Utils.CollectionPage.getErrorsForCollection', function () {
+  var HOOKS = {
+    onValidate: function onValidate(_, errors) {
+      return errors;
+    }
+  };
+  var CONFIG = {
+    id: 'testId'
+  };
+  var FORM_DATA = {
+    collection: [{
+      id: 22,
+      item1: 'blue',
+      child: [{
+        id: 11,
+        item4: 'red'
+      }]
+    }]
+  };
+  var FORM_DATA_MISSING_TOP = {
+    collection: [{
+      id: 22,
+      item2: 'blue',
+      child: [{
+        id: 11,
+        item4: 'red'
+      }]
+    }]
+  };
+  var FORM_DATA_MISSING_NESTED = {
+    collection: [{
+      id: 22,
+      item1: 'blue',
+      child: [{
+        id: 11,
+        item9: 'red'
+      }]
+    }]
+  };
+  var FORM_DATA_MISSING_BOTH = {
+    collection: [{
+      id: 22,
+      item9: 'blue',
+      child: [{
+        id: 11,
+        item9: 'red'
+      }]
+    }]
+  };
+  var MASTER_PAGE = {
+    id: 'masterPage',
+    collection: {
+      name: 'collection',
+      masterPage: true
+    },
+    formData: FORM_DATA,
+    childPages: [{
+      id: 'page1',
+      collection: {
+        name: 'collection'
+      },
+      formData: FORM_DATA,
+      components: [{
+        id: 'item1',
+        fieldId: 'item1',
+        label: 'Item 1',
+        required: true,
+        type: _models.ComponentTypes.TEXT
+      }, {
+        id: 'item2',
+        fieldId: 'item2',
+        label: 'Item 2',
+        type: _models.ComponentTypes.TEXT
+      }]
+    }]
+  };
+  var MASTER_PAGE_WITH_NESTED = {
+    id: 'masterPage',
+    collection: {
+      name: 'collection',
+      masterPage: true
+    },
+    formData: FORM_DATA,
+    childPages: [{
+      id: 'page1',
+      collection: {
+        name: 'collection'
+      },
+      formData: FORM_DATA,
+      components: [{
+        id: 'item1',
+        fieldId: 'item1',
+        label: 'Item 1',
+        required: true,
+        type: _models.ComponentTypes.TEXT
+      }, {
+        id: 'item2',
+        fieldId: 'item2',
+        label: 'Item 2',
+        type: _models.ComponentTypes.TEXT
+      }]
+    }, {
+      id: 'page2',
+      formData: FORM_DATA,
+      collection: {
+        name: 'collection.child',
+        masterPage: true
+      },
+      childPages: [{
+        id: 'nestedPage',
+        formData: FORM_DATA,
+        collection: {
+          name: 'collection.child'
+        },
+        components: [{
+          id: 'item4',
+          fieldId: 'item4',
+          label: 'Item 4',
+          required: true,
+          type: _models.ComponentTypes.TEXT
+        }, {
+          id: 'item5',
+          fieldId: 'item5',
+          label: 'Item 5',
+          type: _models.ComponentTypes.TEXT
+        }]
+      }]
+    }]
+  };
+  it('should return nothing for a master page without errors', function () {
+    var errors = (0, _getErrorsForCollection.default)(CONFIG, MASTER_PAGE, FORM_DATA, HOOKS);
+    expect(errors.length).toEqual(0);
+  });
+  it('should return erorrs for a master page with errors', function () {
+    var errors = (0, _getErrorsForCollection.default)(CONFIG, MASTER_PAGE, FORM_DATA_MISSING_TOP, HOOKS);
+    expect(errors.length).toEqual(1);
+  });
+  it('should return nothing for a master page with a nested master page without errors', function () {
+    var errors = (0, _getErrorsForCollection.default)(CONFIG, MASTER_PAGE_WITH_NESTED, FORM_DATA, HOOKS);
+    expect(errors.length).toEqual(0);
+  });
+  it('should return errors for a master page with a nested master page without errors', function () {
+    var errors = (0, _getErrorsForCollection.default)(CONFIG, MASTER_PAGE_WITH_NESTED, FORM_DATA_MISSING_NESTED, HOOKS);
+    expect(errors.length).toEqual(1);
+  });
+  it('should return errors for a master page with errors with a nested master page with errors', function () {
+    var errors = (0, _getErrorsForCollection.default)(CONFIG, MASTER_PAGE_WITH_NESTED, FORM_DATA_MISSING_BOTH, HOOKS);
+    expect(errors.length).toEqual(2);
+  });
+});

package/dist/utils/CollectionPage/index.js

@@ -10,6 +10,7 @@ var _duplicateCollectionPageEntry = _interopRequireDefault(require("./duplicateC
 var _getCollectionPageActiveId = _interopRequireDefault(require("./getCollectionPageActiveId"));
 var _getCollectionPageActiveIndex = _interopRequireDefault(require("./getCollectionPageActiveIndex"));
 var _getCollectionPageData = _interopRequireDefault(require("./getCollectionPageData"));
+var _getErrorsForCollection = _interopRequireDefault(require("./getErrorsForCollection"));
 var _mergeCollectionPages = _interopRequireDefault(require("./mergeCollectionPages"));
 var _removeCollectionPageEntry = _interopRequireDefault(require("./removeCollectionPageEntry"));
 var _setCollectionPageData = _interopRequireDefault(require("./setCollectionPageData"));
@@ -23,6 +24,7 @@ var CollectionPage = {
   getActiveId: _getCollectionPageActiveId.default,
   getActiveIndex: _getCollectionPageActiveIndex.default,
   getData: _getCollectionPageData.default,
+  getErrorsForCollection: _getErrorsForCollection.default,
   mergePages: _mergeCollectionPages.default,
   removeEntry: _removeCollectionPageEntry.default,
   setData: _setCollectionPageData.default

package/dist/utils/Component/isEditable.js

@@ -7,7 +7,7 @@ exports.default = exports.EDITABLE_TYPES = void 0;
 var _models = require("../../models");
 // Local imports
 
-var EDITABLE_TYPES = exports.EDITABLE_TYPES = [_models.ComponentTypes.AUTOCOMPLETE, _models.ComponentTypes.CALCULATION, _models.ComponentTypes.CHECKBOXES, _models.ComponentTypes.DATE, _models.ComponentTypes.EMAIL, _models.ComponentTypes.FILE, _models.ComponentTypes.MULTI_FILE, _models.ComponentTypes.PHONE_NUMBER, _models.ComponentTypes.RADIOS, _models.ComponentTypes.SELECT, _models.ComponentTypes.TEXT, _models.ComponentTypes.TEXT_AREA, _models.ComponentTypes.TIME];
+var EDITABLE_TYPES = exports.EDITABLE_TYPES = [_models.ComponentTypes.AUTOCOMPLETE, _models.ComponentTypes.CALCULATION, _models.ComponentTypes.CHECKBOXES, _models.ComponentTypes.COLLECTION_SUMMARY, _models.ComponentTypes.DATE, _models.ComponentTypes.EMAIL, _models.ComponentTypes.FILE, _models.ComponentTypes.MULTI_FILE, _models.ComponentTypes.PHONE_NUMBER, _models.ComponentTypes.RADIOS, _models.ComponentTypes.SELECT, _models.ComponentTypes.TEXT, _models.ComponentTypes.TEXT_AREA, _models.ComponentTypes.TIME];
 var isEditable = function isEditable(options) {
   return EDITABLE_TYPES.includes(options === null || options === void 0 ? void 0 : options.type) || (options === null || options === void 0 ? void 0 : options.isEditable) || false;
 };

package/package.json

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