@ukhomeoffice/cop-react-form-renderer 5.20.0 → 5.23.0

package/dist/utils/Validate/validatePage.test.js

@@ -100,6 +100,33 @@ describe('utils.Validate.Page', function () {
           error: 'Echo is required'
         });
       });
+      it('should return an error for each required component on a nested collection page', function () {
+        var COMPONENTS = [setup('a', _models.ComponentTypes.TEXT, 'Alpha', true), setup('b', _models.ComponentTypes.TEXT, 'Bravo', true), setup('c', _models.ComponentTypes.TEXT, 'Charlie', false),
+        // The only unrequired one
+        setup('d', _models.ComponentTypes.TEXT, 'Delta', true), setup('e', _models.ComponentTypes.TEXT, 'Echo', true)];
+        var PAGE = {
+          components: COMPONENTS,
+          collection: {
+            name: 'parent.child'
+          },
+          formData: null
+        };
+        var RESULT = (0, _validatePage.default)(PAGE);
+        expect(RESULT.length).toEqual(4);
+        expect(RESULT).toEqual([{
+          id: 'a',
+          error: 'Alpha is required'
+        }, {
+          id: 'b',
+          error: 'Bravo is required'
+        }, {
+          id: 'd',
+          error: 'Delta is required'
+        }, {
+          id: 'e',
+          error: 'Echo is required'
+        }]);
+      });
       it('should return an error for each required component with interpolated label', function () {
         var COMPONENTS = [
         // eslint-disable-next-line no-template-curly-in-string
@@ -124,26 +151,22 @@ describe('utils.Validate.Page', function () {
         };
         var RESULT = (0, _validatePage.default)(PAGE);
         expect(RESULT.length).toEqual(5);
-        expect(RESULT[0]).toEqual({
+        expect(RESULT).toEqual([{
           id: 'a',
           error: "Alpha ".concat(PAGE.formData.tiger, " is required")
-        });
-        expect(RESULT[1]).toEqual({
+        }, {
           id: 'b',
           error: "Bravo ".concat(PAGE.formData.panther, " is required")
-        });
-        expect(RESULT[2]).toEqual({
+        }, {
           id: 'c',
           error: "Charlie ".concat(PAGE.formData.eagle, " is required")
-        });
-        expect(RESULT[3]).toEqual({
+        }, {
           id: 'd',
           error: "Delta ".concat(PAGE.formData.lion, " is required")
-        });
-        expect(RESULT[4]).toEqual({
+        }, {
           id: 'e',
           error: "Echo ".concat(PAGE.formData.zoo, " is required")
-        });
+        }]);
       });
     });
     describe('when the form data is fully valid', function () {
@@ -337,22 +360,19 @@ describe('utils.Validate.Page', function () {
         };
         var RESULT = (0, _validatePage.default)(PAGE);
         expect(RESULT.length).toEqual(4);
-        expect(RESULT[0]).toEqual({
+        expect(RESULT).toEqual([{
           id: 'a',
           error: 'Alpha is required'
-        });
-        expect(RESULT[1]).toEqual({
+        }, {
           id: 'b',
           error: 'Bravo is required'
-        });
-        expect(RESULT[2]).toEqual({
+        }, {
           id: 'd',
           error: 'Delta is required'
-        });
-        expect(RESULT[3]).toEqual({
+        }, {
           id: 'e',
           error: 'Echo is required'
-        });
+        }]);
       });
       it('should return no errors on a collection page with a show_when that is false', function () {
         var COMPONENTS = [setup('a', _models.ComponentTypes.TEXT, 'Alpha', true), setup('b', _models.ComponentTypes.TEXT, 'Bravo', true), setup('c', _models.ComponentTypes.TEXT, 'Charlie', false),
@@ -469,4 +489,234 @@ describe('utils.Validate.Page', function () {
       });
     });
   });
