@ukhomeoffice/cop-react-form-renderer 6.15.12-accessibilty → 6.15.12

package/dist/components/FormRenderer/FormRenderer.js

@@ -129,17 +129,6 @@ const InternalFormRenderer = _ref2 => {
     validate
   } = (0, _hooks.useValidation)();
 
-  // Set focus to header for accessibility, Screen reader to anounce the page heading
-  const setFocusToHeading = () => {
-    if (document) {
-      const header = Array.from(document.getElementsByTagName('h1')).pop();
-      if (header) {
-        header.setAttribute('tabIndex', '-1');
-        header.focus();
-      }
-    }
-  };
-
   // Need to set submission data when going back
   window.onpopstate = e => {
     var _formState$page;
@@ -156,12 +145,23 @@ const InternalFormRenderer = _ref2 => {
     }
     clearErrors();
     setGoingBack(true);
-    hooks.onGoingBack(e.state ? e.state : null);
+    hooks.onGoingBack.apply(hooks, [e.state ? e.state : null].concat(formState.page.formData));
     if (components && pages && data && (_formState$page = formState.page) !== null && _formState$page !== void 0 && _formState$page.formData && pagePoint === undefined) {
+      var _submissionData$formS;
       const submissionData = _utils.default.Format.form({
         pages,
         components
       }, _objectSpread(_objectSpread({}, data), formState.page.formData), _models.EventTypes.SUBMIT);
+      if (submissionData !== null && submissionData !== void 0 && (_submissionData$formS = submissionData.formStatus) !== null && _submissionData$formS !== void 0 && _submissionData$formS.taskPage) {
+        const object = submissionData.formStatus.tasks;
+        Object.keys(object).forEach(key => {
+          const value = object[key];
+          if (value.currentPage && !value.complete) {
+            delete object[key].currentPage;
+          }
+        });
+        delete submissionData.formStatus.taskPage;
+      }
       setData(submissionData);
     }
   };
@@ -203,11 +203,6 @@ const InternalFormRenderer = _ref2 => {
     setFormState(_helpers.default.getFormState(pageId, pages, hub));
   }, [pages, hub, pageId, setFormState, type, goingBack, data, formState.page]);
 
