@ukhomeoffice/cop-react-form-renderer 6.15.15 → 6.15.16

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/input/data-hidden-component-with-nested-questions-visible-elsewhere.json

@@ -0,0 +1,12 @@
+{
+  "type": "Example form",
+  "alpha": "alpha-value",
+  "bravo": "bravo-value",
+  "person": {
+    "telephoneKnown": "yes",
+    "telephone": "telephone-value",
+    "name":"name-value"
+  },
+  "gamma": "gamma-value",
+  "epsilon": "epsilon-value"
+}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/input/data-nested-answers-hidden-by-option-visible-elsewhere.json

@@ -0,0 +1,12 @@
+{
+  "type": "Example form",
+  "alpha": "alpha-value",
+  "bravo": "bravo-value",
+  "person": {
+    "telephoneKnown": "no",
+    "telephone": "telephone-value",
+    "name":"name-value"
+  },
+  "gamma": "gamma-value",
+  "epsilon": "epsilon-value"
+}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/input/data-page-nested-component.json

@@ -0,0 +1,63 @@
+{
+    "id": "aa767e34-3624-11f0-a073-1a2af3427453",
+    "businessKey": "DEV-20250521-906",
+    "port": {
+        "id": 1639,
+        "name": "Dover",
+        "sea": true,
+        "air": false,
+        "land": false,
+        "rail": false,
+        "countryid": 234,
+        "iata": null,
+        "value": "1639",
+        "label": "Dover",
+        "hint": ""
+    },
+    "modeOfTransport": {
+        "id": 9,
+        "mode": "RoRo Tourist",
+        "modecode": "rorotour",
+        "crossingtype": [
+            "sea"
+        ],
+        "value": "RoRo Tourist",
+        "label": "RoRo Tourist"
+    },
+    "whatHappened": "roroItemsFootPassenger",
+    "peopleActiveId": "16cfee4e-f345-4b29-883f-0ad6877d492c",
+    "people": [
+        {
+            "id": "16cfee4e-f345-4b29-883f-0ad6877d492c",
+            "hasIdentityDocuments": [
+                "no"
+            ],
+            "arrested": "yes",
+            "claimedGivenNames": "Robert",
+            "claimedSurname": "test",
+            "estimatedDob": "27-8-1982",
+            "claimedCountryOfBirth": {
+                "id": 2,
+                "name": "Afghanistan",
+                "iso31661alpha3": "AFG",
+                "value": "2",
+                "label": "Afghanistan",
+                "hint": ""
+            },
+            "howDidYouVerifyTheirIdentity": "TEST",
+            "noAddresses": "Person has no addresses",
+            "noAddressDetails": [
+                "none"
+            ],
+            "travellingRole": {
+                "id": 6,
+                "roletype": "Driver",
+                "value": "6",
+                "label": "Driver",
+                "hint": ""
+            },
+            "governmentOrBorderForceEmployee": "no",
+            "personSearched": "no"
+        }
+    ]
+}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/output/data-hidden-component-with-nested-questions-visible-elsewhere-removed.json

@@ -0,0 +1,11 @@
+{
+  "type": "Example form",
+  "alpha": "alpha-value",
+  "bravo": "bravo-value",
+  "person": {
+    "telephone": "telephone-value",
+    "name":"name-value"
+  },
+  "gamma": "gamma-value",
+  "epsilon": "epsilon-value"
+}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/output/data-nested-answers-hidden-by-option-visible-elsewhere-removed.json

@@ -0,0 +1,12 @@
+{
+  "type": "Example form",
+  "alpha": "alpha-value",
+  "bravo": "bravo-value",
+  "person": {
+    "telephoneKnown": "no",
+    "telephone": "telephone-value",
+    "name":"name-value"
+  },
+  "gamma": "gamma-value",
+  "epsilon": "epsilon-value"
+}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/output/data-page-nested-component.json

