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

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;

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

@@ -0,0 +1,161 @@
+"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 _models = require("../../models");
+
+var _formatDataForComponent = _interopRequireWildcard(require("./formatDataForComponent"));
+
+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 _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; }
+
+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('Format', function () {
+    var setupField = function setupField(fieldId, format) {
+      return {
+        fieldId: fieldId,
+        format: format
+      };
+    };
+
+    var setupData = function setupData(fieldId, value) {
+      return _defineProperty({}, fieldId, value);
+    };
+
+    var setupFieldAndData = function setupFieldAndData(fieldId, format, value) {
+      return [setupField(fieldId, format), setupData(fieldId, value)];
+    };
+
+    describe('formatDataForComponent', function () {
+      it('should handle no format', function () {
+        var EVENT_TYPE = _models.EventTypes.SUBMIT;
+        var FIELD_ID = 'field';
+        var FORMAT = null;
+        var VALUE = 'AlPhA';
+
+        var _setupFieldAndData = setupFieldAndData(FIELD_ID, FORMAT, VALUE),
+            _setupFieldAndData2 = _slicedToArray(_setupFieldAndData, 2),
+            COMPONENT = _setupFieldAndData2[0],
+            DATA = _setupFieldAndData2[1];
+
+        (0, _formatDataForComponent.default)(COMPONENT, DATA, EVENT_TYPE);
+        expect(DATA[FIELD_ID]).toEqual(VALUE);
+      });
+      it('should handle no value', function () {
+        var EVENT_TYPE = _models.EventTypes.SUBMIT;
+        var FIELD_ID = 'field';
+        var FORMAT = {
+          type: 'lowercase',
+          on: EVENT_TYPE
+        };
+        var VALUE = null;
+
+        var _setupFieldAndData3 = setupFieldAndData(FIELD_ID, FORMAT, VALUE),
+            _setupFieldAndData4 = _slicedToArray(_setupFieldAndData3, 2),
+            COMPONENT = _setupFieldAndData4[0],
+            DATA = _setupFieldAndData4[1];
+
+        (0, _formatDataForComponent.default)(COMPONENT, DATA, EVENT_TYPE);
+        expect(DATA[FIELD_ID]).toBeNull();
+      });
+      it('should remain unchanged if the wrong event type', function () {
+        var EVENT_TYPE = _models.EventTypes.SUBMIT;
+        var FIELD_ID = 'field';
+        var FORMAT = {
+          type: 'lowercase',
+          on: _models.EventTypes.BLUR
+        };
+        var VALUE = 'AlPhA';
+
+        var _setupFieldAndData5 = setupFieldAndData(FIELD_ID, FORMAT, VALUE),
+            _setupFieldAndData6 = _slicedToArray(_setupFieldAndData5, 2),
+            COMPONENT = _setupFieldAndData6[0],
+            DATA = _setupFieldAndData6[1];
+
+        (0, _formatDataForComponent.default)(COMPONENT, DATA, EVENT_TYPE);
+        expect(DATA[FIELD_ID]).toEqual(VALUE);
+      });
+      it('should format a string as lowercase', function () {
+        var EVENT_TYPE = _models.EventTypes.SUBMIT;
+        var FIELD_ID = 'field';
+        var FORMAT = {
+          type: 'lowercase',
+          on: EVENT_TYPE
+        };
+        var VALUE = 'AlPhA';
+
+        var _setupFieldAndData7 = setupFieldAndData(FIELD_ID, FORMAT, VALUE),
+            _setupFieldAndData8 = _slicedToArray(_setupFieldAndData7, 2),
+            COMPONENT = _setupFieldAndData8[0],
+            DATA = _setupFieldAndData8[1];
+
+        (0, _formatDataForComponent.default)(COMPONENT, DATA, EVENT_TYPE);
+        expect(DATA[FIELD_ID]).toEqual('alpha');
+      });
+      it('should format a string as uppercase', function () {
+        var EVENT_TYPE = _models.EventTypes.SUBMIT;
+        var FIELD_ID = 'field';
+        var FORMAT = {
+          type: 'uppercase',
+          on: EVENT_TYPE
+        };
+        var VALUE = 'AlPhA';
+
+        var _setupFieldAndData9 = setupFieldAndData(FIELD_ID, FORMAT, VALUE),
+            _setupFieldAndData10 = _slicedToArray(_setupFieldAndData9, 2),
+            COMPONENT = _setupFieldAndData10[0],
+            DATA = _setupFieldAndData10[1];
+
+        (0, _formatDataForComponent.default)(COMPONENT, DATA, EVENT_TYPE);
+        expect(DATA[FIELD_ID]).toEqual('ALPHA');
+      });
+    });
+    describe('formatDataForComponents', function () {
+      it('should appropriately format multiple components', function () {
+        var EVENT_TYPE = _models.EventTypes.SUBMIT;
+        var COMPONENTS = [setupField('alpha', {
+          type: 'lowercase',
+          on: _models.EventTypes.SUBMIT
+        }), // Should be formatted
+        setupField('bravo', null), // Nothing to format
+        setupField('charlie', {
+          type: 'uppercase',
+          on: _models.EventTypes.SUBMIT
+        }), // Should be formatted
+        setupField('delta', {
+          type: 'uppercase',
+          on: _models.EventTypes.BLUR
+        }) // Should not be formatted because of event type
+        ];
+        var DATA = {
+          alpha: 'AlPhA',
+          bravo: 'bRaVo',
+          charlie: 'CHArlie',
+          delta: 'deLTA'
+        };
+        (0, _formatDataForComponent.formatDataForComponents)(COMPONENTS, DATA, EVENT_TYPE);
+        expect(DATA).toEqual({
+          alpha: 'alpha',
+          bravo: 'bRaVo',
+          charlie: 'CHARLIE',
+          delta: 'deLTA'
+        });
+      });
+    });
+  });
+});

