@ukhomeoffice/cop-react-form-renderer 0.1.0-beta

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

@@ -0,0 +1,329 @@
+"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', function () {
+  describe('Component', function () {
+    describe('get', function () {
+      it('should return null for an unknown type', function () {
+        expect((0, _getComponent.default)({
+          type: 'unknown'
+        })).toBeNull();
+      });
+      it('should return a p tag by default for an HTML component', function () {
+        var ID = 'test-id';
+        var CONTENT = 'HTML content';
+        var COMPONENT = {
+          type: _models.ComponentTypes.HTML,
+          content: CONTENT,
+          'data-testid': ID
+        };
+
+        var _render = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render.container;
+
+        var p = (0, _react.getByTestId)(container, ID);
+        expect(p.innerHTML).toContain(CONTENT);
+        expect(p.tagName).toEqual('P');
+      });
+      it('should return an appropriate tag for an HTML component', function () {
+        var ID = 'test-id';
+        var TAG_NAME = 'hr';
+        var COMPONENT = {
+          type: _models.ComponentTypes.HTML,
+          tagName: TAG_NAME,
+          'data-testid': ID
+        };
+
+        var _render2 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render2.container;
+
+        var hr = (0, _react.getByTestId)(container, ID);
+        expect(hr.tagName).toEqual('HR');
+      });
+      it('should return an appropriately rendered heading component', function () {
+        var ID = 'test-id';
+        var SIZE = 'm';
+        var CONTENT = 'Heading text';
+        var COMPONENT = {
+          type: _models.ComponentTypes.HEADING,
+          size: SIZE,
+          content: CONTENT,
+          'data-testid': ID
+        };
+
+        var _render3 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render3.container;
+
+        var heading = (0, _react.getByTestId)(container, ID);
+        expect(heading.innerHTML).toContain(CONTENT);
+        expect(heading.tagName).toEqual('H3');
+        expect(heading.classList).toContain("govuk-heading-".concat(SIZE));
+      });
+      it('should return an appropriately rendered inset-text component', function () {
+        var ID = 'test-id';
+        var CONTENT = 'Heading text';
+        var COMPONENT = {
+          type: _models.ComponentTypes.INSET_TEXT,
+          content: CONTENT,
+          'data-testid': ID
+        };
+
+        var _render4 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render4.container;
+
+        var insetText = (0, _react.getByTestId)(container, ID);
+        expect(insetText.innerHTML).toContain(CONTENT);
+        expect(insetText.tagName).toEqual('DIV');
+        expect(insetText.classList).toContain('govuk-inset-text');
+      });
+      it('should return an appropriately rendered text component', function () {
+        var ID = 'test-id';
+        var FIELD_ID = 'field-id';
+        var LABEL = 'label';
+        var COMPONENT = {
+          type: _models.ComponentTypes.TEXT,
+          id: ID,
+          fieldId: FIELD_ID,
+          label: LABEL,
+          'data-testid': ID
+        };
+
+        var _render5 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render5.container;
+
+        var _getAllByTestId = (0, _react.getAllByTestId)(container, ID),
+            _getAllByTestId2 = _slicedToArray(_getAllByTestId, 2),
+            formGroup = _getAllByTestId2[0],
+            input = _getAllByTestId2[1];
+
+        expect(formGroup.tagName).toEqual('DIV');
+        expect(formGroup.classList).toContain('govuk-form-group');
+        var label = undefined;
+        formGroup.childNodes.forEach(function (node) {
+          // Check if it's an element.
+          if (node instanceof Element && node.tagName === 'LABEL') {
+            label = node;
+          }
+        });
+        expect(label).toBeDefined();
+        expect(label.innerHTML).toContain(LABEL);
+        expect(label.getAttribute('for')).toEqual(ID);
+        expect(input.tagName).toEqual('INPUT');
+        expect(input.classList).toContain('govuk-input');
+        expect(input.id).toEqual(ID);
+      });
+      it('should return an appropriately rendered email component', function () {
+        var ID = 'test-id';
+        var FIELD_ID = 'field-id';
+        var LABEL = 'label';
+        var COMPONENT = {
+          type: _models.ComponentTypes.EMAIL,
+          id: ID,
+          fieldId: FIELD_ID,
+          label: LABEL,
+          'data-testid': ID
+        };
+
+        var _render6 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render6.container;
+
+        var _getAllByTestId3 = (0, _react.getAllByTestId)(container, ID),
+            _getAllByTestId4 = _slicedToArray(_getAllByTestId3, 2),
+            formGroup = _getAllByTestId4[0],
+            input = _getAllByTestId4[1];
+
+        expect(formGroup.tagName).toEqual('DIV');
+        expect(formGroup.classList).toContain('govuk-form-group');
+        var label = undefined;
+        formGroup.childNodes.forEach(function (node) {
+          // Check if it's an element.
+          if (node instanceof Element && node.tagName === 'LABEL') {
+            label = node;
+          }
+        });
+        expect(label).toBeDefined();
+        expect(label.innerHTML).toContain(LABEL);
+        expect(label.getAttribute('for')).toEqual(ID);
+        expect(input.tagName).toEqual('INPUT');
+        expect(input.classList).toContain('govuk-input');
+        expect(input.id).toEqual(ID);
+      });
+      it('should return an appropriately rendered phone-number component', function () {
+        var ID = 'test-id';
+        var FIELD_ID = 'field-id';
+        var LABEL = 'label';
+        var COMPONENT = {
+          type: _models.ComponentTypes.PHONE_NUMBER,
+          id: ID,
+          fieldId: FIELD_ID,
+          label: LABEL,
+          'data-testid': ID
+        };
+
+        var _render7 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render7.container;
+
+        var _getAllByTestId5 = (0, _react.getAllByTestId)(container, ID),
+            _getAllByTestId6 = _slicedToArray(_getAllByTestId5, 2),
+            formGroup = _getAllByTestId6[0],
+            input = _getAllByTestId6[1];
+
+        expect(formGroup.tagName).toEqual('DIV');
+        expect(formGroup.classList).toContain('govuk-form-group');
+        var label = undefined;
+        formGroup.childNodes.forEach(function (node) {
+          // Check if it's an element.
+          if (node instanceof Element && node.tagName === 'LABEL') {
+            label = node;
+          }
+        });
+        expect(label).toBeDefined();
+        expect(label.innerHTML).toContain(LABEL);
+        expect(label.getAttribute('for')).toEqual(ID);
+        expect(input.tagName).toEqual('INPUT');
+        expect(input.classList).toContain('govuk-input');
+        expect(input.id).toEqual(ID);
+      });
+      it('should return an appropriately rendered autocomplete component', function () {
+        var ID = 'test-id';
+        var FIELD_ID = 'field-id';
+        var LABEL = 'label';
+        var OPTIONS = [];
+        var COMPONENT = {
+          type: _models.ComponentTypes.AUTOCOMPLETE,
+          id: ID,
+          fieldId: FIELD_ID,
+          label: LABEL,
+          data: {
+            options: OPTIONS
+          },
+          'data-testid': ID
+        };
+
+        var _render8 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render8.container;
+
+        var formGroup = (0, _react.getByTestId)(container, ID);
+        expect(formGroup.tagName).toEqual('DIV');
+        expect(formGroup.classList).toContain('govuk-form-group');
+        var label = undefined;
+        var autocompleteWrapper = undefined;
+        var autocomplete = undefined;
+        var autocompleteInput = undefined;
+        formGroup.childNodes.forEach(function (node) {
+          // Check if it's an element.
+          if (node instanceof Element) {
+            if (node.tagName === 'LABEL') {
+              label = node;
+            } else if (node.classList.contains('hods-autocomplete__outer-wrapper')) {
+              autocompleteWrapper = node;
+              var autocompleteInner = node.childNodes[0];
+
+              if (autocompleteInner instanceof Element) {
+                autocomplete = autocompleteInner;
+                autocomplete.childNodes.forEach(function (grandchild) {
+                  if (grandchild instanceof Element) {
+                    if (grandchild.tagName === 'INPUT') {
+                      autocompleteInput = grandchild;
+                    }
+                  }
+                });
+              }
+
+              ;
+            }
+          }
+        });
+        expect(label).toBeDefined();
+        expect(label.innerHTML).toContain(LABEL);
+        expect(label.getAttribute('for')).toEqual(ID);
+        expect(autocompleteWrapper).toBeDefined();
+        expect(autocompleteWrapper.tagName).toEqual('DIV');
+        expect(autocomplete).toBeDefined();
+        expect(autocomplete.tagName).toEqual('DIV');
+        expect(autocompleteInput).toBeDefined();
+        expect(autocompleteInput.id).toEqual(ID);
+      });
+      it('should return an appropriately rendered radios component', function () {
+        var ID = 'test-id';
+        var FIELD_ID = 'field-id';
+        var LABEL = 'label';
+        var OPTIONS = [{
+          value: 'a',
+          label: 'Alpha'
+        }];
+        var COMPONENT = {
+          type: _models.ComponentTypes.RADIOS,
+          id: ID,
+          fieldId: FIELD_ID,
+          label: LABEL,
+          data: {
+            options: OPTIONS
+          },
+          'data-testid': ID
+        };
+
+        var _render9 = (0, _react.render)((0, _getComponent.default)(COMPONENT)),
+            container = _render9.container;
+
+        var _getAllByTestId7 = (0, _react.getAllByTestId)(container, ID),
+            _getAllByTestId8 = _slicedToArray(_getAllByTestId7, 2),
+            formGroup = _getAllByTestId8[0],
+            radios = _getAllByTestId8[1];
+
+        expect(formGroup.tagName).toEqual('DIV');
+        expect(formGroup.classList).toContain('govuk-form-group');
+        var label = undefined;
+        formGroup.childNodes.forEach(function (node) {
+          // Check if it's an element.
+          if (node instanceof Element) {
+            if (node.tagName === 'LABEL') {
+              label = node;
+            }
+          }
+        });
+        expect(label).toBeDefined();
+        expect(label.innerHTML).toContain(LABEL);
+        expect(label.getAttribute('for')).toEqual(ID);
+        expect(radios.tagName).toEqual('DIV');
+        expect(radios.classList).toContain('govuk-radios');
+        expect(radios.childNodes.length).toEqual(OPTIONS.length);
+        var radioItems = [];
+        OPTIONS.forEach(function (_, index) {
+          var radio = radios.childNodes[index];
+          expect(radio instanceof Element).toBeTruthy();
+
+          if (radio instanceof Element) {
+            radioItems.push(radio);
+          }
+        });
+        expect(radioItems.length).toEqual(OPTIONS.length);
+        OPTIONS.forEach(function (option, index) {
+          var radio = radioItems[index];
+          expect(radio.tagName).toEqual('DIV');
+          expect(radio.classList).toContain('govuk-radios__item');
+          expect(radio.innerHTML).toContain(option.label);
+        });
+      });
+    });
+  });
+});

