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

package/dist/hooks/useGetRequest.js

@@ -0,0 +1,149 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = exports.STATUS_IDLE = exports.STATUS_FETCHING = exports.STATUS_FETCHED = exports.STATUS_ERROR = void 0;
+
+var _axios = _interopRequireDefault(require("axios"));
+
+var _react = require("react");
+
+var _useAxios = _interopRequireDefault(require("./useAxios"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+
+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; }
+
+var cache = {};
+var errorCache = {};
+var STATUS_IDLE = 'idle';
+exports.STATUS_IDLE = STATUS_IDLE;
+var STATUS_FETCHING = 'fetching';
+exports.STATUS_FETCHING = STATUS_FETCHING;
+var STATUS_FETCHED = 'fetched';
+exports.STATUS_FETCHED = STATUS_FETCHED;
+var STATUS_ERROR = 'error';
+exports.STATUS_ERROR = STATUS_ERROR;
+
+var useGetRequest = function useGetRequest(url) {
+  var axiosInstance = (0, _useAxios.default)();
+
+  var cancelToken = _axios.default.CancelToken.source();
+
+  var cancelRequests = function cancelRequests() {
+    if (cancelToken) cancelToken.cancel();
+  };
+
+  var _useState = (0, _react.useState)(STATUS_IDLE),
+      _useState2 = _slicedToArray(_useState, 2),
+      status = _useState2[0],
+      setStatus = _useState2[1];
+
+  var _useState3 = (0, _react.useState)(null),
+      _useState4 = _slicedToArray(_useState3, 2),
+      error = _useState4[0],
+      setError = _useState4[1];
+
+  var _useState5 = (0, _react.useState)(null),
+      _useState6 = _slicedToArray(_useState5, 2),
+      data = _useState6[0],
+      setData = _useState6[1];
+
+  (0, _react.useEffect)(function () {
+    if (!url || !axiosInstance) return;
+
+    var fetchData = /*#__PURE__*/function () {
+      var _ref = _asyncToGenerator( /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+        var fetchedData, response;
+        return regeneratorRuntime.wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                _context.prev = 0;
+                setError(null);
+                setStatus(STATUS_FETCHING);
+
+                if (!cache[url]) {
+                  _context.next = 7;
+                  break;
+                }
+
+                fetchedData = cache[url];
+                _context.next = 16;
+                break;
+
+              case 7:
+                if (!errorCache[url]) {
+                  _context.next = 11;
+                  break;
+                }
+
+                throw errorCache[url];
+
+              case 11:
+                _context.next = 13;
+                return axiosInstance.get(url, {
+                  cancelToken: cancelToken.token
+                }).catch(function (e) {
+                  throw e;
+                });
+
+              case 13:
+                response = _context.sent;
+                fetchedData = response.data;
+                cache[url] = fetchedData;
+
+              case 16:
+                setData(fetchedData);
+                setStatus(STATUS_FETCHED);
+                _context.next = 26;
+                break;
+
+              case 20:
+                _context.prev = 20;
+                _context.t0 = _context["catch"](0);
+                errorCache[url] = _context.t0;
+                setError(_context.t0);
+                setData(null);
+                setStatus(STATUS_ERROR);
+
+              case 26:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, null, [[0, 20]]);
+      }));
+
+      return function fetchData() {
+        return _ref.apply(this, arguments);
+      };
+    }();
+
+    fetchData();
+  }, [axiosInstance, url, cancelToken.token]);
+  return {
+    status: status,
+    error: error,
+    data: data,
+    cancelRequests: cancelRequests
+  };
+};
+
+var _default = useGetRequest;
+exports.default = _default;

package/dist/hooks/useHooks.js

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.resetHooks = exports.removeHook = exports.default = exports.addHook = void 0;
+var ALLOWED_HOOKS = ['onRequest'];
+var DEFAULT_HOOKS = {
+  onRequest: function onRequest(req) {
+    return req;
+  }
+};
+var hooks = {
+  onRequest: function onRequest(req) {
+    return req;
+  }
+};
+
+var addHook = function addHook(name, hook) {
+  if (ALLOWED_HOOKS.includes(name)) {
+    hooks[name] = hook || DEFAULT_HOOKS[name]; // Don't allow it to be undefined.
+  }
+};
+
+exports.addHook = addHook;
+
+var removeHook = function removeHook(name) {
+  if (ALLOWED_HOOKS.includes(name)) {
+    hooks[name] = DEFAULT_HOOKS[name];
+  }
+};
+
+exports.removeHook = removeHook;
+
+var resetHooks = function resetHooks() {
+  Object.keys(hooks).forEach(removeHook);
+};
+
+exports.resetHooks = resetHooks;
+
+var useHooks = function useHooks() {
+  return {
+    hooks: hooks,
+    addHook: addHook,
+    removeHook: removeHook,
+    resetHooks: resetHooks
+  };
+};
+
+var _default = useHooks;
+exports.default = _default;

package/dist/hooks/useRefData.js

