@ukhomeoffice/cop-react-form-renderer 5.34.1 → 5.37.0

package/dist/components/CollectionSummary/CollectionSummary.js

@@ -66,7 +66,8 @@ var CollectionSummary = function CollectionSummary(_ref) {
     });
   };
   var onDuplicate = function onDuplicate(entry) {
-    _utils.default.CollectionPage.duplicateEntry(config.collectionName, formData, entry.id);
+    var _config$card;
+    _utils.default.CollectionPage.duplicateEntry(config.collectionName, formData, entry.id, ((_config$card = config.card) === null || _config$card === void 0 || (_config$card = _config$card.duplicateAction) === null || _config$card === void 0 ? void 0 : _config$card.fieldsToIgnore) || []);
     var parentCollection = config.collectionName.split('.').shift();
     // Report the whole top-level collection as being changed. We have to do this
     // because of how patch is applied to formData on a page submission.
@@ -162,7 +163,10 @@ CollectionSummary.propTypes = {
     card: _propTypes.default.shape({
       banners: _propTypes.default.arrayOf(_propTypes.default.oneOfType([_propTypes.default.string, _propTypes.default.shape({})])),
       title: _propTypes.default.string,
-      details: _propTypes.default.string
+      details: _propTypes.default.string,
+      duplicateAction: _propTypes.default.shape({
+        fieldsToIgnore: _propTypes.default.arrayOf(_propTypes.default.string)
+      })
     }),
     confirmation: _propTypes.default.shape({
       message: _propTypes.default.string,

package/dist/utils/CheckYourAnswers/getCYARowsForCollectionPage.js

@@ -179,6 +179,7 @@ var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onA
   var activeIds = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : {};
   var collectionName = page.collection.name.split('.').pop();
   var collectionData = data[collectionName] || null;
+  var activeId = data["".concat(collectionName, "ActiveId")];
   if (!collectionData || collectionData.length === 0) {
     return [];
   }
@@ -186,16 +187,24 @@ var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onA
   if (!page.collection.hideNameFromCYA) {
     rows.push(getCollectionNameHeading(page, collectionName));
   }
-  collectionData.forEach(function (item, index) {
+  var itemIndex = 0;
+  if (page.collection.onlyShowActiveEntryOnCYA) {
+    var activeEntry = collectionData.find(function (entry, index) {
+      itemIndex = index;
+      return entry.id === activeId;
+    });
+    collectionData = [activeEntry];
+  }
+  collectionData.forEach(function (item) {
     var _page$collection2;
     // Keep track of the active entry in each collection.
     // This helps us make sure the right entry is being affected
     // by change/remove links.
     // eslint-disable-next-line no-param-reassign
     activeIds = _objectSpread(_objectSpread({}, activeIds), {}, _defineProperty({}, "".concat(collectionName, "ActiveId"), item.id));
-    var labelCount = index + 1;
+    var labelCount = itemIndex + 1;
     var actionPosition = ((_page$collection2 = page.collection) === null || _page$collection2 === void 0 ? void 0 : _page$collection2.actionPosition) || 'top';
-    var fullPath = "".concat(page.collection.name, "[").concat(index, "]");
+    var fullPath = "".concat(page.collection.name, "[").concat(itemIndex, "]");
     var titleRow = getTitleRowForItem(page, item, page.id, labelCount, fullPath);
     var actionRows = getActionRows(page, item, onAction, labelCount, activeIds);
     rows = rows.concat(titleRow);
@@ -206,6 +215,7 @@ var getCYARowsForCollectionPage = function getCYARowsForCollectionPage(page, onA
     if (actionPosition === 'bottom') {
       rows = rows.concat(actionRows);
     }
+    itemIndex += 1;
   });
   return rows.filter(function (row) {
     return !!row;

package/dist/utils/CheckYourAnswers/getCYARowsForCollectionPage.test.js

@@ -170,6 +170,45 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
       key: 'Test date'
     });
   });
+  it('should return correctly formatted rows for only the active entry when page.collection.onlyShowActiveEntryOnCYA is defined', function () {
+    var FORM_DATA = {
+      collectionActiveId: '02',
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }, {
+        id: '02',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        onlyShowActiveEntryOnCYA: true
+      }),
+      formData: FORM_DATA
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
+    expect(ROWS.length).toEqual(7); // Title row + component row for only the active item.
+    expect(ROWS[0]).toMatchObject({
+      type: 'heading',
+      key: 'Collection'
+    });
+    expect(ROWS[1]).toMatchObject({
+      type: 'heading',
+      key: 'Collection entry 2'
+    });
+    expect(ROWS[2].action.label).toEqual('Change');
+    expect(ROWS[3].action.label).toEqual('custom remove label');
+    expect(ROWS[4].action.label).toEqual('custom change label');
+    expect(ROWS[5]).toMatchObject({
+      value: 'value',
+      key: 'Test text'
+    });
+    expect(ROWS[6]).toMatchObject({
+      value: '',
+      key: 'Test date'
+    });
+  });
   it('should exclude components that should not be shown', function () {
     var FD = {
       collection: [{

package/dist/utils/CollectionPage/duplicateCollectionPageEntry.js

@@ -13,6 +13,7 @@ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key i
 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 duplicateCollectionPageEntry = function duplicateCollectionPageEntry(collectionName, formData, entryId) {
+  var fieldsToIgnore = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
   var collectionData = (0, _getCollectionPageData.default)(collectionName, formData);
   var entryToDuplicate = collectionData === null || collectionData === void 0 ? void 0 : collectionData.find(function (entry) {
     return entry.id === entryId;
@@ -23,6 +24,9 @@ var duplicateCollectionPageEntry = function duplicateCollectionPageEntry(collect
   var newEntry = _objectSpread(_objectSpread({}, entryToDuplicate), {}, {
     id: Date.now().toString()
   });
+  fieldsToIgnore.forEach(function (field) {
+    return delete newEntry[field];
+  });
   collectionData.push(newEntry);
   // eslint-disable-next-line no-param-reassign
   formData["".concat(collectionName.split('.').pop(), "ActiveId")] = newEntry.id;

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

@@ -53,10 +53,22 @@ describe('utils.CollectionPage.duplicateCollectionPageEntry', function () {
     expect((0, _getCollectionPageActiveId.default)('parents.children', FORM_DATA)).toBeTruthy();
     expect((0, _getCollectionPageActiveId.default)('parents.children', FORM_DATA) === '2').toBeFalsy();
   });
-  it('should do nothing if an entry with the given id does not exist', function () {
-    var _FORM_DATA2, _expect$toEqual;
+  it('should ignore fields in the fieldToIgnore array', function () {
+    var _FORM_DATA2;
     var FORM_DATA = (_FORM_DATA2 = {}, _defineProperty(_FORM_DATA2, "".concat(COLLECTION_NAME, "ActiveId"), '1'), _defineProperty(_FORM_DATA2, COLLECTION_NAME, [OBJ]), _FORM_DATA2);
     ;
+    var FIELDS_TO_IGNORE = ['value'];
+    (0, _duplicateCollectionPageEntry.default)(COLLECTION_NAME, FORM_DATA, '1', FIELDS_TO_IGNORE);
+    expect(FORM_DATA[COLLECTION_NAME].length).toEqual(2);
+    expect(FORM_DATA[COLLECTION_NAME][0].id).toBeTruthy();
+    expect(FORM_DATA[COLLECTION_NAME][0].value).toBeTruthy();
+    expect(FORM_DATA[COLLECTION_NAME][1].id).toBeTruthy();
+    expect(FORM_DATA[COLLECTION_NAME][1].value).toBeUndefined();
+  });
+  it('should do nothing if an entry with the given id does not exist', function () {
+    var _FORM_DATA3, _expect$toEqual;
+    var FORM_DATA = (_FORM_DATA3 = {}, _defineProperty(_FORM_DATA3, "".concat(COLLECTION_NAME, "ActiveId"), '1'), _defineProperty(_FORM_DATA3, COLLECTION_NAME, [OBJ]), _FORM_DATA3);
+    ;
     (0, _duplicateCollectionPageEntry.default)(COLLECTION_NAME, FORM_DATA, '0');
     expect(FORM_DATA).toEqual((_expect$toEqual = {}, _defineProperty(_expect$toEqual, "".concat(COLLECTION_NAME, "ActiveId"), '1'), _defineProperty(_expect$toEqual, COLLECTION_NAME, [OBJ]), _expect$toEqual));
   });

package/dist/utils/Component/getDefaultValue.test.js

@@ -42,8 +42,12 @@ describe('utils.Component.defaultValue', function () {
   it('should return defaultObjectValue if the component has defaultObjectValue prop', function () {
     expect((0, _getDefaultValue.default)({
       type: _models.ComponentTypes.AUTOCOMPLETE,
-      defaultObjectValue: 'test'
-    })).toEqual('test');
+      defaultObjectValue: {
+        testText: 'text'
+      }
+    })).toEqual({
+      testText: 'text'
+    });
   });
   Object.values(_models.ComponentTypes).forEach(function (value) {
     if (![_models.ComponentTypes.COLLECTION, _models.ComponentTypes.CONTAINER, _models.ComponentTypes.FILE].includes(value)) {

package/dist/utils/Component/getDefaultValueFromConfig.js

@@ -8,10 +8,13 @@ var _dayjs = _interopRequireDefault(require("dayjs"));
 var _getSourceData = _interopRequireDefault(require("../Data/getSourceData"));
 var _models = require("../../models");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// Global imports.
-
+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); } // Global imports.
 // Local imports.
-
 var hasDefaultValue = function hasDefaultValue(component) {
   return component.defaultValue || component.defaultObjectValue;
 };
@@ -20,6 +23,75 @@ var getDefaultForDate = function getDefaultForDate(date) {
   var defaultDate = dateFormat.test(date.defaultValue) ? date.defaultValue : null;
   return date.defaultValue === 'today' ? (0, _dayjs.default)().format('DD-MM-YYYY') : defaultDate;
 };
+
+/**
+ * This function sets up a components defaultObjectValue, handling both a mixture
+ * of literal values and values to be sourced from formData.
+ * 
+ * An example defaultObjectValue is:
+ * {
+ *   skipIfSourceInvalid: true,
+ *   sourced: {
+ *     fieldOne: 'target1.value',
+ *     fieldTwo: 'target2.value'
+ *   },
+ *   literal: {
+ *     fieldThree: 'a literal value',
+ *     fieldFour: 'another literal value'
+ *   }
+ * }
+ * 
+ * Any fields specified in sourced will be searched for in data. If any of the sourced
+ * values cannot be found and 'skipIfSourceInvalid' is true, then the entire defaultObject
+ * is treated as invalid and the function returns null. If any of the sourced values can't
+ * be found and 'skipIfSourceInvalid' is false, then the value of the field in sourced is
+ * used literally - e.g. 'target1.value'. This is often not desired, so it is recommended
+ * to have 'skipIfSourceInvalid' as true when using sourced values.
+ * 
+ * 'skipIfSourceInvalid' is assumed false unless defined.
+ * 
+ * Literal values are taken as is and copied to the resulting object.
+ * 
+ * A defaultObjectValue can contain both sourced & literal, or either individually.
+ * 
+ * The old syntax for defaultObjectValue is also supported. In that scenario, all fields
+ * are treated as sourced fields.
+ * 
+ * @param {object} defaultObject The defaultObjectValue field for a component.
+ * @param {object} data The current formData.
+ * @returns An object to be used as the component's default value.
+ */
+var setupDefaultObjectValue = function setupDefaultObjectValue(defaultObject, data) {
+  var defaultObj = _objectSpread({}, defaultObject);
+  var result = null;
+  // This handles objects using the previous syntax where
+  // defaultObject.literal and defaultObject.sourced won't 
+  // be defined.
+  if (!defaultObj.literal && !defaultObj.sourced) {
+    defaultObj.sourced = _objectSpread({}, defaultObj);
+  }
+  // defaultObject.literal is an object with values that should
+  // be copied as-is to the result object.
+  if (defaultObj.literal) {
+    result = _objectSpread({}, defaultObj.literal);
+  }
+  // defaultObject.sourced is an object with values that should
+  // be used as field names to get values from data.
+  if (defaultObj.sourced) {
+    var _result;
+    (_result = result) !== null && _result !== void 0 ? _result : result = {};
+    Object.keys(defaultObj.sourced).every(function (key) {
+      var sourcedValue = typeof defaultObj.sourced[key] === 'string' && (0, _getSourceData.default)(data, defaultObj.sourced[key]);
+      if (sourcedValue === undefined && defaultObj.skipIfSourceInvalid) {
+        result = null;
+        return false;
+      }
+      result[key] = sourcedValue || defaultObj.sourced[key];
+      return true;
+    });
+  }
+  return result;
+};
 var getDefaultValueFromConfig = function getDefaultValueFromConfig(component, data) {
   if (!hasDefaultValue(component)) {
     return null;
@@ -29,15 +101,8 @@ var getDefaultValueFromConfig = function getDefaultValueFromConfig(component, da
       return getDefaultForDate(component, data);
     default:
       {
-        if (component.defaultObjectValue) {
-          Object.keys(component.defaultObjectValue).forEach(function (value) {
-            if (typeof component.defaultObjectValue[value] === 'string' && (0, _getSourceData.default)(data, component.defaultObjectValue[value]) !== undefined) {
-              // eslint-disable-next-line no-param-reassign
-              component.defaultObjectValue[value] = (0, _getSourceData.default)(data, component.defaultObjectValue[value]);
-            }
-          });
-        }
-        return component.defaultObjectValue ? component.defaultObjectValue : component.defaultValue;
+        var defaultValue = component.defaultObjectValue ? setupDefaultObjectValue(component.defaultObjectValue, data) : null;
+        return defaultValue || component.defaultValue || null;
       }
   }
 };

package/dist/utils/Component/getDefaultValueFromConfig.test.js

@@ -65,6 +65,60 @@ describe('utils.component.defaultValueFromConfig', function () {
       bravo: 'value'
     });
   });
+  it('should allow specific sourced and literal object values to be defined', function () {
+    var COMPONENT = {
+      defaultObjectValue: {
+        sourced: {
+          value1: 'field1.value',
+          value2: 'field2.value'
+        },
+        literal: {
+          value3: 'literal text 1',
+          value4: 'literal text 2'
+        }
+      }
+    };
+    var DATA = {
+      field1: {
+        value: 'sourced text 1'
+      },
+      field2: {
+        value: 'sourced text 2'
+      }
+    };
+    var result = (0, _getDefaultValueFromConfig.default)(COMPONENT, DATA);
+    expect(result).toMatchObject({
+      value1: 'sourced text 1',
+      value2: 'sourced text 2',
+      value3: 'literal text 1',
+      value4: 'literal text 2'
+    });
+  });
+  it('should handle the skipIfSourceInvalid flag and return null if a sourced value cannot be found', function () {
+    var COMPONENT = {
+      defaultObjectValue: {
+        skipIfSourceInvalid: true,
+        sourced: {
+          value1: 'notafield.value',
+          value2: 'field2.value'
+        },
+        literal: {
+          value3: 'literal text 1',
+          value4: 'literal text 2'
+        }
+      }
+    };
+    var DATA = {
+      field1: {
+        value: 'sourced text 1'
+      },
+      field2: {
+        value: 'sourced text 2'
+      }
+    };
+    var result = (0, _getDefaultValueFromConfig.default)(COMPONENT, DATA);
+    expect(result).toEqual(null);
+  });
   describe('for a date component', function () {
     it('should return a normal default value', function () {
       var COMPONENT = {

package/package.json

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