@ukhomeoffice/cop-react-form-renderer 2.5.0 → 2.6.0

package/dist/utils/Container/setupNesting.test.js

@@ -0,0 +1,92 @@
+"use strict";
+
+var _models = require("../../models");
+
+var _setupNesting = _interopRequireDefault(require("./setupNesting"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+describe('utils.Container.setupNesting', function () {
+  var getComponent = function getComponent(id, type) {
+    return {
+      id: id,
+      fieldId: id,
+      type: type
+    };
+  };
+
+  it('should handle an undefined container', function () {
+    expect((0, _setupNesting.default)(undefined)).toBeUndefined();
+  });
+  it('should handle a null container', function () {
+    expect((0, _setupNesting.default)(null)).toBeNull();
+  });
+  it('should handle a single level of nesting', function () {
+    var CONTAINER = _objectSpread(_objectSpread({}, getComponent('container', _models.ComponentTypes.CONTAINER)), {}, {
+      components: [getComponent('text', _models.ComponentTypes.TEXT), getComponent('email', _models.ComponentTypes.EMAIL)]
+    });
+
+    expect((0, _setupNesting.default)(CONTAINER)).toEqual({
+      id: 'container',
+      fieldId: 'container',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [{
+        id: 'text',
+        fieldId: 'text',
+        full_path: 'container.text',
+        type: _models.ComponentTypes.TEXT
+      }, {
+        id: 'email',
+        fieldId: 'email',
+        full_path: 'container.email',
+        type: _models.ComponentTypes.EMAIL
+      }]
+    });
+  });
+  it('should handle multiple levels of nesting', function () {
+    var CONTAINER = _objectSpread(_objectSpread({}, getComponent('container', _models.ComponentTypes.CONTAINER)), {}, {
+      components: [getComponent('text', _models.ComponentTypes.TEXT), _objectSpread(_objectSpread({}, getComponent('inner', _models.ComponentTypes.CONTAINER)), {}, {
+        components: [getComponent('text', _models.ComponentTypes.TEXT), getComponent('email', _models.ComponentTypes.EMAIL)]
+      }), getComponent('email', _models.ComponentTypes.EMAIL)]
+    });
+
+    expect((0, _setupNesting.default)(CONTAINER)).toEqual({
+      id: 'container',
+      fieldId: 'container',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [{
+        id: 'text',
+        fieldId: 'text',
+        full_path: 'container.text',
+        type: _models.ComponentTypes.TEXT
+      }, {
+        id: 'inner',
+        fieldId: 'inner',
+        full_path: 'container.inner',
+        type: _models.ComponentTypes.CONTAINER,
+        components: [{
+          id: 'text',
+          fieldId: 'text',
+          full_path: 'container.inner.text',
+          type: _models.ComponentTypes.TEXT
+        }, {
+          id: 'email',
+          fieldId: 'email',
+          full_path: 'container.inner.email',
+          type: _models.ComponentTypes.EMAIL
+        }]
+      }, {
+        id: 'email',
+        fieldId: 'email',
+        full_path: 'container.email',
+        type: _models.ComponentTypes.EMAIL
+      }]
+    });
+  });
+});

package/dist/utils/Container/showContainer.js

@@ -0,0 +1,61 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Component = _interopRequireDefault(require("../Component"));
+
+var _Condition = _interopRequireDefault(require("../Condition"));
+
+var _getEditableComponents = _interopRequireDefault(require("./getEditableComponents"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+
+/**
+ * Checks whether any of the editable components on a container should be shown.
+ * @param {Array} editableComponents The editable components on the container.
+ * @param {object} data The top-level form data.
+ * @returns Boolean true if ANY of the editable components should be shown; false otherwise.
+ */
+var showEditableComponent = function showEditableComponent(editableComponents, data) {
+  return editableComponents.some(function (component) {
+    return _Component.default.show(component, data);
+  });
+};
+/**
+ * Indicates whether or not a container should be shown.
+ * @param {object} container The container to consider.
+ * @param {object} data The top-level form data.
+ * @returns Boolean true if the container should be shown; false if not.
+ */
+
+
+var showContainer = function showContainer(container, data) {
+  if (!container) {
+    return false;
+  } // If the container has a show_when condition, we should evaluate that.
+
+
+  if (container.show_when) {
+    return _Condition.default.meetsAll(container, data);
+  } // If the container itself doesn't have a show_when, we need to make sure that if it
+  // contains ANY editable components, at least one of them is shown.
+
+
+  var editableComponents = (0, _getEditableComponents.default)(container);
+
+  if (editableComponents.length > 0) {
+    return showEditableComponent(editableComponents, data);
+  } // At this point, either the container has no show_when condition of its own, or
+  // the container has no editable components. In either case, it should be shown.
+
+
+  return true;
+};
+
+var _default = showContainer;
+exports.default = _default;

package/dist/utils/Container/showContainer.test.js

@@ -0,0 +1,128 @@
+"use strict";
+
+var _showContainer = _interopRequireDefault(require("./showContainer"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils.Container.showContainer', function () {
+  var DATA = {
+    alpha: 'Alpha',
+    bravo: 'Bravo'
+  };
+  var HTML = {
+    type: 'html',
+    tagName: 'p',
+    content: 'Alpha'
+  };
+  var INSET_TEXT = {
+    type: 'inset-text',
+    content: 'Bravo'
+  };
+  var HEADING = {
+    type: 'heading',
+    size: 'm',
+    content: 'Charlie'
+  };
+  it('should NOT be shown when the container is null', function () {
+    expect((0, _showContainer.default)(null, DATA)).toBeFalsy();
+  });
+  it('should NOT be shown when the container has a single show_when condition that is NOT matched', function () {
+    var CONTAINER = {
+      show_when: {
+        field: 'charlie',
+        op: '=',
+        value: 'Charlie'
+      }
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeFalsy();
+  });
+  it('should NOT be shown when the container has multiple show_when conditions and at least one is NOT matched', function () {
+    var CONTAINER = {
+      show_when: [{
+        field: 'alpha',
+        op: '=',
+        value: 'Alpha'
+      }, {
+        field: 'charlie',
+        op: '=',
+        value: 'Charlie'
+      }]
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeFalsy();
+  });
+  it('SHOULD be shown when the container has a single show_when condition that IS matched', function () {
+    var CONTAINER = {
+      show_when: {
+        field: 'alpha',
+        op: '=',
+        value: 'Alpha'
+      }
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeTruthy();
+  });
+  it('SHOULD be shown when the container has multiple show_when conditions that are ALL matched', function () {
+    var CONTAINER = {
+      show_when: [{
+        field: 'alpha',
+        op: '=',
+        value: 'Alpha'
+      }, {
+        field: 'charlie',
+        op: '!=',
+        value: 'Charlie'
+      }]
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeTruthy();
+  });
+  it('SHOULD be shown when the container has NO show_when conditions and NO editable components', function () {
+    var CONTAINER = {
+      components: [HTML, INSET_TEXT, HEADING]
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeTruthy();
+  });
+  it('should NOT be shown when the container has NO show_when conditions and NO SHOWN editable components', function () {
+    var TEXT = {
+      type: 'text',
+      show_when: {
+        field: 'charlie',
+        op: '=',
+        value: 'Charlie'
+      }
+    };
+    var RADIOS = {
+      type: 'radios',
+      show_when: {
+        field: 'charlie',
+        op: '=',
+        value: 'Charlie'
+      }
+    };
+    var CONTAINER = {
+      components: [TEXT, RADIOS]
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeFalsy();
+  });
+  it('SHOULD be shown when the container has NO show_when conditions and AT LEAST ONE SHOWN editable components', function () {
+    var TEXT = {
+      type: 'text',
+      show_when: {
+        field: 'alpha',
+        op: '=',
+        value: 'Alpha'
+      }
+    };
+    var RADIOS = {
+      type: 'radios',
+      show_when: {
+        field: 'charlie',
+        op: '=',
+        value: 'Charlie'
+      }
+    };
+    var CONTAINER = {
+      components: [TEXT, RADIOS]
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeTruthy();
+  });
+});

package/dist/utils/Data/getDataPath.js

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var DOT = '.';
+var SLASH = '/';
+var DOT_DOT = "".concat(DOT).concat(DOT);
+var PARENT_PATH = "".concat(DOT).concat(SLASH);
+
+var toPath = function toPath(arr) {
+  return arr.join(DOT);
+};
+
+var toParts = function toParts(str) {
+  var separator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : DOT;
+  return str.split(separator);
+};
+
+var isDotDot = function isDotDot(str) {
+  return str === DOT_DOT;
+};
+
+var isDotOrDotDot = function isDotOrDotDot(str) {
+  return [DOT, DOT_DOT].indexOf(str) > -1;
+};
+
+var isRelativePath = function isRelativePath(path) {
+  return path && path.indexOf(DOT) === 0;
+};
+
+var standardiseRelativePath = function standardiseRelativePath(path) {
+  if (path.indexOf(PARENT_PATH) === 0) {
+    return path;
+  }
+
+  return "".concat(PARENT_PATH).concat(path);
+};
+
+var ascendPath = function ascendPath(startPath, ascent) {
+  var relativePath = standardiseRelativePath(ascent); // Always add 1 because we're starting on a leaf node within a "directory".
+
+  var stepsToClimb = toParts(relativePath, SLASH).filter(isDotDot).length + 1;
+  var pathParts = startPath ? toParts(startPath) : [];
+
+  if (stepsToClimb >= pathParts.length) {
+    return '';
+  }
+
+  return toPath(pathParts.slice(0, -stepsToClimb));
+};
+
+var descendPath = function descendPath(startPath, descent) {
+  var stepsDown = toParts(descent, SLASH).filter(function (str) {
+    return !isDotOrDotDot(str);
+  });
+  return startPath ? "".concat(startPath, ".").concat(toPath(stepsDown)) : toPath(stepsDown);
+};
+/**
+ * Takes a path and a current path and returns an absolute path to a data element.
+ * Note that the path may be absolute or relative.
+ * 
+ * The behaviour should mirror the way imports work.
+ * 
+ * @param {string} path The path to attempt to get to, which may be absolute or relative.
+ * @param {string} currentPath The current absolute path.
+ * @returns An absolute path to a data element.
+ * @example
+ *   getDataPath('./relative.path', 'this.is.the.current.path');
+ *   // => 'this.is.the.current.relative.path'
+ * @example
+ *   getDataPath('../relative.path', 'this.is.the.current.path');
+ *   // => 'this.is.the.relative.path'
+ * @example
+ *   getDataPath('../../relative.path', 'this.is.the.current.path');
+ *   // => 'this.is.relative.path'
+ */
+
+
+var getDataPath = function getDataPath(path, currentPath) {
+  if (isRelativePath(path)) {
+    return descendPath(ascendPath(currentPath, path), path);
+  }
+
+  return path;
+};
+
+var _default = getDataPath;
+exports.default = _default;

package/dist/utils/Data/getDataPath.test.js

@@ -0,0 +1,52 @@
+"use strict";
+
+var _getDataPath = _interopRequireDefault(require("./getDataPath"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('utils.Data.getDataPath', function () {
+  var CURRENT_PATH = 'this.is.the.current.path';
+  var RELATIVE = 'relative.path';
+  var ABSOLUTE = 'absolute.path';
+
+  var doTest = function doTest(path, currentPath, expected) {
+    expect((0, _getDataPath.default)(path, currentPath)).toEqual(expected);
+  };
+
+  it("should return an absolute path appropriately", function () {
+    doTest(ABSOLUTE, CURRENT_PATH, ABSOLUTE);
+  });
+  it("should return an absolute path appropriately where the current path is null", function () {
+    doTest(ABSOLUTE, null, ABSOLUTE);
+  });
+  [{
+    p: "./".concat(RELATIVE),
+    e: "this.is.the.current.".concat(RELATIVE),
+    d: 'a sibling node'
+  }, {
+    p: "../".concat(RELATIVE),
+    e: "this.is.the.".concat(RELATIVE),
+    d: 'a cousin node'
+  }, {
+    p: "./../".concat(RELATIVE),
+    e: "this.is.the.".concat(RELATIVE),
+    d: 'a cousin node with leading dot-slash'
+  }, {
+    p: "../../../../../../../".concat(RELATIVE),
+    e: RELATIVE,
+    d: 'an inappropriately nested node'
+  }].forEach(function (test) {
+    it("should return ".concat(test.d, " appropriately"), function () {
+      doTest(test.p, CURRENT_PATH, test.e);
+    });
+    it("should return ".concat(test.d, " appropriately where the current path is null"), function () {
+      doTest(test.p, null, RELATIVE);
+    });
+  });
+  it('should handle a null path and return null', function () {
+    doTest(null, CURRENT_PATH, null);
+  });
+  it('should handle an undefined path and return undefined', function () {
+    doTest(undefined, CURRENT_PATH, undefined);
+  });
+});

package/dist/utils/Data/index.js

@@ -7,6 +7,8 @@ exports.default = void 0;
 
 var _getAutocompleteSource = _interopRequireDefault(require("./getAutocompleteSource"));
 
+var _getDataPath = _interopRequireDefault(require("./getDataPath"));
+
 var _getOptions = _interopRequireDefault(require("./getOptions"));
 
 var _getSourceData = _interopRequireDefault(require("./getSourceData"));
@@ -22,6 +24,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 // Local imports
 var Data = {
   getAutocompleteSource: _getAutocompleteSource.default,
+  getDataPath: _getDataPath.default,
   getOptions: _getOptions.default,
   getSource: _getSourceData.default,
   refData: {

package/dist/utils/FormPage/getFormPage.js

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _Container = _interopRequireDefault(require("../Container"));
+
 var _Data = _interopRequireDefault(require("../Data"));
 
 var _getPageActions = _interopRequireDefault(require("./getPageActions"));
@@ -49,11 +51,11 @@ var getFormPage = function getFormPage(pageOptions, formComponents, formData) {
     return formData && formData.urls ? _Data.default.refData.setupUrl(ret, formData) : ret;
   });
   var actions = (0, _getPageActions.default)(pageOptions);
-  return _objectSpread(_objectSpread({}, pageOptions), {}, {
+  return _Container.default.setup(_objectSpread(_objectSpread({}, pageOptions), {}, {
     formData: formData,
     components: components,
     actions: actions
-  });
+  }));
 };
 
 var _default = getFormPage;

package/dist/utils/FormPage/getFormPage.test.js

@@ -72,7 +72,9 @@ describe('utils', function () {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[0]
-          }, PAGE.components[1], {
+          }, _objectSpread(_objectSpread({}, PAGE.components[1]), {}, {
+            full_path: PAGE.components[1].fieldId
+          }), {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[2]
@@ -98,14 +100,17 @@ describe('utils', function () {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[0]
-          }, PAGE.components[1], {
+          }, _objectSpread(_objectSpread({}, PAGE.components[1]), {}, {
+            full_path: PAGE.components[1].fieldId
+          }), {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[2]
           }, _objectSpread(_objectSpread({
             use: 'a'
           }, A), {}, {
-            cya_label: A.label
+            cya_label: A.label,
+            full_path: A.fieldId
           })],
           formData: FORM_DATA
         });
@@ -128,7 +133,9 @@ describe('utils', function () {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[0]
-          }, PAGE.components[1], {
+          }, _objectSpread(_objectSpread({}, PAGE.components[1]), {}, {
+            full_path: PAGE.components[1].fieldId
+          }), {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[2]
@@ -138,7 +145,8 @@ describe('utils', function () {
             cya_label: C.label,
             data: {
               url: "".concat(FORM_DATA.urls.refData, "/v3/charlies")
-            }
+            },
+            full_path: C.fieldId
           })],
           formData: FORM_DATA
         });
@@ -161,14 +169,17 @@ describe('utils', function () {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[0]
-          }, PAGE.components[1], {
+          }, _objectSpread(_objectSpread({}, PAGE.components[1]), {}, {
+            full_path: PAGE.components[1].fieldId
+          }), {
             type: 'html',
             tagName: 'p',
             content: PAGE.components[2]
           }, _objectSpread(_objectSpread({
             use: 'c'
           }, C), {}, {
-            cya_label: C.label
+            cya_label: C.label,
+            full_path: C.fieldId
           })],
           formData: {}
         });

package/dist/utils/FormPage/getFormPages.test.js

@@ -75,7 +75,9 @@ describe('utils', function () {
             type: 'html',
             tagName: 'p',
             content: PAGE_2.components[0]
-          }, PAGE_2.components[1], {
+          }, _objectSpread(_objectSpread({}, PAGE_2.components[1]), {}, {
+            full_path: PAGE_2.components[1].fieldId
+          }), {
             type: 'html',
             tagName: 'p',
             content: PAGE_2.components[2]
@@ -85,7 +87,8 @@ describe('utils', function () {
             cya_label: C.label,
             data: {
               url: "".concat(FORM_DATA.urls.refData, "/v3/charlies")
-            }
+            },
+            full_path: C.fieldId
           })],
           formData: FORM_DATA
         }]);

package/dist/utils/FormPage/index.js

@@ -5,8 +5,6 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _getEditableComponents = _interopRequireDefault(require("./getEditableComponents"));
-
 var _getFormPage = _interopRequireDefault(require("./getFormPage"));
 
 var _getFormPages = _interopRequireDefault(require("./getFormPages"));
@@ -16,7 +14,6 @@ var _showFormPage = _interopRequireDefault(require("./showFormPage"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var FormPage = {
-  editableComponents: _getEditableComponents.default,
   get: _getFormPage.default,
   getAll: _getFormPages.default,
   show: _showFormPage.default

package/dist/utils/FormPage/showFormPage.js

@@ -7,44 +7,24 @@ exports.default = void 0;
 
 var _Component = _interopRequireDefault(require("../Component"));
 
-var _Data = _interopRequireDefault(require("../Data"));
+var _Condition = _interopRequireDefault(require("../Condition"));
 
-var _meetsCondition = _interopRequireDefault(require("../meetsCondition"));
-
-var _getEditableComponents = _interopRequireDefault(require("./getEditableComponents"));
+var _Container = _interopRequireDefault(require("../Container"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
 
-/**
- * Evaluates the show_when condition(s) on a page.
- * @param {object} page The page to consider.
- * @param {object} data The top-level form data.
- * @returns Boolean true if all show_when conditions are met; false otherwise.
- */
-var evaluatePageShowWhen = function evaluatePageShowWhen(page, data) {
-  var show_when = Array.isArray(page.show_when) ? page.show_when : [page.show_when];
-  var allConditionsMet = true;
-  show_when.forEach(function (condition) {
-    var sourceDataValue = _Data.default.getSource(data, condition.field);
-
-    allConditionsMet = allConditionsMet && (0, _meetsCondition.default)(condition, sourceDataValue);
-  });
-  return allConditionsMet;
-};
 /**
  * Checks whether any of the editable components on a page should be shown.
  * @param {Array} editableComponents The editable components on the page.
  * @param {object} data The top-level form data.
  * @returns Boolean true if ANY of the editable components should be shown; false otherwise.
  */
-
-
 var showEditableComponent = function showEditableComponent(editableComponents, data) {
-  return editableComponents.reduce(function (shown, component) {
-    return shown || _Component.default.show(component, data);
-  }, false);
+  return editableComponents.some(function (component) {
+    return _Component.default.show(component, data);
+  });
 };
 /**
  * Indicates whether or not a page should be shown.
@@ -61,12 +41,12 @@ var showFormPage = function showFormPage(page, data) {
 
 
   if (page.show_when) {
-    return evaluatePageShowWhen(page, data);
+    return _Condition.default.meetsAll(page, data);
   } // If the page itself doesn't have a show_when, we need to make sure that if it
   // contains ANY editable components, at least one of them is shown.
 
 
-  var editableComponents = (0, _getEditableComponents.default)(page);
+  var editableComponents = _Container.default.editableComponents(page);
 
   if (editableComponents.length > 0) {
     return showEditableComponent(editableComponents, data);

package/dist/utils/Hub/getFormHub.test.js

@@ -78,14 +78,17 @@ describe('utils', function () {
               type: 'html',
               tagName: 'p',
               content: HUB.components[0]
-            }, HUB.components[1], {
+            }, _objectSpread(_objectSpread({}, HUB.components[1]), {}, {
+              full_path: HUB.components[1].fieldId
+            }), {
               type: 'html',
               tagName: 'p',
               content: HUB.components[2]
             }, _objectSpread(_objectSpread({
               use: 'a'
             }, A), {}, {
-              cya_label: A.label
+              cya_label: A.label,
+              full_path: A.fieldId
             })],
             formData: FORM_DATA
           });