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

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/index.js

@@ -15,6 +15,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"));
@@ -34,6 +35,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 +45,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;
 };

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

@@ -58,6 +58,72 @@ describe('utils', function () {
         var VALUE = (0, _dayjs.default)().add(150, 'day').format(_utils.DATE_FORMAT);
         expect((0, _index.default)(COMPONENT, VALUE)).toEqual(undefined);
       });
+      it('should apply optional validators that fail when the value is an object', function () {
+        var COMPONENT = {
+          fieldId: 'container',
+          components: [{
+            id: 'eventDate',
+            fieldId: 'eventDate'
+          }, {
+            id: 'eventTime',
+            fieldId: 'eventTime'
+          }],
+          additionalValidation: [{
+            function: 'mustBeEarlierDateTime',
+            date: 'eventDate',
+            time: 'eventTime',
+            message: 'The date and time cannot be in the future'
+          }]
+        };
+        var VALUE = {
+          container: {
+            eventDate: '01-07-4024',
+            eventTime: '1:1'
+          }
+        };
+        expect((0, _index.default)(COMPONENT, VALUE)).toEqual('The date and time cannot be in the future');
+      });
+      it('should apply optional validators that pass when the value is an object', function () {
+        var COMPONENT = {
+          fieldId: 'container',
+          components: [{
+            id: 'eventDate',
+            fieldId: 'eventDate'
+          }, {
+            id: 'eventTime',
+            fieldId: 'eventTime'
+          }],
+          additionalValidation: [{
+            function: 'mustBeEarlierDateTime',
+            date: 'eventDate',
+            time: 'eventTime',
+            message: 'The date and time cannot be in the future'
+          }]
+        };
+        var VALUE = {
+          container: {
+            eventDate: '01-07-1024',
+            eventTime: '1:1'
+          }
+        };
+        expect((0, _index.default)(COMPONENT, VALUE)).toEqual(undefined);
+      });
+      it('should apply optional validators when the value is within an object', function () {
+        var COMPONENT = {
+          additionalValidation: [{
+            function: 'mustBeAfter',
+            value: 3,
+            unit: 'day',
+            objectValueToUse: "date",
+            message: 'Date must be more than 3 days in the future'
+          }]
+        };
+        var VALUE = {
+          testValue: "",
+          date: (0, _dayjs.default)().add(1, 'day').format(_utils.DATE_FORMAT)
+        };
+        expect((0, _index.default)(COMPONENT, VALUE)).toEqual('Date must be more than 3 days in the future');
+      });
     });
   });
 });

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

@@ -0,0 +1,21 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+/**
+ * Function returns true if the string parameter is contained in the passed in array.
+ * @param {string} string - the string to check.
+ * @param {array} config.array - the array that the string will be checked against. 
+ * @returns true if string is contained in config.array, false if not.
+ */
+var mustBeOneOf = function mustBeOneOf(string, config) {
+  if (!string) {
+    // null, undefined and empty strings should be picked up by the required flag
+    // and not considered here as they would be valid for optional fields.
+    return true;
+  }
+  return config.array.includes(string);
+};
+var _default = exports.default = mustBeOneOf;

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

@@ -0,0 +1,36 @@
+"use strict";
+
+var _mustBeOneOf = _interopRequireDefault(require("./mustBeOneOf"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('additional', function () {
+      describe('mustBeShorterThan', function () {
+        test('should return true given the string is in the array', function () {
+          var result = (0, _mustBeOneOf.default)('test2', {
+            array: ["test1", "test2", "test3", "test4"]
+          });
+          expect(result).toEqual(true);
+        });
+        test('should return false given the string is not in the array', function () {
+          var result = (0, _mustBeOneOf.default)('test5', {
+            array: ["test1", "test2", "test3", "test4"]
+          });
+          expect(result).toEqual(false);
+        });
+        test('should return false given the array is empty', function () {
+          var result = (0, _mustBeOneOf.default)('test1', {
+            array: []
+          });
+          expect(result).toEqual(false);
+        });
+        test('should return false when only the partial string is in the array', function () {
+          var result = (0, _mustBeOneOf.default)('test', {
+            array: ["test1", "test2", "test3", "test4"]
+          });
+          expect(result).toEqual(false);
+        });
+      });
+    });
+  });
+});

package/package.json

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