@ukhomeoffice/cop-react-form-renderer 2.5.0 → 2.6.1-beta

package/dist/utils/CheckYourAnswers/getCYARowsForContainer.test.js

@@ -0,0 +1,257 @@
+"use strict";
+
+var _models = require("../../models");
+
+var _getCYARowsForContainer = _interopRequireDefault(require("./getCYARowsForContainer"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils.CheckYourAnswers.getCYARowsForContainer', function () {
+  var expectObjectLike = function expectObjectLike(received, expected) {
+    Object.keys(expected).forEach(function (key) {
+      expect(received[key]).toEqual(expected[key]);
+    });
+  };
+
+  it('should get an appropriate row for a container with a single readonly text component', function () {
+    var FORM_DATA = {
+      container: {
+        a: 'Bravo'
+      }
+    };
+    var PAGE = {
+      id: 'page',
+      formData: FORM_DATA,
+      cya_link: {}
+    };
+    var COMPONENT = {
+      type: 'text',
+      readonly: true,
+      id: 'a',
+      fieldId: 'a',
+      label: 'Alpha'
+    };
+    var CONTAINER = {
+      id: 'container',
+      fieldId: 'container',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [COMPONENT],
+      value: FORM_DATA.container,
+      formData: FORM_DATA
+    };
+
+    var ON_ACTION = function ON_ACTION() {};
+
+    var ROWS = (0, _getCYARowsForContainer.default)(PAGE, CONTAINER, FORM_DATA.container, ON_ACTION);
+    expect(ROWS.length).toEqual(1);
+    ROWS.forEach(function (row, index) {
+      expectObjectLike(row, {
+        pageId: PAGE.id,
+        fieldId: CONTAINER.components[index].fieldId,
+        key: CONTAINER.components[index].label,
+        action: null,
+        component: COMPONENT,
+        value: 'Bravo'
+      });
+    });
+  });
+  it('should get appropriate rows for a container with two editable text components', function () {
+    var FORM_DATA = {
+      container: {
+        a: 'Alpha Charlie',
+        b: 'Bravo Charlie'
+      }
+    };
+    var PAGE = {
+      id: 'page',
+      formData: FORM_DATA,
+      cya_link: {}
+    };
+    var COMPONENT_A = {
+      type: 'text',
+      id: 'a',
+      fieldId: 'a',
+      label: 'Alpha'
+    };
+    var COMPONENT_B = {
+      type: 'text',
+      id: 'b',
+      fieldId: 'b',
+      label: 'Bravo'
+    };
+    var CONTAINER = {
+      id: 'container',
+      fieldId: 'container',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [COMPONENT_A, COMPONENT_B],
+      value: FORM_DATA.container,
+      formData: FORM_DATA
+    };
+
+    var ON_ACTION = function ON_ACTION() {};
+
+    var ROWS = (0, _getCYARowsForContainer.default)(PAGE, CONTAINER, FORM_DATA.container, ON_ACTION);
+    expect(ROWS.length).toEqual(2);
+    ROWS.forEach(function (row, index) {
+      expectObjectLike(row, {
+        pageId: PAGE.id,
+        fieldId: CONTAINER.components[index].fieldId,
+        key: CONTAINER.components[index].label,
+        component: CONTAINER.components[index],
+        value: "".concat(CONTAINER.components[index].label, " Charlie")
+      });
+      expectObjectLike(row.action, {
+        onAction: ON_ACTION
+      });
+    });
+  });
+  it("should filter out any components that shouldn't be shown", function () {
+    var FORM_DATA = {
+      container: {
+        a: 'Alpha Charlie',
+        b: 'Bravo Charlie'
+      }
+    };
+    var PAGE = {
+      id: 'page',
+      formData: FORM_DATA,
+      cya_link: {}
+    };
+    var COMPONENT_A = {
+      type: 'text',
+      id: 'a',
+      fieldId: 'a',
+      label: 'Alpha'
+    };
+    var COMPONENT_B = {
+      type: 'text',
+      id: 'b',
+      fieldId: 'b',
+      label: 'Bravo'
+    };
+    var COMPONENT_C = {
+      type: 'heading',
+      content: 'Heading component'
+    };
+    var CONTAINER = {
+      id: 'container',
+      fieldId: 'container',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [COMPONENT_A, COMPONENT_B, COMPONENT_C],
+      value: FORM_DATA.container,
+      formData: FORM_DATA
+    };
+
+    var ON_ACTION = function ON_ACTION() {};
+
+    var ROWS = (0, _getCYARowsForContainer.default)(PAGE, CONTAINER, FORM_DATA.container, ON_ACTION);
+    expect(ROWS.length).toEqual(2);
+    ROWS.forEach(function (row, index) {
+      expectObjectLike(row, {
+        pageId: PAGE.id,
+        fieldId: CONTAINER.components[index].fieldId,
+        key: CONTAINER.components[index].label,
+        component: CONTAINER.components[index],
+        value: "".concat(CONTAINER.components[index].label, " Charlie")
+      });
+      expectObjectLike(row.action, {
+        onAction: ON_ACTION
+      });
+    });
+  });
+  it('should get an appropriate row for a container with a single readonly text component inside a nested container', function () {
+    var FORM_DATA = {
+      container: {
+        nested: {
+          a: 'Bravo'
+        }
+      }
+    };
+    var PAGE = {
+      id: 'page',
+      formData: FORM_DATA,
+      cya_link: {}
+    };
+    var COMPONENT = {
+      type: 'text',
+      readonly: true,
+      id: 'a',
+      fieldId: 'a',
+      label: 'Alpha'
+    };
+    var NESTED_CONTAINER = {
+      id: 'nested',
+      fieldId: 'nested',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [COMPONENT],
+      value: FORM_DATA.container.nested,
+      formData: FORM_DATA
+    };
+    var CONTAINER = {
+      id: 'container',
+      fieldId: 'container',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [NESTED_CONTAINER],
+      value: FORM_DATA.container,
+      formData: FORM_DATA
+    };
+
+    var ON_ACTION = function ON_ACTION() {};
+
+    var ROWS = (0, _getCYARowsForContainer.default)(PAGE, CONTAINER, FORM_DATA.container, ON_ACTION);
+    expect(ROWS.length).toEqual(1);
+    ROWS.forEach(function (row, index) {
+      expectObjectLike(row, {
+        pageId: PAGE.id,
+        fieldId: NESTED_CONTAINER.components[index].fieldId,
+        key: NESTED_CONTAINER.components[index].label,
+        action: null,
+        component: COMPONENT,
+        value: 'Bravo'
+      });
+    });
+  });
+  it('should get an appropriate row for a container with a single readonly text component inside a nested container but no formData', function () {
+    var FORM_DATA = undefined;
+    var PAGE = {
+      id: 'page',
+      formData: FORM_DATA,
+      cya_link: {}
+    };
+    var COMPONENT = {
+      type: 'text',
+      readonly: true,
+      id: 'a',
+      fieldId: 'a',
+      label: 'Alpha'
+    };
+    var NESTED_CONTAINER = {
+      id: 'nested',
+      fieldId: 'nested',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [COMPONENT]
+    };
+    var CONTAINER = {
+      id: 'container',
+      fieldId: 'container',
+      type: _models.ComponentTypes.CONTAINER,
+      components: [NESTED_CONTAINER]
+    };
+
+    var ON_ACTION = function ON_ACTION() {};
+
+    var ROWS = (0, _getCYARowsForContainer.default)(PAGE, CONTAINER, undefined, ON_ACTION);
+    expect(ROWS.length).toEqual(1);
+    ROWS.forEach(function (row, index) {
+      expectObjectLike(row, {
+        pageId: PAGE.id,
+        fieldId: NESTED_CONTAINER.components[index].fieldId,
+        key: NESTED_CONTAINER.components[index].label,
+        action: null,
+        component: COMPONENT,
+        value: ''
+      });
+    });
+  });
+});

