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

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

@@ -0,0 +1,236 @@
+"use strict";
+
+var _nestInRefdataOptions = _interopRequireDefault(require("./nestInRefdataOptions"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('utils.Data.combineOptions', () => {
+  it('should combine refdata options with a custom option', () => {
+    const refdataOptions = [{
+      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 customOptions = [{
+      refdata_match: {
+        id: 2
+      },
+      nested: [{
+        id: 'nestedComponent',
+        fieldId: 'nestedComponent',
+        type: 'text',
+        label: 'Nested Component'
+      }]
+    }];
+    expect((0, _nestInRefdataOptions.default)(refdataOptions, customOptions)).toEqual([{
+      description: 'First refdata item',
+      id: 1,
+      label: 'First label',
+      value: 'firstValue'
+    }, {
+      description: 'Second refdata item',
+      id: 2,
+      label: 'Second label',
+      nested: [{
+        id: 'nestedComponent',
+        fieldId: 'nestedComponent',
+        type: 'text',
+        label: 'Nested Component'
+      }],
+      value: 'secondValue'
+    }, {
+      description: 'Third refdata item',
+      id: 3,
+      label: 'Third label',
+      value: 'thirdValue'
+    }]);
+  });
+  it('should not combine options if it can`t find a matching refdata option', () => {
+    const refdataOptions = [{
+      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 customOptions = [{
+      refdata_match: {
+        id: 4
+      },
+      nested: [{
+        id: 'nestedComponent',
+        fieldId: 'nestedComponent',
+        type: 'text',
+        label: 'Nested Component'
+      }]
+    }];
+    expect((0, _nestInRefdataOptions.default)(refdataOptions, customOptions)).toEqual([{
+      description: 'First refdata item',
+      id: 1,
+      label: 'First label',
+      value: 'firstValue'
+    }, {
+      description: 'Second refdata item',
+      id: 2,
+      label: 'Second label',
+      value: 'secondValue'
+    }, {
+      description: 'Third refdata item',
+      id: 3,
+      label: 'Third label',
+      value: 'thirdValue'
+    }]);
+  });
+  it('should append refdata options with a custom option when `combineWithRefdata` flag is set', () => {
+    const refdataOptions = [{
+      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 customOptions = [{
+      combineWithRefdata: true,
+      id: 'otherComponent',
+      fieldId: 'otherComponent',
+      type: 'text',
+      label: 'Other Component'
+    }];
+    expect((0, _nestInRefdataOptions.default)(refdataOptions, customOptions)).toEqual([{
+      description: 'First refdata item',
+      id: 1,
+      label: 'First label',
+      value: 'firstValue'
+    }, {
+      description: 'Second refdata item',
+      id: 2,
+      label: 'Second label',
+      value: 'secondValue'
+    }, {
+      description: 'Third refdata item',
+      id: 3,
+      label: 'Third label',
+      value: 'thirdValue'
+    }, {
+      combineWithRefdata: true,
+      id: 'otherComponent',
+      fieldId: 'otherComponent',
+      type: 'text',
+      label: 'Other Component'
+    }]);
+  });
+  it('should not append refdata options with a custom option when `combineWithRefdata` flag is not set', () => {
+    const refdataOptions = [{
+      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 customOptions = [{
+      id: 'otherComponent',
+      fieldId: 'otherComponent',
+      type: 'text',
+      label: 'Other Component'
+    }];
+    expect((0, _nestInRefdataOptions.default)(refdataOptions, customOptions)).toEqual([{
+      description: 'First refdata item',
+      id: 1,
+      label: 'First label',
+      value: 'firstValue'
+    }, {
+      description: 'Second refdata item',
+      id: 2,
+      label: 'Second label',
+      value: 'secondValue'
+    }, {
+      description: 'Third refdata item',
+      id: 3,
+      label: 'Third label',
+      value: 'thirdValue'
+    }]);
+  });
+  it('should append refdata options with a string when `combineWithRefdata` flag is set and custom option comes after string', () => {
+    const refdataOptions = [{
+      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 customOptions = ["or", {
+      combineWithRefdata: true,
+      id: 'otherComponent',
+      fieldId: 'otherComponent',
+      type: 'text',
+      label: 'Other Component'
+    }];
+    expect((0, _nestInRefdataOptions.default)(refdataOptions, customOptions)).toEqual([{
+      description: 'First refdata item',
+      id: 1,
+      label: 'First label',
+      value: 'firstValue'
+    }, {
+      description: 'Second refdata item',
+      id: 2,
+      label: 'Second label',
+      value: 'secondValue'
+    }, {
+      description: 'Third refdata item',
+      id: 3,
+      label: 'Third label',
+      value: 'thirdValue'
+    }, "or", {
+      combineWithRefdata: true,
+      id: 'otherComponent',
+      fieldId: 'otherComponent',
+      type: 'text',
+      label: 'Other Component'
+    }]);
+  });
+});

package/dist/utils/Data/refDataToOptions.js

@@ -4,23 +4,17 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-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 ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-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 getValueAndLabel = function getValueAndLabel(opt, itemStructure) {
+const getValueAndLabel = (opt, itemStructure) => {
   var _value;
-  var value = opt.value || opt.id;
-  var label = opt.label || opt.name;
+  let value = opt.value || opt.id;
+  let label = opt.label || opt.name;
   if (itemStructure) {
     value = opt[itemStructure.value] || value;
     label = opt[itemStructure.label] || label;
   }
   return {
     value: (_value = value) === null || _value === void 0 ? void 0 : _value.toString(),
-    label: label
+    label
   };
 };
 
@@ -30,13 +24,16 @@ var getValueAndLabel = function getValueAndLabel(opt, itemStructure) {
  * @param {Object} itemStructure The structure of the item.
  * @returns An array of options.
  */
-var refDataToOptions = function refDataToOptions(refDataItems, itemStructure) {
+const refDataToOptions = (refDataItems, itemStructure) => {
   if (Array.isArray(refDataItems)) {
-    return refDataItems.map(function (opt) {
+    return refDataItems.map(opt => {
       if (typeof opt === 'string') {
         return opt;
       }
-      return _objectSpread(_objectSpread({}, opt), getValueAndLabel(opt, itemStructure));
+      return {
+        ...opt,
+        ...getValueAndLabel(opt, itemStructure)
+      };
     });
   }
   return [];

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

@@ -4,17 +4,17 @@ var _refDataToOptions = _interopRequireDefault(require("./refDataToOptions"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 // Local imports
 
-describe('utils', function () {
-  describe('Data', function () {
-    describe('refDataToOptions', function () {
-      it('can handle a null refData', function () {
+describe('utils', () => {
+  describe('Data', () => {
+    describe('refDataToOptions', () => {
+      it('can handle a null refData', () => {
         expect((0, _refDataToOptions.default)(null)).toEqual([]);
       });
-      it('can handle an undefined refData', function () {
+      it('can handle an undefined refData', () => {
         expect((0, _refDataToOptions.default)(undefined)).toEqual([]);
       });
-      it('can handle genuine refData', function () {
-        var REF_DATA = [{
+      it('can handle genuine refData', () => {
+        const REF_DATA = [{
           id: 'a',
           name: 'Alpha'
         }, {
@@ -41,8 +41,8 @@ describe('utils', function () {
           label: 'Charlie'
         }]);
       });
-      it('can handle refData that is already in a usable options format', function () {
-        var REF_DATA = [{
+      it('can handle refData that is already in a usable options format', () => {
+        const REF_DATA = [{
           value: 'a',
           label: 'Alpha'
         }, {
@@ -63,8 +63,8 @@ describe('utils', function () {
           label: 'Charlie'
         }]);
       });
-      it('can handle refData that is in a mixed format', function () {
-        var REF_DATA = [{
+      it('can handle refData that is in a mixed format', () => {
+        const REF_DATA = [{
           id: 'a',
           name: 'Alpha',
           type: 'Delta'
@@ -93,8 +93,8 @@ describe('utils', function () {
           type: 'Delta'
         }]);
       });
-      it('can handle refData that contains strings and objects', function () {
-        var REF_DATA = [{
+      it('can handle refData that contains strings and objects', () => {
+        const REF_DATA = [{
           id: 'a',
           name: 'Alpha',
           type: 'Delta'
@@ -123,8 +123,8 @@ describe('utils', function () {
           type: 'Delta'
         }]);
       });
-      it('can handle refData with custom value and label properties', function () {
-        var REF_DATA = [{
+      it('can handle refData with custom value and label properties', () => {
+        const REF_DATA = [{
           id: 1,
           displayName: 'Alpha'
         }, {
@@ -134,7 +134,7 @@ describe('utils', function () {
           id: 3,
           displayName: 'Charlie'
         }];
-        var ITEM_STRUCTURE = {
+        const ITEM_STRUCTURE = {
           value: 'id',
           label: 'displayName'
         };
@@ -155,8 +155,8 @@ describe('utils', function () {
           label: 'Charlie'
         }]);
       });
-      it('can handle refData with missing custom value and label properties', function () {
-        var REF_DATA = [{
+      it('can handle refData with missing custom value and label properties', () => {
+        const REF_DATA = [{
           id: 1,
           name: 'Alpha'
         }, {
@@ -168,7 +168,7 @@ describe('utils', function () {
           objId: 'chaz',
           name: 'Charlie'
         }];
-        var ITEM_STRUCTURE = {
+        const ITEM_STRUCTURE = {
           value: 'objId',
           label: 'displayName'
         };

package/dist/utils/Data/setDataItem.js

@@ -4,17 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-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); }
-var setDataItem = function setDataItem(data, fieldId, value) {
-  var handleArrayIndices = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
+const setDataItem = function (data, fieldId, value) {
+  let handleArrayIndices = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : false;
   if (fieldId && data) {
-    var parts = handleArrayIndices ?
+    const parts = handleArrayIndices ?
     // Replace all occurrences of '[' with '.' and ']' with ''.
     fieldId.replace(/\[/g, '.').replace(/\]/g, '').split('.') : fieldId.split('.');
-    var leaf = parts.pop();
-    var node = data;
-    parts.forEach(function (part) {
-      if (!node[part] || _typeof(node[part]) !== 'object') {
+    const leaf = parts.pop();
+    let node = data;
+    parts.forEach(part => {
+      if (!node[part] || typeof node[part] !== 'object') {
         node[part] = {};
       }
       node = node[part];

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

@@ -2,48 +2,48 @@
 
 var _setDataItem = _interopRequireDefault(require("./setDataItem"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-describe('utils.Data.setDataItem', function () {
-  it('should handle a null data object', function () {
-    var DATA = null;
-    var FIELD_ID = 'alpha.bravo.charlie';
-    var VALUE = 'delta';
+describe('utils.Data.setDataItem', () => {
+  it('should handle a null data object', () => {
+    const DATA = null;
+    const FIELD_ID = 'alpha.bravo.charlie';
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toBeNull();
     expect(DATA).toBeNull();
   });
-  it('should handle an undefined data object', function () {
-    var DATA = undefined;
-    var FIELD_ID = 'alpha.bravo.charlie';
-    var VALUE = 'delta';
+  it('should handle an undefined data object', () => {
+    const DATA = undefined;
+    const FIELD_ID = 'alpha.bravo.charlie';
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toBeUndefined();
     expect(DATA).toBeUndefined();
   });
-  it('should handle a null fieldId', function () {
-    var DATA = {};
-    var FIELD_ID = null;
-    var VALUE = 'delta';
+  it('should handle a null fieldId', () => {
+    const DATA = {};
+    const FIELD_ID = null;
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toMatchObject({});
     expect(DATA).toMatchObject({});
   });
-  it('should handle an undefined fieldId', function () {
-    var DATA = {};
-    var FIELD_ID = undefined;
-    var VALUE = 'delta';
+  it('should handle an undefined fieldId', () => {
+    const DATA = {};
+    const FIELD_ID = undefined;
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toMatchObject({});
     expect(DATA).toMatchObject({});
   });
-  it('should handle an empty fieldId', function () {
-    var DATA = {};
-    var FIELD_ID = '';
-    var VALUE = 'delta';
+  it('should handle an empty fieldId', () => {
+    const DATA = {};
+    const FIELD_ID = '';
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toMatchObject({});
     expect(DATA).toMatchObject({});
   });
-  it('should appropriately set a nested value', function () {
-    var DATA = {
+  it('should appropriately set a nested value', () => {
+    const DATA = {
       alpha: {}
     };
-    var FIELD_ID = 'alpha.bravo.charlie';
-    var VALUE = 'delta';
+    const FIELD_ID = 'alpha.bravo.charlie';
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toMatchObject({
       alpha: {
         bravo: {
@@ -59,16 +59,16 @@ describe('utils.Data.setDataItem', function () {
       }
     });
   });
-  it('should appropriately change a nested value', function () {
-    var DATA = {
+  it('should appropriately change a nested value', () => {
+    const DATA = {
       alpha: {
         bravo: {
           charlie: 'echo'
         }
       }
     };
-    var FIELD_ID = 'alpha.bravo.charlie';
-    var VALUE = 'delta';
+    const FIELD_ID = 'alpha.bravo.charlie';
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toMatchObject({
       alpha: {
         bravo: {
@@ -84,14 +84,14 @@ describe('utils.Data.setDataItem', function () {
       }
     });
   });
-  it('should handle a parent node that is not an object and convert it appropriately', function () {
-    var DATA = {
+  it('should handle a parent node that is not an object and convert it appropriately', () => {
+    const DATA = {
       alpha: {
         bravo: 'echo'
       }
     };
-    var FIELD_ID = 'alpha.bravo.charlie';
-    var VALUE = 'delta';
+    const FIELD_ID = 'alpha.bravo.charlie';
+    const VALUE = 'delta';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE)).toMatchObject({
       alpha: {
         bravo: {
@@ -107,16 +107,16 @@ describe('utils.Data.setDataItem', function () {
       }
     });
   });
-  it('should handle array indices in fieldPath if handleArrayIndices is true', function () {
-    var DATA = {
+  it('should handle array indices in fieldPath if handleArrayIndices is true', () => {
+    const DATA = {
       alpha: {
         bravo: [{
           charlie: '123'
         }]
       }
     };
-    var FIELD_ID = 'alpha.bravo[0].charlie';
-    var VALUE = '456';
+    const FIELD_ID = 'alpha.bravo[0].charlie';
+    const VALUE = '456';
     expect((0, _setDataItem.default)(DATA, FIELD_ID, VALUE, true)).toMatchObject({
       alpha: {
         bravo: [{

package/dist/utils/Data/setupFormData.js

@@ -6,30 +6,20 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 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 ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-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
-var setupComponentSourceData = function setupComponentSourceData(component, data) {
-  var componentSourceData = data;
+// Local imports
+
+const setupComponentSourceData = (component, data) => {
+  const componentSourceData = data;
   if (component.source) {
     componentSourceData[component.fieldId] = (0, _getSourceData.default)(componentSourceData, component.source.field);
   }
 };
-var setupSourceDataForComponents = function setupSourceDataForComponents(components, data) {
-  components.forEach(function (component) {
-    return setupComponentSourceData(component, data);
-  });
+const setupSourceDataForComponents = (components, data) => {
+  components.forEach(component => setupComponentSourceData(component, data));
 };
-var setupPageSourceData = function setupPageSourceData(pages, data) {
-  pages.forEach(function (page) {
-    page.components.filter(function (c) {
-      return !c.use;
-    }).forEach(function (component) {
-      return setupComponentSourceData(component, data);
-    });
+const setupPageSourceData = (pages, data) => {
+  pages.forEach(page => {
+    page.components.filter(c => !c.use).forEach(component => setupComponentSourceData(component, data));
   });
 };
 
@@ -46,8 +36,10 @@ var setupPageSourceData = function setupPageSourceData(pages, data) {
  * @param {object} baseData 
  * @returns 
  */
-var setupFormData = function setupFormData(pages, components, baseData) {
-  var data = _objectSpread({}, baseData);
+const setupFormData = (pages, components, baseData) => {
+  const data = {
+    ...baseData
+  };
   setupSourceDataForComponents(components, data);
   setupPageSourceData(pages, data);
   return data;