@ukhomeoffice/cop-react-form-renderer 6.15.9-alpha → 6.15.9-delta

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

@@ -28,7 +28,7 @@ const addValue = (key, value, multiMap) => {
  * 
  * @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.
- * @return Nothing, obj above updated.
+ * @return {void}, obj above updated.
  */
 exports.addValue = addValue;
 const deleteNodeByPath = (payload, path) => {
@@ -88,15 +88,20 @@ const getNestedQuestionPath = (optionPath, 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 Nothing, obj above updated.
+ * @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) {
@@ -115,7 +120,7 @@ const deleteNodeAndOptions = (payload, path, component) => {
  * but added by the renderer to find the activeId. If so, remove these objects entirely as they have been pruned.
  * 
  * @param {Array} array Array of objects. Each object which has only 1 remaining field called 'id' should be removed.
- * @return Nothing, array above updated.
+ * @return {void}, array above updated.
  */
 exports.deleteNodeAndOptions = deleteNodeAndOptions;
 const removeObjectWithOnlySingleIdField = array => {
@@ -238,11 +243,13 @@ exports.isShowEntity = isShowEntity;
 const findComponentDefinitionInForm = (pageComponentDef, componentByIdMap, componentByFieldIdMap) => {
   var _ref, _componentByIdMap$get;
   const componentInForm = (_ref = (_componentByIdMap$get = componentByIdMap.get(pageComponentDef.use)) !== null && _componentByIdMap$get !== void 0 ? _componentByIdMap$get : componentByFieldIdMap.get(pageComponentDef.use)) !== null && _ref !== void 0 ? _ref : pageComponentDef;
+
+  // Create clone of component, so processing can make changes to it without changing the form
+  const componentInFormClone = JSON.parse(JSON.stringify(componentInForm));
   if (pageComponentDef.use && pageComponentDef.show_when) {
-    componentInForm.show_when = pageComponentDef.show_when;
+    componentInFormClone.show_when = pageComponentDef.show_when;
   }
-  // Retun clone of component, so subsequent processing can make changes to it without changing the form
-  return JSON.parse(JSON.stringify(componentInForm));
+  return componentInFormClone;
 };
 
 /**
@@ -254,7 +261,7 @@ const findComponentDefinitionInForm = (pageComponentDef, componentByIdMap, compo
  * @param {*} component The component definition being deleted that needs corresponding meta data also deleted
  * @param {*} collectionDataObject The payload containing the file data being deleted (for which the corresponding meta needs deleting)
  * @param {*} formData The entire payload, which will include the meta section
- * @returns Nothing, as the formData will be updated in situ
+ * @returns {void}, as the formData will be updated in situ
  */
 exports.findComponentDefinitionInForm = findComponentDefinitionInForm;
 const deleteCorrespondingMetaInfo = (component, collectionDataObject, formData) => {
@@ -335,6 +342,7 @@ const removeEmptyArraysAndUnusedCollectionIDs = payload => {
  * When the counter reaches 1 we know all other occurences of the component have been resolved
  * so it is safe to delete.
  * 
+ * 
  * @param {*} payload The form payload from which to delete the component data
  * @param {*} path The payload path of the component
  * @param {*} component The component whose data we should attempt to delete

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/Component/getComponentTests/getComponent.multifile.test.js

@@ -23,7 +23,8 @@ describe('utils.Component.get', () => {
       fieldId: FIELD_ID,
       label: LABEL,
       onChange: ON_CHANGE,
-      'data-testid': ID
+      'data-testid': ID,
+      allowedTypes: []
     };
     const {
       container

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.15.9-alpha",
+  "version": "6.15.9-delta",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,12 +16,12 @@
     "yalc-publish": "yarn compile-with-maps && cp -r src dist/src && yalc publish --push"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "4.7.11",
+    "@ukhomeoffice/cop-react-components": "4.7.16",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^5.0.0",
-    "web-vitals": "^1.0.1",
-    "uuid": "^8.1.0"
+    "uuid": "^8.1.0",
+    "web-vitals": "^1.0.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.15.4",