@@ -0,0 +1,63 @@
+{
+    "id": "aa767e34-3624-11f0-a073-1a2af3427453",
+    "businessKey": "DEV-20250521-906",
+    "port": {
+        "id": 1639,
+        "name": "Dover",
+        "sea": true,
+        "air": false,
+        "land": false,
+        "rail": false,
+        "countryid": 234,
+        "iata": null,
+        "value": "1639",
+        "label": "Dover",
+        "hint": ""
+    },
+    "modeOfTransport": {
+        "id": 9,
+        "mode": "RoRo Tourist",
+        "modecode": "rorotour",
+        "crossingtype": [
+            "sea"
+        ],
+        "value": "RoRo Tourist",
+        "label": "RoRo Tourist"
+    },
+    "whatHappened": "roroItemsFootPassenger",
+    "peopleActiveId": "16cfee4e-f345-4b29-883f-0ad6877d492c",
+    "people": [
+        {
+            "id": "16cfee4e-f345-4b29-883f-0ad6877d492c",
+            "hasIdentityDocuments": [
+                "no"
+            ],
+            "arrested": "yes",
+            "claimedGivenNames": "Robert",
+            "claimedSurname": "test",
+            "estimatedDob": "27-8-1982",
+            "claimedCountryOfBirth": {
+                "id": 2,
+                "name": "Afghanistan",
+                "iso31661alpha3": "AFG",
+                "value": "2",
+                "label": "Afghanistan",
+                "hint": ""
+            },
+            "howDidYouVerifyTheirIdentity": "TEST",
+            "noAddresses": "Person has no addresses",
+            "noAddressDetails": [
+                "none"
+            ],
+            "travellingRole": {
+                "id": 6,
+                "roletype": "Driver",
+                "value": "6",
+                "label": "Driver",
+                "hint": ""
+            },
+            "governmentOrBorderForceEmployee": "no",
+            "personSearched": "no"
+        }
+    ]
+}

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

