@ukhomeoffice/cop-react-form-renderer 5.45.1 → 5.48.1-alpha

package/dist/components/CollectionSummary/CollectionSummary.js

@@ -187,6 +187,10 @@ var CollectionSummary = function CollectionSummary(_ref) {
     },
     onAction: onAction
   }), data.map(function (entry, index) {
+    var isInError = errors.filter(function (e) {
+      return e.entryId === entry.id;
+    }).length > 0;
+    var finalConfig = _objectSpread(_objectSpread({}, config.card), isInError && config.errorCard ? config.errorCard : {});
     var key = "".concat(config.fieldId, ".summaryCard").concat(entry.id);
     return /*#__PURE__*/_react.default.createElement(_SummaryCardValidationContext.default, {
       entryId: entry.id,
@@ -198,7 +202,7 @@ var CollectionSummary = function CollectionSummary(_ref) {
         index: index
       }),
       masterPage: masterPage,
-      config: config.card || {},
+      config: finalConfig || {},
       onChange: onSummaryCardChange,
       onDuplicate: onDuplicate,
       onDelete: function onDelete() {
@@ -234,6 +238,14 @@ CollectionSummary.propTypes = {
         fieldsToIgnore: _propTypes.default.arrayOf(_propTypes.default.string)
       })
     }),
+    errorCard: _propTypes.default.shape({
+      banners: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.shape({})])),
+      title: _propTypes.default.string,
+      details: _propTypes.default.string,
+      duplicateAction: _propTypes.default.shape({
+        fieldsToIgnore: _propTypes.default.arrayOf(_propTypes.default.string)
+      })
+    }),
     confirmation: _propTypes.default.shape({
       message: _propTypes.default.string,
       label: _propTypes.default.string

package/dist/components/CollectionSummary/SummaryCard.js

@@ -4,7 +4,7 @@ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" ==
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = exports.DEFAULT_TITLE = exports.DEFAULT_REMOVE_BUTTON_LABEL = exports.DEFAULT_FULL_EDIT_BUTTON_LABEL = exports.DEFAULT_EDIT_LABEL = exports.DEFAULT_DUPLICATE_BUTTON_LABEL = exports.DEFAULT_DELETE_BUTTON_LABEL = exports.DEFAULT_CLASS = exports.DEFAULT_CHANGE_BUTTON_LABEL = void 0;
+exports.default = exports.DEFAULT_TITLE = exports.DEFAULT_EDIT_LABEL = exports.DEFAULT_DUPLICATE_BUTTON_LABEL = exports.DEFAULT_DETAILS_TITLE = exports.DEFAULT_DELETE_BUTTON_LABEL = exports.DEFAULT_CLASS = exports.DEFAULT_CHANGE_BUTTON_LABEL = exports.DEFAULT_CHANGE_BUTTON_CLASS = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = _interopRequireWildcard(require("react"));
@@ -40,10 +40,10 @@ var DEFAULT_CHANGE_BUTTON_LABEL = exports.DEFAULT_CHANGE_BUTTON_LABEL = 'Change'
 var DEFAULT_DELETE_BUTTON_LABEL = exports.DEFAULT_DELETE_BUTTON_LABEL = 'Delete';
 var DEFAULT_EDIT_LABEL = exports.DEFAULT_EDIT_LABEL = 'Quick Edit';
 var DEFAULT_DUPLICATE_BUTTON_LABEL = exports.DEFAULT_DUPLICATE_BUTTON_LABEL = 'Duplicate';
-var DEFAULT_FULL_EDIT_BUTTON_LABEL = exports.DEFAULT_FULL_EDIT_BUTTON_LABEL = 'Full edit';
-var DEFAULT_REMOVE_BUTTON_LABEL = exports.DEFAULT_REMOVE_BUTTON_LABEL = 'Remove';
+var DEFAULT_DETAILS_TITLE = exports.DEFAULT_DETAILS_TITLE = 'Full details';
+var DEFAULT_CHANGE_BUTTON_CLASS = exports.DEFAULT_CHANGE_BUTTON_CLASS = 'secondary';
 var SummaryCard = function SummaryCard(_ref) {
-  var _config$changeAction2, _config$changeAction3, _config$duplicateActi, _config$deleteAction, _config$deleteAction2, _masterPage$childPage;
+  var _config$changeAction2, _config$changeAction3, _config$duplicateActi, _config$deleteAction, _masterPage$childPage;
   var id = _ref.id,
     entryData = _ref.entryData,
     config = _ref.config,
@@ -57,12 +57,12 @@ var SummaryCard = function SummaryCard(_ref) {
     formData = _ref.formData,
     masterPage = _ref.masterPage,
     hideDetails = _ref.hideDetails,
-    isDuplicated = _ref.isDuplicated;
+    inError = _ref.inError;
   var _useState = (0, _react.useState)(false),
     _useState2 = _slicedToArray(_useState, 2),
     quickEdit = _useState2[0],
     setQuickEdit = _useState2[1];
-  var classes = _copReactComponents.Utils.classBuilder(DEFAULT_CLASS, classModifiers, isDuplicated ? 'duplicated' : '');
+  var classes = _copReactComponents.Utils.classBuilder(DEFAULT_CLASS, classModifiers, inError ? 'error' : '');
   var quickEditPage = (0, _react.useMemo)(function () {
     return (0, _getQuickEditPage.default)(config.quickEdit, pages, entryData);
   }, [pages, config, entryData, quickEdit]);
@@ -152,7 +152,7 @@ var SummaryCard = function SummaryCard(_ref) {
     className: classes('header-content-detail')
   }, _copReactComponents.Utils.interpolateString(config.details, entryData))), /*#__PURE__*/_react.default.createElement("div", {
     className: classes('header-actions')
-  }, config.quickEdit && isDuplicated && /*#__PURE__*/_react.default.createElement(_copReactComponents.Button, {
+  }, config.quickEdit && /*#__PURE__*/_react.default.createElement(_copReactComponents.Button, {
     id: "".concat(id, ".quickEditButton"),
     onClick: function onClick() {
       return setQuickEdit(function (prevState) {
@@ -167,8 +167,8 @@ var SummaryCard = function SummaryCard(_ref) {
       var _config$changeAction;
       return onChange((_config$changeAction = config.changeAction) === null || _config$changeAction === void 0 ? void 0 : _config$changeAction.page, entryData.id);
     },
-    classModifiers: isDuplicated ? 'primary' : 'secondary'
-  }, isDuplicated ? ((_config$changeAction2 = config.changeAction) === null || _config$changeAction2 === void 0 ? void 0 : _config$changeAction2.isDuplicateLabel) || DEFAULT_FULL_EDIT_BUTTON_LABEL : ((_config$changeAction3 = config.changeAction) === null || _config$changeAction3 === void 0 ? void 0 : _config$changeAction3.label) || DEFAULT_CHANGE_BUTTON_LABEL), config.duplicateAction && !isDuplicated && typeof onDuplicate === 'function' && /*#__PURE__*/_react.default.createElement(_copReactComponents.Button, {
+    classModifiers: ((_config$changeAction2 = config.changeAction) === null || _config$changeAction2 === void 0 ? void 0 : _config$changeAction2.classModifiers) || DEFAULT_CHANGE_BUTTON_CLASS
+  }, ((_config$changeAction3 = config.changeAction) === null || _config$changeAction3 === void 0 ? void 0 : _config$changeAction3.label) || DEFAULT_CHANGE_BUTTON_LABEL), config.duplicateAction && typeof onDuplicate === 'function' && /*#__PURE__*/_react.default.createElement(_copReactComponents.Button, {
     id: "".concat(id, ".duplicateButton"),
     onClick: function onClick() {
       onDuplicate(entryData);
@@ -180,7 +180,7 @@ var SummaryCard = function SummaryCard(_ref) {
       return onDelete(entryData);
     },
     classModifiers: "secondary"
-  }, isDuplicated ? ((_config$deleteAction = config.deleteAction) === null || _config$deleteAction === void 0 ? void 0 : _config$deleteAction.isDuplicateLabel) || DEFAULT_REMOVE_BUTTON_LABEL : ((_config$deleteAction2 = config.deleteAction) === null || _config$deleteAction2 === void 0 ? void 0 : _config$deleteAction2.label) || DEFAULT_DELETE_BUTTON_LABEL))), quickEdit && /*#__PURE__*/_react.default.createElement(_FormPage.default, {
+  }, ((_config$deleteAction = config.deleteAction) === null || _config$deleteAction === void 0 ? void 0 : _config$deleteAction.label) || DEFAULT_DELETE_BUTTON_LABEL))), quickEdit && quickEditPage && /*#__PURE__*/_react.default.createElement(_FormPage.default, {
     page: quickEditPage,
     onAction: function onAction(action, patch) {
       return _onAction(action, patch);
@@ -189,7 +189,7 @@ var SummaryCard = function SummaryCard(_ref) {
   }), /*#__PURE__*/_react.default.createElement("div", {
     className: classes('body')
   }, !hideDetails && /*#__PURE__*/_react.default.createElement(_copReactComponents.Details, {
-    summary: isDuplicated ? 'View duplicated details' : 'Full details',
+    summary: config.detailsTitle || DEFAULT_DETAILS_TITLE,
     className: "details"
   }, masterPage === null || masterPage === void 0 || (_masterPage$childPage = masterPage.childPages) === null || _masterPage$childPage === void 0 ? void 0 : _masterPage$childPage.map(function (childPage) {
     var _childPage$summaryLay;
@@ -235,22 +235,21 @@ SummaryCard.propTypes = {
     details: _propTypes.default.string,
     changeAction: _propTypes.default.shape({
       label: _propTypes.default.string,
-      isDuplicateLabel: _propTypes.default.string,
-      page: _propTypes.default.string.isRequired
+      page: _propTypes.default.string.isRequired,
+      classModifiers: _propTypes.default.string
     }),
     deleteAction: _propTypes.default.shape({
-      label: _propTypes.default.string,
-      isDuplicateLabel: _propTypes.default.string
+      label: _propTypes.default.string
     }),
     duplicateAction: _propTypes.default.shape({
-      label: _propTypes.default.string,
-      isDuplicateLabel: _propTypes.default.string
+      label: _propTypes.default.string
     }),
     quickEdit: _propTypes.default.shape({
       components: _propTypes.default.arrayOf(_propTypes.default.shape({
         use: _propTypes.default.string
       }))
-    })
+    }),
+    detailsTitle: _propTypes.default.string
   }).isRequired,
   masterPage: _propTypes.default.shape({
     childPages: _propTypes.default.arrayOf(_propTypes.default.shape({
@@ -266,7 +265,7 @@ SummaryCard.propTypes = {
   parentCollectionName: _propTypes.default.string.isRequired,
   formData: _propTypes.default.shape({}).isRequired,
   hideDetails: _propTypes.default.bool,
-  isDuplicated: _propTypes.default.bool
+  inError: _propTypes.default.bool
 };
 SummaryCard.defaultProps = {
   classModifiers: null,
@@ -275,6 +274,6 @@ SummaryCard.defaultProps = {
   onDuplicate: null,
   onQuickEdit: null,
   hideDetails: false,
-  isDuplicated: false
+  inError: false
 };
 var _default = exports.default = SummaryCard;

package/dist/components/CollectionSummary/SummaryCard.scss

@@ -19,7 +19,7 @@ $govuk-font-family: 'Roboto', arial, sans-serif;
   padding: 0.75rem;
   display: block;
 
-  &.duplicated {
+  &.error {
     border-left: 7px solid red;
   }
 

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

@@ -204,7 +204,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
     expect(headerDetails.textContent).toEqual("".concat(ENTRY.detailsText, " that are interpolated"));
   });
   describe('Change action button', function () {
-    var isDuplicatedValue = true;
+    var inErrorValue = true;
     var onChangeArgs = [];
     var onChangeCalls = 0;
     var ON_CHANGE = function ON_CHANGE(page, id) {
@@ -213,7 +213,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
         id: id
       });
       onChangeCalls += 1;
-      isDuplicatedValue = false;
+      inErrorValue = false;
     };
     beforeEach(function () {
       onChangeArgs = [];
@@ -252,7 +252,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
         id: ENTRY.id
       });
     });
-    it('should render correctly when isDuplicated is true', function () {
+    it('should render correctly when inError is true', function () {
       var CONFIG = {
         changeAction: {
           label: 'Change label',
@@ -270,7 +270,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
           masterPage: {
             childPages: []
           },
-          isDuplicated: isDuplicatedValue
+          inError: inErrorValue
         })),
         container = _renderWithValidation7.container;
       var _checkSetup7 = checkSetup(container),
@@ -286,8 +286,8 @@ describe('components.CollectionSummary.SummaryCard', function () {
         id: ENTRY.id
       });
 
-      // Check that the isDuplicated prop is now false
-      expect(isDuplicatedValue).toBe(false);
+      // Check that the inError prop is now false
+      expect(inErrorValue).toBe(false);
     });
     it('should use the default label when one is not provided', function () {
       var CONFIG = {
@@ -630,7 +630,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
           masterPage: {
             childPages: []
           },
-          isDuplicated: true
+          inError: true
         })),
         container = _renderWithValidation20.container;
       var _checkSetup19 = checkSetup(container),
@@ -672,7 +672,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
           masterPage: {
             childPages: []
           },
-          isDuplicated: true
+          inError: true
         })),
         container = _renderWithValidation21.container;
       var _checkSetup20 = checkSetup(container),
@@ -735,7 +735,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
           masterPage: {
             childPages: []
           },
-          isDuplicated: true
+          inError: true
         }))),
         container = _renderWithValidation22.container;
       var _checkSetup21 = checkSetup(container),
@@ -782,7 +782,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
                 childPages: []
               },
               onQuickEdit: function onQuickEdit() {},
-              isDuplicated: true
+              inError: true
             }))), container = _renderWithValidation23.container;
             _checkSetup22 = checkSetup(container), headerActionDiv = _checkSetup22.headerActionDiv;
             expect(headerActionDiv.children.length).toEqual(1);
