@ukhomeoffice/cop-react-form-renderer 0.1.0-beta → 1.0.0-delta

package/dist/components/FormRenderer/handlers/handlers.test.js

@@ -0,0 +1,97 @@
+"use strict";
+
+var _ = _interopRequireDefault(require("."));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('components', function () {
+  describe('FormRenderer', function () {
+    describe('handlers', function () {
+      describe('cyaAction', function () {
+        it('should not call the onChange method when the page is unchanged', function () {
+          var CURRENT_PAGE_ID = 'alpha';
+          var PAGE = {
+            pageId: CURRENT_PAGE_ID
+          };
+          var ON_CHANGE_CALLS = [];
+
+          var ON_CHANGE = function ON_CHANGE(pageId) {
+            ON_CHANGE_CALLS.push(pageId);
+          };
+
+          _.default.cyaAction(PAGE, CURRENT_PAGE_ID, ON_CHANGE);
+
+          expect(ON_CHANGE_CALLS.length).toEqual(0);
+        });
+        it('should call the onChange method when the page has changed', function () {
+          var CURRENT_PAGE_ID = 'alpha';
+          var NEW_PAGE_ID = 'bravo';
+          var PAGE = {
+            pageId: NEW_PAGE_ID
+          };
+          var ON_CHANGE_CALLS = [];
+
+          var ON_CHANGE = function ON_CHANGE(pageId) {
+            ON_CHANGE_CALLS.push(pageId);
+          };
+
+          _.default.cyaAction(PAGE, CURRENT_PAGE_ID, ON_CHANGE);
+
+          expect(ON_CHANGE_CALLS.length).toEqual(1);
+          expect(ON_CHANGE_CALLS[0]).toEqual(NEW_PAGE_ID);
+        });
+      });
+      describe('navigate', function () {
+        it('should not call the onNavigate method when the page is unchanged', function () {
+          var CURRENT_PAGE_ID = 'alpha';
+          var ACTION = {
+            href: "/".concat(CURRENT_PAGE_ID)
+          };
+          var ON_NAVIGATE_CALLS = [];
+
+          var ON_NAVIGATE = function ON_NAVIGATE(pageId) {
+            ON_NAVIGATE_CALLS.push(pageId);
+          };
+
+          _.default.navigate(ACTION, CURRENT_PAGE_ID, ON_NAVIGATE);
+
+          expect(ON_NAVIGATE_CALLS.length).toEqual(0);
+        });
+        it('should call the onNavigate method when the page has changed', function () {
+          var CURRENT_PAGE_ID = 'alpha';
+          var NEW_PAGE_ID = 'bravo';
+          var ACTION = {
+            href: "/".concat(NEW_PAGE_ID)
+          };
+          var ON_NAVIGATE_CALLS = [];
+
+          var ON_NAVIGATE = function ON_NAVIGATE(pageId) {
+            ON_NAVIGATE_CALLS.push(pageId);
+          };
+
+          _.default.navigate(ACTION, CURRENT_PAGE_ID, ON_NAVIGATE);
+
+          expect(ON_NAVIGATE_CALLS.length).toEqual(1);
+          expect(ON_NAVIGATE_CALLS[0]).toEqual(NEW_PAGE_ID);
+        });
+      });
+      describe('submissionError', function () {
+        it('should call the onError method with the same errors', function () {
+          var ON_ERROR_CALLS = [];
+
+          var ON_ERROR = function ON_ERROR(errors) {
+            ON_ERROR_CALLS.push(errors);
+          };
+
+          var ERRORS = ['alpha', 'bravo', 'charlie'];
+
+          _.default.submissionError(ERRORS, ON_ERROR);
+
+          expect(ON_ERROR_CALLS.length).toEqual(1);
+          expect(ON_ERROR_CALLS[0]).toEqual(ERRORS);
+        });
+      });
+    });
+  });
+});

package/dist/components/FormRenderer/handlers/index.js