+  describe('with a nested CollectionPage', function () {
+    var COLLECTION = {
+      name: 'parent.child'
+    };
+    describe('when the form data is fully valid', function () {
+      var DATA = {
+        parentActiveId: '01',
+        childActiveId: '01',
+        parent: [{
+          id: '01',
+          child: [{
+            id: '01',
+            alpha: 'alpha.smith@digital.homeoffice.gov.uk',
+            bravo: 'bravo.jones@digital.homeoffice.gov.uk'
+          }]
+        }]
+      };
+      it('should return no errors when none of the components are required or email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.TEXT, 'Alpha', false), setup('bravo', _models.ComponentTypes.TEXT, 'Bravo', false)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: DATA
+        };
+        expect((0, _validatePage.default)(PAGE).length).toEqual(0);
+      });
+      it('should return no errors when all of the components are required but not email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.TEXT, 'Alpha', true), setup('bravo', _models.ComponentTypes.TEXT, 'Bravo', true)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: DATA
+        };
+        expect((0, _validatePage.default)(PAGE).length).toEqual(0);
+      });
+      it('should return no errors when none of the components are required but are all email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.EMAIL, 'Alpha', false), setup('bravo', _models.ComponentTypes.EMAIL, 'Bravo', false)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: DATA
+        };
+        expect((0, _validatePage.default)(PAGE).length).toEqual(0);
+      });
+      it('should return no errors when all of the components are required and email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.EMAIL, 'Alpha', true), setup('bravo', _models.ComponentTypes.EMAIL, 'Bravo', true)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: DATA
+        };
+        expect((0, _validatePage.default)(PAGE).length).toEqual(0);
+      });
+      it('should return an error for each required component on a collection page with a show_when that is true', function () {
+        var COMPONENTS = [setup('a', _models.ComponentTypes.TEXT, 'Alpha', true), setup('b', _models.ComponentTypes.TEXT, 'Bravo', true), setup('c', _models.ComponentTypes.TEXT, 'Charlie', false),
+        // The only unrequired one
+        setup('d', _models.ComponentTypes.TEXT, 'Delta', true), setup('e', _models.ComponentTypes.TEXT, 'Echo', true)];
+        var PAGE = {
+          components: COMPONENTS,
+          collection: {
+            name: 'parent.child'
+          },
+          show_when: {
+            field: 'isShown',
+            op: '=',
+            value: true
+          },
+          formData: {
+            parentActiveId: '01',
+            childActiveId: '01',
+            parent: [{
+              id: '01',
+              child: [{
+                id: '01',
+                isShown: true
+              }]
+            }]
+          }
+        };
+        var RESULT = (0, _validatePage.default)(PAGE);
+        expect(RESULT.length).toEqual(4);
+        expect(RESULT).toEqual([{
+          id: 'a',
+          error: 'Alpha is required'
+        }, {
+          id: 'b',
+          error: 'Bravo is required'
+        }, {
+          id: 'd',
+          error: 'Delta is required'
+        }, {
+          id: 'e',
+          error: 'Echo is required'
+        }]);
+      });
+      it('should return no errors on a collection page with a show_when that is false', function () {
+        var COMPONENTS = [setup('a', _models.ComponentTypes.TEXT, 'Alpha', true), setup('b', _models.ComponentTypes.TEXT, 'Bravo', true), setup('c', _models.ComponentTypes.TEXT, 'Charlie', false),
+        // The only unrequired one
+        setup('d', _models.ComponentTypes.TEXT, 'Delta', true), setup('e', _models.ComponentTypes.TEXT, 'Echo', true)];
+        var PAGE = {
+          components: COMPONENTS,
+          collection: {
+            name: 'parent.child'
+          },
+          show_when: {
+            field: 'isShown',
+            op: '=',
+            value: true
+          },
+          formData: {
+            parentActiveId: '01',
+            childActiveId: '01',
+            parent: [{
+              id: '01',
+              child: [{
+                id: '01',
+                isShown: false
+              }]
+            }]
+          }
+        };
+        var RESULT = (0, _validatePage.default)(PAGE);
+        expect(RESULT.length).toEqual(0);
+      });
+    });
+    describe('when the form data has one field missing and includes an invalid email', function () {
+      var DATA = {
+        parentActiveId: '01',
+        childActiveId: '01',
+        parent: [{
+          id: '01',
+          child: [{
+            id: '01',
+            alpha: 'alpha.smith@digital.homeoffice.gov.uk',
+            bravo: 'bravo.jones@hotmail.com'
+          }]
+        }]
+      };
+      it('should return no errors when none of the components are required or email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.TEXT, 'Alpha', false), setup('bravo', _models.ComponentTypes.TEXT, 'Bravo', false), setup('charlie', _models.ComponentTypes.TEXT, 'Charlie', false)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: null
+        };
+        expect((0, _validatePage.default)(PAGE).length).toEqual(0);
+      });
+      it('should return an error for the missing field when all are required but not email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.TEXT, 'Alpha', true), setup('bravo', _models.ComponentTypes.TEXT, 'Bravo', true), setup('charlie', _models.ComponentTypes.TEXT, 'Charlie', true)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: DATA
+        };
+        var RESULT = (0, _validatePage.default)(PAGE);
+        expect(RESULT.length).toEqual(1);
+        expect(RESULT[0]).toEqual({
+          id: 'charlie',
+          error: 'Charlie is required'
+        });
+      });
+      it('should return an error for the invalid email field when none are required but all email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.EMAIL, 'Alpha', false), setup('bravo', _models.ComponentTypes.EMAIL, 'Bravo', false), setup('charlie', _models.ComponentTypes.EMAIL, 'Charlie', false)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: DATA
+        };
+        var RESULT = (0, _validatePage.default)(PAGE);
+        expect(RESULT.length).toEqual(1);
+        expect(RESULT[0]).toEqual({
+          id: 'bravo',
+          error: 'Enter bravo in the correct format, like jane.doe@homeoffice.gov.uk'
+        });
+      });
+      it('should return an error for both invalid fields when all are required and email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.EMAIL, 'Alpha', true), setup('bravo', _models.ComponentTypes.EMAIL, 'Bravo', true), setup('charlie', _models.ComponentTypes.EMAIL, 'Charlie', true)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: DATA
+        };
+        var RESULT = (0, _validatePage.default)(PAGE);
+        expect(RESULT.length).toEqual(2);
+        expect(RESULT[0]).toEqual({
+          id: 'bravo',
+          error: 'Enter bravo in the correct format, like jane.doe@homeoffice.gov.uk'
+        });
+        expect(RESULT[1]).toEqual({
+          id: 'charlie',
+          error: 'Charlie is required'
+        });
+      });
+      it('should return an interpolated error for both invalid fields when all are required and email types', function () {
+        var COMPONENTS = [setup('alpha', _models.ComponentTypes.EMAIL, 'Alpha', true),
+        // eslint-disable-next-line no-template-curly-in-string
+        setup('bravo', _models.ComponentTypes.EMAIL, 'Bravo ${lion}', true),
+        // eslint-disable-next-line no-template-curly-in-string
+        setup('charlie', _models.ComponentTypes.EMAIL, 'Charlie ${panther}', true)];
+        var PAGE = {
+          collection: COLLECTION,
+          components: COMPONENTS,
+          formData: {
+            parentActiveId: '01',
+            childActiveId: '01',
+            parent: [{
+              id: '01',
+              child: [{
+                id: '01',
+                alpha: 'alpha.smith@digital.homeoffice.gov.uk',
+                bravo: 'bravo.jones@hotmail.com',
+                lion: 'Lion',
+                panther: 'Panther'
+              }]
+            }]
+          }
+        };
+        var RESULT = (0, _validatePage.default)(PAGE);
+        expect(RESULT.length).toEqual(2);
+        expect(RESULT[0]).toEqual({
+          id: 'bravo',
+          error: "Enter bravo Lion in the correct format, like jane.doe@homeoffice.gov.uk"
+        });
+        expect(RESULT[1]).toEqual({
+          id: 'charlie',
+          error: "Charlie Panther is required"
+        });
+      });
+    });
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "5.20.0",
+  "version": "5.23.0",
   "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.6.2",
+    "@ukhomeoffice/cop-react-components": "^3.9.0",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",