@ukhomeoffice/cop-react-form-renderer 6.11.1 → 6.12.1

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

@@ -103,6 +103,45 @@ describe('utils.CheckYourAnswers.getCYARowsForCollectionPage', function () {
     expect(ROWS.length).toEqual(7); // Collection title, item title, action rows & component rows
     expect(ROWS[1].key).toEqual('Collection entry 1');
   });
+  it('should hide titles when hideItemTitles is true', function () {
+    var FORM_DATA = {
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA,
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        hideItemTitles: true
+      })
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
+    expect(ROWS.length).toEqual(6); // Collection title, NO item title, action rows & component rows
+  });
+
+  it('should hide titles when hideItemTitles is a show_when that is true', function () {
+    var FORM_DATA = {
+      shouldShow: false,
+      collection: [{
+        id: '01',
+        testText: 'value'
+      }]
+    };
+    var PAGE = _objectSpread(_objectSpread({}, MASTER_PAGE), {}, {
+      formData: FORM_DATA,
+      collection: _objectSpread(_objectSpread({}, MASTER_PAGE.collection), {}, {
+        hideItemTitles: [{
+          field: 'shouldShow',
+          op: '=',
+          value: false
+        }]
+      })
+    });
+    var ROWS = (0, _getCYARowsForCollectionPage.default)(PAGE, null, null, FORM_DATA);
+    expect(ROWS.length).toEqual(6); // Collection title, NO item title, action rows & component rows
+  });
+
   it('should provide default titles if collection.labels.item is not specified', function () {
     var FORM_DATA = {
       collection: [{

package/dist/utils/CheckYourAnswers/showComponentCYA.js

@@ -33,7 +33,7 @@ var showComponentCYA = function showComponentCYA(options, data) {
   }
   if (options.hideOnCyaWhenEmpty) {
     if (options.type === _models.ComponentTypes.COLLECTION) {
-      var itemCollectionsData = (0, _getSourceData.default)(data, options.full_path);
+      var itemCollectionsData = (0, _getSourceData.default)(data, options.full_path || options.fieldId);
       if (!(itemCollectionsData !== null && itemCollectionsData !== void 0 && itemCollectionsData.length)) {
         return false;
       }

package/dist/utils/CollectionPage/duplicateCollectionPageEntry.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _uuid = require("uuid");
 var _getCollectionPageData = _interopRequireDefault(require("./getCollectionPageData"));
 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); }
@@ -33,7 +34,7 @@ var duplicateCollectionPageEntry = function duplicateCollectionPageEntry(collect
   if (!entryToDuplicate) {
     return null;
   }
-  var newEntryId = Date.now().toString();
+  var newEntryId = (0, _uuid.v4)();
   var newEntry = _objectSpread(_objectSpread(_objectSpread({}, entryToDuplicate), fieldsToAdd), {}, {
     id: newEntryId
   });

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

@@ -23,32 +23,6 @@ describe('utils.CollectionPage.mergeCollectionPages', function () {
     }];
     expect((0, _mergeCollectionPages.default)(PAGES)).toEqual(PAGES);
   });
-  it('should merge pages from the same collection into a single page', function () {
-    var PAGES = [{
-      id: 'page1',
-      collection: {
-        name: 'collection'
-      },
-      components: [TEXT_COMP]
-    }, {
-      id: 'page2',
-      collection: {
-        name: 'collection'
-      },
-      components: [DATE_COMP]
-    }];
-    var RESULT = (0, _mergeCollectionPages.default)(PAGES);
-    expect(RESULT.length).toEqual(1);
-    expect(RESULT[0]).toMatchObject({
-      id: 'page1',
-      collection: {
-        name: 'collection',
-        masterPage: true
-      },
-      formData: {},
-      childPages: PAGES
-    });
-  });
   it('should correctly merge and nest child collection pages under their parents', function () {
     var PAGES = [{
       id: 'page1',

package/dist/utils/CollectionPage/setCollectionPageData.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _uuid = require("uuid");
 var isValidIndex = function isValidIndex(value) {
   return typeof value === 'number' && value >= 0;
 };
@@ -36,7 +37,7 @@ var setCollectionPageData = function setCollectionPageData(collectionName, newDa
     if (!data[name].find(function (e) {
       return e.id === formData["".concat(name, "ActiveId")];
     })) {
-      var newEntryId = Date.now().toString();
+      var newEntryId = (0, _uuid.v4)();
       // eslint-disable-next-line no-param-reassign
       formData["".concat(name, "ActiveId")] = formData["".concat(name, "ActiveId")] || newEntryId;
       data[name].push({

package/dist/utils/Data/deleteValues.js

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Find values in data not in formData
+ * and delete them from data.
+ * @param {object} data The page's data.
+ * @param {object} formData The page's formData.
+ */
+var deleteValues = function deleteValues(data, formData) {
+  var deletedValues = Object.keys(data).filter(function (k) {
+    return !(k in formData);
+  });
+  var node = data;
+  deletedValues.forEach(function (i) {
+    return delete node[i];
+  });
+};
+var _default = exports.default = deleteValues;

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

@@ -0,0 +1,57 @@
+"use strict";
+
+var _deleteValues = _interopRequireDefault(require("./deleteValues"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('Utils.Data.deleteValues', function () {
+  it('Should delete values from data', function () {
+    var DATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    var FORMDATA = {
+      a: '1'
+    };
+    (0, _deleteValues.default)(DATA, FORMDATA);
+    expect(DATA).toEqual({
+      a: '1'
+    });
+  });
+  it('Should leave data unchanged if no differences', function () {
+    var DATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    var FORMDATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    (0, _deleteValues.default)(DATA, FORMDATA);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2',
+      c: '3'
+    });
+  });
+  it('Should leave data unchanged if form data has additional fields', function () {
+    var DATA = {
+      a: '1',
+      b: '2',
+      c: '3'
+    };
+    var FORMDATA = {
+      a: '1',
+      b: '2',
+      c: '3',
+      d: '4'
+    };
+    (0, _deleteValues.default)(DATA, FORMDATA);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2',
+      c: '3'
+    });
+  });
+});

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

@@ -14,6 +14,7 @@ describe('utils', function () {
     var gbCurrency = {
       currencyName: 'Great British Pounds',
       currencyCode: 'GBP',
+      hint: 'hint',
       value: 'GBP',
       label: 'GBP',
       slangTerm: 'quid'
@@ -21,6 +22,7 @@ describe('utils', function () {
     var usCurrency = {
       currencyName: 'United States Dollars',
       currencyCode: 'USD',
+      hint: 'hint',
       value: 'USD',
       label: 'USD',
       slangTerm: 'bucks',
@@ -29,19 +31,23 @@ describe('utils', function () {
     var options = {
       alpha: {
         value: 'a',
-        label: 'Alpha'
+        label: 'Alpha',
+        hint: 'hint'
       },
       bravo: {
         value: 'b',
-        label: 'Bravo'
+        label: 'Bravo',
+        hint: 'hint'
       },
       alIncluded: {
         value: 'c',
-        label: 'Call me alan'
+        label: 'Call me alan',
+        hint: 'hint'
       },
       alStart: {
         value: 'd',
-        label: 'Word Alphabet'
+        label: 'Word Alphabet',
+        hint: 'hint'
       }
     };
     var testCurrencies = [gbCurrency, usCurrency];
@@ -71,7 +77,8 @@ describe('utils', function () {
             expect(results.length).toEqual(1);
             expect(results).toEqual([{
               value: 'a',
-              label: 'Alpha'
+              label: 'Alpha',
+              hint: 'hint'
             }]);
           });
         });
@@ -249,6 +256,7 @@ describe('utils', function () {
               options: [gbCurrency, {
                 currencyName: 'United States Dollars',
                 currencyCode: 'USD',
+                hint: 'hint',
                 value: 'USD'
               }]
             }
@@ -263,6 +271,7 @@ describe('utils', function () {
             expect(results).toEqual([gbCurrency, {
               currencyName: 'United States Dollars',
               currencyCode: 'USD',
+              hint: 'hint',
               value: 'USD',
               label: ''
             }]);

package/dist/utils/Data/getOptions.js

@@ -32,7 +32,8 @@ var interpolateOptions = function interpolateOptions(config, options) {
     }
     return _objectSpread(_objectSpread({}, opt), {}, {
       value: _copReactComponents.Utils.interpolateString(opt.value, config.formData),
-      label: _copReactComponents.Utils.interpolateString(opt.label, config.formData)
+      label: _copReactComponents.Utils.interpolateString(opt.label, config.formData),
+      hint: _copReactComponents.Utils.interpolateString(opt.hint, config.formData)
     });
   }).filter(function (n) {
     return n;

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

@@ -16,10 +16,12 @@ describe('utils', function () {
         var CONFIG = {
           options: [{
             value: 'a',
-            label: 'Alpha'
+            label: 'Alpha',
+            hint: ''
           }, {
             value: 'b',
-            label: 'Bravo'
+            label: 'Bravo',
+            hint: ''
           }]
         };
         (0, _getOptions.default)(CONFIG, function (options) {
@@ -31,10 +33,12 @@ describe('utils', function () {
           data: {
             options: [{
               value: 'a',
-              label: 'Alpha'
+              label: 'Alpha',
+              hint: ''
             }, {
               value: 'b',
-              label: 'Bravo'
+              label: 'Bravo',
+              hint: ''
             }]
           }
         };
@@ -46,10 +50,12 @@ describe('utils', function () {
         var CONFIG = {
           options: [{
             value: 'a',
-            label: 'Alpha'
+            label: 'Alpha',
+            hint: ''
           }, {
             value: 'b',
-            label: 'Bravo'
+            label: 'Bravo',
+            hint: ''
           }],
           data: {
             options: [{
@@ -71,6 +77,7 @@ describe('utils', function () {
           options: [{
             value: 'a',
             label: 'Alpha',
+            hint: '',
             show_when: {
               field: 'other',
               op: 'eq',
@@ -79,6 +86,7 @@ describe('utils', function () {
           }, {
             value: 'b',
             label: 'Bravo',
+            hint: '',
             show_when: {
               field: 'other',
               op: 'neq',
@@ -99,6 +107,7 @@ describe('utils', function () {
           options: [{
             value: 'a',
             label: 'Alpha',
+            hint: '',
             show_when: {
               type: 'or',
               conditions: [{
@@ -114,6 +123,7 @@ describe('utils', function () {
           }, {
             value: 'b',
             label: 'Bravo',
+            hint: '',
             show_when: {
               type: 'or',
               conditions: [{
@@ -152,16 +162,19 @@ describe('utils', function () {
           options: [{
             id: 1,
             description: 'First refdata item',
+            hint: '',
             value: 'firstValue',
             label: 'First label'
           }, {
             id: 2,
             description: 'Second refdata item',
+            hint: '',
             value: 'secondValue',
             label: 'Second label'
           }, {
             id: 3,
             description: 'Third refdata item',
+            hint: '',
             value: 'thirdValue',
             label: 'Third label'
           }]
@@ -169,11 +182,13 @@ describe('utils', function () {
         var MERGED_CONFIG = [{
           id: 1,
           description: 'First refdata item',
+          hint: '',
           value: 'firstValue',
           label: 'First label'
         }, {
           id: 2,
           description: 'Second refdata item',
+          hint: '',
           value: 'secondValue',
           nested: [{
             value: 'a',
@@ -183,6 +198,7 @@ describe('utils', function () {
         }, {
           id: 3,
           description: 'Third refdata item',
+          hint: '',
           value: 'thirdValue',
           label: 'Third label'
         }];
@@ -196,11 +212,13 @@ describe('utils', function () {
           options: [{
             value: 'a',
             label: 'Alpha',
-            description: 'first'
+            description: 'first',
+            hint: ''
           }, {
             value: 'b',
             label: 'Bravo',
-            description: 'second'
+            description: 'second',
+            hint: ''
           }]
         };
         (0, _getOptions.default)(CONFIG, function (options) {

package/dist/utils/Data/index.js

@@ -10,6 +10,7 @@ var _getDataPath = _interopRequireDefault(require("./getDataPath"));
 var _getOptions = _interopRequireDefault(require("./getOptions"));
 var _getSourceData = _interopRequireDefault(require("./getSourceData"));
 var _refDataToOptions = _interopRequireDefault(require("./refDataToOptions"));
+var _deleteValues = _interopRequireDefault(require("./deleteValues"));
 var _setDataItem = _interopRequireDefault(require("./setDataItem"));
 var _setupFormData = _interopRequireDefault(require("./setupFormData"));
 var _setupRefDataUrlForComponent = _interopRequireDefault(require("./setupRefDataUrlForComponent"));
@@ -26,6 +27,7 @@ var Data = {
     setupUrl: _setupRefDataUrlForComponent.default,
     toOptions: _refDataToOptions.default
   },
+  deleteValues: _deleteValues.default,
   setDataItem: _setDataItem.default,
   setupForm: _setupFormData.default
 };

package/dist/utils/Operate/deleteValueInFormData.js

@@ -0,0 +1,26 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Simple operation to delete a value in the form data.
+ * @param {object} config The operation config.
+ * @param {object} data The page's formData.
+ * @param {function} onChange The page's onChange handler.
+ */
+var deleteValueInFormData = function deleteValueInFormData(config, data, onChange) {
+  var node = data;
+  if (config !== null && config !== void 0 && config.field && config !== null && config !== void 0 && config.component) {
+    delete node[config.field];
+    onChange({
+      target: {
+        name: config.field,
+        value: null,
+        component: config.component
+      }
+    });
+  }
+};
+var _default = exports.default = deleteValueInFormData;

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

@@ -0,0 +1,60 @@
+"use strict";
+
+var _deleteValueInFormData = _interopRequireDefault(require("./deleteValueInFormData"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('Utils.Operate.deleteValueInFormData', function () {
+  var ON_CHANGE = function ON_CHANGE() {};
+  it('Should delete value from data', function () {
+    var CONFIG = {
+      field: 'a',
+      component: 'A'
+    };
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      b: '2'
+    });
+  });
+  it('Should do nothing if value is absent', function () {
+    var CONFIG = {
+      field: 'c',
+      component: 'C'
+    };
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2'
+    });
+  });
+  it('Should do nothing if config is null', function () {
+    var CONFIG = null;
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2'
+    });
+  });
+  it('Should do nothing if config is empty', function () {
+    var CONFIG = {};
+    var DATA = {
+      a: '1',
+      b: '2'
+    };
+    (0, _deleteValueInFormData.default)(CONFIG, DATA, ON_CHANGE);
+    expect(DATA).toEqual({
+      a: '1',
+      b: '2'
+    });
+  });
+});

package/dist/utils/Operate/runPageOperations.js

@@ -9,6 +9,7 @@ var _checkValueIsTruthy = _interopRequireDefault(require("./checkValueIsTruthy")
 var _getIndexOfMatchingValueIn = _interopRequireDefault(require("./getIndexOfMatchingValueIn"));
 var _persistValueInFormData = _interopRequireDefault(require("./persistValueInFormData"));
 var _setValueInFormData = _interopRequireDefault(require("./setValueInFormData"));
+var _deleteValueInFormData = _interopRequireDefault(require("./deleteValueInFormData"));
 var _shouldRun = _interopRequireDefault(require("./shouldRun"));
 var _setDataItem = _interopRequireDefault(require("../Data/setDataItem"));
 var _getFirstOf = _interopRequireDefault(require("./getFirstOf"));
@@ -23,6 +24,7 @@ var functions = {
   getIndexOfMatchingValueIn: _getIndexOfMatchingValueIn.default,
   persistValueInFormData: _persistValueInFormData.default,
   setValueInFormData: _setValueInFormData.default,
+  deleteValueInFormData: _deleteValueInFormData.default,
   getLength: _getLength.default,
   getFirstOf: _getFirstOf.default
 };

package/dist/utils/Validate/additional/conditionallyPermittedChange.js

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Additional validator to not permit a value change if a specified item exists in formData.
+ * @param {object} data the changed value
+ * @param {object} config the config for the validation must contain 
+ * a property 'base' holding the value for checking
+ * a property 'check' holding the formData item name to check if exists
+ * @param {object} formData the form data
+ * @returns false if: 
+ * the 'base' value is not the same as the changed value AND
+ * the 'check' value exists in formData as an item
+ * otherwise returns true
+ */
+var conditionallyPermittedChange = function conditionallyPermittedChange(data, config, _, formData) {
+  if (data !== config.base && formData[config.check]) {
+    return false;
+  }
+  return true;
+};
+var _default = exports.default = conditionallyPermittedChange;

package/dist/utils/Validate/additional/conditionallyPermittedChange.test.js

@@ -0,0 +1,33 @@
+"use strict";
+
+var _conditionallyPermittedChange = _interopRequireDefault(require("./conditionallyPermittedChange"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('additional', function () {
+      describe('conditionallyPermittedChange', function () {
+        var CONFIG = {
+          base: 'Value1',
+          check: 'Item1'
+        };
+        test('should pass if the base value has same value as data parameter', function () {
+          var DATA = 'Value1';
+          var FORMDATA = {};
+          expect((0, _conditionallyPermittedChange.default)(DATA, CONFIG, null, FORMDATA)).toEqual(true);
+        });
+        test('should fail if the base value is different to data parameter and check item exists in form data', function () {
+          var DATA = 'Value2';
+          var FORMDATA = {
+            Item1: "any"
+          };
+          expect((0, _conditionallyPermittedChange.default)(DATA, CONFIG, null, FORMDATA)).toEqual(false);
+        });
+        test('should pass if the base value is different to data parameter and check item not exists in form data', function () {
+          var DATA = 'Value2';
+          var FORMDATA = {};
+          expect((0, _conditionallyPermittedChange.default)(DATA, CONFIG, null, FORMDATA)).toEqual(true);
+        });
+      });
+    });
+  });
+});

package/dist/utils/Validate/additional/index.js

@@ -4,6 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
+var _conditionallyPermittedChange = _interopRequireDefault(require("./conditionallyPermittedChange"));
 var _conditionallyRequired = _interopRequireDefault(require("./conditionallyRequired"));
 var _mustBeAfter = _interopRequireDefault(require("./mustBeAfter"));
 var _mustBeBefore = _interopRequireDefault(require("./mustBeBefore"));
@@ -15,6 +16,7 @@ var _mustBeShorterThan = _interopRequireDefault(require("./mustBeShorterThan"));
 var _mustBeGreaterThan = _interopRequireDefault(require("./mustBeGreaterThan"));
 var _mustBeLessThan = _interopRequireDefault(require("./mustBeLessThan"));
 var _mustBeNumbersOnly = _interopRequireDefault(require("./mustBeNumbersOnly"));
+var _mustBeOneOf = _interopRequireDefault(require("./mustBeOneOf"));
 var _mustBeUniqueInCollection = _interopRequireDefault(require("./mustBeUniqueInCollection"));
 var _mustEnterAtLeastOne = _interopRequireDefault(require("./mustEnterAtLeastOne"));
 var _mustHaveLessThanDecimalPlaces = _interopRequireDefault(require("./mustHaveLessThanDecimalPlaces"));
@@ -24,6 +26,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 // Local imports
 
 var functions = {
+  conditionallyPermittedChange: _conditionallyPermittedChange.default,
   conditionallyRequired: _conditionallyRequired.default,
   mustBeAfter: _mustBeAfter.default,
   mustBeBefore: _mustBeBefore.default,
@@ -34,6 +37,7 @@ var functions = {
   mustBeLessThan: _mustBeLessThan.default,
   mustBeLongerThan: _mustBeLongerThan.default,
   mustBeNumbersOnly: _mustBeNumbersOnly.default,
+  mustBeOneOf: _mustBeOneOf.default,
   mustBeShorterThan: _mustBeShorterThan.default,
   mustBeUniqueInCollection: _mustBeUniqueInCollection.default,
   mustEnterAtLeastOne: _mustEnterAtLeastOne.default,
@@ -43,8 +47,9 @@ var functions = {
 };
 var additionalValidation = function additionalValidation(value, config, component, formData) {
   var fn = functions[config.function];
+  var valueToValidate = config.objectValueToUse ? value[config.objectValueToUse] : value;
   if (typeof fn === 'function') {
-    return fn(value, config, component, formData) ? undefined : config.message;
+    return fn(valueToValidate, config, component, formData) ? undefined : config.message;
   }
   return undefined;
 };