@ukhomeoffice/cop-react-form-renderer 5.14.0 → 5.14.4

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

@@ -2,58 +2,92 @@
 
 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 = {
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+describe('Utils.Meta.documents.add', () => {
+  const ALPHA_DOCUMENT = {
     field: 'alpha',
     url: 'http://alpha-bravo.com/files/alpha'
   };
-  var BRAVO_DOCUMENT = {
+  const 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 return an appropriately set up object if formData is null', () => {
+    expect((0, _setDocumentsForField.default)([ALPHA_DOCUMENT], null, ALPHA_DOCUMENT.field)).toEqual({
+      [_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 a new document to the array', () => {
+    const FORM_DATA = {
+      [_constants.META_PROPERTY]: {
+        [_constants.META_DOCUMENTS_PROPERTY]: [ALPHA_DOCUMENT]
+      }
+    };
+    expect((0, _setDocumentsForField.default)([BRAVO_DOCUMENT], FORM_DATA, BRAVO_DOCUMENT.field)).toEqual({
+      [_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 add multiple new documents to the array', () => {
+    const FORM_DATA = {
+      [_constants.META_PROPERTY]: {
+        [_constants.META_DOCUMENTS_PROPERTY]: []
+      }
+    };
+    const SECOND_DOCUMENT = {
+      ...ALPHA_DOCUMENT
+    };
+    expect((0, _setDocumentsForField.default)([ALPHA_DOCUMENT, SECOND_DOCUMENT], FORM_DATA, ALPHA_DOCUMENT.field)).toEqual({
+      [_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 = {
+  it('should replace an existing document with the same field', () => {
+    const NEW_URL = 'http://replacement.com/files/alpha';
+    const 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]));
+    const FORM_DATA = {
+      [_constants.META_PROPERTY]: {
+        [_constants.META_DOCUMENTS_PROPERTY]: [ALPHA_DOCUMENT]
+      }
+    };
+    expect((0, _setDocumentsForField.default)([NEW_ALPHA], FORM_DATA, NEW_ALPHA.field)).toEqual({
+      [_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 = {
+  it('should add a document with the same field if allowMultiple is true', () => {
+    const NEW_URL = 'http://replacement.com/files/alpha';
+    const 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]));
+    const FORM_DATA = {
+      [_constants.META_PROPERTY]: {
+        [_constants.META_DOCUMENTS_PROPERTY]: [ALPHA_DOCUMENT]
+      }
+    };
+    expect((0, _setDocumentsForField.default)([NEW_ALPHA], FORM_DATA, NEW_ALPHA.field, true)).toEqual({
+      [_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 already exists', () => {
+    const FORM_DATA = {
+      [_constants.META_PROPERTY]: {
+        [_constants.META_DOCUMENTS_PROPERTY]: [ALPHA_DOCUMENT]
+      }
+    };
+    expect((0, _setDocumentsForField.default)(null, FORM_DATA, ALPHA_DOCUMENT.field)).toEqual({
+      [_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]));
+  it('should handle a null document being passed where a document with that field does not already exist', () => {
+    const FORM_DATA = {
+      [_constants.META_PROPERTY]: {
+        [_constants.META_DOCUMENTS_PROPERTY]: [ALPHA_DOCUMENT]
+      }
+    };
+    expect((0, _setDocumentsForField.default)(null, FORM_DATA, BRAVO_DOCUMENT.field)).toEqual({
+      [_constants.META_DOCUMENTS_PROPERTY]: [ALPHA_DOCUMENT]
+    });
   });
 });

package/dist/utils/Meta/index.js

@@ -6,12 +6,11 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _constants = require("./constants");
 var _documents = _interopRequireDefault(require("./documents"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // Local imports
 
-var Meta = {
+const Meta = {
   documents: _documents.default,
   name: _constants.META_PROPERTY
 };
-var _default = Meta;
-exports.default = _default;
+var _default = exports.default = Meta;

package/dist/utils/Operate/checkValueIsTruthy.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // Global imports.
 
 // Local imports.
@@ -18,12 +18,11 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {object} data The page's formData.
  * @returns true if the value is truthy, false if it isn't or doesn't exist.
  */
-var checkValueIsTruthy = function checkValueIsTruthy(config, data) {
-  if (config !== null && config !== void 0 && config.field) {
-    var fieldPath = _copReactComponents.Utils.interpolateString(config.field, data);
+const checkValueIsTruthy = (config, data) => {
+  if (config?.field) {
+    const fieldPath = _copReactComponents.Utils.interpolateString(config.field, data);
     return !!(0, _getSourceData.default)(data, fieldPath);
   }
   return false;
 };
-var _default = checkValueIsTruthy;
-exports.default = _default;
+var _default = exports.default = checkValueIsTruthy;

package/dist/utils/Operate/checkValueIsTruthy.test.js

@@ -1,42 +1,42 @@
 "use strict";
 
 var _checkValueIsTruthy = _interopRequireDefault(require("./checkValueIsTruthy"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-describe('Utils.Operate.checkValueIsTruthy', function () {
-  var DATA = {
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+describe('Utils.Operate.checkValueIsTruthy', () => {
+  const DATA = {
     alpha: 'abc',
     bravo: ''
   };
-  it('Should return true is the value of the field is truthy', function () {
-    var CONFIG = {
+  it('Should return true is the value of the field is truthy', () => {
+    const CONFIG = {
       field: 'alpha'
     };
-    var result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
+    const result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
     expect(result).toEqual(true);
   });
-  it('Should return false if the value of the field is falsy', function () {
-    var CONFIG = {
+  it('Should return false if the value of the field is falsy', () => {
+    const CONFIG = {
       field: 'bravo'
     };
-    var result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
+    const result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
     expect(result).toEqual(false);
   });
-  it('Should return false if the field does not exist', function () {
-    var CONFIG = {
+  it('Should return false if the field does not exist', () => {
+    const CONFIG = {
       field: 'charlie'
     };
-    var result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
+    const result = (0, _checkValueIsTruthy.default)(CONFIG, DATA);
     expect(result).toEqual(false);
   });
-  it('Should return false when an invalid config is used', function () {
-    var result = (0, _checkValueIsTruthy.default)(null, DATA);
+  it('Should return false when an invalid config is used', () => {
+    const result = (0, _checkValueIsTruthy.default)(null, DATA);
     expect(result).toEqual(false);
   });
-  it('Should return false when invalid data is used', function () {
-    var CONFIG = {
+  it('Should return false when invalid data is used', () => {
+    const CONFIG = {
       field: 'alpha'
     };
-    var result = (0, _checkValueIsTruthy.default)(CONFIG, null);
+    const result = (0, _checkValueIsTruthy.default)(CONFIG, null);
     expect(result).toEqual(false);
   });
 });

package/dist/utils/Operate/getFirstOf.js

@@ -6,17 +6,17 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // Global imports.
 
 // Local imports.
 
-var getFirstOf = function getFirstOf(config, data) {
-  if (config !== null && config !== void 0 && config.fields) {
-    var fieldValue;
-    config.fields.find(function (field) {
-      var fieldPath = _copReactComponents.Utils.interpolateString(field, data);
-      var foundValue = (0, _getSourceData.default)(data, fieldPath);
+const getFirstOf = (config, data) => {
+  if (config?.fields) {
+    let fieldValue;
+    config.fields.find(field => {
+      const fieldPath = _copReactComponents.Utils.interpolateString(field, data);
+      const foundValue = (0, _getSourceData.default)(data, fieldPath);
       if (foundValue) {
         fieldValue = foundValue;
         return true;
@@ -25,7 +25,6 @@ var getFirstOf = function getFirstOf(config, data) {
     });
     return fieldValue || (config.fallback ? _copReactComponents.Utils.interpolateString(config.fallback, data) : '');
   }
-  return (config === null || config === void 0 ? void 0 : config.value) || null;
+  return config?.value || null;
 };
-var _default = getFirstOf;
-exports.default = _default;
+var _default = exports.default = getFirstOf;

package/dist/utils/Operate/getFirstOf.test.js

@@ -1,9 +1,9 @@
 "use strict";
 
 var _getFirstOf = _interopRequireDefault(require("./getFirstOf"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-describe('Utils.Operate.getFirstOf', function () {
-  var DATA = {
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+describe('Utils.Operate.getFirstOf', () => {
+  const DATA = {
     name: 'sam',
     id: 1,
     test: ['2', '3'],
@@ -12,75 +12,75 @@ describe('Utils.Operate.getFirstOf', function () {
     otherIdDoc: '',
     anotherMadeUpId: 789
   };
-  it('Should handle interpolated field strings', function () {
+  it('Should handle interpolated field strings', () => {
     // eslint-disable-next-line no-template-curly-in-string
-    var CONFIG = {
+    const CONFIG = {
       fields: ['test[${id}]']
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
     expect(result).toEqual(DATA.test[1]);
   });
-  it('Should return the value provided in config if no field is specified', function () {
-    var CONFIG = {
+  it('Should return the value provided in config if no field is specified', () => {
+    const CONFIG = {
       value: '2'
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
     expect(result).toEqual(CONFIG.value);
   });
-  it('Should return the fallback if the requested fields are not found', function () {
+  it('Should return the fallback if the requested fields are not found', () => {
     // eslint-disable-next-line no-template-curly-in-string
-    var CONFIG = {
+    const CONFIG = {
       value: '2',
       fields: ['nonExistent'],
       fallback: "Test ${name}"
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
-    expect(result).toEqual("Test ".concat(DATA.name));
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
+    expect(result).toEqual(`Test ${DATA.name}`);
   });
-  it('Should return the value of the passportNumber field given in config', function () {
-    var CONFIG = {
+  it('Should return the value of the passportNumber field given in config', () => {
+    const CONFIG = {
       fields: ['passportNumber', 'anotherMadeUpId', 'otherIdDoc']
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
     expect(result).toEqual(DATA.passportNumber);
   });
-  it('Should return the value of the anotherMadeUpId field given in config', function () {
-    var CONFIG = {
+  it('Should return the value of the anotherMadeUpId field given in config', () => {
+    const CONFIG = {
       fields: ['anotherMadeUpId', 'passportNumber', 'otherIdDoc']
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
     expect(result).toEqual(DATA.anotherMadeUpId);
   });
-  it('Should return the value of the otherIdDoc field given in config', function () {
-    var CONFIG = {
+  it('Should return the value of the otherIdDoc field given in config', () => {
+    const CONFIG = {
       fields: ['otherIdDoc', 'passportNumber', 'anotherMadeUpId']
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
     expect(result).toEqual(DATA.passportNumber);
   });
-  it('Should return the value of the otherIdDoc field given in config, if it exists, otherwise next field next in the array', function () {
-    var CONFIG = {
+  it('Should return the value of the otherIdDoc field given in config, if it exists, otherwise next field next in the array', () => {
+    const CONFIG = {
       fields: ['otherIdDoc', 'passportNumber', 'anotherMadeUpId']
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
     expect(result).toEqual(DATA.passportNumber);
   });
-  it('Should return no value if elements in config.fields are not found in data', function () {
-    var CONFIG = {
+  it('Should return no value if elements in config.fields are not found in data', () => {
+    const CONFIG = {
       fields: ['otherIdDoc1', 'passportNumber1', 'anotherMadeUpId1']
     };
-    var result = (0, _getFirstOf.default)(CONFIG, DATA);
+    const result = (0, _getFirstOf.default)(CONFIG, DATA);
     expect(result).toEqual('');
   });
-  it('Should return null when an invalid config is used', function () {
-    var result = (0, _getFirstOf.default)(null, DATA);
+  it('Should return null when an invalid config is used', () => {
+    const result = (0, _getFirstOf.default)(null, DATA);
     expect(result).toEqual(null);
   });
-  it('Should return null when invalid data is used', function () {
-    var CONFIG = {
+  it('Should return null when invalid data is used', () => {
+    const CONFIG = {
       field: 'a'
     };
-    var result = (0, _getFirstOf.default)(CONFIG, null);
+    const result = (0, _getFirstOf.default)(CONFIG, null);
     expect(result).toEqual(null);
   });
 });

package/dist/utils/Operate/getIndexOfMatchingValueIn.js

@@ -6,16 +6,16 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 // Global imports.
 
 // Local imports.
 
-var getValueOrField = function getValueOrField(config, data) {
-  if (config !== null && config !== void 0 && config.value) {
+const getValueOrField = (config, data) => {
+  if (config?.value) {
     return config.value;
   }
-  var path = _copReactComponents.Utils.interpolateString(config === null || config === void 0 ? void 0 : config.field, data);
+  const path = _copReactComponents.Utils.interpolateString(config?.field, data);
   return (0, _getSourceData.default)(data, path);
 };
 
@@ -28,18 +28,18 @@ var getValueOrField = function getValueOrField(config, data) {
  * @param {object} data A page's formData.
  * @returns The index of the matching value if one exists, or null.
  */
-var getIndexOfMatchingValueIn = function getIndexOfMatchingValueIn(config, data) {
+const getIndexOfMatchingValueIn = (config, data) => {
   if (!config || !data) {
     return null;
   }
-  var targetPath = _copReactComponents.Utils.interpolateString(config.target, data);
-  var target = (0, _getSourceData.default)(data, targetPath);
-  var value = getValueOrField(config, data);
-  var cutoff = getValueOrField(config.cutoff, data);
-  var ignore = getValueOrField(config.ignore, data);
-  var result = null;
+  const targetPath = _copReactComponents.Utils.interpolateString(config.target, data);
+  const target = (0, _getSourceData.default)(data, targetPath);
+  const value = getValueOrField(config, data);
+  const cutoff = getValueOrField(config.cutoff, data);
+  const ignore = getValueOrField(config.ignore, data);
+  let result = null;
   if (target && value && Array.isArray(target)) {
-    target.every(function (entry, index) {
+    target.every((entry, index) => {
       if (index === cutoff) {
         return false;
       }
@@ -64,5 +64,4 @@ var getIndexOfMatchingValueIn = function getIndexOfMatchingValueIn(config, data)
   }
   return typeof result === 'number' ? result.toString() : result;
 };
-var _default = getIndexOfMatchingValueIn;
-exports.default = _default;
+var _default = exports.default = getIndexOfMatchingValueIn;