@@ -0,0 +1,23 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.handlers = exports.default = void 0;
+
+var _cyaAction = _interopRequireDefault(require("./cyaAction"));
+
+var _navigate = _interopRequireDefault(require("./navigate"));
+
+var _submissionError = _interopRequireDefault(require("./submissionError"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var handlers = {
+  cyaAction: _cyaAction.default,
+  navigate: _navigate.default,
+  submissionError: _submissionError.default
+};
+exports.handlers = handlers;
+var _default = handlers;
+exports.default = _default;

package/dist/components/FormRenderer/handlers/navigate.js

@@ -0,0 +1,28 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getPageId = _interopRequireDefault(require("./getPageId"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+/**
+ * Gets the pageId from the invoked page action and calls onNavigate if it is
+ * different to the currentPageId.
+ * @param {object} action The invoked action.
+ * @param {string} currentPageId The current pageId.
+ * @param {Function} onNavigate The handler to call if the pageId is different to the currentPageId.
+ */
+var navigate = function navigate(action, currentPageId, onNavigate) {
+  var pageId = (0, _getPageId.default)(action, currentPageId);
+
+  if (pageId !== currentPageId) {
+    onNavigate(pageId);
+  }
+};
+
+var _default = navigate;
+exports.default = _default;

package/dist/components/FormRenderer/handlers/submissionError.js

@@ -0,0 +1,20 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * Formats back-end errors and invokes an onError handler.
+ * @param {Array} errors The errors returned by the backend when submitting.
+ * @param {Function} onError The handler to call with the formatted errors.
+ */
+var submissionError = function submissionError(errors, onError) {
+  // For now, simply pass them straight through as we don't yet know
+  // what the errors will look like.
+  onError(errors);
+};
+
+var _default = submissionError;
+exports.default = _default;

package/dist/components/FormRenderer/helpers/canActionProceed.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = _interopRequireDefault(require("../../../utils"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+
+/**
+ * Assesses whether the action can proceed when navigating, submitting, etc.
+ * Presently, this will validate a page when submitting and, only if the page is
+ * valid will it proceed. If it's simple navigation, it simply returns true.
+ * @param {object} action The action object we're assessing.
+ * @param {object} page The page configuration object this action relates to.
+ * @param {Function} onError A function to call with any validation errors.
+ * @returns A boolean where `true` means the action can proceed and `false` means it cannot.
+ */
+var canActionProceed = function canActionProceed(action, page, onError) {
+  if (action.validate) {
+    var errors = _utils.default.Validate.page(page.components, page.formData);
+
+    onError(errors);
+    return errors.length === 0;
+  }
+
+  return true;
+};
+
+var _default = canActionProceed;
+exports.default = _default;

package/dist/components/FormRenderer/helpers/canActionProceed.test.js

@@ -0,0 +1,73 @@
+"use strict";
+
+var _canActionProceed = _interopRequireDefault(require("./canActionProceed"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread 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 _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+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; }
+
+describe('components', function () {
+  describe('FormRenderer', function () {
+    describe('helpers', function () {
+      describe('canActionProceed', function () {
+        it('should return true when the action does not require validation', function () {
+          var ACTION = {
+            validate: false
+          };
+          expect((0, _canActionProceed.default)(ACTION, {}, function () {})).toBeTruthy();
+        });
+        it('should return true when the page is valid', function () {
+          var ACTION = {
+            validate: true
+          };
+          var PAGE = {
+            components: [{
+              id: 'a',
+              fieldId: 'a',
+              label: 'Alpha',
+              required: true
+            }],
+            formData: {
+              a: 'Bravo'
+            }
+          };
+          expect((0, _canActionProceed.default)(ACTION, PAGE, function () {})).toBeTruthy();
+        });
+        it('should return false when the page is invalid and should have called the onErrors method appropriately', function () {
+          var ACTION = {
+            validate: true
+          };
+          var PAGE = {
+            components: [{
+              id: 'a',
+              fieldId: 'a',
+              label: 'Alpha',
+              required: true
+            }],
+            formData: {}
+          };
+          var ERRORS = [];
+
+          var ON_ERROR = function ON_ERROR(errors) {
+            ERRORS.push.apply(ERRORS, _toConsumableArray(errors));
+          };
+
+          expect((0, _canActionProceed.default)(ACTION, PAGE, ON_ERROR)).toBeFalsy();
+          expect(ERRORS.length).toEqual(1);
+          expect(ERRORS[0].id).toEqual('a');
+          expect(ERRORS[0].error).toEqual('Alpha is required');
+        });
+      });
+    });
+  });
+});

package/dist/components/FormRenderer/helpers/canCYASubmit.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _utils = _interopRequireDefault(require("../../../utils"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread 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 _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+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; }
+
+/**
+ * Assesses whether the CYA screen can submit.
+ * Presently, this will validate all of the form pages and, only if all pages are
+ * valid will it proceed.
+ * @param {Array} pages All of the pages contained within the form.
+ * @param {Function} onError A function to call with any validation errors.
+ * @returns A boolean where `true` means the CYA can submit and `false` means it cannot.
+ */
+var canCYASubmit = function canCYASubmit(pages, onError) {
+  var errors = [];
+  pages.forEach(function (p) {
+    errors.push.apply(errors, _toConsumableArray(_utils.default.Validate.page(p.components, p.formData)));
+  });
+  onError(errors);
+  return errors.length === 0;
+};
+
+var _default = canCYASubmit;
+exports.default = _default;

package/dist/components/FormRenderer/helpers/canCYASubmit.test.js

@@ -0,0 +1,155 @@
+"use strict";
+
+var _canCYASubmit = _interopRequireDefault(require("./canCYASubmit"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread 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 _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+
+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; }
+
+describe('components', function () {
+  describe('FormRenderer', function () {
+    describe('helpers', function () {
+      describe('canCYASubmit', function () {
+        it('should return true when all pages are valid', function () {
+          var PAGE_1 = {
+            components: [{
+              id: 'a',
+              fieldId: 'a',
+              label: 'Alpha',
+              required: true
+            }],
+            formData: {
+              a: 'Bravo'
+            }
+          };
+          var PAGE_2 = {
+            components: [{
+              id: 'c',
+              fieldId: 'c',
+              label: 'Charlie',
+              required: true
+            }],
+            formData: {
+              c: 'Delta'
+            }
+          };
+          expect((0, _canCYASubmit.default)([PAGE_1, PAGE_2], function () {})).toBeTruthy();
+        });
+        it('should return false when the first page is invalid and should have called the onErrors method appropriately', function () {
+          var PAGE_1 = {
+            components: [{
+              id: 'a',
+              fieldId: 'a',
+              label: 'Alpha',
+              required: true
+            }],
+            formData: {}
+          };
+          var PAGE_2 = {
+            components: [{
+              id: 'c',
+              fieldId: 'c',
+              label: 'Charlie',
+              required: true
+            }],
+            formData: {
+              c: 'Delta'
+            }
+          };
+          var ERRORS = [];
+
+          var ON_ERROR = function ON_ERROR(errors) {
+            ERRORS.push.apply(ERRORS, _toConsumableArray(errors));
+          };
+
+          expect((0, _canCYASubmit.default)([PAGE_1, PAGE_2], ON_ERROR)).toBeFalsy();
+          expect(ERRORS.length).toEqual(1);
+          expect(ERRORS[0]).toEqual({
+            id: 'a',
+            error: 'Alpha is required'
+          });
+        });
+        it('should return false when the second page is invalid and should have called the onErrors method appropriately', function () {
+          var PAGE_1 = {
+            components: [{
+              id: 'a',
+              fieldId: 'a',
+              label: 'Alpha',
+              required: true
+            }],
+            formData: {
+              a: 'Bravo'
+            }
+          };
+          var PAGE_2 = {
+            components: [{
+              id: 'c',
+              fieldId: 'c',
+              label: 'Charlie',
+              required: true
+            }],
+            formData: {}
+          };
+          var ERRORS = [];
+
+          var ON_ERROR = function ON_ERROR(errors) {
+            ERRORS.push.apply(ERRORS, _toConsumableArray(errors));
+          };
+
+          expect((0, _canCYASubmit.default)([PAGE_1, PAGE_2], ON_ERROR)).toBeFalsy();
+          expect(ERRORS.length).toEqual(1);
+          expect(ERRORS[0]).toEqual({
+            id: 'c',
+            error: 'Charlie is required'
+          });
+        });
+        it('should return false when the both pages are invalid and should have called the onErrors method appropriately', function () {
+          var PAGE_1 = {
+            components: [{
+              id: 'a',
+              fieldId: 'a',
+              label: 'Alpha',
+              required: true
+            }],
+            formData: {}
+          };
+          var PAGE_2 = {
+            components: [{
+              id: 'c',
+              fieldId: 'c',
+              label: 'Charlie',
+              required: true
+            }],
+            formData: {}
+          };
+          var ERRORS = [];
+
+          var ON_ERROR = function ON_ERROR(errors) {
+            ERRORS.push.apply(ERRORS, _toConsumableArray(errors));
+          };
+
+          expect((0, _canCYASubmit.default)([PAGE_1, PAGE_2], ON_ERROR)).toBeFalsy();
+          expect(ERRORS.length).toEqual(2);
+          expect(ERRORS[0]).toEqual({
+            id: 'a',
+            error: 'Alpha is required'
+          });
+          expect(ERRORS[1]).toEqual({
+            id: 'c',
+            error: 'Charlie is required'
+          });
+        });
+      });
+    });
+  });
+});

package/dist/components/FormRenderer/helpers/getCYA.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _models = require("../../../models");
+
+// Local imports
+
+/**
+ * Gets a configuration object for the Check your answers screen.
+ * @param {string} pageId The current page identifier.
+ * @param {object} hub The hub, if there is one.
+ * @returns A configuration object for the Check your answers screen.
+ */
+var getCYA = function getCYA(pageId, hub) {
+  if (pageId === _models.FormPages.HUB && hub === _models.HubFormats.CYA) {
+    return {
+      title: ''
+    };
+  } else if (pageId === _models.FormPages.CYA) {
+    return {};
+  }
+
+  return undefined;
+};
+
+var _default = getCYA;
+exports.default = _default;

package/dist/components/FormRenderer/helpers/getCYA.test.js

@@ -0,0 +1,38 @@
+"use strict";
+
+var _models = require("../../../models");
+
+var _getCYA = _interopRequireDefault(require("./getCYA"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('components', function () {
+  describe('FormRenderer', function () {
+    describe('helpers', function () {
+      var HUB = {
+        id: _models.FormPages.HUB,
+        components: []
+      };
+      describe('getCYA', function () {
+        it('should give an empty object if the pageId is "CYA"', function () {
+          expect((0, _getCYA.default)(_models.FormPages.CYA)).toEqual({});
+        });
+        it('should give an object with a blank title if the pageId is "hub" and the hub is the CYA', function () {
+          expect((0, _getCYA.default)(_models.FormPages.HUB, _models.HubFormats.CYA)).toEqual({
+            title: ''
+          });
+        });
+        it('should give undefined if pageId is "hub" and the hub is NOT the CYA', function () {
+          expect((0, _getCYA.default)(_models.FormPages.HUB, HUB)).toBeUndefined();
+        });
+        it('should give undefined if pageId is NOT "hub" and the hub is NOT the CYA', function () {
+          expect((0, _getCYA.default)(_models.FormPages.HUB, HUB)).toBeUndefined();
+        });
+        it('should give undefined if pageId is NOT "hub" and the hub is the CYA', function () {
+          expect((0, _getCYA.default)('bob', _models.HubFormats.CYA)).toBeUndefined();
+        });
+      });
+    });
+  });
+});

package/dist/components/FormRenderer/helpers/getFormState.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _getCYA = _interopRequireDefault(require("./getCYA"));
+
+var _getPage = _interopRequireDefault(require("./getPage"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+
+/**
+ * Sets up the state of the form, including the current page and the Check your answers screen.
+ * @param {string} pageId The current page identifier.
+ * @param {Array} pages All of the pages in the form.
+ * @param {object} hub The hub, if there is one.
+ * @returns The current state of the form.
+ */
+var getFormState = function getFormState(pageId, pages, hub) {
+  return {
+    pageId: pageId,
+    cya: (0, _getCYA.default)(pageId, hub),
+    page: (0, _getPage.default)(pageId, pages, hub)
+  };
+};
+
+var _default = getFormState;
+exports.default = _default;

package/dist/components/FormRenderer/helpers/getFormState.test.js

@@ -0,0 +1,61 @@
+"use strict";
+
+var _models = require("../../../models");
+
+var _getFormState = _interopRequireDefault(require("./getFormState"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('components', function () {
+  describe('FormRenderer', function () {
+    describe('helpers', function () {
+      var HUB = {
+        id: _models.FormPages.HUB,
+        components: []
+      };
+      var PAGES = [{
+        id: 'alpha',
+        components: ['x']
+      }, {
+        id: 'bravo',
+        components: ['y', 'z']
+      }, HUB];
+      describe('getFormState', function () {
+        it('should set up accordingly when viewing a hub that is the CYA', function () {
+          expect((0, _getFormState.default)(_models.FormPages.HUB, PAGES, _models.HubFormats.CYA)).toEqual({
+            pageId: _models.FormPages.HUB,
+            cya: {
+              title: ''
+            },
+            page: undefined
+          });
+        });
+        it('should set up accordingly when viewing a hub that is NOT the CYA', function () {
+          expect((0, _getFormState.default)(_models.FormPages.HUB, PAGES, HUB)).toEqual({
+            pageId: _models.FormPages.HUB,
+            cya: undefined,
+            page: HUB
+          });
+        });
+        it('should set up accordingly when viewing the CYA', function () {
+          expect((0, _getFormState.default)(_models.FormPages.CYA, PAGES, HUB)).toEqual({
+            pageId: _models.FormPages.CYA,
+            cya: {},
+            page: undefined
+          });
+        });
+        it('should set up accordingly when viewing a standard page', function () {
+          expect((0, _getFormState.default)('bravo', PAGES, HUB)).toEqual({
+            pageId: 'bravo',
+            cya: undefined,
+            page: {
+              id: 'bravo',
+              components: ['y', 'z']
+            }
+          });
+        });
+      });
+    });
+  });
+});