@ukhomeoffice/cop-react-form-renderer 6.0.6-peter → 6.7.0-alpha

package/dist/utils/Data/getOptions.test.js

@@ -4,16 +4,16 @@ var _getOptions = _interopRequireDefault(require("./getOptions"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // Local imports
 
-describe('utils', function () {
-  describe('Data', function () {
-    describe('getOptions', function () {
-      it('should handle a null config', function () {
-        (0, _getOptions.default)(null, function (options) {
+describe('utils', () => {
+  describe('Data', () => {
+    describe('getOptions', () => {
+      it('should handle a null config', () => {
+        (0, _getOptions.default)(null, options => {
           expect(options).toEqual([]);
         });
       });
-      it('should get any specified options from the config', function () {
-        var CONFIG = {
+      it('should get any specified options from the config', () => {
+        const CONFIG = {
           options: [{
             value: 'a',
             label: 'Alpha'
@@ -22,12 +22,12 @@ describe('utils', function () {
             label: 'Bravo'
           }]
         };
-        (0, _getOptions.default)(CONFIG, function (options) {
+        (0, _getOptions.default)(CONFIG, options => {
           expect(options).toEqual(CONFIG.options);
         });
       });
-      it('should get any specified options from the data property of the config', function () {
-        var CONFIG = {
+      it('should get any specified options from the data property of the config', () => {
+        const CONFIG = {
           data: {
             options: [{
               value: 'a',
@@ -38,12 +38,12 @@ describe('utils', function () {
             }]
           }
         };
-        (0, _getOptions.default)(CONFIG, function (options) {
+        (0, _getOptions.default)(CONFIG, options => {
           expect(options).toEqual(CONFIG.data.options);
         });
       });
-      it('should use the top-level options over those in the data property', function () {
-        var CONFIG = {
+      it('should use the top-level options over those in the data property', () => {
+        const CONFIG = {
           options: [{
             value: 'a',
             label: 'Alpha'
@@ -61,12 +61,12 @@ describe('utils', function () {
             }]
           }
         };
-        (0, _getOptions.default)(CONFIG, function (options) {
+        (0, _getOptions.default)(CONFIG, options => {
           expect(options).toEqual(CONFIG.options);
         });
       });
-      it('should exclude options from the config that fail show_when checks', function () {
-        var CONFIG = {
+      it('should exclude options from the config that fail show_when checks', () => {
+        const CONFIG = {
           id: 'test',
           options: [{
             value: 'a',
@@ -89,12 +89,12 @@ describe('utils', function () {
             other: 'c'
           }
         };
-        (0, _getOptions.default)(CONFIG, function (options) {
+        (0, _getOptions.default)(CONFIG, options => {
           expect(options).toEqual([CONFIG.options[0]]);
         });
       });
-      it('should exclude options from the config that fail or type show_when checks', function () {
-        var CONFIG = {
+      it('should exclude options from the config that fail or type show_when checks', () => {
+        const CONFIG = {
           id: 'test',
           options: [{
             value: 'a',
@@ -131,10 +131,83 @@ describe('utils', function () {
             other: 'c'
           }
         };
-        (0, _getOptions.default)(CONFIG, function (options) {
+        (0, _getOptions.default)(CONFIG, options => {
           expect(options).toEqual([CONFIG.options[0]]);
         });
       });
+      it('should should use both data from refdata url and options if both present', () => {
+        const CONFIG = {
+          data: {
+            options: [{
+              refdata_match: {
+                id: 2
+              },
+              nested: [{
+                value: 'a',
+                label: 'Alpha'
+              }]
+            }],
+            url: 'refdata.url'
+          },
+          options: [{
+            id: 1,
+            description: 'First refdata item',
+            value: 'firstValue',
+            label: 'First label'
+          }, {
+            id: 2,
+            description: 'Second refdata item',
+            value: 'secondValue',
+            label: 'Second label'
+          }, {
+            id: 3,
+            description: 'Third refdata item',
+            value: 'thirdValue',
+            label: 'Third label'
+          }]
+        };
+        const MERGED_CONFIG = [{
+          id: 1,
+          description: 'First refdata item',
+          value: 'firstValue',
+          label: 'First label'
+        }, {
+          id: 2,
+          description: 'Second refdata item',
+          value: 'secondValue',
+          nested: [{
+            value: 'a',
+            label: 'Alpha'
+          }],
+          label: 'Second label'
+        }, {
+          id: 3,
+          description: 'Third refdata item',
+          value: 'thirdValue',
+          label: 'Third label'
+        }];
+        (0, _getOptions.default)(CONFIG, options => {
+          expect(options).toEqual(MERGED_CONFIG);
+        });
+      });
+      it('should override the hint if specified in the config', () => {
+        const CONFIG = {
+          alternativeHintField: 'description',
+          options: [{
+            value: 'a',
+            label: 'Alpha',
+            description: 'first'
+          }, {
+            value: 'b',
+            label: 'Bravo',
+            description: 'second'
+          }]
+        };
+        (0, _getOptions.default)(CONFIG, options => {
+          expect(options[0].hint).toEqual(CONFIG.options[0].description);
+          expect(options[1].hint).toEqual(CONFIG.options[1].description);
+        });
+      });
     });
   });
 });

package/dist/utils/Data/getSourceData.js

@@ -4,24 +4,14 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-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(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t.return && (u = t.return(), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
-function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-var getItemInArray = function getItemInArray(arr, index) {
+const getItemInArray = (arr, index) => {
   if (Array.isArray(arr)) {
     return arr[parseInt(index, 10)];
   }
   return undefined;
 };
-var isArrayProp = function isArrayProp(prop) {
-  return prop.includes('[');
-};
-var getPropertyAndIndex = function getPropertyAndIndex(prop) {
-  return prop.replace(']', '').split('[');
-};
+const isArrayProp = prop => prop.includes('[');
+const getPropertyAndIndex = prop => prop.replace(']', '').split('[');
 
 /**
  * Gets the value of a field within the top-level JSON form data,
@@ -38,16 +28,13 @@ var getPropertyAndIndex = function getPropertyAndIndex(prop) {
  * @param {string} fieldId The dot-separated path to the field.
  * @returns The value of the field specified.
  */
-var getSourceData = function getSourceData(data, fieldId) {
+const getSourceData = (data, fieldId) => {
   if (!fieldId) {
     return undefined;
   }
-  return fieldId.split('.').reduce(function (obj, prop) {
+  return fieldId.split('.').reduce((obj, prop) => {
     if (obj && isArrayProp(prop)) {
-      var _getPropertyAndIndex = getPropertyAndIndex(prop),
-        _getPropertyAndIndex2 = _slicedToArray(_getPropertyAndIndex, 2),
-        actualProp = _getPropertyAndIndex2[0],
-        index = _getPropertyAndIndex2[1];
+      const [actualProp, index] = getPropertyAndIndex(prop);
       return getItemInArray(obj[actualProp], index);
     }
     return obj ? obj[prop] : undefined;

package/dist/utils/Data/getSourceData.test.js

@@ -2,49 +2,53 @@
 
 var _getSourceData = _interopRequireDefault(require("./getSourceData"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
-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); } // Local imports
-describe('utils', function () {
-  describe('Data', function () {
-    describe('getSourceData', function () {
-      it('should return the value at the top level', function () {
-        var FIELD_ID = 'field';
-        var VALUE = 'value';
-        var DATA = _defineProperty({}, FIELD_ID, VALUE);
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+// Local imports
+
+describe('utils', () => {
+  describe('Data', () => {
+    describe('getSourceData', () => {
+      it('should return the value at the top level', () => {
+        const FIELD_ID = 'field';
+        const VALUE = 'value';
+        const DATA = {
+          [FIELD_ID]: VALUE
+        };
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toEqual(VALUE);
       });
-      it('should handle boolean true', function () {
-        var FIELD_ID = 'field';
-        var VALUE = true;
-        var DATA = _defineProperty({}, FIELD_ID, VALUE);
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+      it('should handle boolean true', () => {
+        const FIELD_ID = 'field';
+        const VALUE = true;
+        const DATA = {
+          [FIELD_ID]: VALUE
+        };
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toStrictEqual(true);
       });
-      it('should handle boolean false', function () {
-        var FIELD_ID = 'field';
-        var VALUE = false;
-        var DATA = _defineProperty({}, FIELD_ID, VALUE);
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+      it('should handle boolean false', () => {
+        const FIELD_ID = 'field';
+        const VALUE = false;
+        const DATA = {
+          [FIELD_ID]: VALUE
+        };
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toStrictEqual(false);
       });
-      it('should return a nested value', function () {
-        var FIELD_ID = 'field.nested';
-        var VALUE = 'nested value';
-        var DATA = {
+      it('should return a nested value', () => {
+        const FIELD_ID = 'field.nested';
+        const VALUE = 'nested value';
+        const DATA = {
           field: {
             nested: VALUE
           }
         };
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toEqual(VALUE);
       });
-      it('should return a deeply nested value', function () {
-        var FIELD_ID = 'field.nested.and.even.further.down';
-        var VALUE = 'deeply nested value';
-        var DATA = {
+      it('should return a deeply nested value', () => {
+        const FIELD_ID = 'field.nested.and.even.further.down';
+        const VALUE = 'deeply nested value';
+        const DATA = {
           field: {
             nested: {
               and: {
@@ -57,95 +61,95 @@ describe('utils', function () {
             }
           }
         };
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toEqual(VALUE);
       });
-      it('should handle null data', function () {
-        var FIELD_ID = 'field.nested';
-        var value = (0, _getSourceData.default)(null, FIELD_ID);
+      it('should handle null data', () => {
+        const FIELD_ID = 'field.nested';
+        const value = (0, _getSourceData.default)(null, FIELD_ID);
         expect(value).toBeUndefined();
       });
-      it('should handle undefined data', function () {
-        var FIELD_ID = 'field.nested';
-        var value = (0, _getSourceData.default)(undefined, FIELD_ID);
+      it('should handle undefined data', () => {
+        const FIELD_ID = 'field.nested';
+        const value = (0, _getSourceData.default)(undefined, FIELD_ID);
         expect(value).toBeUndefined();
       });
-      it('should handle missing value', function () {
-        var FIELD_ID = 'field.nested';
-        var VALUE = 'other value';
-        var DATA = {
+      it('should handle missing value', () => {
+        const FIELD_ID = 'field.nested';
+        const VALUE = 'other value';
+        const DATA = {
           field: {
             other: VALUE
           }
         };
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toBeUndefined();
       });
-      it('should handle null fieldId', function () {
-        var VALUE = 'value';
-        var DATA = {
+      it('should handle null fieldId', () => {
+        const VALUE = 'value';
+        const DATA = {
           field: VALUE
         };
-        var value = (0, _getSourceData.default)(DATA, null);
+        const value = (0, _getSourceData.default)(DATA, null);
         expect(value).toBeUndefined();
       });
-      it('should handle undefined fieldId', function () {
-        var VALUE = 'value';
-        var DATA = {
+      it('should handle undefined fieldId', () => {
+        const VALUE = 'value';
+        const DATA = {
           field: VALUE
         };
-        var value = (0, _getSourceData.default)(DATA, undefined);
+        const value = (0, _getSourceData.default)(DATA, undefined);
         expect(value).toBeUndefined();
       });
-      it('should handle empty fieldId', function () {
-        var VALUE = 'value';
-        var DATA = {
+      it('should handle empty fieldId', () => {
+        const VALUE = 'value';
+        const DATA = {
           field: VALUE
         };
-        var value = (0, _getSourceData.default)(DATA, '');
+        const value = (0, _getSourceData.default)(DATA, '');
         expect(value).toBeUndefined();
       });
-      it('should handle fieldId with trailing dot', function () {
-        var FIELD_ID = 'field.';
-        var VALUE = 'value';
-        var DATA = {
+      it('should handle fieldId with trailing dot', () => {
+        const FIELD_ID = 'field.';
+        const VALUE = 'value';
+        const DATA = {
           field: VALUE
         };
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toBeUndefined();
       });
-      it('should handle fieldId with leading dot', function () {
-        var FIELD_ID = '.field';
-        var VALUE = 'value';
-        var DATA = {
+      it('should handle fieldId with leading dot', () => {
+        const FIELD_ID = '.field';
+        const VALUE = 'value';
+        const DATA = {
           field: VALUE
         };
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toBeUndefined();
       });
-      it('should handle fieldId that is just a dot', function () {
-        var FIELD_ID = '.';
-        var VALUE = 'value';
-        var DATA = {
+      it('should handle fieldId that is just a dot', () => {
+        const FIELD_ID = '.';
+        const VALUE = 'value';
+        const DATA = {
           field: VALUE
         };
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toBeUndefined();
       });
-      it('should handle a reference to an array item', function () {
-        var FIELD_ID = 'items[1]';
-        var ALPHA = 'alpha';
-        var BETA = 'beta';
-        var DATA = {
+      it('should handle a reference to an array item', () => {
+        const FIELD_ID = 'items[1]';
+        const ALPHA = 'alpha';
+        const BETA = 'beta';
+        const DATA = {
           items: [ALPHA, BETA]
         };
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toEqual(BETA);
       });
-      it('should handle a reference to an array that does not exist', function () {
-        var FIELD_ID = 'items[1]';
-        var DATA = {};
-        var value = (0, _getSourceData.default)(DATA, FIELD_ID);
+      it('should handle a reference to an array that does not exist', () => {
+        const FIELD_ID = 'items[1]';
+        const DATA = {};
+        const value = (0, _getSourceData.default)(DATA, FIELD_ID);
         expect(value).toBeUndefined();
       });
     });

package/dist/utils/Data/index.js

@@ -16,7 +16,7 @@ var _setupRefDataUrlForComponent = _interopRequireDefault(require("./setupRefDat
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // Local imports
 
-var Data = {
+const Data = {
   applyFormula: _applyFormula.default,
   getAutocompleteSource: _getAutocompleteSource.default,
   getDataPath: _getDataPath.default,

package/dist/utils/Data/nestInRefdataOptions.js

@@ -0,0 +1,42 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Combines refdata options with custom options with the use of `from_refdata` in the custom option
+ * Allowing for nesting of components within refdata lists of checkboxes or radios
+ * Also allows appending custom options to refdata options list
+ * @param {Array} refdataOptions The list of options coming from refdata
+ * @param {Array} options The list of options being defined in the form
+ * @returns A combined list of refdata options and custom options to be rendered
+ */
+const nestInRefdataOptions = (refdataOptions, options) => {
+  const nestedRefdataOptions = refdataOptions;
+  options.forEach((option, index) => {
+    if (option.refdata_match) {
+      const refdataMatch = option.refdata_match;
+      const refdataKey = Object.keys(refdataMatch)[0];
+      const refdataIndex = refdataOptions.findIndex(refdataOption => refdataOption[refdataKey] === refdataMatch[refdataKey]);
+      if (refdataIndex >= 0) {
+        nestedRefdataOptions[refdataIndex] = {
+          ...refdataOptions[refdataIndex],
+          nested: option.nested
+        };
+      }
+    }
+
+    // checks if already exists in `nestedRefdataOptions` else
+    // re-renders would cause array to grow with each render
+    if (option.combineWithRefdata && !nestedRefdataOptions.includes(option)) {
+      // adds previous array entry if string e.g. "or" operator
+      if (index > 0 && typeof options[index - 1] === 'string') {
+        nestedRefdataOptions.push(options[index - 1]);
+      }
+      nestedRefdataOptions.push(option);
+    }
+  });
+  return nestedRefdataOptions;
+};
+var _default = exports.default = nestInRefdataOptions;