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

package/dist/utils/FormPage/getFormPages.js

@@ -15,18 +15,23 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+/**
+ * Converts pages objects defined in the JSON to page objects for rendering.
+ * @param {Array} pages The JSON pages.
+ * @param {Array} components The components defined at the top-level of the form.
+ * @param {object} formData The top-level form data, used for setting up components.
+ * @returns An array of page objects for rendering.
+ */
 var getFormPages = function getFormPages(pages, components, formData) {
-  var formPages = [];
-
   if (Array.isArray(pages)) {
-    pages.forEach(function (options, index) {
-      formPages.push(_objectSpread(_objectSpread({}, (0, _getFormPage.default)(options, components, formData)), {}, {
+    return pages.map(function (options, index) {
+      return _objectSpread(_objectSpread({}, (0, _getFormPage.default)(options, components, formData)), {}, {
         index: index
-      }));
+      });
     });
   }
 
-  return formPages;
+  return [];
 };
 
 var _default = getFormPages;

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

@@ -0,0 +1,95 @@
+"use strict";
+
+var _getFormPages = _interopRequireDefault(require("./getFormPages"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+describe('utils', function () {
+  describe('FormPage', function () {
+    describe('getFormPages', function () {
+      var FORM_COMPONENTS = [{
+        id: 'a',
+        fieldId: 'a',
+        label: 'Alpha',
+        type: 'text'
+      }, {
+        id: 'b',
+        fieldId: 'b',
+        label: 'Bravo',
+        type: 'text'
+      }, // eslint-disable-next-line no-template-curly-in-string
+      {
+        id: 'c',
+        fieldId: 'c',
+        label: 'Charlie',
+        type: 'radios',
+        data: {
+          url: '${environmentContext.refData}/v3/charlies'
+        }
+      }];
+      var FORM_DATA = {
+        environmentContext: {
+          refData: 'https://ho.gov.uk/ref-data/'
+        }
+      };
+      it('should handle null or undefined pageOptions', function () {
+        expect((0, _getFormPages.default)(null, FORM_COMPONENTS, FORM_DATA)).toEqual([]);
+        expect((0, _getFormPages.default)(undefined, FORM_COMPONENTS, FORM_DATA)).toEqual([]);
+      });
+      it('should appropriately set up multiples pages with various configurations', function () {
+        var PAGE_1 = {
+          title: 'Page 1',
+          components: [{
+            type: 'heading',
+            size: 'l',
+            content: 'Page heading'
+          }]
+        };
+        var PAGE_2 = {
+          title: 'Page 2',
+          components: ["Opening paragraph", {
+            type: 'heading',
+            size: 'l',
+            content: 'Page heading'
+          }, "Closing paragraph", {
+            use: 'c'
+          }]
+        };
+        var PAGES = [PAGE_1, PAGE_2];
+        var C = FORM_COMPONENTS[2];
+        expect((0, _getFormPages.default)(PAGES, FORM_COMPONENTS, FORM_DATA)).toEqual([{
+          index: 0,
+          title: PAGE_1.title,
+          components: PAGE_1.components,
+          formData: FORM_DATA
+        }, {
+          index: 1,
+          title: PAGE_2.title,
+          components: [{
+            type: 'html',
+            tagName: 'p',
+            content: PAGE_2.components[0]
+          }, PAGE_2.components[1], {
+            type: 'html',
+            tagName: 'p',
+            content: PAGE_2.components[2]
+          }, _objectSpread(_objectSpread({
+            use: 'c'
+          }, C), {}, {
+            cya_label: C.label,
+            data: {
+              url: "".concat(FORM_DATA.environmentContext.refData, "/v3/charlies")
+            }
+          })],
+          formData: FORM_DATA
+        }]);
+      });
+    });
+  });
+});

package/dist/utils/FormPage/getParagraphFromText.js

@@ -8,6 +8,12 @@ exports.default = void 0;
 var _models = require("../../models");
 
 // Local imports
+
+/**
+ * Converts simple text into a paragraph component.
+ * @param {string} content The content to render as a paragraph.
+ * @returns An HTML component configuration for a paragraph of the supplied tect.
+ */
 var getParagraphFromText = function getParagraphFromText(content) {
   return {
     type: _models.ComponentTypes.HTML,

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

@@ -0,0 +1,29 @@
+"use strict";
+
+var _models = require("../../models");
+
+var _getParagraphFromText = _interopRequireDefault(require("./getParagraphFromText"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('FormPage', function () {
+    describe('getParagraphFromText', function () {
+      it('should handle text content', function () {
+        var CONTENT = 'Appropriate text content';
+        expect((0, _getParagraphFromText.default)(CONTENT)).toEqual({
+          type: _models.ComponentTypes.HTML,
+          tagName: 'p',
+          content: CONTENT
+        });
+      });
+      it('should handle undefined content', function () {
+        expect((0, _getParagraphFromText.default)(undefined)).toEqual({
+          type: _models.ComponentTypes.HTML,
+          tagName: 'p'
+        });
+      });
+    });
+  });
+});

package/dist/utils/FormPage/useComponent.js

@@ -11,10 +11,17 @@ function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { va
 
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
+/**
+ * Use an existing component from the formComponents, overriding any properties
+ * where appropriate.
+ * @param {object} toUse A configuration object that references the component to use and any overrides.
+ * @param {Array} formComponents An array of existing components on the form.
+ * @returns A component configuration object.
+ */
 var useComponent = function useComponent(toUse, formComponents) {
-  var formComponent = formComponents.find(function (fc) {
+  var formComponent = toUse ? formComponents.find(function (fc) {
     return fc.id === toUse.use;
-  });
+  }) : undefined;
 
   if (formComponent) {
     var fieldId = toUse.fieldId || formComponent.fieldId;

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

@@ -0,0 +1,82 @@
+"use strict";
+
+var _useComponent = _interopRequireDefault(require("./useComponent"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+describe('utils', function () {
+  describe('FormPage', function () {
+    describe('useComponent', function () {
+      var FORM_COMPONENTS = [{
+        id: 'a',
+        fieldId: 'a',
+        label: 'Alpha',
+        type: 'text'
+      }, {
+        id: 'b',
+        fieldId: 'b',
+        label: 'Bravo',
+        type: 'text'
+      }, {
+        id: 'c',
+        fieldId: 'c',
+        label: 'Charlie',
+        type: 'text'
+      }];
+      it('should handle a null toUse configuration', function () {
+        var TO_USE = null;
+        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual({});
+      });
+      it('should handle an unrecognised component reference', function () {
+        var TO_USE = {
+          use: 'd',
+          label: 'Delta'
+        };
+        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(TO_USE);
+      });
+      it('should use the appropriate component', function () {
+        var TO_USE = {
+          use: 'a'
+        };
+        var A = FORM_COMPONENTS[0];
+        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
+          use: 'a'
+        }, A), {}, {
+          cya_label: A.label
+        }));
+      });
+      it('should allow the fieldId to be overridden', function () {
+        var TO_USE = {
+          use: 'a',
+          fieldId: 'alpha'
+        };
+        var A = FORM_COMPONENTS[0];
+        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
+          use: 'a'
+        }, A), {}, {
+          cya_label: A.label,
+          fieldId: TO_USE.fieldId
+        }));
+      });
+      it('should allow the label to be overridden but keep the cya_label unaffected', function () {
+        var TO_USE = {
+          use: 'a',
+          label: 'Alpha foxtrot'
+        };
+        var A = FORM_COMPONENTS[0];
+        expect((0, _useComponent.default)(TO_USE, FORM_COMPONENTS)).toEqual(_objectSpread(_objectSpread({
+          use: 'a'
+        }, A), {}, {
+          cya_label: A.label,
+          label: TO_USE.label
+        }));
+      });
+    });
+  });
+});

package/dist/utils/Hub/getFormHub.js

@@ -5,21 +5,21 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
-var _FormPage = _interopRequireDefault(require("../FormPage"));
-
 var _models = require("../../models");
 
+var _FormPage = _interopRequireDefault(require("../FormPage"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
-var getFormHub = function getFormHub(type, hub, components) {
+var getFormHub = function getFormHub(type, hub, components, formData) {
   if (type === _models.FormTypes.HUB && hub) {
     if (hub.format === _models.HubFormats.CYA) {
       return _models.HubFormats.CYA;
     }
 
     if (hub.components) {
-      return _FormPage.default.get(hub, components);
+      return _FormPage.default.get(hub, components, formData);
     }
   }
 

package/dist/utils/Hub/getFormHub.test.js

@@ -0,0 +1,96 @@
+"use strict";
+
+var _models = require("../../models");
+
+var _getFormHub = _interopRequireDefault(require("./getFormHub"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+describe('utils', function () {
+  describe('Hub', function () {
+    describe('getFormHub', function () {
+      var FORM_COMPONENTS = [{
+        id: 'a',
+        fieldId: 'a',
+        label: 'Alpha',
+        type: 'text'
+      }, {
+        id: 'b',
+        fieldId: 'b',
+        label: 'Bravo',
+        type: 'text'
+      }, // eslint-disable-next-line no-template-curly-in-string
+      {
+        id: 'c',
+        fieldId: 'c',
+        label: 'Charlie',
+        type: 'radios',
+        data: {
+          url: '${environmentContext.refData}/v3/charlies'
+        }
+      }];
+      var FORM_DATA = {
+        environmentContext: {
+          refData: 'https://ho.gov.uk/ref-data/'
+        }
+      };
+      [_models.FormTypes.CYA, _models.FormTypes.FORM, _models.FormTypes.WIZARD].forEach(function (formType) {
+        describe("when the FormType is \"".concat(formType, "\""), function () {
+          it('should return undefined', function () {
+            expect((0, _getFormHub.default)(formType, {}, FORM_COMPONENTS, FORM_DATA)).toBeUndefined();
+          });
+        });
+      });
+      describe("when the FormType is \"".concat(_models.FormTypes.HUB, "\""), function () {
+        it('should return undefined when there is no hub', function () {
+          expect((0, _getFormHub.default)(_models.FormTypes.HUB, null, FORM_COMPONENTS, FORM_DATA)).toBeUndefined();
+        });
+        it("should return undefined when the format is not \"".concat(_models.HubFormats.CYA, "\" but hub also has no components"), function () {
+          expect((0, _getFormHub.default)(_models.FormTypes.HUB, {}, FORM_COMPONENTS, FORM_DATA)).toBeUndefined();
+        });
+        it("should return the string \"".concat(_models.HubFormats.CYA, "\" when the format is set to \"").concat(_models.HubFormats.CYA, "\""), function () {
+          var HUB = {
+            format: _models.HubFormats.CYA
+          };
+          expect((0, _getFormHub.default)(_models.FormTypes.HUB, HUB, FORM_COMPONENTS, FORM_DATA)).toEqual(_models.HubFormats.CYA);
+        });
+        it("should return an appropriate page when the format is not \"".concat(_models.HubFormats.CYA, "\" and hub contains components"), function () {
+          var HUB = {
+            title: 'Hub title',
+            components: ["Opening paragraph", {
+              type: 'heading',
+              size: 'l',
+              content: 'Hub heading'
+            }, "Closing paragraph", {
+              use: 'a'
+            }]
+          };
+          var A = FORM_COMPONENTS[0];
+          expect((0, _getFormHub.default)(_models.FormTypes.HUB, HUB, FORM_COMPONENTS, FORM_DATA)).toEqual({
+            title: HUB.title,
+            components: [{
+              type: 'html',
+              tagName: 'p',
+              content: HUB.components[0]
+            }, HUB.components[1], {
+              type: 'html',
+              tagName: 'p',
+              content: HUB.components[2]
+            }, _objectSpread(_objectSpread({
+              use: 'a'
+            }, A), {}, {
+              cya_label: A.label
+            })],
+            formData: FORM_DATA
+          });
+        });
+      });
+    });
+  });
+});

package/dist/utils/Hub/index.js

@@ -7,13 +7,10 @@ exports.default = void 0;
 
 var _getFormHub = _interopRequireDefault(require("./getFormHub"));
 
-var _models = require("../../models");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
 var Hub = {
-  formats: _models.HubFormats,
   get: _getFormHub.default
 };
 var _default = Hub;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "0.1.0-beta",
+  "version": "0.1.0-gamma",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",