@ukhomeoffice/cop-react-form-renderer 6.0.6-peter → 6.6.1

package/dist/utils/Validate/validatePage.test.js

@@ -719,4 +719,73 @@ describe('utils.Validate.Page', function () {
       });
     });
   });
+  describe('when there are queued errors', function () {
+    it('should return any errors queued for a component as well as errors found during validation', function () {
+      var COMPONENTS = [setup('a', _models.ComponentTypes.TEXT, 'Alpha', true)];
+      var PAGE = {
+        components: COMPONENTS,
+        formData: null
+      };
+      var QUEUED_ERRORS = [{
+        id: 'a',
+        error: 'Error queued for Alpha 1'
+      }, {
+        id: 'a',
+        error: 'Error queued for Alpha 2'
+      }];
+      var RESULT = (0, _validatePage.default)(PAGE, QUEUED_ERRORS);
+      expect(RESULT.length).toEqual(3);
+      expect(RESULT[0]).toEqual(_objectSpread({}, QUEUED_ERRORS[0]));
+      expect(RESULT[1]).toEqual(_objectSpread({}, QUEUED_ERRORS[1]));
+      expect(RESULT[2]).toEqual({
+        id: 'a',
+        error: 'Alpha is required'
+      });
+    });
+    it('should return any errors queued for a component even if no errors are found during validation', function () {
+      var COMPONENTS = [setup('a', _models.ComponentTypes.TEXT, 'Alpha', true)];
+      var PAGE = {
+        components: COMPONENTS,
+        formData: {
+          a: 'Value'
+        }
+      };
+      var QUEUED_ERRORS = [{
+        id: 'a',
+        error: 'Error queued for Alpha 1'
+      }, {
+        id: 'a',
+        error: 'Error queued for Alpha 2'
+      }];
+      var RESULT = (0, _validatePage.default)(PAGE, QUEUED_ERRORS);
+      expect(RESULT.length).toEqual(2);
+      expect(RESULT[0]).toEqual(_objectSpread({}, QUEUED_ERRORS[0]));
+      expect(RESULT[1]).toEqual(_objectSpread({}, QUEUED_ERRORS[1]));
+    });
+    it('should return any queued errors if the component is not shown', function () {
+      var COMPONENTS = [_objectSpread(_objectSpread({}, setup('a', _models.ComponentTypes.TEXT, 'Alpha', true)), {}, {
+        show_when: [{
+          field: 'b',
+          op: '=',
+          value: 'yes'
+        }]
+      })];
+      var PAGE = {
+        components: COMPONENTS,
+        formData: {
+          a: 'Value',
+          b: 'no'
+        }
+      };
+      var QUEUED_ERRORS = [{
+        id: 'a',
+        error: 'Error queued for Alpha 1'
+      }, {
+        id: 'a',
+        error: 'Error queued for Alpha 2'
+      }];
+      var RESULT = (0, _validatePage.default)(PAGE, QUEUED_ERRORS);
+      expect(RESULT.length).toEqual(0);
+    });
+  });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "6.0.6-peter",
+  "version": "6.6.1",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,10 +16,10 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "^3.19.1",
+    "@ukhomeoffice/cop-react-components": "^4.0.0",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
-    "govuk-frontend": "^4.3.1",
+    "govuk-frontend": "^5.0.0",
     "web-vitals": "^1.0.1"
   },
   "devDependencies": {
@@ -48,11 +48,11 @@
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-prettier": "^8.6.0",
     "html-react-parser": "^0.10.5",
-    "node-sass": "^6.0.1",
     "prop-types": "^15.8.1",
     "react": "^16.13.1",
     "react-dom": "^16.13.1",
     "react-scripts": "4.0.3",
+    "sass": "^1.69.5",
     "storybook-addon-mock": "^2.0.1"
   },
   "peerDependencies": {

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/component-used-in-multiple-pages-data.json

@@ -1,4 +0,0 @@
-{
-  "componentA": "show",
-  "componentB": "hide"
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/component-used-in-multiple-pages-form.json

@@ -1,61 +0,0 @@
-{
-  "components": [
-    {
-      "id": "componentA",
-      "type": "radios",
-      "label": "Field A",
-      "fieldId": "fieldA",
-      "required": true
-    },
-    {
-      "id": "componentB",
-      "type": "collection",
-      "label": "Component B",
-      "fieldId": "componentB"
-    }
-  ],
-  "pages": [
-    {
-      "id": "pageA",
-      "show_when": {
-        "op": "=",
-        "field": "componentA",
-        "value": "hide"
-      },
-      "components": [
-        {
-          "id": "componentB",
-          "use": "componentB"
-        }
-      ]
-    },
-    {
-      "id": "pageB",
-      "show_when": {
-        "op": "=",
-        "field": "componentA",
-        "value": "show"
-      },
-      "components": [
-        {
-          "id": "componentB",
-          "use": "componentB"
-        }
-      ]
-    },
-    {
-      "id": "pageC",
-      "show_when": {
-        "op": "=",
-        "field": "componentA",
-        "value": "hide"
-      },
-      "components": [
-        {
-          "id": "componentB",
-          "use": "componentB"
-        }
-      ]
-    }
-  ]
-}

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

@@ -1,4 +0,0 @@
-{
-  "componentA": "false",
-  "componentAs": [{}]
-}

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

@@ -1,8 +0,0 @@
-{
-  "componentA": "false",
-  "componentAs": [
-    {
-      "itemCategory": "1111111111"
-    }
-  ]
-}

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

@@ -1,3 +0,0 @@
-{
-  "componentA": "hide"
-}

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

@@ -1,5 +0,0 @@
-{
-  "componentA": "show",
-  "componentB": "hide if component A is anything other than show",
-  "componentC": "hide if component A is anything other than show"
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/data-with-entire-collection-removed.json

@@ -1,3 +0,0 @@
-{
-  "componentA": "false"
-}

package/dist/components/FormRenderer/clear-uncompleted-routes/test-data/data-with-nested-component-removed.json

@@ -1,10 +0,0 @@
-{
-  "type": "Example form",
-  "alpha": "alpha",
-  "bravo": "bravo",
-  "person": {
-    "charlie": "Smith"
-  },
-  "gamma": "gamma",
-  "epsilon": "epsilon"
-}

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

@@ -1,11 +0,0 @@
-{
-  "type": "Example form",
-  "alpha": "alpha",
-  "bravo": "bravo",
-  "person": {
-    "charlie": "Smith",
-    "delta":"Acme Inc"
-  },
-  "gamma": "gamma",
-  "epsilon": "epsilon"
-}

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;