@ukhomeoffice/cop-react-form-renderer 6.15.7-alpha → 6.15.8-alpha

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

@@ -5,41 +5,44 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _mergeCollectionPages = _interopRequireDefault(require("../../../utils/CollectionPage/mergeCollectionPages"));
-var _deleteNodeByPath = _interopRequireDefault(require("./deleteNodeByPath"));
-var _Condition = _interopRequireDefault(require("../../../utils/Condition"));
+var Utils = _interopRequireWildcard(require("./clearOutUncompletedRoutesUtils"));
 var _optionIsSelected = _interopRequireDefault(require("../../../utils/Component/optionIsSelected"));
+function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
+function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } /* eslint-disable no-param-reassign */
-function removeObjectWithSingleIdFieldInPlace(array) {
-  for (let i = array.length - 1; i >= 0; i -= 1) {
-    const obj = array[i];
-    if (Object.keys(obj).length === 1 && Object.keys(obj)[0] === 'id') {
-      array.splice(i, 1); // Remove the object at index i
-    }
-  }
-}
-const getImmediateParent = path => {
-  if (typeof path !== 'string' || !path.includes('.')) {
-    return null;
+const addValue = (key, value, multiMap) => {
+  if (!multiMap.has(key)) {
+    multiMap.set(key, []);
   }
-  const parts = path.split('.');
-  parts.pop();
-  return parts.join('.');
+  multiMap.get(key).push(value);
 };
-
-/**
- * The nested fieldIds are placed in the payload at the same level in the heirarchy as the option question they relate to
- */
-const getNestedQuestionPath = (optionPath, nestedFieldId) => {
-  const parentPath = getImmediateParent(optionPath);
-  return parentPath ? "".concat(parentPath, ".").concat(nestedFieldId) : nestedFieldId;
+const pruneSingleComponent = (formData, path, component, componentsToKeep) => {
+  // If there is more than one entry for this component, then it is being used elsewhere in a visible page. Don't prune, but reduce the count by 1
+  if (componentsToKeep[path] > 1) {
+    componentsToKeep[path] -= 1;
+  } else {
+    var _component$data;
+    Utils.deleteNodeByPath(formData, 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 => {
+          Utils.deleteNodeByPath(formData, Utils.getNestedQuestionPath(path, nested.fieldId));
+        });
+      });
+    }
+  }
 };
