@ukhomeoffice/cop-react-form-renderer 6.7.0-alpha → 6.11.1

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

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

package/dist/utils/Operate/getFirstOf.js

@@ -11,12 +11,12 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 // Local imports.
 
-const getFirstOf = (config, data) => {
+var getFirstOf = function getFirstOf(config, data) {
   if (config !== null && config !== void 0 && config.fields) {
-    let fieldValue;
-    config.fields.find(field => {
-      const fieldPath = _copReactComponents.Utils.interpolateString(field, data);
-      const foundValue = (0, _getSourceData.default)(data, fieldPath);
+    var fieldValue;
+    config.fields.find(function (field) {
+      var fieldPath = _copReactComponents.Utils.interpolateString(field, data);
+      var foundValue = (0, _getSourceData.default)(data, fieldPath);
       if (foundValue) {
         fieldValue = foundValue;
         return true;

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

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

package/dist/utils/Operate/getIndexOfMatchingValueIn.js

@@ -11,11 +11,11 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 // Local imports.
 
-const getValueOrField = (config, data) => {
+var getValueOrField = function getValueOrField(config, data) {
   if (config !== null && config !== void 0 && config.value) {
     return config.value;
   }
-  const path = _copReactComponents.Utils.interpolateString(config === null || config === void 0 ? void 0 : config.field, data);
+  var path = _copReactComponents.Utils.interpolateString(config === null || config === void 0 ? void 0 : config.field, data);
   return (0, _getSourceData.default)(data, path);
 };
 
@@ -28,18 +28,18 @@ const getValueOrField = (config, data) => {
  * @param {object} data A page's formData.
  * @returns The index of the matching value if one exists, or null.
  */
-const getIndexOfMatchingValueIn = (config, data) => {
+var getIndexOfMatchingValueIn = function getIndexOfMatchingValueIn(config, data) {
   if (!config || !data) {
     return 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;
+  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;
   if (target && value && Array.isArray(target)) {
-    target.every((entry, index) => {
+    target.every(function (entry, index) {
       if (index === cutoff) {
         return false;
       }

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

@@ -2,8 +2,8 @@
 
 var _getIndexOfMatchingValueIn = _interopRequireDefault(require("./getIndexOfMatchingValueIn"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-describe('Utils.Operate.getIndexOfPriorMatchingValueIn', () => {
-  const DATA = {
+describe('Utils.Operate.getIndexOfPriorMatchingValueIn', function () {
+  var DATA = {
     arrayOfValues: ['abc', 'bcd', 'cde', 'def', {
       root: {
         branch: 'leaf'
@@ -17,141 +17,147 @@ describe('Utils.Operate.getIndexOfPriorMatchingValueIn', () => {
     cutoffName: 'cutoffIndex',
     ignoreName: 'ignoreIndex'
   };
-  it('Should return the index of a matching value if one exists', () => {
-    const CONFIG = {
+  it('Should return the index of a matching value if one exists', function () {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde'
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual('2');
   });
-  it('Should handle getting value from given field', () => {
-    const CONFIG = {
+  it('Should handle getting value from given field', function () {
+    var CONFIG = {
       target: 'arrayOfValues',
       field: 'valueToSearchFor'
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual('2');
   });
-  it('Should handle interpolated string for field', () => {
+  it('Should handle interpolated string for field', function () {
     // eslint-disable-next-line no-template-curly-in-string
-    const CONFIG = {
+    var CONFIG = {
       target: 'arrayOfValues',
       field: '${fieldName}'
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual('2');
   });
-  it('Should handle interpolated string for key', () => {
+  it('Should handle interpolated string for key', function () {
     // eslint-disable-next-line no-template-curly-in-string
-    const CONFIG = {
+    var CONFIG = {
       target: 'arrayOfValues',
       key: 'root.branch',
       value: 'leaf'
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual('4');
   });
-  it('Should handle a cutoff value being specified', () => {
-    const CONFIG = {
+  it('Should handle a cutoff value being specified', function () {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde',
       cutoff: {
         value: 1
       }
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null); // Cutoff occurs before matching value is reached.
   });
-  it('Should handle a cutoff field being specified', () => {
-    const CONFIG = {
+
+  it('Should handle a cutoff field being specified', function () {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde',
       cutoff: {
         field: 'cutoffIndex'
       }
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null); // Cutoff occurs before matching value is reached.
   });
-  it('Should handle interpolated string for cutoff.field', () => {
+
+  it('Should handle interpolated string for cutoff.field', function () {
     // eslint-disable-next-line no-template-curly-in-string
-    const CONFIG = {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde',
       cutoff: {
         field: '${cutoffName}'
       }
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null); // Cutoff occurs before matching value is reached.
   });
-  it('Should handle an ignore value being specified', () => {
-    const CONFIG = {
+
+  it('Should handle an ignore value being specified', function () {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde',
       ignore: {
         value: 2
       }
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null); // Should ignore the matching value.
   });
-  it('Should handle an ignore field being specified', () => {
-    const CONFIG = {
+
+  it('Should handle an ignore field being specified', function () {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde',
       ignore: {
         field: 'ignoreIndex'
       }
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null); // Should ignore the matching value.
   });
-  it('Should handle interpolated string for ignore.field', () => {
+
+  it('Should handle interpolated string for ignore.field', function () {
     // eslint-disable-next-line no-template-curly-in-string
-    const CONFIG = {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde',
       ignore: {
         field: '${ignoreName}'
       }
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null); // Should ignore the matching value.
   });
-  it('Should handle interpolated string for target', () => {
+
+  it('Should handle interpolated string for target', function () {
     // eslint-disable-next-line no-template-curly-in-string
-    const CONFIG = {
+    var CONFIG = {
       target: '${targetName}',
       value: 'cde'
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual('2');
   });
-  it('Should return null when the target does not exist', () => {
-    const CONFIG = {
+  it('Should return null when the target does not exist', function () {
+    var CONFIG = {
       target: 'notARealTarget',
       value: 'cde'
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null);
   });
-  it('Should return null when config is missing fields', () => {
-    const CONFIG = {};
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
+  it('Should return null when config is missing fields', function () {
+    var CONFIG = {};
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, DATA);
     expect(result).toEqual(null);
   });
-  it('Should return null when config is invalid', () => {
-    const result = (0, _getIndexOfMatchingValueIn.default)(null, DATA);
+  it('Should return null when config is invalid', function () {
+    var result = (0, _getIndexOfMatchingValueIn.default)(null, DATA);
     expect(result).toEqual(null);
   });
-  it('Should return null when data is invalid', () => {
-    const CONFIG = {
+  it('Should return null when data is invalid', function () {
+    var CONFIG = {
       target: 'arrayOfValues',
       value: 'cde'
     };
-    const result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, null);
+    var result = (0, _getIndexOfMatchingValueIn.default)(CONFIG, null);
     expect(result).toEqual(null);
   });
 });

package/dist/utils/Operate/getLength.js

@@ -0,0 +1,50 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _copReactComponents = require("@ukhomeoffice/cop-react-components");
+var _getCollectionPageActiveIndex = _interopRequireDefault(require("../CollectionPage/getCollectionPageActiveIndex"));
+var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+// Global imports.
+
+// Local imports.
+
+/**
+ * Finds a field within data and returns its length
+ * @param {object} config The config of the operation.
+ * @param {string} config.target The path to the target field. If the path
+ * goes through a collection this can be specified as 'collectionName[]'
+ * and this function will use the active entry within that collection.
+ * @param {object} data A page's formData.
+ * @returns The length of a field if found or 0
+ */
+var getLength = function getLength(config, data) {
+  if (!config || !data) {
+    return null;
+  }
+
+  // Replace any instances of 'collectionName[]' with 'collectionName[activeIndex]'
+  var pathParts = config.target.split('.');
+  var updatedPath = '';
+  pathParts.forEach(function (part) {
+    if (updatedPath !== '') {
+      updatedPath += '.';
+    }
+    if (part.slice(-2) === '[]') {
+      var collectionName = part.slice(0, -2);
+      var activeIndex = (0, _getCollectionPageActiveIndex.default)(collectionName, data);
+      updatedPath += "".concat(collectionName, "[").concat(activeIndex, "]");
+    } else {
+      updatedPath += part;
+    }
+  });
+
+  // Get the field and return its length
+  var targetPath = _copReactComponents.Utils.interpolateString(updatedPath, data);
+  var target = (0, _getSourceData.default)(data, targetPath);
+  return (target === null || target === void 0 ? void 0 : target.length) || 0;
+};
+var _default = exports.default = getLength;

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

@@ -0,0 +1,89 @@
+"use strict";
+
+var _getLength = _interopRequireDefault(require("./getLength"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('Utils.Operate.getLength', function () {
+  it('returns null if config is not defined', function () {
+    expect((0, _getLength.default)(null, {})).toEqual(null);
+  });
+  it('returns null if data is not defined', function () {
+    expect((0, _getLength.default)({}, null)).toEqual(null);
+  });
+  it('returns the length of a top level string', function () {
+    var CONFIG = {
+      target: 'alpha'
+    };
+    var DATA = {
+      alpha: 'abcdef'
+    };
+    expect((0, _getLength.default)(CONFIG, DATA)).toEqual(6);
+  });
+  it('returns the length of a top level array', function () {
+    var CONFIG = {
+      target: 'alpha'
+    };
+    var DATA = {
+      alpha: [{
+        test: 'test'
+      }, {
+        test: 'test'
+      }, {
+        test: 'test'
+      }, {
+        test: 'test'
+      }]
+    };
+    expect((0, _getLength.default)(CONFIG, DATA)).toEqual(4);
+  });
+  it('returns 0 if the field cannot be found', function () {
+    var CONFIG = {
+      target: 'alpha'
+    };
+    var DATA = {
+      beta: [{
+        test: 'test'
+      }, {
+        test: 'test'
+      }, {
+        test: 'test'
+      }, {
+        test: 'test'
+      }]
+    };
+    expect((0, _getLength.default)(CONFIG, DATA)).toEqual(0);
+  });
+  it('returns the length of a field not on the top level', function () {
+    var CONFIG = {
+      target: 'alpha.beta'
+    };
+    var DATA = {
+      alphaActiveId: 3,
+      alpha: {
+        beta: 'qwerty'
+      }
+    };
+    expect((0, _getLength.default)(CONFIG, DATA)).toEqual(6);
+  });
+  it('returns the length of an array nested under an array', function () {
+    var CONFIG = {
+      target: 'alpha[].beta'
+    };
+    var DATA = {
+      alphaActiveId: 3,
+      alpha: [{
+        id: 1,
+        beta: ['test']
+      }, {
+        id: 2,
+        beta: ['test', 'test']
+      }, {
+        id: 3,
+        beta: ['test', 'test', 'test']
+      }, {
+        id: 4,
+        beta: ['test', 'test', 'test', 'test']
+      }]
+    };
+    expect((0, _getLength.default)(CONFIG, DATA)).toEqual(3);
+  });
+});

package/dist/utils/Operate/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _runPageOperations = _interopRequireDefault(require("./runPageOperations"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-const Operate = {
+var Operate = {
   runPageOperations: _runPageOperations.default
 };
 var _default = exports.default = Operate;

package/dist/utils/Operate/persistValueInFormData.js

@@ -18,10 +18,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * @param {object} data The page's formData.
  * @param {function} onChange The page's onChange handler.
  */
-const persistValueInFormData = (config, data, onChange) => {
-  let value;
+var persistValueInFormData = function persistValueInFormData(config, data, onChange) {
+  var value;
   if (config !== null && config !== void 0 && config.field) {
-    const fieldPath = _copReactComponents.Utils.interpolateString(config.field, data);
+    var fieldPath = _copReactComponents.Utils.interpolateString(config.field, data);
     value = (0, _getSourceData.default)(data, fieldPath);
   } else {
     value = config === null || config === void 0 ? void 0 : config.value;