@ukhomeoffice/cop-react-form-renderer 2.6.2 → 2.7.1

package/dist/json/groupOfRow.json

@@ -0,0 +1,158 @@
+{
+  "id": "userProfile",
+  "version": "1",
+  "name": "userProfile",
+  "title": "Your profile",
+  "type": "cya",
+  "components": [
+    {
+      "id": "firstName",
+      "fieldId": "firstName",
+      "label": "First name",
+      "type": "text",
+      "readonly": false,
+      "source": {
+        "field": "currentUser.givenName"
+      }
+    },
+    {
+      "id": "surname",
+      "fieldId": "surname",
+      "label": "Last name",
+      "type": "text",
+      "readonly": false,
+      "source": {
+        "field": "currentUser.familyName"
+      }
+    },
+    {
+      "id": "dateGroup",
+      "fieldId": "dateGroup",
+      "label": "Date",
+      "type": "date",
+      "required": true,
+      "readonly": false,
+      "source": {
+        "field": "dateGroupField"
+      }
+    },
+    {
+      "id": "timeGroup",
+      "fieldId": "timeGroup",
+      "label": "Time",
+      "type": "time",
+      "required": true,
+      "readonly": false,
+      "source": {
+        "field": "timeGroupField"
+      }
+    },
+    {
+      "id": "portGroup",
+      "fieldId": "portGroup",
+      "label": "Port",
+      "type": "text",
+      "required": true,
+      "readonly": false,
+      "source": {
+        "field": "portGroupField"
+      }
+    },
+    {
+      "id": "whereGroup",
+      "fieldId": "whereGroup",
+      "label": "Where did you see the incident take place",
+      "type": "text",
+      "required": true,
+      "readonly": false,
+      "source": {
+        "field": "whereGroupField"
+      }
+    },
+    {
+      "id": "extraDetails",
+      "fieldId": "extraDetails",
+      "label": "Extra details",
+      "type": "textarea",
+      "readonly": false
+    }
+  ],
+  "pages": [
+    {
+      "id": "names",
+      "name": "names",
+      "title": "Name",
+      "components": [
+        {
+          "use": "firstName"
+        },
+        {
+          "use": "surname"
+        }
+      ],
+      "cya_link": {
+        "page": "names",
+        "aria_suffix": "names"
+      },
+      "actions": [
+        "submit"
+      ]
+    },
+    {
+      "id": "dateLocDet",
+      "name": "dateLocDetName",
+      "title": "Date and location details",
+      "components": [
+        {
+          "use": "dateGroup"
+        },
+        {
+          "use": "timeGroup"
+        },
+        {
+          "use": "portGroup"
+        },
+        {
+          "use": "whereGroup"
+        }
+      ],
+      "cya_link": {
+        "page": "dateLocDet",
+        "aria_suffix": "Date and location details"
+      },
+      "actions": [
+        "submit"
+      ]
+    },
+    {
+      "id": "additional-info",
+      "name": "additional-info",
+      "title": "Additional Information",
+      "components": [
+        {
+          "use": "extraDetails"
+        }
+      ],
+      "cya_link": {
+        "page": "additional-info",
+        "aria_suffix": "Additional Information"
+      },
+      "actions": [
+        "submit"
+      ]
+    }
+  ],
+  "cya": {
+    "hide_page_titles": true,
+    "hide_actions": true,
+    "groups": [
+      {
+        "pageId": "dateLocDet"
+      },
+      {
+        "pageId": "names",
+        "title": "Names"
+      }
+    ]
+  }
+}

package/dist/json/groupOfRowData.json

@@ -0,0 +1,15 @@
+{
+  "currentUser": {
+    "givenName": "John",
+    "familyName": "Smith"
+  },
+  "businessKey": "123456789",
+  "dateGroupField": "01-01-2022",
+  "timeGroupField": "14:57",
+  "portGroupField": "Glasgow",
+  "whereGroupField": "terminal",
+  "firstName": "sample",
+  "surname": "test",
+  "age": "12",
+  "extraDetails": "extra notes here"
+}

package/dist/utils/Validate/validatePage.js

@@ -7,20 +7,21 @@ exports.default = void 0;
 
 var _validateComponent = _interopRequireDefault(require("./validateComponent"));
 