+const toArray = value => Array.isArray(value) ? value : [value];
 const recursivelyMapFieldsAndDeleteHiddenNested = (page, component, path, allComponents, componentsToKeep, formData) => {
-  var _component$data;
+  var _component$data3;
   // Many component, such as warnings, html and details do not have data so we can ignore them
   if (!component.fieldId) return;
   path = path ? "".concat(path, ".").concat(component.fieldId) : component.fieldId;
@@ -50,143 +53,74 @@ const recursivelyMapFieldsAndDeleteHiddenNested = (page, component, path, allCom
   // add the fully qualified path to the component, which will be required when resolving the dependencies later
   component.path = path;
 
-  // If the parent page has a rule, this overides the component rule
-  if (page.show_when) component.show_when = page.show_when;
+  // If the parent page has a rule, combine it with any component rule
+  if (page.show_when) {
+    component.show_when = component.show_when ? [].concat(toArray(page.show_when), toArray(component.show_when)) : page.show_when;
+  }
 
-  // this is the master repository of all components
-  allComponents.set(path, component);
+  // this is the master repository of all components. Can be more than one component per path, so keep a map of <path, array>
+  addValue(path, component, allComponents);
   if (component.components) {
     component.components.forEach(c => {
       recursivelyMapFieldsAndDeleteHiddenNested(page, c, path, allComponents, componentsToKeep, formData);
     });
-  } else if (component !== null && component !== void 0 && (_component$data = component.data) !== null && _component$data !== void 0 && _component$data.options) {
-    var _component$data2;
+  } else if (component !== null && component !== void 0 && (_component$data3 = component.data) !== null && _component$data3 !== void 0 && _component$data3.options) {
+    var _component$data4;
     /**
      * Perform processing for any options, and any options containing nested questions.
      * - set hidden nested questions when the parent option is not selected
      * - any nested questions must be treated as components which can be shown/hidden
      */
-    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 => {
+    component === null || component === void 0 || (_component$data4 = component.data) === null || _component$data4 === void 0 || (_component$data4 = _component$data4.options) === null || _component$data4 === void 0 || _component$data4.forEach(option => {
       if (option.nested) {
         if (!(0, _optionIsSelected.default)(formData[component.id], option)) {
           option.nested.forEach(nestedComponent => {
             // It is safe to delete this now, as we know this data item can not be required as the associated option is not selected                     
-            (0, _deleteNodeByPath.default)(formData, getNestedQuestionPath(path, nestedComponent.fieldId));
+            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, getImmediateParent(path), allComponents, componentsToKeep, formData);
+            recursivelyMapFieldsAndDeleteHiddenNested(page, nestedComponent, Utils.getImmediateParent(path), allComponents, componentsToKeep, formData);
           });
         }
       }
     });
   }
 };
-const findShowWhenFields = (element, showWhenFields) => {
-  if (typeof element === 'object' && element !== null) {
-    if (Array.isArray(element)) {
-      element.forEach(value => {
-        findShowWhenFields(value, showWhenFields);
-      });
-    } else {
-      Object.keys(element).forEach(key => {
-        if (key === 'field') {
-          showWhenFields.push(element[key]);
-        }
-        findShowWhenFields(element[key], showWhenFields);
-      });
-    }
-  }
-  return showWhenFields;
-};
-function getDependencies(entity) {
-  let dependencies = null;
-  if (entity.show_when) {
-    var _findShowWhenFields;
-    // Set dependencies. Maybe multiple as show_whens can be compound and nested
-    dependencies = new Set();
-    const showWhenFields = [];
-    (_findShowWhenFields = findShowWhenFields(entity.show_when, showWhenFields)) === null || _findShowWhenFields === void 0 || _findShowWhenFields.forEach(showWhenField => {
-      dependencies.add(showWhenField);
-    });
-  }
-  return dependencies;
-}
-function addEntityToGraph(entity, componentDependencies, allDependencyRelationships) {
-  if (componentDependencies) {
-    allDependencyRelationships.set(entity.path, componentDependencies);
-  }
-}
 const recursivelyMapDependencies = (component, allDependencyRelationships) => {
   // Non data components can be ignored - can we remove this when doing the allcomponents thing?
   if (!component.fieldId) return;
-  const componentDependencies = getDependencies(component);
-  addEntityToGraph(component, componentDependencies, allDependencyRelationships);
+  const componentDependencies = Utils.getDependencies(component);
+  if (componentDependencies) {
+    // This path may already exist (if a component is defined twice in the form) so build up the dependencies
+    if (allDependencyRelationships.has(component.path)) {
+      const existingSet = allDependencyRelationships.get(component.path);
+      componentDependencies.forEach(dep => existingSet.add(dep));
+    } else {
+      allDependencyRelationships.set(component.path, new Set(componentDependencies));
+    }
+  }
   if (component.components) {
     component.components.forEach(c => {
       recursivelyMapDependencies(c, allDependencyRelationships);
     });
   }
 };
-/**
- * Some show_when field values point to data items that are within objects provided by external calls to refdata, eg modeOfTransport.id
- * These won't map directly to the path keyed components in allComponents, so go back up levels in the path until we find the component.
- * The neighbour component might not be found at all, as the dependency might be on a field that is either provided by cop-ui (eg jobHolderStaffDetails.linemanagerEmail), 
- * or by the "addToFormData" function (eg epmsSubmitted). These will be leaf level in a dependency chain so component is not required.
- */
-
-const getNeighbourObjectFromPath = (neighbourPath, allComponents) => {
-  const segments = neighbourPath.split(".");
-  for (let i = segments.length; i > 0; i -= 1) {
-    const currentPath = segments.slice(0, i).join(".");
-    const neighbour = allComponents.get(currentPath);
-    if (neighbour) return neighbour;
-  }
-  return null;
-};
-const isShowEntity = (entity, data) => {
-  var _entity$show_when;
-  // If there is no rule set, then the entity can be shown
-  if (!entity.show_when) {
-    return true;
-  }
-  if (((_entity$show_when = entity.show_when) === null || _entity$show_when === void 0 ? void 0 : _entity$show_when.type) === "or") {
-    return _Condition.default.meetsOne(entity, data);
-  }
-  return _Condition.default.meetsAll(entity, data);
-};
-const pruneSingleComponent = (formData, path, component, componentsToKeep) => {
-  // If there is more than one entry for this component, then it is being used elsewhere in a visible page. Don't prune, but reduce the count by 1
-  if (componentsToKeep[path] > 1) {
-    componentsToKeep[path] -= 1;
-  } else {
-    var _component$data3;
-    (0, _deleteNodeByPath.default)(formData, 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$data3 = component.data) !== null && _component$data3 !== void 0 && _component$data3.options) {
-      var _component$data4;
-      component === null || component === void 0 || (_component$data4 = component.data) === null || _component$data4 === void 0 || (_component$data4 = _component$data4.options) === null || _component$data4 === void 0 || _component$data4.forEach(option => {
-        var _option$nested;
-        (_option$nested = option.nested) === null || _option$nested === void 0 || _option$nested.forEach(nested => {
-          (0, _deleteNodeByPath.default)(formData, getNestedQuestionPath(path, nested.fieldId));
-        });
-      });
-    }
-  }
-};
 const recursivelyResolveDependencies = (visited, dependentEntity, dependencyRelationships, form, formData, allComponents, componentsToKeep, allCollections) => {
-  if (visited.has(dependentEntity.id)) return;
-  visited.add(dependentEntity.id);
+  if (visited.has(dependentEntity)) return;
+  visited.add(dependentEntity);
   const neighbours = dependencyRelationships.get(dependentEntity.path);
   neighbours === null || neighbours === void 0 || neighbours.forEach(neighbourPath => {
-    const neighbour = getNeighbourObjectFromPath(neighbourPath, allComponents);
-    if (neighbour) {
-      if (!visited.has(neighbour.id)) {
-        recursivelyResolveDependencies(visited, neighbour, dependencyRelationships, form, formData, allComponents, componentsToKeep, allCollections);
-      }
+    const neighbourArray = Utils.getDependencyObjectFromPath(neighbourPath, allComponents);
+    if (neighbourArray) {
+      neighbourArray.forEach(neighbour => {
+        if (!visited.has(neighbour)) {
+          recursivelyResolveDependencies(visited, neighbour, dependencyRelationships, form, formData, allComponents, componentsToKeep, allCollections);
+        }
+      });
     } else {
       // Refactor out helper methods
       const arrayNamePattern = /([a-zA-Z_$][\w$]*)\[\d+\]/;
@@ -208,38 +142,18 @@ const recursivelyResolveDependencies = (visited, dependentEntity, dependencyRela
     }
   });
   // Whilst unravelling the recursion, we can start pruning from the leaf upwards
-  if (!isShowEntity(dependentEntity, formData)) {
+  if (!Utils.isShowEntity(dependentEntity, formData)) {
     pruneSingleComponent(formData, dependentEntity.path, dependentEntity, componentsToKeep);
   }
 };
-const findComponentDefinitionInForm = (useComponentInPage, form) => {
-  var _ref, _form$components$find;
-  const componentInForm = (_ref = (_form$components$find = form.components.find(c => c.fieldId === useComponentInPage.use)) !== null && _form$components$find !== void 0 ? _form$components$find : form.components.find(c => c.id === useComponentInPage.use)) !== null && _ref !== void 0 ? _ref : useComponentInPage;
-  // Retun clone of component, so subsequent processing can make changes to it without changing the form
-  return JSON.parse(JSON.stringify(componentInForm));
-};
-const deleteCorrespondingMetaInfo = (component, collectionDataObject, formData) => {
-  const {
-    meta: {
-      documents
-    }
-  } = formData;
-  const fileDataBeingDeleted = collectionDataObject[component.fieldId];
-  if (!documents || !fileDataBeingDeleted) return;
-  const fileDataAsArray = Array.isArray(fileDataBeingDeleted) ? fileDataBeingDeleted : [fileDataBeingDeleted];
-  const metaDocumentIndex = documents.findIndex(document => fileDataAsArray.some(fileItem => document.url === fileItem.url));
-  if (metaDocumentIndex !== -1) {
-    documents.splice(metaDocumentIndex, 1);
-  }
-};
 const pruneCollectionEntry = (pathsToKeep, componentsToPrune, collectionDataObject, formData) => {
   componentsToPrune.forEach(component => {
     if (!pathsToKeep.has(component.fieldId)) {
       var _component$data5;
       if (component.type === "multifile") {
-        deleteCorrespondingMetaInfo(component, collectionDataObject, formData);
+        Utils.deleteCorrespondingMetaInfo(component, collectionDataObject, formData);
       }
-      (0, _deleteNodeByPath.default)(collectionDataObject, component.fieldId);
+      Utils.deleteNodeByPath(collectionDataObject, component.fieldId);
 
       // REFACTOR
       // 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.
@@ -248,42 +162,18 @@ const pruneCollectionEntry = (pathsToKeep, componentsToPrune, collectionDataObje
         component === null || component === void 0 || (_component$data6 = component.data) === null || _component$data6 === void 0 || (_component$data6 = _component$data6.options) === null || _component$data6 === void 0 || _component$data6.forEach(option => {
           var _option$nested2;
           (_option$nested2 = option.nested) === null || _option$nested2 === void 0 || _option$nested2.forEach(nested => {
-            (0, _deleteNodeByPath.default)(collectionDataObject, getNestedQuestionPath(component.fieldId, nested.fieldId));
+            Utils.deleteNodeByPath(collectionDataObject, Utils.getNestedQuestionPath(component.fieldId, nested.fieldId));
           });
         });
       }
     }
   });
 };
-function removeEmptyArraysAndUnusedCollectionIDs(payload) {
-  if (Array.isArray(payload)) {
-    for (let i = payload.length - 1; i >= 0; i -= 1) {
-      if (Array.isArray(payload[i]) && payload[i].length === 0) {
-        payload.splice(i, 1);
-      } else {
-        removeEmptyArraysAndUnusedCollectionIDs(payload[i]); // Recurse for nested structures
-      }
-    }
-  } else if (payload !== null && typeof payload === 'object') {
-    Object.keys(payload).forEach(key => {
-      if (Array.isArray(payload[key]) && payload[key].length === 0) {
-        // If the array being removed has an activeId associated with it, remove it
-        if (payload["".concat(key, "ActiveId")]) {
-          delete payload["".concat(key, "ActiveId")];
-          console.log("Deleted element : ".concat(key, "ActiveId}"));
-        }
-        delete payload["".concat(key, "ActiveId")];
-        if (payload[key]) {
-          delete payload[key];
-          console.log("Deleted element : ".concat(key));
-        }
-      } else {
-        removeEmptyArraysAndUnusedCollectionIDs(payload[key]); // Recurse for nested structures
-      }
-    });
-  }
-}
 const clearOutUncompletedRoutes = (form, formData) => {
+  // Load components into maps keyed on id and field for subsequent efficient access
+  const componentByIdMap = new Map(form.components.map(c => [c.id, c]));
+  const componentByFieldIdMap = new Map(form.components.map(c => [c.fieldId, c]));
+
   // Recurse through the whole form, building a map of all fields and their owning component id. 
   // This is required to build the component->dependency graph in the next step, as the dependencies reference fields, not components.
 
@@ -297,24 +187,29 @@ const clearOutUncompletedRoutes = (form, formData) => {
     } else {
       var _page$components;
       (_page$components = page.components) === null || _page$components === void 0 || _page$components.forEach(useComponentInPage => {
-        const componentObj = findComponentDefinitionInForm(useComponentInPage, form);
+        const componentObj = Utils.findComponentDefinitionInForm(useComponentInPage, componentByIdMap, componentByFieldIdMap);
         recursivelyMapFieldsAndDeleteHiddenNested(page, componentObj, null, allComponents, componentsToKeep, formData);
       });
     }
   });
   const allDependencyRelationships = new Map();
-  allComponents === null || allComponents === void 0 || allComponents.forEach(component => {
-    recursivelyMapDependencies(component, allDependencyRelationships);
+  allComponents === null || allComponents === void 0 || allComponents.forEach(componentArray => {
+    componentArray === null || componentArray === void 0 || componentArray.forEach(component => {
+      recursivelyMapDependencies(component, allDependencyRelationships);
+    });
   });
 
   // Visit all components with 'show_whens' and resolve the dependency. Only delete the data at the leaf element, or when un-winding the recursion
   // to deal with the edge case that an element is dependent on a data item that is hidden by a different constraint
   const visited = new Set();
   allDependencyRelationships === null || allDependencyRelationships === void 0 || allDependencyRelationships.forEach((neighbours, dependentEntityPath) => {
-    const dependentEntity = allComponents.get(dependentEntityPath);
-    if (!visited.has(dependentEntity.id)) {
-      recursivelyResolveDependencies(visited, dependentEntity, allDependencyRelationships, form, formData, allComponents, componentsToKeep, allCollections);
-    }
+    // Each path that a component is dependent on may have > 1 possible dependent components, if a field is used twice
+    const dependentEntities = allComponents.get(dependentEntityPath);
+    dependentEntities === null || dependentEntities === void 0 || dependentEntities.forEach(dependentEntity => {
+      if (!visited.has(dependentEntity)) {
+        recursivelyResolveDependencies(visited, dependentEntity, allDependencyRelationships, form, formData, allComponents, componentsToKeep, allCollections);
+      }
+    });
   });
   allCollections === null || allCollections === void 0 || allCollections.forEach((collection, collectionName) => {
     const collectionDataArray = formData[collectionName];
@@ -327,14 +222,14 @@ const clearOutUncompletedRoutes = (form, formData) => {
       const componentsToPrune = new Map();
       (_collection$childPage2 = collection.childPages) === null || _collection$childPage2 === void 0 || _collection$childPage2.forEach(childPage => {
         var _childPage$components;
-        const showPage = isShowEntity(childPage, dataForEvaluation);
+        const showPage = Utils.isShowEntity(childPage, dataForEvaluation);
         (_childPage$components = childPage.components) === null || _childPage$components === void 0 || _childPage$components.forEach(useComponentInPage => {
-          const componentObj = findComponentDefinitionInForm(useComponentInPage, form);
+          const componentObj = Utils.findComponentDefinitionInForm(useComponentInPage, componentByIdMap, componentByFieldIdMap);
 
           // Non-data components can be ignored (eg html)
           if (!componentObj.fieldId) return;
-          const showComponentOnPage = isShowEntity(useComponentInPage, dataForEvaluation);
-          if (showPage && showComponentOnPage && isShowEntity(componentObj, dataForEvaluation)) {
+          const showComponentOnPage = Utils.isShowEntity(useComponentInPage, dataForEvaluation);
+          if (showPage && showComponentOnPage && Utils.isShowEntity(componentObj, dataForEvaluation)) {
             // There may be 2 components with the same path (eg quantity in EAB2), so don't delete hidden components if they are required elsewhere
             pathsToKeep.add(componentObj.fieldId);
           } else {
@@ -344,10 +239,10 @@ const clearOutUncompletedRoutes = (form, formData) => {
       });
       pruneCollectionEntry(pathsToKeep, componentsToPrune, collectionDataEntry, formData);
     });
-    // Pruning this collection 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
-    if (collectionDataArray) removeObjectWithSingleIdFieldInPlace(collectionDataArray);
+    // 
+    if (collectionDataArray) Utils.removeObjectWithSingleIdFieldInPlace(collectionDataArray);
   });
-  removeEmptyArraysAndUnusedCollectionIDs(formData);
+  Utils.removeEmptyArraysAndUnusedCollectionIDs(formData);
   return formData;
 };
 var _default = exports.default = clearOutUncompletedRoutes;