-  // Set focus to heading for accessibility
-  (0, _react.useEffect)(() => {
-    setFocusToHeading();
-  }, [formState]);
-
   // Call the onFormLoad hook just when this component first renders.
   (0, _react.useEffect)(() => {
     setPagePoint(undefined);

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-hidden-entire-collection.json

@@ -0,0 +1,114 @@
+{
+  "id": "example-form",
+  "cleanseHiddenData": true,
+  "version": "0.0.1",
+  "name": "example-form",
+  "title": "Example form",
+  "type": "form",
+  "components": [
+    {
+      "id": "itemCategory",
+      "fieldId": "itemCategory",
+      "label": "Item category",
+      "type": "text"
+    },
+    {
+      "id": "itemSubCategory",
+      "fieldId": "itemSubCategory",
+      "label": "Item Sub category",
+      "type": "text"
+    },
+    {
+      "id": "abvDetails",
+      "fieldId": "abvDetails",
+      "label": "AbvDetails",
+      "type": "text"
+    },
+    {
+      "id": "firearmCheck",
+      "fieldId": "firearmCheck",
+      "label": "FirearmCheck",
+      "type": "text"
+    },
+    {
+      "id": "brandText",
+      "fieldId": "brandText",
+      "label": "BrandText",
+      "type": "text"
+    }
+  ],
+  "pages": [
+    {
+      "id": "item-seal-details",
+      "name": "item-seal-details",
+      "title": "Item seal details",
+      "components": [
+        {
+          "use": "itemCategory"
+        },
+        {
+          "use": "itemSubCategory"
+        }
+      ],
+      "collection": {
+        "show_when": {
+          "op": "=",
+          "field": "alpha",
+          "value": "NOT-alpha-value"
+        },
+        "name": "items",
+        "actionPosition": "inHeading",
+        "labels": {
+          "item": "Item ${index}"
+        }
+      }
+    },
+    {
+      "id": "alcohol",
+      "name": "alcohol",
+      "title": "Alcohol",
+      "collection": {
+        "name": "items",
+        "waitForFormData": true,
+        "heading": {
+          "text": "Alcohol",
+          "size": "m",
+          "changeLink": true
+        }
+      },
+      "components": [
+        {
+          "use": "brandText",
+          "label": "Model or brand"
+        },
+        {
+          "use": "abvDetails",
+          "label": ""
+        }
+      ]
+    },
+    {
+      "id": "firearm",
+      "name": "firearm",
+      "title": "Firearm",
+      "collection": {
+        "name": "items",
+        "waitForFormData": true,
+        "heading": {
+          "text": "Firearm",
+          "size": "m",
+          "changeLink": true
+        }
+      },
+      "components": [
+        {
+          "use": "brandText",
+          "label": "Model or brand"
+        },
+        {
+          "use": "firearmCheck"
+        }
+      ]
+    }
+  ]
+}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/input/data-hidden-entire-collection.json

@@ -0,0 +1,20 @@
+{
+  "alpha": "alpha-value",
+  "itemsActiveId": "8b9b7671-d06d-447e-a907-e9215072741a",
+  "items": [
+    {
+      "id": "da056129-34e9-4218-8e98-574856977727",
+      "itemCategory": "alcohol",
+      "itemSubCategory": "itemSubCategory-value",
+      "brandText": "brandText-value",
+      "abvDetails": "abv-value"
+    },
+    {
+      "id": "da056129-34e9-4218-8e98-574856977727",
+      "itemCategory": "weapons",
+      "itemSubCategory": "ARM",
+      "brandText": "brandText-value",
+      "firearmCheck": "firearmCheck-value"
+    }
+  ]
+}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/output/data-hidden-entire-collection-removed.json

@@ -0,0 +1,3 @@
+{
+  "alpha": "alpha-value"
+}

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

@@ -212,7 +212,10 @@ const resolveComponentDependenciesGraph = (allDependencyRelationships, allCompon
  * rules for each payload object.
  * 
  * Some of the rules may be dependent on payload items outside the collection. These will already have been cleansed
- * so will be in a reliable state.   
+ * so will be in a reliable state. 
+ * 
+ * It is possible in the form spec to specify in the master page that the whole collection has a show_when rule.
+ * If this is the case, evaluate the rule and if false delete the entire collection array.  
  * 
  * @param {Map} allCollections A map of collection objects, which are a grouping of the pages that make up a single collection  
  * @param {Object} formData The form payload
@@ -221,6 +224,11 @@ const resolveComponentDependenciesGraph = (allDependencyRelationships, allCompon
  */
 const cleanseCollectionData = (allCollections, formData, componentByIdMap, componentByFieldIdMap) => {
   allCollections === null || allCollections === void 0 || allCollections.forEach((collection, collectionName) => {
+    if (!Utils.isShowEntity(collection, formData)) {
+      // Delete the entire collection array (including activeId) if the master page has an unmet rule
+      delete formData[collectionName];
+      delete formData["".concat(collectionName, "ActiveId")];
+    }
     const collectionDataArray = formData[collectionName];
     collectionDataArray === null || collectionDataArray === void 0 || collectionDataArray.forEach(collectionDataEntry => {
       var _collection$childPage2;

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

@@ -75,6 +75,9 @@ var _dataChainedComponentShowWhensTargetComponentNestedRemoved = _interopRequire
 var _formHiddenPageCollection = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-hidden-page-collection.json"));
 var _dataHiddenPageCollection = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-hidden-page-collection.json"));
 var _dataHiddenPageCollectionRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-hidden-page-collection-removed.json"));
+var _formHiddenEntireCollection = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-hidden-entire-collection.json"));
+var _dataHiddenEntireCollection = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-hidden-entire-collection.json"));
+var _dataHiddenEntireCollectionRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-hidden-entire-collection-removed.json"));
 var _formHiddenCollectionComponentDependentOnExternalData = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-hidden-collection-component-dependent-on-external-data.json"));
 var _dataHiddenCollectionComponentDependentOnExternalData = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-hidden-collection-component-dependent-on-external-data.json"));
 var _dataHiddenCollectionComponentDependentOnExternalDataRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-hidden-collection-component-dependent-on-external-data-removed.json"));
@@ -149,6 +152,8 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 
 // Hidden page collection
 
+// Should remove all collection components if show_when at the master page level
+
 // Hidden collection component, dependent on data external to and internal to collection payload
 
 // Mandec business interests
@@ -296,6 +301,12 @@ describe('FormRenderer', () => {
         const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
         expect(result).toEqual(_dataHiddenPageComponentUsedElsewhereRemoved.default);
       });
+      it('should remove all collection components if show_when at the master page level.', () => {
+        const submissionData = JSON.parse(JSON.stringify(_dataHiddenEntireCollection.default));
+        const form = JSON.parse(JSON.stringify(_formHiddenEntireCollection.default));
+        const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
+        expect(result).toEqual(_dataHiddenEntireCollectionRemoved.default);
+      });
       it('chained show_whens should be resolved from the end of the chain backup to the start.', () => {
         const submissionData = JSON.parse(JSON.stringify(_dataChainedComponentShowWhens.default));
         const form = JSON.parse(JSON.stringify(_formChainedComponentShowWhens.default));

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

@@ -30,6 +30,12 @@ const getCurrentTaskState = function (_ref) {
   if (currentPage) {
     return _models.TaskStates.TYPES.IN_PROGRESS;
   }
+  // If the user has clicked on the back link (see FormRenderer.jsx window.onpopstate event handler) 
+  // the task will be incomplete and the currentPage deleted
+  // and the task state should be recognised as 'In progress'.
+  if (complete !== undefined && !complete && currentPage === undefined) {
+    return _models.TaskStates.TYPES.IN_PROGRESS;
+  }
   return defaultState;
 };
 

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

@@ -115,6 +115,26 @@ describe('components.FormRenderer.helpers.getUpdatedSectionStates', () => {
       expect(updatedSections[0].tasks[0].state).toEqual(_models.TaskStates.TYPES.IN_PROGRESS);
       expect(updatedSections[0].tasks[1].state).toEqual(_models.TaskStates.TYPES.CANNOT_START_YET);
     });
+    it("should set tasks to '".concat(_models.TaskStates.TYPES.IN_PROGRESS, "' if they have no current page and are not complete"), () => {
+      const SECTIONS = [{
+        name: 'Add event details',
+        tasks: [{
+          name: 'Date, location and mode details',
+          pages: ['eventDate', 'eventMode']
+        }, {
+          name: 'Officer and agency details',
+          pages: ['officeDetails']
+        }]
+      }];
+      const TASKS = {
+        'Date, location and mode details': {
+          complete: false
+        }
+      };
+      const updatedSections = (0, _getUpdatedSectionStates.default)(SECTIONS, TASKS);
+      expect(updatedSections[0].tasks[0].state).toEqual(_models.TaskStates.TYPES.IN_PROGRESS);
+      expect(updatedSections[0].tasks[1].state).toEqual(_models.TaskStates.TYPES.CANNOT_START_YET);
+    });
     it("should set the status of any tasks in a section with a failed show_when to '".concat(_models.TaskStates.TYPES.SKIPPED, "'"), () => {
       const SECTIONS = [{
         name: 'Add event details',

package/dist/utils/CollectionPage/mergeCollectionPages.js

@@ -25,11 +25,17 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 * can be one of either:
 * - A regular form page.
 * - The master page for a child collection, with its own array of child pages.
+*
+* To specify that an entire collection (including labels and actions) is hidden, 
+* then add a show_when to the 1st collection entry in the form.
 */
 
-const createMasterPage = page => ({
+const createMasterPage = page => _objectSpread(_objectSpread({
   id: page.id,
-  name: page.name,
+  name: page.name
+}, page.collection.show_when && {
+  show_when: page.collection.show_when
+}), {}, {
   orderInForm: page.orderInForm,
   deleteCollectionWhenHidden: page.deleteCollectionWhenHidden,
   collection: _objectSpread({

package/package.json

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