@ukhomeoffice/cop-react-form-renderer 3.1.0 → 3.2.3

package/dist/context/HooksContext/HooksContext.js

@@ -1,11 +1,17 @@
 "use strict";
 
+function _typeof(obj) { "@babel/helpers - typeof"; if (typeof Symbol === "function" && typeof Symbol.iterator === "symbol") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === "function" && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }; } return _typeof(obj); }
+
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = exports.HooksContext = exports.ALLOWED_HOOKS = void 0;
 
-var _react = require("react");
+var _react = _interopRequireWildcard(require("react"));
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 
 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; }
 
@@ -78,7 +84,7 @@ var HooksContextProvider = function HooksContextProvider(_ref) {
     }
   };
 
-  return /*#__PURE__*/React.createElement(HooksContext.Provider, {
+  return /*#__PURE__*/_react.default.createElement(HooksContext.Provider, {
     value: {
       hooks: hooks,
       addHook: addHook,

package/dist/utils/Component/getComponent.js

@@ -224,8 +224,7 @@ var getComponent = function getComponent(config) {
   var component = getComponentByType(config);
 
   if (component && wrap && (0, _isEditable.default)(config)) {
-    var attrs = (0, _cleanAttributes.default)(config, ['fieldId', 'displayMenu']);
-    return (0, _wrapInFormGroup.default)(attrs, component);
+    return (0, _wrapInFormGroup.default)(config, component);
   }
 
   return component;

package/dist/utils/Component/getComponentTests/getComponent.time.test.js

@@ -0,0 +1,106 @@
+"use strict";
+
+var _react = require("@testing-library/react");
+
+var _models = require("../../../models");
+
+var _getComponent = _interopRequireDefault(require("../getComponent"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+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; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+describe('utils.Component.get', function () {
+  it('should return an appropriately rendered time component', function () {
+    var ID = 'test-id';
+    var FIELD_ID = 'field-id';
+    var LABEL = 'label';
+    var ON_CHANGE_CALLS = [];
+
+    var ON_CHANGE = function ON_CHANGE(e) {
+      ON_CHANGE_CALLS.push(e.target);
+    };
+
+    var COMPONENT = {
+      type: _models.ComponentTypes.TIME,
+      id: ID,
+      fieldId: FIELD_ID,
+      label: LABEL,
+      onChange: ON_CHANGE,
+      'data-testid': ID
+    };
+
+    var _render = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+        container = _render.container;
+
+    var _getAllByTestId = (0, _react.getAllByTestId)(container, ID),
+        _getAllByTestId2 = _slicedToArray(_getAllByTestId, 2),
+        formGroup = _getAllByTestId2[0],
+        timeInput = _getAllByTestId2[1];
+
+    expect(formGroup.tagName).toEqual('DIV');
+    expect(formGroup.classList).toContain('govuk-form-group');
+    var label = formGroup.childNodes[0];
+    expect(label.innerHTML).toContain(LABEL);
+    expect(label.getAttribute('for')).toEqual(ID);
+    expect(timeInput.tagName).toEqual('DIV');
+    expect(timeInput.classList).toContain('govuk-date-input');
+    expect(timeInput.id).toEqual(ID);
+    var onChangeCalls = ON_CHANGE_CALLS.length;
+
+    var _timeInput$childNodes = _slicedToArray(timeInput.childNodes, 2),
+        hourItem = _timeInput$childNodes[0],
+        minuteItem = _timeInput$childNodes[1];
+
+    [{
+      id: 'hour',
+      label: 'Hour',
+      item: hourItem,
+      value: '5',
+      expectedValue: '5:'
+    }, {
+      id: 'minute',
+      label: 'Minute',
+      item: minuteItem,
+      value: '11',
+      expectedValue: '5:11'
+    }].forEach(function (part) {
+      expect(part.item.tagName).toEqual('DIV');
+      expect(part.item.classList).toContain('govuk-date-input__item');
+
+      var _part$item$childNodes = _slicedToArray(part.item.childNodes, 2),
+          label = _part$item$childNodes[0],
+          input = _part$item$childNodes[1];
+
+      expect(label.tagName).toEqual('LABEL');
+      expect(label.classList).toContain('govuk-label');
+      expect(label.textContent).toEqual(part.label);
+      expect(input.tagName).toEqual('INPUT');
+      expect(input.id).toEqual("".concat(ID, "-").concat(part.id)); // Put something in the input and make sure it fires.
+
+      _react.fireEvent.change(input, {
+        target: {
+          name: "".concat(FIELD_ID, "-").concat(part.id),
+          value: part.value
+        }
+      });
+
+      onChangeCalls++;
+      expect(ON_CHANGE_CALLS.length).toEqual(onChangeCalls);
+      expect(ON_CHANGE_CALLS[onChangeCalls - 1]).toMatchObject({
+        name: FIELD_ID,
+        value: part.expectedValue
+      });
+    });
+  });
+});

package/dist/utils/Component/showComponent.js

@@ -11,6 +11,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 // Local imports
 var showComponent = function showComponent(component, data) {
+  var _component$show_when;
+
   if (!component) {
     return false;
   }
@@ -19,6 +21,10 @@ var showComponent = function showComponent(component, data) {
     return false;
   }
 
+  if (((_component$show_when = component.show_when) === null || _component$show_when === void 0 ? void 0 : _component$show_when.type) === "or") {
+    return _Condition.default.meetsOne(component, data);
+  }
+
   return _Condition.default.meetsAll(component, data);
 };
 

package/dist/utils/Component/showComponent.test.js

@@ -89,6 +89,69 @@ describe('utils', function () {
         };
         expect((0, _showComponent.default)(COMPONENT, DATA)).toBeFalsy();
       });
+      it('SHOULD be shown when the component has multiple show_when conditions, with type "or" provided and ALL are matched', function () {
+        var COMPONENT = {
+          show_when: {
+            "type": "or",
+            "conditions": [{
+              field: 'alpha',
+              op: '=',
+              value: 'Alpha'
+            }, {
+              field: 'bravo',
+              op: '=',
+              value: 'Bravo'
+            }]
+          }
+        };
+        var DATA = {
+          alpha: 'Alpha',
+          bravo: 'Bravo'
+        };
+        expect((0, _showComponent.default)(COMPONENT, DATA)).toBeTruthy();
+      });
+      it('SHOULD be shown when the component has multiple show_when conditions, with type "or" provided and at least ONE is matched', function () {
+        var COMPONENT = {
+          show_when: {
+            "type": "or",
+            "conditions": [{
+              field: 'alpha',
+              op: '=',
+              value: 'Alpha'
+            }, {
+              field: 'charlie',
+              op: '=',
+              value: 'Charlie'
+            }]
+          }
+        };
+        var DATA = {
+          alpha: 'Alpha',
+          bravo: 'Bravo'
+        };
+        expect((0, _showComponent.default)(COMPONENT, DATA)).toBeTruthy();
+      });
+      it('should NOT be shown when the component has multiple show_when conditions, with type "or" provided and NONE are matched', function () {
+        var COMPONENT = {
+          show_when: {
+            "type": "or",
+            "conditions": [{
+              field: 'alpha',
+              op: '!=',
+              value: 'Alpha'
+            }, {
+              field: 'charlie',
+              op: '=',
+              value: 'Charlie'
+            }]
+          }
+        };
+        var DATA = {
+          alpha: 'Alpha',
+          bravo: 'Bravo'
+        };
+        expect((0, _showComponent.default)(COMPONENT, DATA)).toBeFalsy();
+      });
     });
   });
 });

package/dist/utils/Component/wrapInFormGroup.js

@@ -5,16 +5,19 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
 var _react = _interopRequireDefault(require("react"));
 
-var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+var _cleanAttributes = _interopRequireDefault(require("./cleanAttributes"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
 var wrapInFormGroup = function wrapInFormGroup(config, children) {
-  return /*#__PURE__*/_react.default.createElement(_copReactComponents.FormGroup, _extends({}, config, {
+  var attrs = (0, _cleanAttributes.default)(config, ['fieldId', 'displayMenu']);
+  return /*#__PURE__*/_react.default.createElement(_copReactComponents.FormGroup, _extends({}, attrs, {
     onChange: null
   }), children);
 };

package/dist/utils/Condition/index.js

@@ -9,9 +9,12 @@ var _meetsAllConditions = _interopRequireDefault(require("./meetsAllConditions")
 
 var _meetsCondition = _interopRequireDefault(require("./meetsCondition"));
 
+var _meetsOneCondition = _interopRequireDefault(require("./meetsOneCondition"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 var Condition = {
+  meetsOne: _meetsOneCondition.default,
   meetsAll: _meetsAllConditions.default,
   met: _meetsCondition.default
 };

package/dist/utils/Condition/meetsOneCondition.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 at least one conditions is met; false otherwise.
+ */
+var meetsOneCondition = function meetsOneCondition(options, data) {
+  var conditions = (0, _setupConditions.default)(options);
+
+  if (conditions) {
+    var arr = Array.isArray(conditions) ? conditions : [conditions];
+    return arr.some(function (condition) {
+      var sourceDataValue = _Data.default.getSource(data, condition.field);
+
+      return (0, _meetsCondition.default)(condition, sourceDataValue);
+    });
+  }
+
+  return true;
+};
+
+var _default = meetsOneCondition;
+exports.default = _default;

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

@@ -0,0 +1,101 @@
+"use strict";
+
+var _meetsOneCondition = _interopRequireDefault(require("./meetsOneCondition"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils.Condition.meetsOneCondition', function () {
+  var DATA = {
+    alpha: 'bravo',
+    charlie: 'delta'
+  };
+  it('should evaluate to true when conditions are null', function () {
+    expect((0, _meetsOneCondition.default)(null, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when conditions are undefined', function () {
+    expect((0, _meetsOneCondition.default)(undefined, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when conditions is an empty array', function () {
+    var CONDITION = {
+      "type": "or",
+      "conditions": []
+    };
+    expect((0, _meetsOneCondition.default)(CONDITION, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when one condition is provided and one condition is met', function () {
+    var CONDITION = {
+      "type": "or",
+      "conditions": [{
+        field: 'alpha',
+        op: 'eq',
+        value: 'bravo'
+      }]
+    };
+    expect((0, _meetsOneCondition.default)(CONDITION, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when two conditions are provided and one condition is met', function () {
+    var CONDITION = {
+      "type": "or",
+      "conditions": [{
+        field: 'alpha',
+        op: 'eq',
+        value: 'bravo'
+      }, {
+        field: 'alpha',
+        op: 'eq',
+        value: "charlie"
+      }]
+    };
+    expect((0, _meetsOneCondition.default)(CONDITION, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when three conditions are provided and two conditions are met', function () {
+    var CONDITION = {
+      "type": "or",
+      "conditions": [{
+        field: 'alpha',
+        op: 'eq',
+        value: 'bravo'
+      }, {
+        field: 'charlie',
+        op: 'eq',
+        value: 'delta'
+      }, {
+        field: 'alpha',
+        op: 'eq',
+        value: "charlie"
+      }]
+    };
+    expect((0, _meetsOneCondition.default)(CONDITION, DATA)).toBeTruthy();
+  });
+  it('should evaluate to true when all conditions are met', function () {
+    var CONDITION = {
+      "type": "or",
+      "conditions": [{
+        field: 'alpha',
+        op: 'eq',
+        value: 'bravo'
+      }, {
+        field: 'charlie',
+        op: 'eq',
+        value: 'delta'
+      }]
+    };
+    expect((0, _meetsOneCondition.default)(CONDITION, DATA)).toBeTruthy();
+  });
+  it('should evaluate to false when no conditions are met', function () {
+    var CONDITION = {
+      "type": "or",
+      "conditions": [{
+        field: 'alpha',
+        op: 'eq',
+        value: 'delta'
+      }, {
+        field: 'charlie',
+        op: 'eq',
+        value: 'bravo'
+      }]
+    };
+    expect((0, _meetsOneCondition.default)(CONDITION, DATA)).toBeTruthy();
+  });
+});

package/dist/utils/Condition/setupConditions.js

@@ -17,12 +17,13 @@ function _defineProperty(obj, key, value) { if (key in obj) { Object.definePrope
 
 var makeComponentFieldsAbsolute = function makeComponentFieldsAbsolute(component) {
   if (component.show_when) {
+    var conditions = component.show_when.type ? component.show_when.conditions : component.show_when;
     var full_path = component.full_path;
-    var show_when = Array.isArray(component.show_when) ? component.show_when : [component.show_when];
-    return show_when.map(function (sw) {
-      var field = _Data.default.getDataPath(sw.field, full_path);
+    conditions = Array.isArray(conditions) ? conditions : [conditions];
+    return conditions.map(function (condition) {
+      var field = _Data.default.getDataPath(condition.field, full_path);
 
-      return _objectSpread(_objectSpread({}, sw), {}, {
+      return _objectSpread(_objectSpread({}, condition), {}, {
         field: field
       });
     });

package/dist/utils/Container/showContainer.js

@@ -41,6 +41,10 @@ var showContainer = function showContainer(container, data) {
 
 
   if (container.show_when) {
+    if (container.show_when.type === "or") {
+      return _Condition.default.meetsOne(container, data);
+    }
+
     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.

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

@@ -125,4 +125,55 @@ describe('utils.Container.showContainer', function () {
     };
     expect((0, _showContainer.default)(CONTAINER, DATA)).toBeTruthy();
   });
+  it('SHOULD be shown when the container has multiple show_when conditions, with type "or" provided and ALL are matched', function () {
+    var CONTAINER = {
+      show_when: {
+        "type": "or",
+        "conditions": [{
+          field: 'alpha',
+          op: '=',
+          value: 'Alpha'
+        }, {
+          field: 'bravo',
+          op: '=',
+          value: 'Bravo'
+        }]
+      }
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeTruthy();
+  });
+  it('SHOULD be shown when the container has multiple show_when conditions, with type "or" provided and at least ONE is matched', function () {
+    var CONTAINER = {
+      show_when: {
+        "type": "or",
+        "conditions": [{
+          field: 'alpha',
+          op: '=',
+          value: 'Alpha'
+        }, {
+          field: 'charlie',
+          op: '=',
+          value: 'Charlie'
+        }]
+      }
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeTruthy();
+  });
+  it('should NOT be shown when the container has multiple show_when conditions, with type "or" provided and NONE are matched', function () {
+    var CONTAINER = {
+      show_when: {
+        "type": "or",
+        "conditions": [{
+          field: 'alpha',
+          op: '!=',
+          value: 'Alpha'
+        }, {
+          field: 'charlie',
+          op: '=',
+          value: 'Charlie'
+        }]
+      }
+    };
+    expect((0, _showContainer.default)(CONTAINER, DATA)).toBeFalsy();
+  });
 });

package/dist/utils/FormPage/showFormPage.js

@@ -41,6 +41,10 @@ var showFormPage = function showFormPage(page, data) {
 
 
   if (page.show_when) {
+    if (page.show_when.type === "or") {
+      return _Condition.default.meetsOne(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.

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

@@ -126,6 +126,57 @@ describe('utils', function () {
         };
         expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
       });
+      it('SHOULD be shown when the page has multiple show_when conditions, with type "or" provided and ALL are matched', function () {
+        var PAGE = {
+          show_when: {
+            "type": "or",
+            "conditions": [{
+              field: 'alpha',
+              op: '=',
+              value: 'Alpha'
+            }, {
+              field: 'bravo',
+              op: '=',
+              value: 'Bravo'
+            }]
+          }
+        };
+        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
+      });
+      it('SHOULD be shown when the page has multiple show_when conditions, with type "or" provided and at least ONE is matched', function () {
+        var PAGE = {
+          show_when: {
+            "type": "or",
+            "conditions": [{
+              field: 'alpha',
+              op: '=',
+              value: 'Alpha'
+            }, {
+              field: 'charlie',
+              op: '=',
+              value: 'Charlie'
+            }]
+          }
+        };
+        expect((0, _showFormPage.default)(PAGE, DATA)).toBeTruthy();
+      });
+      it('should NOT be shown when the page has multiple show_when conditions, with type "or" provided and NONE are matched', function () {
+        var PAGE = {
+          show_when: {
+            "type": "or",
+            "conditions": [{
+              field: 'alpha',
+              op: '!=',
+              value: 'Alpha'
+            }, {
+              field: 'charlie',
+              op: '=',
+              value: 'Charlie'
+            }]
+          }
+        };
+        expect((0, _showFormPage.default)(PAGE, DATA)).toBeFalsy();
+      });
     });
   });
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "3.1.0",
+  "version": "3.2.3",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "1.7.3",
+    "@ukhomeoffice/cop-react-components": "1.7.4",
     "axios": "^0.21.1",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^3.13.0",