package/dist/utils/CheckYourAnswers/getCYARowsForPage.js

@@ -5,10 +5,14 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _models = require("../../models");
+
 var _FormPage = _interopRequireDefault(require("../FormPage"));
 
 var _getCYARow = _interopRequireDefault(require("./getCYARow"));
 
+var _getCYARowsForContainer = _interopRequireDefault(require("./getCYARowsForContainer"));
+
 var _showComponentCYA = _interopRequireDefault(require("./showComponentCYA"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -27,7 +31,11 @@ var getCYARowsForPage = function getCYARowsForPage(page, onAction) {
   if (_FormPage.default.show(page, page.formData)) {
     return page.components.filter(function (c) {
       return (0, _showComponentCYA.default)(c, page.formData);
-    }).map(function (component) {
+    }).flatMap(function (component) {
+      if (component.type === _models.ComponentTypes.CONTAINER) {
+        return (0, _getCYARowsForContainer.default)(page, component, page.formData[component.fieldId], onAction);
+      }
+
       return (0, _getCYARow.default)(page, component, onAction);
     });
   }

package/dist/utils/CheckYourAnswers/getCYARowsForPage.test.js

@@ -1,5 +1,7 @@
 "use strict";
 
+var _models = require("../../models");
+
 var _getCYARowsForPage = _interopRequireDefault(require("./getCYARowsForPage"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -129,6 +131,48 @@ describe('utils', function () {
           });
         });
       });
+      it('should get a appropriate row for a page with a single readonly text component inside of a container', function () {
+        var FORM_DATA = {
+          container: {
+            a: 'Bravo'
+          }
+        };
+        var COMPONENT = {
+          type: 'text',
+          readonly: true,
+          id: 'a',
+          fieldId: 'a',
+          label: 'Alpha'
+        };
+        var CONTAINER = {
+          id: 'container',
+          fieldId: 'container',
+          type: _models.ComponentTypes.CONTAINER,
+          components: [COMPONENT],
+          value: FORM_DATA.container,
+          formData: FORM_DATA
+        };
+        var PAGE = {
+          id: 'page',
+          components: [CONTAINER],
+          formData: FORM_DATA
+        };
+
+        var ON_ACTION = function ON_ACTION() {};
+
+        var ROWS = (0, _getCYARowsForPage.default)(PAGE, ON_ACTION);
+        expect(ROWS.length).toEqual(1);
+        ROWS.forEach(function (row, index) {
+          expectObjectLike(row, {
+            pageId: PAGE.id,
+            fieldId: CONTAINER.components[index].fieldId,
+            key: CONTAINER.components[index].label,
+            action: null,
+            component: COMPONENT,
+            value: 'Bravo'
+          });
+        });
+      });
     });
   });
 });