@@ -0,0 +1,91 @@
+"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.STATUS_LOADING = exports.STATUS_COMPLETE = void 0;
+
+var _react = require("react");
+
+var _Data = _interopRequireDefault(require("../utils/Data"));
+
+var _useGetRequest2 = _interopRequireWildcard(require("./useGetRequest"));
+
+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 _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; }
+
+var STATUS_LOADING = 'loading';
+exports.STATUS_LOADING = STATUS_LOADING;
+var STATUS_COMPLETE = 'complete';
+exports.STATUS_COMPLETE = STATUS_COMPLETE;
+
+var getRefDataUrl = function getRefDataUrl(component) {
+  var data = component.data;
+
+  if (data && !data.options) {
+    return data.url;
+  }
+
+  return undefined;
+};
+
+var useRefData = function useRefData(component) {
+  var url = getRefDataUrl(component);
+
+  var _useGetRequest = (0, _useGetRequest2.default)(url),
+      _status = _useGetRequest.status,
+      _data = _useGetRequest.data;
+
+  var _useState = (0, _react.useState)([]),
+      _useState2 = _slicedToArray(_useState, 2),
+      data = _useState2[0],
+      setData = _useState2[1];
+
+  var _useState3 = (0, _react.useState)(STATUS_LOADING),
+      _useState4 = _slicedToArray(_useState3, 2),
+      status = _useState4[0],
+      setStatus = _useState4[1];
+
+  (0, _react.useEffect)(function () {
+    if (!url) {
+      if (component.data && component.data.options) {
+        setData(_Data.default.refData.toOptions(component.data.options));
+      }
+
+      setStatus(STATUS_COMPLETE);
+    } else if (_status === _useGetRequest2.STATUS_FETCHED) {
+      if (_data) {
+        setData(_Data.default.refData.toOptions(_data.data));
+      }
+
+      setStatus(STATUS_COMPLETE);
+    } else if (_status === _useGetRequest2.STATUS_ERROR) {
+      setData([]);
+      setStatus(STATUS_COMPLETE);
+    }
+  }, [component, _status, _data, url, setData, setStatus]);
+  return {
+    data: data,
+    status: status
+  };
+};
+
+var _default = useRefData;
+exports.default = _default;