@@ -42,6 +42,7 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 const createComponentMapsFromForm = (condensedPages, componentByIdMap, componentByFieldIdMap, formData) => {
   const allComponents = new Map();
   const componentsToKeep = {};
+  const unselectedOptionsNestedPaths = [];
   const allCollections = new Map();
 
   /*
@@ -68,20 +69,14 @@ const createComponentMapsFromForm = (condensedPages, componentByIdMap, component
       var _component$data2;
       component === null || component === void 0 || (_component$data2 = component.data) === null || _component$data2 === void 0 || (_component$data2 = _component$data2.options) === null || _component$data2 === void 0 || _component$data2.forEach(option => {
         if (option.nested) {
-          // in container need to use the JPath for the data since the field that the component is looking at is nested in the container.
-          if (!(0, _optionIsSelected.default)((0, _getSourceData.default)(formData, path), option)) {
-            option.nested.forEach(nestedComponent => {
-              // delete hidden nested question payload items when the parent option is not selected
-              Utils.deleteNodeByPath(formData, Utils.getNestedQuestionPath(path, nestedComponent.fieldId));
-            });
-          } else {
-            // If the option is selected, then add any nested components to the allComponents list. If the nested block has a show_when, pass it down to the child questions                        
-            const blockShowWhen = option.show_when;
-            option.nested.forEach(nestedComponent => {
-              if (blockShowWhen) nestedComponent.show_when = blockShowWhen;
-              recursivelyMapFieldsAndDeleteHiddenNested(page, nestedComponent, Utils.getImmediateParent(path), allComponents, componentsToKeep, formData);
-            });
-          }
+          const unselectedOption = !(0, _optionIsSelected.default)((0, _getSourceData.default)(formData, path), option);
+          const blockShowWhen = option.show_when;
+          option.nested.forEach(nestedComponent => {
+            // prepare to delete hidden nested question payload items when the parent option is not selected
+            if (unselectedOption) unselectedOptionsNestedPaths.push(Utils.getNestedQuestionPath(path, nestedComponent.fieldId));
+            if (blockShowWhen) nestedComponent.show_when = blockShowWhen;
+            recursivelyMapFieldsAndDeleteHiddenNested(page, nestedComponent, Utils.getImmediateParent(path), allComponents, componentsToKeep, formData);
+          });
         }
       });
     }
@@ -100,6 +95,14 @@ const createComponentMapsFromForm = (condensedPages, componentByIdMap, component
       });
     }
   });
+  // Now delete all the unselected options, if they are not used elsewhere
+  unselectedOptionsNestedPaths.forEach(path => {
+    if (componentsToKeep[path] > 1) {
+      componentsToKeep[path] -= 1;
+    } else {
+      Utils.deleteNodeByPath(formData, path);
+    }
+  });
   return {
     allComponents,
     componentsToKeep,

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

@@ -31,9 +31,15 @@ var _dataHiddenOptionsRemoved = _interopRequireDefault(require("../clear-uncompl
 var _formHiddenComponentWithNestedQuestions = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-hidden-component-with-nested-questions.json"));
 var _dataHiddenComponentWithNestedQuestions = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-hidden-component-with-nested-questions.json"));
 var _dataHiddenComponentWithNestedQuestionsRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-hidden-component-with-nested-questions-removed.json"));
+var _formHiddenComponentWithNestedQuestionsVisibleElsewhere = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-hidden-component-with-nested-questions-visible-elsewhere.json"));
+var _dataHiddenComponentWithNestedQuestionsVisibleElsewhere = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-hidden-component-with-nested-questions-visible-elsewhere.json"));
+var _dataHiddenComponentWithNestedQuestionsVisibleElsewhereRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-hidden-component-with-nested-questions-visible-elsewhere-removed.json"));
 var _formNestedAnswersHiddenByOption = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-nested-answers-hidden-by-option.json"));
 var _dataNestedAnswersHiddenByOption = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-nested-answers-hidden-by-option.json"));
 var _dataNestedAnswersHiddenByOptionRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-nested-answers-hidden-by-option-removed.json"));
+var _formNestedAnswersHiddenByOptionVisibleElsewhere = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-nested-answers-hidden-by-option-visible-elsewhere.json"));
+var _dataNestedAnswersHiddenByOptionVisibleElsewhere = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-nested-answers-hidden-by-option-visible-elsewhere.json"));
+var _dataNestedAnswersHiddenByOptionVisibleElsewhereRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-nested-answers-hidden-by-option-visible-elsewhere-removed.json"));
 var _formHiddenPage = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-hidden-page.json"));
 var _dataHiddenPage = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-hidden-page.json"));
 var _dataHiddenPageRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-hidden-page-removed.json"));
@@ -99,6 +105,9 @@ var _copAirpaxCarrier = _interopRequireDefault(require("../clear-uncompleted-rou
 var _formPageNestedRadioComponent = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-page-nested-radio-component.json"));
 var _dataPageNestedRadioComponent = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-page-nested-radio-component.json"));
 var _dataPageNestedRadioComponentRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-page-nested-radio-component-removed.json"));
+var _formPageNestedComponent = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-page-nested-component.json"));
+var _dataPageNestedComponent = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/data-page-nested-component.json"));
+var _dataPageNestedComponent2 = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/output/data-page-nested-component.json"));
 var _formVarianceBreach = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/forms/form-variance-breach.json"));
 var _copVarianceBreachWithUploadFiles = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/input/cop-variance-breach-with-upload-files.json"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
@@ -122,8 +131,12 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
 
 // Nested questions within options inside a hidden component
 
+// Nested questions within options inside a hidden component, but one nested path visible elsewhere
+
 // Nested options inside a visible component, but answers don't align with option selected
 
+// Nested options inside a visible component, answers don't align with option selected, but path visible elsewhere
+
 // Hidden page
 
 // Hidden page containing same component reused
@@ -243,12 +256,24 @@ describe('FormRenderer', () => {
         const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
         expect(result).toEqual(_dataHiddenComponentWithNestedQuestionsRemoved.default);
       });
+      it('should NOT remove hidden component with nested questions in options when same path is visible elsewhere.', () => {
+        const submissionData = JSON.parse(JSON.stringify(_dataHiddenComponentWithNestedQuestionsVisibleElsewhere.default));
+        const form = JSON.parse(JSON.stringify(_formHiddenComponentWithNestedQuestionsVisibleElsewhere.default));
+        const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
+        expect(result).toEqual(_dataHiddenComponentWithNestedQuestionsVisibleElsewhereRemoved.default);
+      });
       it('should remove answers associated with unselected options in a containerised component.', () => {
         const submissionData = JSON.parse(JSON.stringify(_dataNestedAnswersHiddenByOption.default));
         const form = JSON.parse(JSON.stringify(_formNestedAnswersHiddenByOption.default));
         const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
         expect(result).toEqual(_dataNestedAnswersHiddenByOptionRemoved.default);
       });
+      it('should NOT remove answers associated with unselected options in a containerised component if component visible elsewhere.', () => {
+        const submissionData = JSON.parse(JSON.stringify(_dataNestedAnswersHiddenByOptionVisibleElsewhere.default));
+        const form = JSON.parse(JSON.stringify(_formNestedAnswersHiddenByOptionVisibleElsewhere.default));
+        const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
+        expect(result).toEqual(_dataNestedAnswersHiddenByOptionVisibleElsewhereRemoved.default);
+      });
       it('should remove hidden page.', () => {
         const submissionData = JSON.parse(JSON.stringify(_dataHiddenPage.default));
         const form = JSON.parse(JSON.stringify(_formHiddenPage.default));
@@ -397,6 +422,12 @@ describe('FormRenderer', () => {
         const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
         expect(result).toEqual(_dataPageNestedRadioComponentRemoved.default);
       });
+      it('should handle not removing the field if its used both nested option and a separate component.', () => {
+        const submissionData = JSON.parse(JSON.stringify(_dataPageNestedComponent.default));
+        const form = JSON.parse(JSON.stringify(_formPageNestedComponent.default));
+        const result = _index.default.clearOutUncompletedRoutes(true, form, submissionData);
+        expect(result).toEqual(_dataPageNestedComponent2.default);
+      });
     });
   });
 });

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

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.toArray = exports.removeObjectWithOnlySingleIdField = exports.removeEmptyArraysAndUnusedCollectionIDs = exports.pruneCollectionEntry = exports.isShowEntity = exports.getNestedQuestionPath = exports.getImmediateParent = exports.getDependencyObjectFromPath = exports.getDependencies = exports.findComponentDefinitionInForm = exports.deleteNodeByPath = exports.deleteNodeAndOptions = exports.deleteCorrespondingMetaInfo = exports.deleteComponentData = exports.addValue = void 0;
+exports.toArray = exports.removeObjectWithOnlySingleIdField = exports.removeEmptyArraysAndUnusedCollectionIDs = exports.pruneCollectionEntry = exports.iterateOptions = exports.isShowEntity = exports.getNestedQuestionPath = exports.getImmediateParent = exports.getDependencyObjectFromPath = exports.getDependencies = exports.findComponentDefinitionInForm = exports.deleteNodeByPath = exports.deleteCorrespondingMetaInfo = exports.deleteComponentData = exports.addValue = void 0;
 var _Condition = _interopRequireDefault(require("../../../utils/Condition"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /* eslint-disable no-param-reassign */
@@ -85,36 +85,6 @@ const getNestedQuestionPath = (optionPath, nestedFieldId) => {
   return parentPath ? "".concat(parentPath, ".").concat(nestedFieldId) : nestedFieldId;
 };
 
-/** 
- * If the component has options, go through each option removing the data for any nested fields. 
- * Required as nested options are in the payload at the same heirarchical level.
- * 
- * There are occasions when a field shouldn't be removed from the payload, eg if a form is being used for 2 purposes
- * eg the cop-reassign-task-to-rcc.json, and the field is only being hidden for display purposes. Allow these fields
- * to be preserved with a property on the component.
-
- * @param {Object} payload Javascript object from which the node will be deleted. Updated by the method.
- * @param {String} path A string containing a decimal point delimited path specifying the node to delete.
- * @param {Object} component The form component representing the path being deleted
- * @return {void}, obj above updated.
- */
-exports.getNestedQuestionPath = getNestedQuestionPath;
-const deleteNodeAndOptions = (payload, path, component) => {
-  var _component$data;
-  if (component.preserveInPayload) return;
-  deleteNodeByPath(payload, path);
-  // If the component has options, go through each option removing the data for any nested fields. Required as nested options are in the payload at the same heirarchical level.
-  if (component !== null && component !== void 0 && (_component$data = component.data) !== null && _component$data !== void 0 && _component$data.options) {
-    var _component$data2;
-    component === null || component === void 0 || (_component$data2 = component.data) === null || _component$data2 === void 0 || (_component$data2 = _component$data2.options) === null || _component$data2 === void 0 || _component$data2.forEach(option => {
-      var _option$nested;
-      (_option$nested = option.nested) === null || _option$nested === void 0 || _option$nested.forEach(nested => {
-        deleteNodeByPath(payload, getNestedQuestionPath(path, nested.fieldId));
-      });
-    });
-  }
-};
-
 /**
  * Pruning a collection payload may have resulted in objects that are only left with their 'id' field, which isn't data 
  * but added by the renderer to find the activeId. If so, remove these objects entirely as they have been pruned.
@@ -122,7 +92,7 @@ const deleteNodeAndOptions = (payload, path, component) => {
  * @param {Array} array Array of objects. Each object which has only 1 remaining field called 'id' should be removed.
  * @return {void}, array above updated.
  */
-exports.deleteNodeAndOptions = deleteNodeAndOptions;
+exports.getNestedQuestionPath = getNestedQuestionPath;
 const removeObjectWithOnlySingleIdField = array => {
   for (let i = array.length - 1; i >= 0; i -= 1) {
     const obj = array[i];
@@ -333,6 +303,24 @@ const removeEmptyArraysAndUnusedCollectionIDs = payload => {
   }
 };
 
+/** 
+ * Helper method to go through each option calling a passed in function for any nested fields. 
+ * @param {Object} component The form component representing the path being deleted
+ * @param {Function} action The action to perform on each nested question. Varies for collections and non-collections
+ * @return {void}, obj above updated.
+ */
+exports.removeEmptyArraysAndUnusedCollectionIDs = removeEmptyArraysAndUnusedCollectionIDs;
+const iterateOptions = (component, action) => {
+  var _component$data;
+  if (component !== null && component !== void 0 && (_component$data = component.data) !== null && _component$data !== void 0 && _component$data.options) {
+    var _component$data2;
+    component === null || component === void 0 || (_component$data2 = component.data) === null || _component$data2 === void 0 || (_component$data2 = _component$data2.options) === null || _component$data2 === void 0 || _component$data2.forEach(option => {
+      var _option$nested;
+      (_option$nested = option.nested) === null || _option$nested === void 0 || _option$nested.forEach(action);
+    });
+  }
+};
+
 /**
  * Delete a component's payload item from the overall payload.
  * A component can be defined in >1 places in the form spec. To cater for this, 
@@ -348,12 +336,23 @@ const removeEmptyArraysAndUnusedCollectionIDs = payload => {
  * @param {*} component The component whose data we should attempt to delete
  * @param {*} componentsToKeep A list of all components with a count of their number of uses in the form
  */
-exports.removeEmptyArraysAndUnusedCollectionIDs = removeEmptyArraysAndUnusedCollectionIDs;
+exports.iterateOptions = iterateOptions;
 const deleteComponentData = (payload, path, component, componentsToKeep) => {
   if (componentsToKeep[path] > 1) {
     componentsToKeep[path] -= 1;
   } else {
-    deleteNodeAndOptions(payload, path, component);
+    if (component.preserveInPayload) return;
+    deleteNodeByPath(payload, path);
+
+    // If the component has options, go through each option removing the data for any nested fields. Required as nested options are in the payload at the same heirarchical level.
+    iterateOptions(component, nested => {
+      const nestedQuestionPath = getNestedQuestionPath(path, nested.fieldId);
+      if (componentsToKeep[nestedQuestionPath] > 1) {
+        componentsToKeep[nestedQuestionPath] -= 1;
+      } else {
+        deleteNodeByPath(payload, nestedQuestionPath);
+      }
+    });
   }
 };
 
@@ -361,6 +360,7 @@ const deleteComponentData = (payload, path, component, componentsToKeep) => {
  * 
  * Takes a single page collection payload object and removes the payload items specified in the componentsToPrune list
  * as long as they don't appear in the componentsToKeep list.
+ * 
  * Additionally, if the component type is multifile, remove the corresponding data entries that will have been created 
  * in the meta section of the payload by the form renderer.
  * 
@@ -376,7 +376,16 @@ const pruneCollectionEntry = (pathsToKeep, componentsToPrune, collectionDataObje
       if (component.type === "multifile") {
         deleteCorrespondingMetaInfo(component, collectionDataObject, formData);
       }
-      deleteNodeAndOptions(collectionDataObject, component.fieldId, component);
+      if (component.preserveInPayload) return;
+      deleteNodeByPath(collectionDataObject, component.fieldId);
+
+      // If the component has options, go through each option removing the data for any nested fields. Required as nested options are in the payload at the same heirarchical level.
+      iterateOptions(component, nested => {
+        const nestedQuestionPath = getNestedQuestionPath(component.fieldId, nested.fieldId);
+        if (!pathsToKeep.has(nestedQuestionPath)) {
+          deleteNodeByPath(collectionDataObject, nestedQuestionPath);
+        }
+      });
     }
   });
 };

package/package.json

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