@ukhomeoffice/cop-react-form-renderer 5.87.1 → 5.88.2

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

@@ -15,14 +15,14 @@ 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"));
 var _mustNotContainSql = _interopRequireDefault(require("./mustNotContainSql"));
 var _mustSelectOnlyOne = _interopRequireDefault(require("./mustSelectOnlyOne"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-// Local 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); } // Local imports
 var functions = {
   conditionallyRequired: _conditionallyRequired.default,
   mustBeAfter: _mustBeAfter.default,
@@ -34,6 +34,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 +44,9 @@ var functions = {
 };
 var additionalValidation = function additionalValidation(value, config, component, formData) {
   var fn = functions[config.function];
+  var valueToValidate = _typeof(value) === 'object' ? 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,22 @@ 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 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": "5.87.1",
+  "version": "5.88.2",
   "private": false,
   "scripts": {
     "clean": "rimraf dist",
@@ -16,7 +16,7 @@
     "post-compile": "rimraf dist/*.test.* dist/**/*.test.* dist/**/*.stories.* dist/docs dist/assets"
   },
   "dependencies": {
-    "@ukhomeoffice/cop-react-components": "3.23.0",
+    "@ukhomeoffice/cop-react-components": "3.24.0",
     "axios": "^0.23.0",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^4.3.1",