package/dist/utils/Format/formatDataForForm.js

@@ -0,0 +1,33 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _formatDataForComponent = require("./formatDataForComponent");
+
+var _formatDataForPage = require("./formatDataForPage");
+
+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; }
+
+/**
+ * Formats the data for all components on a form, according to each component's format configuration.
+ * @param {object} form The form to format the components for.
+ * @param {object} data The top-level form data.
+ * @param {string} eventType What type of event initiated this call.
+ */
+var formatDataForForm = function formatDataForForm(form, baseData, eventType) {
+  var data = _objectSpread({}, baseData);
+
+  (0, _formatDataForComponent.formatDataForComponents)(form.components, data, eventType);
+  (0, _formatDataForPage.formatDataForPages)(form.pages, data, eventType);
+  return data;
+};
+
+var _default = formatDataForForm;
+exports.default = _default;

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

@@ -0,0 +1,78 @@
+"use strict";
+
+var _models = require("../../models");
+
+var _formatDataForForm = _interopRequireDefault(require("./formatDataForForm"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Format', function () {
+    var setupField = function setupField(fieldId, format) {
+      return {
+        fieldId: fieldId,
+        format: format
+      };
+    };
+
+    describe('formatDataForForm', function () {
+      it('should appropriately format entire form', function () {
+        var EVENT_TYPE = _models.EventTypes.SUBMIT;
+        var COMPONENTS = [setupField('alpha', {
+          type: 'lowercase',
+          on: _models.EventTypes.SUBMIT
+        }), // Should be formatted
+        setupField('bravo', null), // Nothing to format
+        setupField('charlie', {
+          type: 'uppercase',
+          on: _models.EventTypes.SUBMIT
+        }), // Should be formatted
+        setupField('delta', {
+          type: 'uppercase',
+          on: _models.EventTypes.BLUR
+        }), // Should not be formatted because of event type
+        setupField('echo', {
+          type: 'uppercase',
+          on: _models.EventTypes.SUBMIT
+        }), // Should not be formatted because of event type
+        setupField('foxtrot', {
+          type: 'lowercase',
+          on: _models.EventTypes.SUBMIT
+        }) // Should not be formatted because of event type
+        ];
+        var DATA = {
+          alpha: 'AlPhA',
+          bravo: 'bRaVo',
+          charlie: 'CHArlie',
+          delta: 'deLTA',
+          foxtrot: 'FOXTROT'
+        };
+        var FORM = {
+          components: COMPONENTS.slice(0, 1),
+          pages: [{
+            components: COMPONENTS.slice(2, 3)
+          }, {
+            components: COMPONENTS.slice(4)
+          }]
+        };
+        var FORMATTED_DATA = (0, _formatDataForForm.default)(FORM, DATA, EVENT_TYPE);
+        expect(FORMATTED_DATA).toEqual({
+          alpha: 'alpha',
+          bravo: 'bRaVo',
+          charlie: 'CHARLIE',
+          delta: 'deLTA',
+          foxtrot: 'foxtrot'
+        }); // The original DATA, meanwhile, should remain untouched.
+
+        expect(DATA).toEqual({
+          alpha: 'AlPhA',
+          bravo: 'bRaVo',
+          charlie: 'CHArlie',
+          delta: 'deLTA',
+          foxtrot: 'FOXTROT'
+        });
+      });
+    });
+  });
+});

package/dist/utils/Format/formatDataForPage.js

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.formatDataForPages = exports.default = void 0;
+
+var _formatDataForComponent = require("./formatDataForComponent");
+
+// Local imports
+
+/**
+ * Formats the data for all components on a page, according to each component's format configuration.
+ * @param {object} page The page to format the components for.
+ * @param {object} data The top-level form data.
+ * @param {string} eventType What type of event initiated this call.
+ */
+var formatDataForPage = function formatDataForPage(page, data, eventType) {
+  (0, _formatDataForComponent.formatDataForComponents)(page.components, data, eventType);
+};
+/**
+ * Formats the data for all components on a page, according to each component's format configuration.
+ * @param {Array} pages The pages to format the components for.
+ * @param {object} data The top-level form data.
+ * @param {string} eventType What type of event initiated this call.
+ */
+
+
+var formatDataForPages = function formatDataForPages(pages, data, eventType) {
+  pages.forEach(function (page) {
+    return formatDataForPage(page, data, eventType);
+  });
+};
+
+exports.formatDataForPages = formatDataForPages;
+var _default = formatDataForPage;
+exports.default = _default;