@ukhomeoffice/cop-react-form-renderer 5.61.0 → 5.62.1

package/dist/components/CollectionPage/CollectionPage.js

@@ -31,6 +31,7 @@ var DEFAULT_CLASS = exports.DEFAULT_CLASS = _FormPage2.DEFAULT_CLASS;
 var CollectionPage = function CollectionPage(_ref) {
   var _page$collection, _objectSpread4;
   var page = _ref.page,
+    pages = _ref.pages,
     onCollectionChange = _ref.onCollectionChange,
     onAction = _ref.onAction,
     hashLink = _ref.hashLink,
@@ -127,6 +128,7 @@ var CollectionPage = function CollectionPage(_ref) {
         });
       })
     }),
+    pages: pages,
     onAction: onInnerPageAction,
     onWrapperChange: onInnerPageChange,
     onTopLevelChange: onTopLevelChange,
@@ -149,6 +151,7 @@ CollectionPage.propTypes = {
     actions: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.shape({}), _propTypes.default.string])),
     formData: _propTypes.default.shape({}).isRequired
   }).isRequired,
+  pages: _propTypes.default.arrayOf(_propTypes.default.shape({})).isRequired,
   onCollectionChange: _propTypes.default.func,
   onAction: _propTypes.default.func.isRequired,
   hashLink: _propTypes.default.bool,

package/dist/components/FormComponent/FormComponent.js

@@ -67,6 +67,17 @@ var FormComponent = function FormComponent(_ref) {
         // eslint-disable-next-line no-param-reassign
         target.value = target.value.trim();
       }
