@ukhomeoffice/cop-react-form-renderer 6.0.6-peter → 6.7.0-alpha

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/form-for-nested-components.json

@@ -1,96 +0,0 @@
-{
-  "id": "example-form",
-  "version": "0.0.1",
-  "name": "example-form",
-  "title": "Example form",
-  "type": "form",
-  "components": [
-    {
-      "id": "alpha",
-      "fieldId": "alpha",
-      "label": "Alpha",
-      "type": "text"
-    },
-    {
-      "id": "bravo",
-      "fieldId": "bravo",
-      "label": "Bravo",
-      "type": "text"
-    },
-    {
-      "id": "person",
-      "fieldId": "person",
-      "type": "container",
-      "components": [
-        {
-          "id": "charlie",
-          "fieldId": "charlie",
-          "label": "Charlie",
-          "type": "text",
-          "show_when": {
-            "op": "=",
-            "field": "bravo",
-            "value": "bravo"
-          }
-        },
-        {
-          "id": "delta",
-          "fieldId": "delta",
-          "label": "Delta",
-          "type": "text",
-          "show_when": {
-            "op": "=",
-            "field": "bravo",
-            "value": "another"
-          }
-        }
-      ]
-    },
-    {
-      "id": "gamma",
-      "fieldId": "gamma",
-      "label": "Gamma",
-      "type": "text"
-    },
-    {
-      "id": "epsilon",
-      "fieldId": "epsilon",
-      "label": "Epsilon",
-      "type": "text"
-    }
-  ],
-  "pages": [
-    {
-      "id": "general",
-      "name": "general",
-      "title": "General information",
-      "components": [
-        {
-          "use": "alpha"
-        },
-        {
-          "use": "bravo"
-        },
-        {
-          "use": "person"
-        },
-        {
-          "use": "gamma"
-        },
-        {
-          "use": "epsilon"
-        }
-      ],
-      "actions": [
-        "submit",
-        {
-          "type": "cancel",
-          "page": "",
-          "validate": false,
-          "classModifiers": "secondary",
-          "label": "Cancel"
-        }
-      ]
-    }
-  ]
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/form-with-collections-delete-entire.json

@@ -1,47 +0,0 @@
-{
-  "name": "form-with-collection",
-  "components": [
-    {
-      "id": "componentA",
-      "fieldId": "componentA"
-    },
-    {
-      "id": "itemCategory",
-      "fieldId": "itemCategory"
-    }
-  ],
-  "pages": [
-    {
-      "id": "pageA",
-      "name": "Page A",
-      "components": [
-        {
-          "use": "componentA"
-        }
-      ]
-    },
-    {
-      "id": "pageB",
-      "deleteCollectionWhenHidden": true,
-      "collection": {
-        "name": "componentAs",
-        "labels": {
-          "item": "Component A ${index}"
-        }
-      },
-      "name": "pageB",
-      "show_when": [
-        {
-          "op": "=",
-          "field": "componentA",
-          "value": true
-        }
-      ],
-      "components": [
-        {
-          "use": "itemCategory"
-        }
-      ]
-    }
-  ]
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/form-with-collections.json

@@ -1,46 +0,0 @@
-{
-  "name": "form-with-collection",
-  "components": [
-    {
-      "id": "componentA",
-      "fieldId": "componentA"
-    },
-    {
-      "id": "itemCategory",
-      "fieldId": "itemCategory"
-    }
-  ],
-  "pages": [
-    {
-      "id": "pageA",
-      "name": "Page A",
-      "components": [
-        {
-          "use": "componentA"
-        }
-      ]
-    },
-    {
-      "id": "pageB",
-      "collection": {
-        "name": "componentAs",
-        "labels": {
-          "item": "Component A ${index}"
-        }
-      },
-      "name": "pageB",
-      "show_when": [
-        {
-          "op": "=",
-          "field": "componentA",
-          "value": true
-        }
-      ],
-      "components": [
-        {
-          "use": "itemCategory"
-        }
-      ]
-    }
-  ]
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/form-with-components.json

@@ -1,48 +0,0 @@
-{
-  "name": "form-with-components",
-  "components": [
-    {
-      "id": "componentA",
-      "fieldId": "componentA"
-    },
-    {
-      "id": "componentB",
-      "fieldId": "componentB",
-      "show_when": [
-        {
-          "op": "=",
-          "field": "componentA",
-          "value": "show"
-        }
-      ]
-    },
-    {
-      "id": "componentC",
-      "fieldId": "componentC",
-      "show_when": [
-        {
-          "op": "=",
-          "field": "componentA",
-          "value": "show"
-        }
-      ]
-    }
-  ],
-  "pages": [
-    {
-      "id": "pageA",
-      "name": "Page A",
-      "components": [
-        {
-          "use": "componentA"
-        },
-        {
-          "use": "componentB"
-        },
-        {
-          "use": "componentC"
-        }
-      ]
-    }
-  ]
-}

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

@@ -1,175 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-var _showComponent = _interopRequireDefault(require("../../../utils/Component/showComponent"));
-var _mergeCollectionPages = _interopRequireDefault(require("../../../utils/CollectionPage/mergeCollectionPages"));
-var _deleteNodeByPath = _interopRequireDefault(require("./deleteNodeByPath"));
-var _optionIsSelected = _interopRequireDefault(require("../../../utils/Component/optionIsSelected"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-/* eslint-disable no-param-reassign */
-
-var recurseCheckForHiddenComponents = function recurseCheckForHiddenComponents(component, formData, path, candidateComponentForDeletion) {
-  path = path ? "".concat(path, ".").concat(component.fieldId) : component.fieldId;
-  if (component) {
-    if (component.components) {
-      var _component$components;
-      (_component$components = component.components) === null || _component$components === void 0 || _component$components.forEach(function (c) {
-        recurseCheckForHiddenComponents(c, formData, path, candidateComponentForDeletion);
-      });
-    } else if ((0, _showComponent.default)(component, formData)) {
-      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(function (option) {
-          if (!(0, _optionIsSelected.default)(formData[component.id], option) && option.nested) {
-            option.nested.forEach(function (nested) {
-              path = nested.fieldId;
-              if (path) {
-                candidateComponentForDeletion.set(path, component);
-              }
-            });
-          }
-        });
-      }
-    } else if (!(0, _showComponent.default)(component, formData)) {
-      if (path) {
-        candidateComponentForDeletion.set(path, component);
-      }
-    }
-  }
-};
-var buildListOfComponentsUsedInVisiblePages = function buildListOfComponentsUsedInVisiblePages(page, form, formData, componentsUsedInVisiblePagesIds) {
-  var _page$components;
-  (_page$components = page.components) === null || _page$components === void 0 || _page$components.forEach(function (component) {
-    var _ref, _form$components$find;
-    var componentObj = (_ref = (_form$components$find = form.components.find(function (c) {
-      return c.fieldId === component.use;
-    })) !== null && _form$components$find !== void 0 ? _form$components$find : form.components.find(function (c) {
-      return c.id === component.use;
-    })) !== null && _ref !== void 0 ? _ref : component;
-    if (page && (0, _showComponent.default)(page, formData)) {
-      if (componentObj && (0, _showComponent.default)(componentObj, formData)) {
-        if (componentObj.fieldId) {
-          componentsUsedInVisiblePagesIds.push(componentObj.fieldId);
-        } else if (componentObj.id) {
-          componentsUsedInVisiblePagesIds.push(componentObj.id);
-        }
-      }
-    }
-  });
-};
-var recurseDeleteComponents = function recurseDeleteComponents(component, formData, path, checkIfComponentHidden) {
-  path = path ? "".concat(path, ".").concat(component.fieldId) : component.fieldId;
-  if (component) {
-    if (component.components) {
-      var _component$components2;
-      (_component$components2 = component.components) === null || _component$components2 === void 0 || _component$components2.forEach(function (c) {
-        recurseDeleteComponents(c, formData, path, checkIfComponentHidden);
-      });
-    } else if (checkIfComponentHidden) {
-      if (!(0, _showComponent.default)(component, formData)) {
-        delete formData[path];
-      }
-    } else {
-      delete formData[path];
-    }
-  }
-};
-var markComponentsForDeletion = function markComponentsForDeletion(page, form, formData, candidateComponentForDeletion, componentsUsedInVisiblePages) {
-  var _page$components2;
-  if (page.disableClearWhenHidden) {
-    return;
-  }
-  (_page$components2 = page.components) === null || _page$components2 === void 0 || _page$components2.forEach(function (component) {
-    var _ref2, _form$components$find2;
-    var componentObj = (_ref2 = (_form$components$find2 = form.components.find(function (c) {
-      return c.fieldId === component.use;
-    })) !== null && _form$components$find2 !== void 0 ? _form$components$find2 : form.components.find(function (c) {
-      return c.id === component.use;
-    })) !== null && _ref2 !== void 0 ? _ref2 : component;
-    if (page && (0, _showComponent.default)(page, formData)) {
-      buildListOfComponentsUsedInVisiblePages(page, form, formData, componentsUsedInVisiblePages);
-      recurseCheckForHiddenComponents(componentObj, formData, null, candidateComponentForDeletion);
-    } else if (componentObj.fieldId) {
-      candidateComponentForDeletion.set(componentObj.fieldId, componentObj);
-    } else if (componentObj.id) {
-      candidateComponentForDeletion.set(componentObj.id, componentObj);
-    }
-  });
-};
-var deleteHiddenComponent = function deleteHiddenComponent(page, form, collectionData, formData) {
-  if (page.disableClearWhenHidden) {
-    return;
-  }
-  if (page && (0, _showComponent.default)(page, formData)) {
-    var _page$components3;
-    (_page$components3 = page.components) === null || _page$components3 === void 0 || _page$components3.forEach(function (component) {
-      var _ref3, _form$components$find3;
-      var componentObj = (_ref3 = (_form$components$find3 = form.components.find(function (c) {
-        return c.fieldId === component.use;
-      })) !== null && _form$components$find3 !== void 0 ? _form$components$find3 : form.components.find(function (c) {
-        return c.id === component.use;
-      })) !== null && _ref3 !== void 0 ? _ref3 : component;
-      recurseDeleteComponents(componentObj, collectionData, null, true);
-    });
-  } else {
-    var _page$components4;
-    // recursively delete all components on the page
-    (_page$components4 = page.components) === null || _page$components4 === void 0 || _page$components4.forEach(function (component) {
-      var _ref4, _form$components$find4;
-      var componentObj = (_ref4 = (_form$components$find4 = form.components.find(function (c) {
-        return c.fieldId === component.use;
-      })) !== null && _form$components$find4 !== void 0 ? _form$components$find4 : form.components.find(function (c) {
-        return c.id === component.use;
-      })) !== null && _ref4 !== void 0 ? _ref4 : component;
-      recurseDeleteComponents(componentObj, collectionData, null, false);
-    });
-  }
-};
-function clearUncompletedRoutesForCollections(formData, page, form) {
-  var _page$collection;
-  var collectionDatas = formData[page === null || page === void 0 || (_page$collection = page.collection) === null || _page$collection === void 0 ? void 0 : _page$collection.name];
-  if (collectionDatas) {
-    collectionDatas.forEach(function (collectionData) {
-      var _page$childPages;
-      /* eslint-disable consistent-return */
-      (_page$childPages = page.childPages) === null || _page$childPages === void 0 || _page$childPages.forEach(function (childPage) {
-        if (childPage.deleteCollectionWhenHidden) {
-          if (childPage && !(0, _showComponent.default)(childPage, formData)) {
-            delete formData[childPage.collection.name];
-            return false;
-          }
-        }
-        deleteHiddenComponent(childPage, form, collectionData, formData);
-      });
-    });
-  }
-}
-var clearOutUncompletedRoutes = function clearOutUncompletedRoutes(form, formData) {
-  if (form.disableClearWhenHidden) {
-    return formData;
-  }
-  var condensedPages = (0, _mergeCollectionPages.default)(form.pages);
-  var candidateComponentForDeletion = new Map();
-  var componentsUsedInVisiblePagesIds = [];
-  condensedPages === null || condensedPages === void 0 || condensedPages.forEach(function (page) {
-    var _page$collection2;
-    if (page !== null && page !== void 0 && (_page$collection2 = page.collection) !== null && _page$collection2 !== void 0 && _page$collection2.name) {
-      clearUncompletedRoutesForCollections(formData, page, form);
-    } else {
-      markComponentsForDeletion(page, form, formData, candidateComponentForDeletion, componentsUsedInVisiblePagesIds);
-    }
-  });
-  componentsUsedInVisiblePagesIds = [].concat(new Set(componentsUsedInVisiblePagesIds));
-  componentsUsedInVisiblePagesIds.forEach(function (componentId) {
-    return candidateComponentForDeletion.delete(componentId);
-  });
-  candidateComponentForDeletion.forEach(function (val, key) {
-    (0, _deleteNodeByPath.default)(formData, key);
-  });
-  return formData;
-};
-var _default = exports.default = clearOutUncompletedRoutes;

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

@@ -1,113 +0,0 @@
-"use strict";
-
-var _index = _interopRequireDefault(require("./index"));
-var _componentUsedInMultiplePagesForm = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/component-used-in-multiple-pages-form.json"));
-var _componentUsedInMultiplePagesData = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/component-used-in-multiple-pages-data.json"));
-var _formWithCollections = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/form-with-collections.json"));
-var _formWithCollectionsDeleteEntire = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/form-with-collections-delete-entire.json"));
-var _dataWithCollections = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/data-with-collections.json"));
-var _dataWithEntireCollectionRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/data-with-entire-collection-removed.json"));
-var _dataWithCollectionDataRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/data-with-collection-data-removed.json"));
-var _formWithComponents = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/form-with-components.json"));
-var _dataWithComponents = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/data-with-components.json"));
-var _dataWithComponentsRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/data-with-components-removed.json"));
-var _formForNestedComponents = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/form-for-nested-components.json"));
-var _dataWithNestedComponents = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/data-with-nested-components.json"));
-var _dataWithNestedComponentRemoved = _interopRequireDefault(require("../clear-uncompleted-routes/test-data/data-with-nested-component-removed.json"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-describe('FormRenderer', function () {
-  describe('helpers', function () {
-    describe('clearOutUncompletedRoutes', function () {
-      it('should not remove hidden component where it is visible in another page', function () {
-        var form = JSON.parse(JSON.stringify(_componentUsedInMultiplePagesForm.default));
-        var formData = JSON.parse(JSON.stringify(_componentUsedInMultiplePagesData.default));
-        expect(_index.default.clearOutUncompletedRoutes(form, formData)).toEqual(_componentUsedInMultiplePagesData.default);
-      });
-      it('should remove collection data when page hidden', function () {
-        var form = JSON.parse(JSON.stringify(_formWithCollections.default));
-        var formData = JSON.parse(JSON.stringify(_dataWithCollections.default));
-        var result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithCollectionDataRemoved.default);
-        formData = JSON.parse(JSON.stringify(_dataWithCollections.default));
-        formData.componentA = true;
-        result = _index.default.clearOutUncompletedRoutes(form, formData);
-        var expected = JSON.parse(JSON.stringify(_dataWithCollections.default));
-        expected.componentA = true;
-        expect(result).toEqual(expected);
-      });
-      it('should remove entire collection data when page hidden', function () {
-        var form = JSON.parse(JSON.stringify(_formWithCollectionsDeleteEntire.default));
-        var formData = JSON.parse(JSON.stringify(_dataWithCollections.default));
-        var result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithEntireCollectionRemoved.default);
-      });
-      it('should remove hidden component', function () {
-        var form = JSON.parse(JSON.stringify(_formWithComponents.default));
-        var formData = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        var result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithComponents.default);
-        formData.componentA = "hide";
-        result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithComponentsRemoved.default);
-      });
-      it('should not remove hidden component when disableClearWhenHidden attribute is true on component', function () {
-        var formData = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        formData.componentA = "hide";
-        var form = JSON.parse(JSON.stringify(_formWithComponents.default));
-        var result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithComponentsRemoved.default);
-        form.components[1].disableClearWhenHidden = true;
-        form.components[2].disableClearWhenHidden = true;
-        formData = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithComponents.default);
-      });
-      it('should not remove hidden component when disableClearWhenHidden attribute is true on page', function () {
-        var formData = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        formData.componentA = "hide";
-        var form = JSON.parse(JSON.stringify(_formWithComponents.default));
-        var result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithComponentsRemoved.default);
-        form.pages[0].disableClearWhenHidden = true;
-        formData = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        result = _index.default.clearOutUncompletedRoutes(form, formData);
-        expect(result).toEqual(_dataWithComponents.default);
-      });
-      it('should not remove hidden component when disableClearWhenHidden attribute is true on form', function () {
-        var submissionData = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        var form = JSON.parse(JSON.stringify(_formWithComponents.default));
-        submissionData.componentA = "hide";
-        var result = _index.default.clearOutUncompletedRoutes(form, submissionData);
-        expect(result).toEqual(_dataWithComponentsRemoved.default);
-        form.disableClearWhenHidden = true;
-        submissionData = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        submissionData.componentA = "hide";
-        result = _index.default.clearOutUncompletedRoutes(form, submissionData);
-        var expected = JSON.parse(JSON.stringify(_dataWithComponents.default));
-        expected.componentA = "hide";
-        expect(result).toEqual(expected);
-      });
-      it('should remove nested hidden component', function () {
-        var submissionData = JSON.parse(JSON.stringify(_dataWithNestedComponents.default));
-        var form = JSON.parse(JSON.stringify(_formForNestedComponents.default));
-        var result = _index.default.clearOutUncompletedRoutes(form, submissionData);
-        expect(result).toEqual(_dataWithNestedComponentRemoved.default);
-        submissionData = JSON.parse(JSON.stringify(_dataWithNestedComponents.default));
-        submissionData.bravo = "another";
-        result = _index.default.clearOutUncompletedRoutes(form, submissionData);
-        var expected = JSON.parse(JSON.stringify(_dataWithNestedComponents.default));
-        delete expected.person.charlie;
-        expected.bravo = "another";
-        expect(result).toEqual(expected);
-        submissionData = JSON.parse(JSON.stringify(_dataWithNestedComponents.default));
-        submissionData.bravo = "notMatchAnything";
-        result = _index.default.clearOutUncompletedRoutes(form, submissionData);
-        expected = JSON.parse(JSON.stringify(_dataWithNestedComponents.default));
-        delete expected.person.charlie;
-        delete expected.person.delta;
-        expected.bravo = "notMatchAnything";
-        expect(result).toEqual(expected);
-      });
-    });
-  });
-});

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

