@ukhomeoffice/cop-react-form-renderer 6.15.12-alpha → 6.15.13

package/dist/components/FormRenderer/FormRenderer.js

@@ -39,6 +39,7 @@ const FormRenderer = _ref => {
   let {
     title,
     type,
+    cleanseHiddenData,
     components,
     pages,
     hub,
@@ -61,6 +62,7 @@ const FormRenderer = _ref => {
   }, /*#__PURE__*/_react.default.createElement(_context.ValidationContextProvider, null, /*#__PURE__*/_react.default.createElement(InternalFormRenderer, {
     title: title,
     type: type,
+    cleanseHiddenData: cleanseHiddenData,
     components: components,
     pages: pages,
     hub: hub,
@@ -84,6 +86,7 @@ const InternalFormRenderer = _ref2 => {
   let {
     title,
     type,
+    cleanseHiddenData,
     components,
     pages: _pages,
     hub: _hub,
@@ -126,6 +129,17 @@ 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 && document.activeElement !== header) {
+        header.setAttribute('tabIndex', '-1');
+        header.focus();
+      }
+    }
+  };
+
   // Need to set submission data when going back
   window.onpopstate = e => {
     var _formState$page;
@@ -142,12 +156,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);
     }
   };
@@ -178,6 +203,11 @@ const InternalFormRenderer = _ref2 => {
     setHub(_utils.default.Hub.get(type, _hub, components, _objectSpread({}, data)));
   }, [type, _hub, data, components, setHub]);
 
+  // Set focus to heading for accessibility
+  (0, _react.useEffect)(() => {
+    setFocusToHeading();
+  }, [formState]);
+
   // Form state.
   (0, _react.useEffect)(() => {
     var _formState$page2;
@@ -189,17 +219,6 @@ const InternalFormRenderer = _ref2 => {
     setFormState(_helpers.default.getFormState(pageId, pages, hub));
   }, [pages, hub, pageId, setFormState, type, goingBack, data, formState.page]);
 
-  // page rendered page
-  (0, _react.useEffect)(() => {
-    if (document) {
-      const element = document.getElementsByTagName("h1")[0];
-      if (element) {
-        element.setAttribute("tabIndex", "-1");
-        element.focus();
-      }
-    }
-  }, [formState.page]);
-
   // Call the onFormLoad hook just when this component first renders.
   (0, _react.useEffect)(() => {
     setPagePoint(undefined);
@@ -306,7 +325,7 @@ const InternalFormRenderer = _ref2 => {
     actions: (_formState$page$actio = formState.page.actions) === null || _formState$page$actio === void 0 ? void 0 : _formState$page$actio.filter(action => _utils.default.Component.show(action, data))
   }, formState.cya, {
     onAction: action => {
-      (0, _onCYAAction.default)(setPagePoint, action, pages, validate, components, data, setData, type, pageId, currentTask, hooks, addErrors, hub, onPageChange, formState, submitting, setSubmitting);
+      (0, _onCYAAction.default)(setPagePoint, action, pages, validate, cleanseHiddenData, components, data, setData, type, pageId, currentTask, hooks, addErrors, hub, onPageChange, formState, submitting, setSubmitting);
     },
     onRowAction: onCYARowAction,
     summaryListClassModifiers: summaryListClassModifiers,
@@ -327,7 +346,7 @@ const InternalFormRenderer = _ref2 => {
     page: formState.page,
     pages: [].concat(pages),
     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, errors);
+      (0, _onPageAction.default)(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, cleanseHiddenData, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, errors);
     },
     onChange: onChange,
     hashLink: hashLink,
@@ -340,7 +359,7 @@ const InternalFormRenderer = _ref2 => {
     pages: pages,
     onCollectionChange: onChange,
     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, errors);
+      (0, _onPageAction.default)(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, cleanseHiddenData, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, errors);
     },
     hashLink: hashLink,
     classModifiers: formState.page.classModifiers,
@@ -374,6 +393,7 @@ const propTypes = {
   pages: _propTypes.default.arrayOf(_propTypes.default.shape({})).isRequired,
   summaryListClassModifiers: _propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.arrayOf(_propTypes.default.string)]),
   title: _propTypes.default.string,
+  cleanseHiddenData: _propTypes.default.bool,
   /** See <a href="/?path=/docs/f-json--page#formtypes">FormTypes</a>. */
   type: _propTypes.default.oneOf([_models.FormTypes.CYA, _models.FormTypes.FORM, _models.FormTypes.HUB, _models.FormTypes.TASK, _models.FormTypes.WIZARD, _models.FormTypes.TASK_CYA, _models.FormTypes.FORM_WITH_TASK]).isRequired,
   viewOnly: _propTypes.default.bool,
@@ -399,6 +419,7 @@ const defaultProps = {
   noChangeAction: false,
   summaryListClassModifiers: [],
   title: '',
+  cleanseHiddenData: false,
   viewOnly: true,
   hideBlankRows: false
 };

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/cop-reassign-task-to-rcc.json

@@ -1,4 +1,5 @@
 {
+    "cleanseHiddenData": true,
     "cya": {
         "actions": [
             {

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-containerised.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-dependent-component-nested-block.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-dependent-component-nested.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-refdata.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens-target-component-nested.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-component-show-whens.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-chained-show-whens-page-hidden.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-cop-airpax.json

@@ -1,4 +1,5 @@
 {
+  "cleanseHiddenData": true,
   "cya": {
       "actions": [
           {

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-cop-mandec.json

@@ -1,5 +1,6 @@
 {
   "name": "cop-make-your-mandatory-declarations",
+  "cleanseHiddenData": true,
   "title": "Make your mandatory declarations",
   "type": "form-with-task-list",
   "components": [

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-hidden-collection-component-dependent-on-external-data.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-hidden-component-show-when-in-component-and-page.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-hidden-component-with-nested-questions.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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/forms/form-hidden-multilevel-containerised-component-leaf-hidden.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-hidden-multilevel-containerised-component.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-hidden-page-component-used-elsewhere.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-hidden-page-same-component-reused.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

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

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/forms/form-nested-answers-hidden-by-option.json

@@ -1,5 +1,6 @@
 {
   "id": "example-form",
+  "cleanseHiddenData": true,
   "version": "0.0.1",
   "name": "example-form",
   "title": "Example form",