+      if (component.type === _models.ComponentTypes.CHECKBOXES && Array.isArray(target.value)) {
+        target.value.forEach(function (item) {
+          if (item.children && item.nested) {
+            // eslint-disable-next-line no-param-reassign
+            delete item.children;
+            // eslint-disable-next-line no-param-reassign
+            delete item.nested;
+          }
+        });
+      }
+
       // eslint-disable-next-line no-param-reassign
       target = (0, _helpers.addLabel)(target, component, data);
       onChange({

package/dist/components/FormRenderer/FormRenderer.js

@@ -366,6 +366,7 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
     submitting: submitting
   }), formState.page && !formState.cya && formState.page.collection && /*#__PURE__*/_react.default.createElement(_CollectionPage.default, {
     page: formState.page,
+    pages: pages,
     onCollectionChange: onChange,
     onAction: function onAction(action, patch, patchLabel) {
       (0, _onPageAction.default)(action, patch, patchLabel, hooks, data, formState, validate, onPageChange, type, pages, components, pageId, setPagePoint, currentTask, setData, hubDetails, setSubmitted, addErrors, submitting, setSubmitting, errors);

package/dist/hooks/useRefData.js

@@ -29,7 +29,7 @@ var STATUS_COMPLETE = exports.STATUS_COMPLETE = 'complete';
 var getRefDataUrl = function getRefDataUrl(component) {
   // eslint-disable-next-line prefer-destructuring
   var data = component.data;
-  if (data && !data.options) {
+  if (data && !data.options || data !== null && data !== void 0 && data.url) {
     return _copReactComponents.Utils.interpolateString(data.url, component.formData);
   }
   return undefined;

package/dist/utils/CollectionPage/addCollectionPageEntry.js

@@ -17,7 +17,6 @@ exports.default = void 0;
  */
 var addCollectionPageEntry = function addCollectionPageEntry(collectionName, formData) {
   var fieldName = collectionName.split('.').pop();
-  formData["".concat(fieldName, "ActiveId")] = '0';
-  formData["".concat(fieldName, "NumberedIndex")] = Number(formData["".concat(fieldName, "ActiveId")]) + 1;
+  formData["".concat(fieldName, "ActiveId")] = null;
 };
 var _default = exports.default = addCollectionPageEntry;

package/dist/utils/CollectionPage/addCollectionPageEntry.test.js

@@ -3,34 +3,14 @@
 var _addCollectionPageEntry = _interopRequireDefault(require("./addCollectionPageEntry"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 describe('Utils.CollectionPage.addCollectionPageEntry', function () {
-  it('should correctly add a new entry for a top-level collection', function () {
+  it('should set active ID as null for a top-level collection', function () {
     var FORM_DATA = {};
     (0, _addCollectionPageEntry.default)('testCollection', FORM_DATA);
-    expect(FORM_DATA.testCollectionActiveId).toBeTruthy();
+    expect(FORM_DATA.testCollectionActiveId).toBeFalsy();
   });
-  it('should correctly add a new entry for a nested collection', function () {
+  it('should set a active ID as null for a nested collection', function () {
     var FORM_DATA = {};
     (0, _addCollectionPageEntry.default)('parent.child.grandchild', FORM_DATA);
-    expect(FORM_DATA.grandchildActiveId).toBeTruthy();
-  });
-  it('should correctly set the active ID for a top-level collection', function () {
-    var FORM_DATA = {};
-    (0, _addCollectionPageEntry.default)('testCollection', FORM_DATA);
-    expect(FORM_DATA.testCollectionActiveId).toBe('0');
-  });
-  it('should correctly set the active ID for a nested collection', function () {
-    var FORM_DATA = {};
-    (0, _addCollectionPageEntry.default)('parent.child.grandchild', FORM_DATA);
-    expect(FORM_DATA.grandchildActiveId).toBe('0');
-  });
-  it('should correctly increment the numbered index for a top-level collection', function () {
-    var FORM_DATA = {};
-    (0, _addCollectionPageEntry.default)('testCollection', FORM_DATA);
-    expect(FORM_DATA.testCollectionNumberedIndex).toBe(1);
-  });
-  it('should correctly increment the numbered index for a nested collection', function () {
-    var FORM_DATA = {};
-    (0, _addCollectionPageEntry.default)('parent.child.grandchild', FORM_DATA);
-    expect(FORM_DATA.grandchildNumberedIndex).toBe(1);
+    expect(FORM_DATA.grandchildActiveId).toBeFalsy();
   });
 });

package/dist/utils/CollectionPage/setCollectionPageData.js

@@ -28,15 +28,20 @@ var setCollectionPageData = function setCollectionPageData(collectionName, newDa
   var data = formData;
   nameParts.some(function (name) {
     var _data$name;
-    // Current collection doesn't exist, so create it,
-    // add an entry and set the active id.
+    // Current collection doesn't exist, so create it
     if (!data[name]) {
+      data[name] = [];
+    }
+    // If the entry matching the active ID doesn't exist in the collection, create it. 
+    if (!data[name].find(function (e) {
+      return e.id === formData["".concat(name, "ActiveId")];
+    })) {
       var newEntryId = Date.now().toString();
       // eslint-disable-next-line no-param-reassign
       formData["".concat(name, "ActiveId")] = formData["".concat(name, "ActiveId")] || newEntryId;
-      data[name] = [{
+      data[name].push({
         id: formData["".concat(name, "ActiveId")]
-      }];
+      });
     }
     // We're at the target collection's level, so 
     // set the new data.

package/dist/utils/CollectionPage/setCollectionPageData.test.js

@@ -160,4 +160,22 @@ describe('Utils.CollectionPage.setCollectionPageData', function () {
       value: 'newValue'
     });
   });
+  it('creates a new entry and updates active ID if no matching active ID is found', function () {
+    var formData = {};
+    var collectionName = 'testCollection';
+    var newData = [{
+      id: 'dataId',
+      value: 'testValue'
+    }];
+    (0, _setCollectionPageData.default)(collectionName, newData, formData);
+
+    // Check if formData has been updated
+    expect(formData["".concat(collectionName, "ActiveId")]).toBeDefined();
+
+    // Check if the new entry was added to the collection
+    expect(formData[collectionName]).toBeDefined();
+    expect(formData[collectionName].length).toBe(1);
+    expect(formData[collectionName][0].id).toBe(newData[0].id);
+    expect(formData[collectionName][0]).toEqual(expect.objectContaining(newData[0]));
+  });
 });

package/dist/utils/Data/getOptions.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.default = void 0;
 var _copReactComponents = require("@ukhomeoffice/cop-react-components");
 var _Condition = _interopRequireDefault(require("../Condition"));
+var _nestInRefdataOptions = _interopRequireDefault(require("./nestInRefdataOptions"));
 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; }
@@ -35,6 +36,11 @@ var interpolateOptions = function interpolateOptions(config, options) {
 };
 var getOptions = function getOptions(config, callback) {
   if (config) {
+    var _config$data, _config$data2;
+    if (config.options && config !== null && config !== void 0 && (_config$data = config.data) !== null && _config$data !== void 0 && _config$data.options && config !== null && config !== void 0 && (_config$data2 = config.data) !== null && _config$data2 !== void 0 && _config$data2.url) {
+      var combinedOptions = (0, _nestInRefdataOptions.default)(config.options, config.data.options);
+      return callback(interpolateOptions(config, combinedOptions));
+    }
     if (config.options) {
       return callback(interpolateOptions(config, config.options));
     }

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

@@ -135,6 +135,61 @@ describe('utils', function () {
           expect(options).toEqual([CONFIG.options[0]]);
         });
       });
+      it('should should use both data from refdata url and options if both present', function () {
+        var 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'
+          }]
+        };
+        var 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, function (options) {
+          expect(options).toEqual(MERGED_CONFIG);
+        });
+      });
     });
   });
 });

package/dist/utils/Data/nestInRefdataOptions.js

@@ -0,0 +1,38 @@
+"use strict";
+
+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); }
+/**
+ * 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
+ * @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
+ */
+var nestInRefdataOptions = function nestInRefdataOptions(refdataOptions, options) {
+  var nestedRefdataOptions = refdataOptions;
+  options.forEach(function (option) {
+    if (option.refdata_match) {
+      var refdataMatch = option.refdata_match;
+      var refdataKey = Object.keys(refdataMatch)[0];
+      var refdataIndex = refdataOptions.findIndex(function (refdataOption) {
+        return refdataOption[refdataKey] === refdataMatch[refdataKey];
+      });
+      if (refdataIndex >= 0) {
+        nestedRefdataOptions[refdataIndex] = _objectSpread(_objectSpread({}, refdataOptions[refdataIndex]), {}, {
+          nested: option.nested
+        });
+      }
+    }
+  });
+  return nestedRefdataOptions;
+};
+var _default = exports.default = nestInRefdataOptions;

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

@@ -0,0 +1,102 @@
+"use strict";
+
+var _nestInRefdataOptions = _interopRequireDefault(require("./nestInRefdataOptions"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe("utils.Data.combineOptions", function () {
+  it("should combine refdata options with a custom option", function () {
+    var 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"
+    }];
+    var 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", function () {
+    var 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"
+    }];
+    var 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"
+    }]);
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "5.61.0",
+  "version": "5.62.1",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",