@@ -1,20 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-/* eslint-disable consistent-return */
-var deleteNodeByPath = function deleteNodeByPath(obj, path) {
-  var keys = path.split('.');
-  var current = obj;
-  for (var i = 0; i < keys.length - 1; i += 1) {
-    current = current[keys[i]];
-    if (current === undefined) {
-      return;
-    }
-  }
-  delete current[keys[keys.length - 1]];
-  return obj;
-};
-var _default = exports.default = deleteNodeByPath;

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

@@ -1,56 +0,0 @@
-"use strict";
-
-var _deleteNodeByPath = _interopRequireDefault(require("./deleteNodeByPath"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-describe('Delete node based on path', function () {
-  it('delete where node is at parent level', function () {
-    var nested = {
-      type: "Example form",
-      alpha: "alpha",
-      bravo: "bravo",
-      person: {
-        charlie: "Smith",
-        delta: "Acme Inc"
-      },
-      gamma: "gamma",
-      epsilon: "epsilon"
-    };
-    var path = 'type';
-    var result = (0, _deleteNodeByPath.default)(nested, path);
-    expect(result).toEqual({
-      alpha: "alpha",
-      bravo: "bravo",
-      person: {
-        charlie: "Smith",
-        delta: "Acme Inc"
-      },
-      gamma: "gamma",
-      epsilon: "epsilon"
-    });
-  });
-  it('delete where node is at child level', function () {
-    var nested = {
-      type: "Example form",
-      alpha: "alpha",
-      bravo: "bravo",
-      person: {
-        charlie: "Smith",
-        delta: "Acme Inc"
-      },
-      gamma: "gamma",
-      epsilon: "epsilon"
-    };
-    var path = 'person.charlie';
-    var result = (0, _deleteNodeByPath.default)(nested, path);
-    expect(result).toEqual({
-      type: "Example form",
-      alpha: "alpha",
-      bravo: "bravo",
-      person: {
-        delta: "Acme Inc"
-      },
-      gamma: "gamma",
-      epsilon: "epsilon"
-    });
-  });
-});