@@ -896,7 +896,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
           masterPage: {
             childPages: []
           },
-          isDuplicated: true
+          inError: true
         })),
         container = _renderWithValidation24.container;
       var _checkSetup23 = checkSetup(container),
@@ -944,7 +944,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
           masterPage: {
             childPages: []
           },
-          isDuplicated: true
+          inError: true
         }), {
           hooks: hooks
         }),
@@ -996,7 +996,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
               masterPage: {
                 childPages: []
               },
-              isDuplicated: true
+              inError: true
             }), {
               hooks: hooks
             }), container = _renderWithValidation26.container;
@@ -1081,7 +1081,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
               masterPage: {
                 childPages: []
               },
-              isDuplicated: true
+              inError: true
             }), {
               hooks: hooks
             }), container = _renderWithValidation27.container;
@@ -1122,11 +1122,11 @@ describe('components.CollectionSummary.SummaryCard', function () {
       }, _callee8);
     })));
     it('should apply changes if no errors are present', /*#__PURE__*/_asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee10() {
-      var isDuplicatedValue, ON_SUBMIT_CALLS, hooks, ON_QUICK_EDIT_CALLS, ON_QUICK_EDIT, _renderWithValidation28, container, _checkSetup27, headerActionDiv, editButton, quickEdit, component, componentInput, quickEditButtons, saveButton;
+      var inErrorValue, ON_SUBMIT_CALLS, hooks, ON_QUICK_EDIT_CALLS, ON_QUICK_EDIT, _renderWithValidation28, container, _checkSetup27, headerActionDiv, editButton, quickEdit, component, componentInput, quickEditButtons, saveButton;
       return _regeneratorRuntime().wrap(function _callee10$(_context10) {
         while (1) switch (_context10.prev = _context10.next) {
           case 0:
-            isDuplicatedValue = true;
+            inErrorValue = true;
             ON_SUBMIT_CALLS = [];
             hooks = {
               onSubmit: function onSubmit(type, patch) {
@@ -1137,7 +1137,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
             ON_QUICK_EDIT = function ON_QUICK_EDIT(_ref12) {
               var target = _ref12.target;
               ON_QUICK_EDIT_CALLS.push(target);
-              isDuplicatedValue = false;
+              inErrorValue = false;
             };
             _renderWithValidation28 = (0, _setupTests.renderWithValidation)( /*#__PURE__*/_react2.default.createElement(_SummaryCard.default, {
               id: ID,
@@ -1157,7 +1157,7 @@ describe('components.CollectionSummary.SummaryCard', function () {
               masterPage: {
                 childPages: []
               },
-              isDuplicated: isDuplicatedValue
+              inError: inErrorValue
             }), {
               hooks: hooks
             }), container = _renderWithValidation28.container;
@@ -1193,8 +1193,8 @@ describe('components.CollectionSummary.SummaryCard', function () {
               testText: 'new value'
             });
 
-            // Check that the isDuplicated prop is now false
-            expect(isDuplicatedValue).toBe(false);
+            // Check that the inError prop is now false
+            expect(inErrorValue).toBe(false);
           case 20:
           case "end":
             return _context10.stop();

package/dist/components/FormRenderer/FormRenderer.js

@@ -157,6 +157,7 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
   var _useValidation = (0, _hooks.useValidation)(),
     addErrors = _useValidation.addErrors,
     clearErrors = _useValidation.clearErrors,
+    errors = _useValidation.errors,
     validate = _useValidation.validate;
 
   // Need to set submission data when going back
@@ -356,7 +357,7 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     page: formState.page,
     pages: [].concat(pages),
     onAction: function onAction(action, patch, patchLabel) {
-      (0, _onPageAction.default)(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting);
+      (0, _onPageAction.default)(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, errors);
     },
     onChange: onChange,
     hashLink: hashLink,
@@ -367,7 +368,7 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     page: formState.page,
     onCollectionChange: onChange,
     onAction: function onAction(action, patch, patchLabel) {
-      (0, _onPageAction.default)(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting);
+      (0, _onPageAction.default)(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, errors);
     },
     hashLink: hashLink,
     classModifiers: formState.page.classModifiers,

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

@@ -11,10 +11,14 @@ exports.default = void 0;
  * @param {object} action The action object we're assessing.
  * @param {object} page The page configuration object this action relates to.
  * @param {Function} pageValidator A function to validate the page.
+ * @param {Array} errors An array of existing errors.
  * @returns A boolean where `true` means the action can proceed and `false` means it cannot.
  */
-var canActionProceed = function canActionProceed(action, page, pageValidator) {
+var canActionProceed = function canActionProceed(action, page, pageValidator, errors) {
   if (action.validate) {
+    if (action.checkPreexistingErrors && errors.length !== 0) {
+      return false;
+    }
     return pageValidator(page).length === 0;
   }
   return true;

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

@@ -27,7 +27,7 @@ describe('components.FormRenderer.helpers.canActionProceed', function () {
         a: 'Bravo'
       }
     };
-    expect((0, _canActionProceed.default)(ACTION, PAGE, _Validate.default.page)).toBeTruthy();
+    expect((0, _canActionProceed.default)(ACTION, PAGE, _Validate.default.page, [])).toBeTruthy();
   });
   it('should return false when the page is invalid', function () {
     var ACTION = {
@@ -42,6 +42,42 @@ describe('components.FormRenderer.helpers.canActionProceed', function () {
       }],
       formData: {}
     };
-    expect((0, _canActionProceed.default)(ACTION, PAGE, _Validate.default.page)).toBeFalsy();
+    expect((0, _canActionProceed.default)(ACTION, PAGE, _Validate.default.page, [])).toBeFalsy();
+  });
+  it('should return false when the action has checkPreexistingErrors and errors is not empty', function () {
+    var ACTION = {
+      validate: true,
+      checkPreexistingErrors: true
+    };
+    var PAGE = {
+      components: [{
+        id: 'a',
+        fieldId: 'a',
+        label: 'Alpha',
+        required: true
+      }],
+      formData: {
+        a: 'value'
+      }
+    };
+    expect((0, _canActionProceed.default)(ACTION, PAGE, _Validate.default.page, ['anError'])).toBeFalsy();
+  });
+  it('should return true when the action has checkPreexistingErrors and errors is empty', function () {
+    var ACTION = {
+      validate: true,
+      checkPreexistingErrors: true
+    };
+    var PAGE = {
+      components: [{
+        id: 'a',
+        fieldId: 'a',
+        label: 'Alpha',
+        required: true
+      }],
+      formData: {
+        a: 'value'
+      }
+    };
+    expect((0, _canActionProceed.default)(ACTION, PAGE, _Validate.default.page, [])).toBeTruthy();
   });
 });

package/dist/components/FormRenderer/onPageAction.js

@@ -19,7 +19,7 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
 // (patch captures payload-ready field name and value, 
 // patchLabel captures non-ID values 
 // for display purposes after submission.)
-var onPageAction = function onPageAction(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting) {
+var onPageAction = function onPageAction(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, existingErrors) {
   // Save a copy of data in case submit errors and we need to revert
   var preSubmitData = _objectSpread({}, data);
   var form = formState;
@@ -42,7 +42,7 @@ var onPageAction = function onPageAction(action, patch, patchLabel, hooks, data,
 
   // Check to see whether the action is able to proceed, which in
   // in the case of a submission will validate the fields in the page.
-  if (_helpers.default.canActionProceed(action, form.page, validate.page) && (!submitting || action.ignoreSubmittingFlag)) {
+  if (_helpers.default.canActionProceed(action, form.page, validate.page, existingErrors) && (!submitting || action.ignoreSubmittingFlag)) {
     _patch = _helpers.default.cleanHiddenNestedData(_patch, form.page);
     setSubmitting(true);
     if (action.addToFormData) {

package/dist/utils/Validate/additional/index.js

@@ -15,6 +15,7 @@ var _mustBeShorterThan = _interopRequireDefault(require("./mustBeShorterThan"));
 var _mustBeGreaterThan = _interopRequireDefault(require("./mustBeGreaterThan"));
 var _mustBeLessThan = _interopRequireDefault(require("./mustBeLessThan"));
 var _mustBeNumbersOnly = _interopRequireDefault(require("./mustBeNumbersOnly"));
+var _mustBeUniqueInCollection = _interopRequireDefault(require("./mustBeUniqueInCollection"));
 var _mustEnterAtLeastOne = _interopRequireDefault(require("./mustEnterAtLeastOne"));
 var _mustHaveLessThanDecimalPlaces = _interopRequireDefault(require("./mustHaveLessThanDecimalPlaces"));
 var _mustNotContainSql = _interopRequireDefault(require("./mustNotContainSql"));
@@ -34,19 +35,20 @@ var functions = {
   mustBeLongerThan: _mustBeLongerThan.default,
   mustBeNumbersOnly: _mustBeNumbersOnly.default,
   mustBeShorterThan: _mustBeShorterThan.default,
+  mustBeUniqueInCollection: _mustBeUniqueInCollection.default,
   mustEnterAtLeastOne: _mustEnterAtLeastOne.default,
   mustHaveLessThanDecimalPlaces: _mustHaveLessThanDecimalPlaces.default,
   mustNotContainSql: _mustNotContainSql.default,
   mustSelectOnlyOne: _mustSelectOnlyOne.default
 };
-var additionalValidation = function additionalValidation(value, config, component) {
+var additionalValidation = function additionalValidation(value, config, component, formData) {
   var fn = functions[config.function];
   if (typeof fn === 'function') {
-    return fn(value, config, component) ? undefined : config.message;
+    return fn(value, config, component, formData) ? undefined : config.message;
   }
   return undefined;
 };
-var runAdditionalComponentValidation = function runAdditionalComponentValidation(component, value) {
+var runAdditionalComponentValidation = function runAdditionalComponentValidation(component, value, formData) {
   // We only care when we have a value - if we don't have one but want one, set `required: true`.
   // eslint-disable-next-line no-extra-boolean-cast
   if (!!value) {
@@ -55,7 +57,7 @@ var runAdditionalComponentValidation = function runAdditionalComponentValidation
       component.additionalValidation.forEach(function (config) {
         // If we've already encountered an error, don't run any more validators.
         if (!error) {
-          error = additionalValidation(value, config, component);
+          error = additionalValidation(value, config, component, formData);
         }
       });
       return error;

package/dist/utils/Validate/additional/mustBeUniqueInCollection.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _getCollectionPageActiveId = _interopRequireDefault(require("../../CollectionPage/getCollectionPageActiveId"));
+var _getCollectionPageData = _interopRequireDefault(require("../../CollectionPage/getCollectionPageData"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * @param {*} value - the value to check.
+ * @param {string} config.collectionPath - the path to the collection within formData
+ * @param {object} component - the component definition
+ * @param {object} formData - the current form data
+ * @returns true if components value is not the same in any other entry in the collection
+ */
+var mustBeUniqueInCollection = function mustBeUniqueInCollection(value, config, component, formData) {
+  if (!value || !formData) {
+    // null, undefined and empty strings should be picked up by the required flag
+    // and not considered here as they would be valid for optional fields.
+    return true;
+  }
+  var activeId = (0, _getCollectionPageActiveId.default)(config.collectionPath, formData);
+  var collectionData = (0, _getCollectionPageData.default)(config.collectionPath, formData);
+  var result = collectionData === null || collectionData === void 0 ? void 0 : collectionData.some(function (entry) {
+    // Don't compare it to itself
+    if (entry.id === activeId) {
+      return false;
+    }
+    ;
+    return entry[component.id] === value;
+  });
+  return !result;
+};
+var _default = exports.default = mustBeUniqueInCollection;

package/dist/utils/Validate/additional/mustBeUniqueInCollection.test.js

@@ -0,0 +1,127 @@
+"use strict";
+
+var _mustBeUniqueInCollection = _interopRequireDefault(require("./mustBeUniqueInCollection"));
+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); }
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('additional', function () {
+      describe('mustBeUniqueInCollection', function () {
+        var COMPONENT = {
+          id: 'firstName',
+          type: 'text',
+          label: 'First name',
+          fieldId: 'firstName',
+          additionalValidation: [{
+            function: 'mustBeUniqueInCollection',
+            collectionPath: 'names',
+            message: 'Should be unique'
+          }]
+        };
+        var CONFIG = {
+          function: 'mustBeUniqueInCollection',
+          collectionPath: 'names',
+          message: 'Should be unique'
+        };
+        var VALUE = 'NAME';
+        test('should return true given no value', function () {
+          var result = (0, _mustBeUniqueInCollection.default)(undefined, CONFIG, COMPONENT, {});
+          expect(result).toBeTruthy();
+        });
+        test('should return true given no formData', function () {
+          var result = (0, _mustBeUniqueInCollection.default)(1, CONFIG, COMPONENT, undefined);
+          expect(result).toBeTruthy();
+        });
+        test('should return true for first entry in a collection', function () {
+          var FORM_DATA = {
+            namesActiveId: 1,
+            names: [{
+              id: 1,
+              firstName: VALUE
+            }]
+          };
+          var result = (0, _mustBeUniqueInCollection.default)(VALUE, CONFIG, COMPONENT, FORM_DATA);
+          expect(result).toBeTruthy();
+        });
+        test('should return true if other entries do not have the same value for this field', function () {
+          var FORM_DATA = {
+            namesActiveId: 3,
+            names: [{
+              id: 1,
+              firstName: 'alpha'
+            }, {
+              id: 2,
+              firstName: 'bravo'
+            }, {
+              id: 3,
+              firstName: VALUE
+            }]
+          };
+          var result = (0, _mustBeUniqueInCollection.default)(VALUE, CONFIG, COMPONENT, FORM_DATA);
+          expect(result).toBeTruthy();
+        });
+        test('should return false if other entries do have the same value for this field', function () {
+          var FORM_DATA = {
+            namesActiveId: 3,
+            names: [{
+              id: 1,
+              firstName: VALUE
+            }, {
+              id: 2,
+              firstName: 'bravo'
+            }, {
+              id: 3,
+              firstName: VALUE
+            }]
+          };
+          var result = (0, _mustBeUniqueInCollection.default)(VALUE, CONFIG, COMPONENT, FORM_DATA);
+          expect(result).toBeFalsy();
+        });
+        test('should return false if other entries do have the same value for this field within a nested collection', function () {
+          var NESTED_VALUE = 'delta';
+          var FORM_DATA = {
+            namesActiveId: 3,
+            names: [{
+              id: 1,
+              firstName: 'alpha'
+            }, {
+              id: 2,
+              firstName: 'bravo'
+            }, {
+              id: 3,
+              firstName: VALUE,
+              surnamesActiveId: 2,
+              surnames: [{
+                id: 1,
+                surname: 'delta'
+              }, {
+                id: 2,
+                surname: 'delta'
+              }]
+            }]
+          };
+          var COMPONENT_NESTED = {
+            id: 'surname',
+            type: 'text',
+            label: 'Surname',
+            fieldId: 'surname',
+            additionalValidation: [{
+              function: 'mustBeUniqueInCollection',
+              collectionPath: 'names.surname',
+              message: 'Should be unique'
+            }]
+          };
+          var result = (0, _mustBeUniqueInCollection.default)(NESTED_VALUE, _objectSpread(_objectSpread({}, CONFIG), {}, {
+            collectionPath: 'names.surnames'
+          }), COMPONENT_NESTED, FORM_DATA);
+          expect(result).toBeFalsy();
+        });
+      });
+    });
+  });
+});

package/dist/utils/Validate/validateComponent.js

@@ -95,7 +95,7 @@ var validateComponent = function validateComponent(component, outerData, formDat
       error = (0, _validateRegex.default)(value, component.label, component.pattern, component.custom_errors);
     }
     if (!error && component.additionalValidation) {
-      error = (0, _additional.default)(component, value);
+      error = (0, _additional.default)(component, value, formData);
       if (component.type === _models.ComponentTypes.DATE && error) {
         properties = {
           day: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "5.45.1",
+  "version": "5.48.1-alpha",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "^3.15.7",
+    "@ukhomeoffice/cop-react-components": "^3.15.8-alpha",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",