package/dist/index.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "FormRenderer", {
+  enumerable: true,
+  get: function get() {
+    return _FormRenderer.default;
+  }
+});
+Object.defineProperty(exports, "FormTypes", {
+  enumerable: true,
+  get: function get() {
+    return _models.FormTypes;
+  }
+});
+Object.defineProperty(exports, "HubFormats", {
+  enumerable: true,
+  get: function get() {
+    return _models.HubFormats;
+  }
+});
+Object.defineProperty(exports, "Utils", {
+  enumerable: true,
+  get: function get() {
+    return _utils.default;
+  }
+});
+exports.intercepts = exports.default = void 0;
+
+var _FormRenderer = _interopRequireDefault(require("./components/FormRenderer"));
+
+var _useHooks = require("./hooks/useHooks");
+
+var _models = require("./models");
+
+var _utils = _interopRequireDefault(require("./utils"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var intercepts = {
+  add: _useHooks.addHook
+};
+exports.intercepts = intercepts;
+var _default = _FormRenderer.default;
+exports.default = _default;

package/dist/models/ComponentTypes.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var TYPE_AUTOCOMPLETE = 'autocomplete';
+var TYPE_EMAIL = 'email';
+var TYPE_HEADING = 'heading';
+var TYPE_HTML = 'html';
+var TYPE_INSET_TEXT = 'inset-text';
+var TYPE_PHONE_NUMBER = 'phone-number';
+var TYPE_RADIOS = 'radios';
+var TYPE_TEXT = 'text';
+var ComponentTypes = {
+  AUTOCOMPLETE: TYPE_AUTOCOMPLETE,
+  EMAIL: TYPE_EMAIL,
+  HEADING: TYPE_HEADING,
+  HTML: TYPE_HTML,
+  INSET_TEXT: TYPE_INSET_TEXT,
+  PHONE_NUMBER: TYPE_PHONE_NUMBER,
+  RADIOS: TYPE_RADIOS,
+  TEXT: TYPE_TEXT
+};
+var _default = ComponentTypes;
+exports.default = _default;

package/dist/models/FormTypes.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var TYPE_FORM = 'form';
+var TYPE_CHECK_YOUR_ANSWERS = 'cya';
+var TYPE_HUB_AND_SPOKE = 'hub-and-spoke';
+var TYPE_WIZARD = 'wizard';
+var FormTypes = {
+  FORM: TYPE_FORM,
+  CYA: TYPE_CHECK_YOUR_ANSWERS,
+  HUB: TYPE_HUB_AND_SPOKE,
+  WIZARD: TYPE_WIZARD
+};
+var _default = FormTypes;
+exports.default = _default;

package/dist/models/HubFormats.js

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var HUB_FORMAT_CYA = 'CYA';
+var HubFormats = {
+  CYA: HUB_FORMAT_CYA
+};
+var _default = HubFormats;
+exports.default = _default;

package/dist/models/index.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ComponentTypes", {
+  enumerable: true,
+  get: function get() {
+    return _ComponentTypes.default;
+  }
+});
+Object.defineProperty(exports, "FormTypes", {
+  enumerable: true,
+  get: function get() {
+    return _FormTypes.default;
+  }
+});
+Object.defineProperty(exports, "HubFormats", {
+  enumerable: true,
+  get: function get() {
+    return _HubFormats.default;
+  }
+});
+
+var _ComponentTypes = _interopRequireDefault(require("./ComponentTypes"));
+
+var _FormTypes = _interopRequireDefault(require("./FormTypes"));
+
+var _HubFormats = _interopRequireDefault(require("./HubFormats"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

package/dist/utils/CheckYourAnswers/getCYAAction.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var getCYAAction = function getCYAAction(readonly, cya_link, onAction) {
+  if (readonly !== true && cya_link) {
+    return {
+      href: cya_link.url || '#',
+      label: cya_link.label || 'Change',
+      aria_suffix: cya_link.aria_suffix,
+      onAction: onAction
+    };
+  }
+
+  return null;
+};
+
+var _default = getCYAAction;
+exports.default = _default;

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

@@ -0,0 +1,92 @@
+"use strict";
+
+var _getCYAAction = _interopRequireDefault(require("./getCYAAction"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('CheckYourAnswers', function () {
+    describe('getCYAAction', function () {
+      it('should return null if readonly', function () {
+        expect((0, _getCYAAction.default)(true, {}, function () {})).toBeNull();
+      });
+      it('should return null if there is no cya_link', function () {
+        expect((0, _getCYAAction.default)(false, null, function () {})).toBeNull();
+      });
+      it('should return a default action if the cya_link is empty', function () {
+        var CYA_LINK = {};
+
+        var ON_ACTION = function ON_ACTION() {};
+
+        expect((0, _getCYAAction.default)(false, CYA_LINK, ON_ACTION)).toEqual({
+          href: '#',
+          label: 'Change',
+          onAction: ON_ACTION
+        });
+      });
+      it('should use url specified in cya_link', function () {
+        var URL = 'https://fake.url.com/something';
+        var CYA_LINK = {
+          url: URL
+        };
+
+        var ON_ACTION = function ON_ACTION() {};
+
+        expect((0, _getCYAAction.default)(false, CYA_LINK, ON_ACTION)).toEqual({
+          href: URL,
+          label: 'Change',
+          onAction: ON_ACTION
+        });
+      });
+      it('should use label specified in cya_link', function () {
+        var LABEL = 'Alpha Bravo Charlie';
+        var CYA_LINK = {
+          label: LABEL
+        };
+
+        var ON_ACTION = function ON_ACTION() {};
+
+        expect((0, _getCYAAction.default)(false, CYA_LINK, ON_ACTION)).toEqual({
+          href: '#',
+          label: LABEL,
+          onAction: ON_ACTION
+        });
+      });
+      it('should use aria_suffix specified in cya_link', function () {
+        var ARIA_SUFFIX = 'This is hidden text';
+        var CYA_LINK = {
+          aria_suffix: ARIA_SUFFIX
+        };
+
+        var ON_ACTION = function ON_ACTION() {};
+
+        expect((0, _getCYAAction.default)(false, CYA_LINK, ON_ACTION)).toEqual({
+          href: '#',
+          label: 'Change',
+          aria_suffix: ARIA_SUFFIX,
+          onAction: ON_ACTION
+        });
+      });
+      it('should use all properties specified in cya_link', function () {
+        var URL = 'https://fake.url.com/something';
+        var LABEL = 'Alpha Bravo Charlie';
+        var ARIA_SUFFIX = 'This is hidden text';
+        var CYA_LINK = {
+          label: LABEL,
+          url: URL,
+          aria_suffix: ARIA_SUFFIX
+        };
+
+        var ON_ACTION = function ON_ACTION() {};
+
+        expect((0, _getCYAAction.default)(false, CYA_LINK, ON_ACTION)).toEqual({
+          href: URL,
+          label: LABEL,
+          aria_suffix: ARIA_SUFFIX,
+          onAction: ON_ACTION
+        });
+      });
+    });
+  });
+});

package/dist/utils/CheckYourAnswers/getCYARow.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _Component = _interopRequireDefault(require("../Component"));
+
+var _getCYAAction = _interopRequireDefault(require("./getCYAAction"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+var getCYARow = function getCYARow(page, component, onAction) {
+  return {
+    pageId: page.id,
+    fieldId: component.fieldId,
+    key: component.label || component.cya_label,
+    component: _Component.default.editable(component) ? component : undefined,
+    value: page.formData[component.fieldId] || '',
+    action: (0, _getCYAAction.default)(component.readonly, page.cya_link, onAction)
+  };
+};
+
+var _default = getCYARow;
+exports.default = _default;