+var _showFormPage = _interopRequireDefault(require("../FormPage/showFormPage"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
 
 /**
  * Validate all of the components on a page.
- * @param {Array} components The components to validate.
- * @param {object} formData The data to use that holds this components' values.
+ * @param {object} page The page to validate
  * @returns An array containing all of the errors.
  */
-var validatePage = function validatePage(components, formData) {
-  if (Array.isArray(components)) {
-    return components.reduce(function (errors, component) {
-      return errors.concat((0, _validateComponent.default)(component, formData));
+var validatePage = function validatePage(page) {
+  if ((0, _showFormPage.default)(page, page.formData) && Array.isArray(page.components)) {
+    return page.components.reduce(function (errors, component) {
+      return errors.concat((0, _validateComponent.default)(component, page.formData));
     }, []).filter(function (e) {
       return !!e;
     }).flat();

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

@@ -21,20 +21,36 @@ describe('utils', function () {
       };
 
       it('should return no error when the components array is null', function () {
-        expect((0, _validatePage.default)(null, {}).length).toEqual(0);
+        var PAGE = {
+          components: null,
+          formData: null
+        };
+        expect((0, _validatePage.default)(PAGE).length).toEqual(0);
       });
       it('should return no error when the components array is empty', function () {
-        expect((0, _validatePage.default)([], {}).length).toEqual(0);
+        var PAGE = {
+          components: [],
+          formData: null
+        };
+        expect((0, _validatePage.default)(PAGE).length).toEqual(0);
       });
       describe('when there is no form data', function () {
         it('should return no errors when no components are required', function () {
           var COMPONENTS = [setup('a', _models.ComponentTypes.TEXT, 'Alpha', false), setup('b', _models.ComponentTypes.TEXT, 'Bravo', false)];
-          expect((0, _validatePage.default)(COMPONENTS, null).length).toEqual(0);
+          var PAGE = {
+            components: COMPONENTS,
+            formData: null
+          };
+          expect((0, _validatePage.default)(PAGE).length).toEqual(0);
         });
         it('should return an error for each required component', 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 RESULT = (0, _validatePage.default)(COMPONENTS, null);
+          var PAGE = {
+            components: COMPONENTS,
+            formData: null
+          };
+          var RESULT = (0, _validatePage.default)(PAGE);
           expect(RESULT.length).toEqual(4);
           expect(RESULT[0]).toEqual({
             id: 'a',
@@ -61,19 +77,35 @@ describe('utils', function () {
         };
         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)];
-          expect((0, _validatePage.default)(COMPONENTS, DATA).length).toEqual(0);
+          var PAGE = {
+            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)];
-          expect((0, _validatePage.default)(COMPONENTS, DATA).length).toEqual(0);
+          var PAGE = {
+            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)];
-          expect((0, _validatePage.default)(COMPONENTS, DATA).length).toEqual(0);
+          var PAGE = {
+            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)];
-          expect((0, _validatePage.default)(COMPONENTS, DATA).length).toEqual(0);
+          var PAGE = {
+            components: COMPONENTS,
+            formData: DATA
+          };
+          expect((0, _validatePage.default)(PAGE).length).toEqual(0);
         });
       });
       describe('when the form data has one field missing and includes an invalid email', function () {
@@ -83,11 +115,19 @@ describe('utils', function () {
         };
         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)];
-          expect((0, _validatePage.default)(COMPONENTS, DATA).length).toEqual(0);
+          var PAGE = {
+            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 RESULT = (0, _validatePage.default)(COMPONENTS, DATA);
+          var PAGE = {
+            components: COMPONENTS,
+            formData: DATA
+          };
+          var RESULT = (0, _validatePage.default)(PAGE);
           expect(RESULT.length).toEqual(1);
           expect(RESULT[0]).toEqual({
             id: 'charlie',
@@ -96,7 +136,11 @@ describe('utils', function () {
         });
         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 RESULT = (0, _validatePage.default)(COMPONENTS, DATA);
+          var PAGE = {
+            components: COMPONENTS,
+            formData: DATA
+          };
+          var RESULT = (0, _validatePage.default)(PAGE);
           expect(RESULT.length).toEqual(1);
           expect(RESULT[0]).toEqual({
             id: 'bravo',
@@ -105,7 +149,11 @@ describe('utils', function () {
         });
         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 RESULT = (0, _validatePage.default)(COMPONENTS, DATA);
+          var PAGE = {
+            components: COMPONENTS,
+            formData: DATA
+          };
+          var RESULT = (0, _validatePage.default)(PAGE);
           expect(RESULT.length).toEqual(2);
           expect(RESULT[0]).toEqual({
             id: 'bravo',

package/package.json

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