package/dist/utils/CheckYourAnswers/showComponentCYA.js

@@ -9,6 +9,8 @@ var _models = require("../../models");
 
 var _Component = _interopRequireDefault(require("../Component"));
 
+var _Container = _interopRequireDefault(require("../Container"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
@@ -31,6 +33,10 @@ var showComponentCYA = function showComponentCYA(options, data) {
     return false;
   }
 
+  if (options.type === _models.ComponentTypes.CONTAINER) {
+    return _Container.default.show(options, data);
+  }
+
   return _Component.default.show(options, data);
 };
 

package/dist/utils/Component/cleanAttributes.js

@@ -19,7 +19,7 @@ function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToAr
 
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
 
-var JSON_ONLY_PROPERTIES = ['source', 'use', 'show_when', 'options', 'additionalValidation'];
+var JSON_ONLY_PROPERTIES = ['source', 'use', 'show_when', 'options', 'additionalValidation', 'full_path'];
 /**
  * This method removes and properties that are entirely specific to the JSON
  * configuration and that should not be used as HTML attributes.

package/dist/utils/Component/showComponent.js

@@ -5,9 +5,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _Data = _interopRequireDefault(require("../Data"));
-
-var _meetsCondition = _interopRequireDefault(require("../meetsCondition"));
+var _Condition = _interopRequireDefault(require("../Condition"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -21,23 +19,7 @@ var showComponent = function showComponent(component, data) {
     return false;
   }
 
-  if (component.show_when) {
-    if (Array.isArray(component.show_when)) {
-      var allConditionsMet = true;
-      component.show_when.forEach(function (condition) {
-        var sourceDataValue = _Data.default.getSource(data, condition.field);
-
-        allConditionsMet = allConditionsMet && (0, _meetsCondition.default)(condition, sourceDataValue);
-      });
-      return allConditionsMet;
-    } else {
-      var sourceDataValue = _Data.default.getSource(data, component.show_when.field);
-
-      return (0, _meetsCondition.default)(component.show_when, sourceDataValue);
-    }
-  }
-
-  return true;
+  return _Condition.default.meetsAll(component, data);
 };
 
 var _default = showComponent;

package/dist/utils/Condition/index.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _meetsAllConditions = _interopRequireDefault(require("./meetsAllConditions"));
+
+var _meetsCondition = _interopRequireDefault(require("./meetsCondition"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var Condition = {
+  meetsAll: _meetsAllConditions.default,
+  met: _meetsCondition.default
+};
+var _default = Condition;
+exports.default = _default;

package/dist/utils/Condition/meetsAllConditions.js

@@ -0,0 +1,40 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Data = _interopRequireDefault(require("../Data"));
+
+var _meetsCondition = _interopRequireDefault(require("./meetsCondition"));
+
+var _setupConditions = _interopRequireDefault(require("./setupConditions"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+
+/**
+ * Evaluates all condition(s) on a page, container, or component.
+ * @param {object} options The container to consider.
+ * @param {object} data The top-level form data.
+ * @returns Boolean true if all conditions are met; false otherwise.
+ */
+var meetsAllConditions = function meetsAllConditions(options, data) {
+  var conditions = (0, _setupConditions.default)(options);
+
+  if (conditions) {
+    var arr = Array.isArray(conditions) ? conditions : [conditions];
+    return arr.every(function (condition) {
+      var sourceDataValue = _Data.default.getSource(data, condition.field);
+
+      return (0, _meetsCondition.default)(condition, sourceDataValue);
+    });
+  }
+
+  return true;
+};
+
+var _default = meetsAllConditions;
+exports.default = _default;

package/dist/utils/Condition/meetsAllConditions.test.js

@@ -0,0 +1,62 @@
+"use strict";
+
+var _meetsAllConditions = _interopRequireDefault(require("./meetsAllConditions"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils.Condition.meetsAllConditions', function () {
+  var DATA = {
+    alpha: 'bravo',
+    charlie: 'delta'
+  };
+  it('should evaluate to true when conditions are null', function () {
+    expect((0, _meetsAllConditions.default)(null, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when conditions are undefined', function () {
+    expect((0, _meetsAllConditions.default)(undefined, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when conditions is an empty array', function () {
+    expect((0, _meetsAllConditions.default)([], DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when a single condition is met', function () {
+    var CONDITION = {
+      field: 'alpha',
+      op: 'eq',
+      value: 'bravo'
+    };
+    expect((0, _meetsAllConditions.default)(CONDITION, DATA)).toBeTruthy();
+  });
+  it('should evaluate to false when a single condition is not met', function () {
+    var CONDITION = {
+      field: 'alpha',
+      op: 'ne',
+      value: 'bravo'
+    };
+    expect((0, _meetsAllConditions.default)(CONDITION, DATA)).toBeFalsy();
+  });
+  it('should evaluate to true when all conditions are met', function () {
+    var CONDITIONS = [{
+      field: 'alpha',
+      op: 'eq',
+      value: 'bravo'
+    }, {
+      field: 'charlie',
+      op: 'eq',
+      value: 'delta'
+    }];
+    expect((0, _meetsAllConditions.default)(CONDITIONS, DATA)).toBeTruthy();
+  });
+  it('should evaluate to false when one of the conditions is not met', function () {
+    var CONDITIONS = [{
+      field: 'alpha',
+      op: 'eq',
+      value: 'bravo'
+    }, {
+      field: 'charlie',
+      op: 'eq',
+      value: 'echo'
+    }];
+    expect((0, _meetsAllConditions.default)(CONDITIONS, DATA)).toBeFalsy();
+  });
+});