@ukhomeoffice/cop-react-form-renderer 5.0.0-alpha → 5.0.1

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

@@ -0,0 +1,45 @@
+"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

@@ -15,8 +15,9 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {string} eventType What type of event initiated this call.
  */
 var formatDataForComponent = function formatDataForComponent(component, data, eventType) {
+  var componentData = data;
   if (component.format && component.format.on === eventType) {
-    data[component.fieldId] = (0, _formatData.default)(component.format, data[component.fieldId]);
+    componentData[component.fieldId] = (0, _formatData.default)(component.format, componentData[component.fieldId]);
   }
 };
 

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

@@ -0,0 +1,142 @@
+"use strict";
+
+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 _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(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 = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+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

@@ -6,9 +6,12 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _formatDataForComponent = require("./formatDataForComponent");
 var _formatDataForPage = require("./formatDataForPage");
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : 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; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 /**
  * 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.

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

@@ -0,0 +1,81 @@
+"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.test.js

@@ -0,0 +1,99 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+var _models = require("../../models");
+var _formatDataForPage = _interopRequireWildcard(require("./formatDataForPage"));
+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; }
+// Local imports
+
+describe('utils', function () {
+  describe('Format', function () {
+    var setupField = function setupField(fieldId, format) {
+      return {
+        fieldId: fieldId,
+        format: format
+      };
+    };
+    describe('formatDataForPage', function () {
+      it('should appropriately format a page of 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'
+        };
+        var PAGE = {
+          components: COMPONENTS
+        };
+        (0, _formatDataForPage.default)(PAGE, DATA, EVENT_TYPE);
+        expect(DATA).toEqual({
+          alpha: 'alpha',
+          bravo: 'bRaVo',
+          charlie: 'CHARLIE',
+          delta: 'deLTA'
+        });
+      });
+    });
+    describe('formatDataForPages', function () {
+      it('should appropriately format multiple pages', 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'
+        };
+        var PAGES = [{
+          components: COMPONENTS.slice(0, 1)
+        }, {
+          components: COMPONENTS.slice(2)
+        }];
+        (0, _formatDataForPage.formatDataForPages)(PAGES, DATA, EVENT_TYPE);
+        expect(DATA).toEqual({
+          alpha: 'alpha',
+          bravo: 'bRaVo',
+          charlie: 'CHARLIE',
+          delta: 'deLTA'
+        });
+      });
+    });
+  });
+});

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

@@ -0,0 +1,105 @@
+"use strict";
+
+var _models = require("../../models");
+var _getFormHub = _interopRequireDefault(require("./getFormHub"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+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: '${urls.refData}/v3/charlies'
+        }
+      }];
+      var FORM_DATA = {
+        urls: {
+          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]
+            }, _objectSpread(_objectSpread({}, HUB.components[1]), {}, {
+              full_path: HUB.components[1].fieldId
+            }), {
+              type: 'html',
+              tagName: 'p',
+              content: HUB.components[2]
+            }, _objectSpread(_objectSpread({
+              use: 'a'
+            }, A), {}, {
+              cya_label: A.label,
+              full_path: A.fieldId
+            })],
+            formData: FORM_DATA
+          });
+        });
+      });
+      describe("when the FormType is \"".concat(_models.FormTypes.TASK, "\""), function () {
+        it("should return the string \"".concat(_models.HubFormats.TASK, "\" when the format is set to \"").concat(_models.HubFormats.TASK, "\""), function () {
+          var HUB = {
+            format: _models.HubFormats.TASK
+          };
+          expect((0, _getFormHub.default)(_models.FormTypes.TASK, HUB, FORM_COMPONENTS, FORM_DATA)).toEqual(_models.HubFormats.TASK);
+        });
+      });
+    });
+  });
+});

package/dist/utils/Meta/documents/getDocuments.test.js

@@ -3,7 +3,10 @@
 var _constants = require("../constants");
 var _getDocuments = _interopRequireDefault(require("./getDocuments"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-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; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 describe('Utils.Meta.documents.get', function () {
   it('should return an empty array if formData is null', function () {
     expect((0, _getDocuments.default)(null)).toEqual([]);

package/dist/utils/Meta/documents/index.js

@@ -5,13 +5,13 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 var _constants = require("../constants");
-var _setDocumentForField = _interopRequireDefault(require("./setDocumentForField"));
+var _setDocumentsForField = _interopRequireDefault(require("./setDocumentsForField"));
 var _getDocuments = _interopRequireDefault(require("./getDocuments"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // Local imports
 
 var documents = {
-  setForField: _setDocumentForField.default,
+  setForField: _setDocumentsForField.default,
   get: _getDocuments.default,
   name: _constants.META_DOCUMENTS_PROPERTY
 };

package/dist/utils/Meta/documents/setDocumentsForField.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _constants = require("../constants");
+var _getDocuments = _interopRequireDefault(require("./getDocuments"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+var setDocumentsForField = function setDocumentsForField(documents, formData, field, allowMultiple) {
+  var changedDocuments = allowMultiple ? (0, _getDocuments.default)(formData) : (0, _getDocuments.default)(formData).filter(function (d) {
+    return d.field !== field;
+  });
+  if (Array.isArray(documents)) {
+    documents.forEach(function (document) {
+      changedDocuments.push(_objectSpread(_objectSpread({}, document), {}, {
+        field: field
+      }));
+    });
+  }
+  var existing = formData ? formData[_constants.META_PROPERTY] : undefined;
+  return _objectSpread(_objectSpread({}, existing), {}, _defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, changedDocuments));
+};
+var _default = setDocumentsForField;
+exports.default = _default;

package/dist/utils/Meta/documents/setDocumentsForField.test.js

@@ -0,0 +1,59 @@
+"use strict";
+
+var _constants = require("../constants");
+var _setDocumentsForField = _interopRequireDefault(require("./setDocumentsForField"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); 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 = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+describe('Utils.Meta.documents.add', function () {
+  var ALPHA_DOCUMENT = {
+    field: 'alpha',
+    url: 'http://alpha-bravo.com/files/alpha'
+  };
+  var BRAVO_DOCUMENT = {
+    field: 'bravo',
+    url: 'http://alpha-bravo.com/files/bravo'
+  };
+  it('should return an appropriately set up object if formData is null', function () {
+    expect((0, _setDocumentsForField.default)([ALPHA_DOCUMENT], null, ALPHA_DOCUMENT.field)).toEqual(_defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT]));
+  });
+  it('should add a new document to the array', function () {
+    var FORM_DATA = _defineProperty({}, _constants.META_PROPERTY, _defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT]));
+    expect((0, _setDocumentsForField.default)([BRAVO_DOCUMENT], FORM_DATA, BRAVO_DOCUMENT.field)).toEqual(_defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT, BRAVO_DOCUMENT]));
+  });
+  it('should add multiple new documents to the array', function () {
+    var FORM_DATA = _defineProperty({}, _constants.META_PROPERTY, _defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, []));
+    var SECOND_DOCUMENT = _objectSpread({}, ALPHA_DOCUMENT);
+    expect((0, _setDocumentsForField.default)([ALPHA_DOCUMENT, SECOND_DOCUMENT], FORM_DATA, ALPHA_DOCUMENT.field)).toEqual(_defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT, SECOND_DOCUMENT]));
+  });
+  it('should replace an existing document with the same field', function () {
+    var NEW_URL = 'http://replacement.com/files/alpha';
+    var NEW_ALPHA = {
+      field: ALPHA_DOCUMENT.field,
+      url: NEW_URL
+    };
+    var FORM_DATA = _defineProperty({}, _constants.META_PROPERTY, _defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT]));
+    expect((0, _setDocumentsForField.default)([NEW_ALPHA], FORM_DATA, NEW_ALPHA.field)).toEqual(_defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [NEW_ALPHA]));
+  });
+  it('should add a document with the same field if allowMultiple is true', function () {
+    var NEW_URL = 'http://replacement.com/files/alpha';
+    var NEW_ALPHA = {
+      field: ALPHA_DOCUMENT.field,
+      url: NEW_URL
+    };
+    var FORM_DATA = _defineProperty({}, _constants.META_PROPERTY, _defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT]));
+    expect((0, _setDocumentsForField.default)([NEW_ALPHA], FORM_DATA, NEW_ALPHA.field, true)).toEqual(_defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT, NEW_ALPHA]));
+  });
+  it('should handle a null document being passed where a document with that field already exists', function () {
+    var FORM_DATA = _defineProperty({}, _constants.META_PROPERTY, _defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT]));
+    expect((0, _setDocumentsForField.default)(null, FORM_DATA, ALPHA_DOCUMENT.field)).toEqual(_defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, []));
+  });
+  it('should handle a null document being passed where a document with that field does not already exist', function () {
+    var FORM_DATA = _defineProperty({}, _constants.META_PROPERTY, _defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT]));
+    expect((0, _setDocumentsForField.default)(null, FORM_DATA, BRAVO_DOCUMENT.field)).toEqual(_defineProperty({}, _constants.META_DOCUMENTS_PROPERTY, [ALPHA_DOCUMENT]));
+  });
+});