package/dist/utils/Component/index.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _cleanAttributes = _interopRequireDefault(require("./cleanAttributes"));
+
+var _getComponent = _interopRequireDefault(require("./getComponent"));
+
+var _isEditable = _interopRequireDefault(require("./isEditable"));
+
+var _showComponent = _interopRequireDefault(require("./showComponent"));
+
+var _wrapInFormGroup = _interopRequireDefault(require("./wrapInFormGroup"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var Component = {
+  clean: _cleanAttributes.default,
+  get: _getComponent.default,
+  editable: _isEditable.default,
+  show: _showComponent.default,
+  wrap: _wrapInFormGroup.default
+};
+var _default = Component;
+exports.default = _default;

package/dist/utils/Component/isEditable.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.EDITABLE_TYPES = void 0;
+
+var _models = require("../../models");
+
+// Local imports
+var EDITABLE_TYPES = [_models.ComponentTypes.AUTOCOMPLETE, _models.ComponentTypes.EMAIL, _models.ComponentTypes.PHONE_NUMBER, _models.ComponentTypes.RADIOS, _models.ComponentTypes.TEXT];
+exports.EDITABLE_TYPES = EDITABLE_TYPES;
+
+var isEditable = function isEditable(options) {
+  return EDITABLE_TYPES.includes(options === null || options === void 0 ? void 0 : options.type);
+};
+
+var _default = isEditable;
+exports.default = _default;

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

@@ -0,0 +1,42 @@
+"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); }
+
+var _isEditable = _interopRequireWildcard(require("./isEditable"));
+
+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; }
+
+// Local imports
+describe('utils', function () {
+  describe('Component', function () {
+    describe('isEditable', function () {
+      _isEditable.EDITABLE_TYPES.forEach(function (type) {
+        it("should return true for a type of '".concat(type, "'"), function () {
+          var OPTIONS = {
+            type: type
+          };
+          expect((0, _isEditable.default)(OPTIONS)).toEqual(true);
+        });
+      });
+
+      it('should return false if options is undefined', function () {
+        expect((0, _isEditable.default)(undefined)).toEqual(false);
+      });
+      it('should return false if options is null', function () {
+        expect((0, _isEditable.default)(null)).toEqual(false);
+      });
+      it('should return false if options has no type', function () {
+        expect((0, _isEditable.default)({
+          bob: 'Bob'
+        })).toEqual(false);
+      });
+      it("should return false if options has a type of 'hidden'", function () {
+        expect((0, _isEditable.default)({
+          type: 'hidden'
+        })).toEqual(false);
+      });
+    });
+  });
+});

package/dist/utils/Component/showComponent.js

@@ -0,0 +1,44 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Data = _interopRequireDefault(require("../Data"));
+
+var _meetsCondition = _interopRequireDefault(require("../meetsCondition"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var showComponent = function showComponent(component, data) {
+  if (!component) {
+    return false;
+  }
+
+  if (component.hidden && component.disabled) {
+    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;
+};
+
+var _default = showComponent;
+exports.default = _default;

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

@@ -0,0 +1,94 @@
+"use strict";
+
+var _showComponent = _interopRequireDefault(require("./showComponent"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Component', function () {
+    describe('show', function () {
+      it('should not show when there are no options', function () {
+        expect((0, _showComponent.default)(null, null)).toBeFalsy();
+      });
+      it('should not show when hidden and disabled', function () {
+        expect((0, _showComponent.default)({
+          hidden: true,
+          disabled: true
+        }, null)).toBeFalsy();
+      });
+      it('should show when hidden but not disabled', function () {
+        expect((0, _showComponent.default)({
+          hidden: true
+        }, null)).toBeTruthy();
+      });
+      it('should show when disabled but not hidden', function () {
+        expect((0, _showComponent.default)({
+          disabled: true
+        }, null)).toBeTruthy();
+      });
+      it('should show when a single show_when condition is met', function () {
+        var COMPONENT = {
+          show_when: {
+            field: 'alpha',
+            op: 'eq',
+            value: 'bravo'
+          }
+        };
+        var DATA = {
+          alpha: 'bravo'
+        };
+        expect((0, _showComponent.default)(COMPONENT, DATA)).toBeTruthy();
+      });
+      it('should not show when a single show_when condition is not met', function () {
+        var COMPONENT = {
+          show_when: {
+            field: 'alpha',
+            op: 'eq',
+            value: 'bravo'
+          }
+        };
+        var DATA = {
+          alpha: 'charlie'
+        };
+        expect((0, _showComponent.default)(COMPONENT, DATA)).toBeFalsy();
+      });
+      it('should show when multiple show_when conditions are met', function () {
+        var COMPONENT = {
+          show_when: [{
+            field: 'alpha',
+            op: 'eq',
+            value: 'bravo'
+          }, {
+            field: 'charlie',
+            op: 'eq',
+            value: 'delta'
+          }]
+        };
+        var DATA = {
+          alpha: 'bravo',
+          charlie: 'delta'
+        };
+        expect((0, _showComponent.default)(COMPONENT, DATA)).toBeTruthy();
+      });
+      it('should not show when one of multiple show_when conditions is not met', function () {
+        var COMPONENT = {
+          show_when: [{
+            field: 'alpha',
+            op: 'eq',
+            value: 'bravo'
+          }, {
+            field: 'charlie',
+            op: 'eq',
+            value: 'delta'
+          }]
+        };
+        var DATA = {
+          alpha: 'bravo',
+          charlie: 'echo'
+        };
+        expect((0, _showComponent.default)(COMPONENT, DATA)).toBeFalsy();
+      });
+    });
+  });
+});

package/dist/utils/Component/wrapInFormGroup.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _react = _interopRequireDefault(require("react"));
+
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+
+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, {
+    onChange: null
+  }), children);
+};
+
+var _default = wrapInFormGroup;
+exports.default = _default;

package/dist/utils/Data/getAutocompleteSource.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getOptions = _interopRequireDefault(require("./getOptions"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var getAutocompleteSource = function getAutocompleteSource(config) {
+  var options = [];
+  (0, _getOptions.default)(config, function (val) {
+    options = val;
+  });
+  return function (query, populateResults) {
+    var lcQuery = query ? query.toLowerCase() : '';
+    populateResults(options.filter(function (opt) {
+      var lcLabel = opt.label ? opt.label.toLowerCase() : '';
+      return lcLabel.includes(lcQuery);
+    }));
+  };
+};
+
+var _default = getAutocompleteSource;
+exports.default = _default;