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

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

@@ -0,0 +1,178 @@
+"use strict";
+
+var _getFormPage = _interopRequireDefault(require("./getFormPage"));
+
+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('getFormPage', 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: '${urls.refData}/v3/charlies'
+        }
+      }];
+      var FORM_DATA = {
+        urls: {
+          refData: 'https://ho.gov.uk/ref-data/'
+        }
+      };
+      it('should handle null or undefined pageOptions', function () {
+        expect((0, _getFormPage.default)(null, FORM_COMPONENTS, FORM_DATA)).toBeNull();
+        expect((0, _getFormPage.default)(undefined, FORM_COMPONENTS, FORM_DATA)).toBeNull();
+      });
+      it('should handle a page not using any form components', function () {
+        var PAGE = {
+          title: 'Page',
+          components: [{
+            type: 'heading',
+            size: 'l',
+            content: 'Page heading'
+          }]
+        };
+        expect((0, _getFormPage.default)(PAGE, FORM_COMPONENTS, FORM_DATA)).toEqual({
+          title: PAGE.title,
+          components: PAGE.components,
+          formData: FORM_DATA
+        });
+      });
+      it('should handle a page with inline strings and convert them to paragraphs', function () {
+        var PAGE = {
+          title: 'Page',
+          components: ["Opening paragraph", {
+            type: 'heading',
+            size: 'l',
+            content: 'Page heading'
+          }, "Closing paragraph"]
+        };
+        expect((0, _getFormPage.default)(PAGE, FORM_COMPONENTS, FORM_DATA)).toEqual({
+          title: PAGE.title,
+          components: [{
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[0]
+          }, PAGE.components[1], {
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[2]
+          }],
+          formData: FORM_DATA
+        });
+      });
+      it('should handle a page that references a form-level component', function () {
+        var PAGE = {
+          title: 'Page',
+          components: ["Opening paragraph", {
+            type: 'heading',
+            size: 'l',
+            content: 'Page heading'
+          }, "Closing paragraph", {
+            use: 'a'
+          }]
+        };
+        var A = FORM_COMPONENTS[0];
+        expect((0, _getFormPage.default)(PAGE, FORM_COMPONENTS, FORM_DATA)).toEqual({
+          title: PAGE.title,
+          components: [{
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[0]
+          }, PAGE.components[1], {
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[2]
+          }, _objectSpread(_objectSpread({
+            use: 'a'
+          }, A), {}, {
+            cya_label: A.label
+          })],
+          formData: FORM_DATA
+        });
+      });
+      it('should handle a page that references a form-level component with a data url', function () {
+        var PAGE = {
+          title: 'Page',
+          components: ["Opening paragraph", {
+            type: 'heading',
+            size: 'l',
+            content: 'Page heading'
+          }, "Closing paragraph", {
+            use: 'c'
+          }]
+        };
+        var C = FORM_COMPONENTS[2];
+        expect((0, _getFormPage.default)(PAGE, FORM_COMPONENTS, FORM_DATA)).toEqual({
+          title: PAGE.title,
+          components: [{
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[0]
+          }, PAGE.components[1], {
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[2]
+          }, _objectSpread(_objectSpread({
+            use: 'c'
+          }, C), {}, {
+            cya_label: C.label,
+            data: {
+              url: "".concat(FORM_DATA.urls.refData, "/v3/charlies")
+            }
+          })],
+          formData: FORM_DATA
+        });
+      });
+      it('should handle a page that references a form-level component with a data url without an environment context', function () {
+        var PAGE = {
+          title: 'Page',
+          components: ["Opening paragraph", {
+            type: 'heading',
+            size: 'l',
+            content: 'Page heading'
+          }, "Closing paragraph", {
+            use: 'c'
+          }]
+        };
+        var C = FORM_COMPONENTS[2];
+        expect((0, _getFormPage.default)(PAGE, FORM_COMPONENTS, {})).toEqual({
+          title: PAGE.title,
+          components: [{
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[0]
+          }, PAGE.components[1], {
+            type: 'html',
+            tagName: 'p',
+            content: PAGE.components[2]
+          }, _objectSpread(_objectSpread({
+            use: 'c'
+          }, C), {}, {
+            cya_label: C.label
+          })],
+          formData: {}
+        });
+      });
+    });
+  });
+});

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: '${urls.refData}/v3/charlies'
+        }
+      }];
+      var FORM_DATA = {
+        urls: {
+          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.urls.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/Format/formatData.js

@@ -0,0 +1,32 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * Formats a string according to a format configuration object.
+ * @param {object} format The format configuration object.
+ * @param {string} value The string value to be formatted.
+ * @returns A formatted version of the value.
+ */
+var formatData = function formatData(format, value) {
+  if (format && value) {
+    switch (format.type) {
+      case 'lowercase':
+        return value.toLowerCase();
+
+      case 'uppercase':
+        return value.toUpperCase();
+
+      default:
+        return value;
+    }
+  }
+
+  return value;
+};
+
+var _default = formatData;
+exports.default = _default;

package/dist/utils/Format/formatData.test.js

@@ -0,0 +1,46 @@
+"use strict";
+
+var _formatData = _interopRequireDefault(require("./formatData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Format', function () {
+    describe('formatData', function () {
+      it('should handle no format', function () {
+        var FORMAT = null;
+        var VALUE = 'AlPhA';
+        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual(VALUE);
+      });
+      it('should handle no value', function () {
+        var FORMAT = {
+          type: 'lowercase'
+        };
+        var VALUE = null;
+        expect((0, _formatData.default)(FORMAT, VALUE)).toBeNull();
+      });
+      it('should format a string as lowercase', function () {
+        var FORMAT = {
+          type: 'lowercase'
+        };
+        var VALUE = 'AlPhA';
+        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual('alpha');
+      });
+      it('should format a string as uppercase', function () {
+        var FORMAT = {
+          type: 'uppercase'
+        };
+        var VALUE = 'AlPhA';
+        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual('ALPHA');
+      });
+      it('should leave an unknown format type alone', function () {
+        var FORMAT = {
+          type: 'not-a-real-type'
+        };
+        var VALUE = 'AlPhA';
+        expect((0, _formatData.default)(FORMAT, VALUE)).toEqual(VALUE);
+      });
+    });
+  });
+});

package/dist/utils/Format/formatDataForComponent.js

@@ -0,0 +1,41 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.formatDataForComponents = exports.default = void 0;
+
+var _formatData = _interopRequireDefault(require("./formatData"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+
+/**
+ * Formats the data for a given component, according to the component's format configuration.
+ * @param {object} component The component to format.
+ * @param {object} data The top-level form data.
+ * @param {string} eventType What type of event initiated this call.
+ */
+var formatDataForComponent = function formatDataForComponent(component, data, eventType) {
+  if (component.format && component.format.on === eventType) {
+    data[component.fieldId] = (0, _formatData.default)(component.format, data[component.fieldId]);
+  }
+};
+/**
+ * Formats the data for an array of components, according to each component's format configuration.
+ * @param {Array} components The array of components to format.
+ * @param {object} data The top-level form data.
+ * @param {string} eventType What type of event initiated this call.
+ */
+
+
+var formatDataForComponents = function formatDataForComponents(components, data, eventType) {
+  components.forEach(function (component) {
+    return formatDataForComponent(component, data, eventType);
+  });
+};
+
+exports.formatDataForComponents = formatDataForComponents;
+var _default = formatDataForComponent;
+exports.default = _default;