@ukhomeoffice/cop-react-form-renderer 4.24.0 → 4.26.0

package/dist/components/FormRenderer/FormRenderer.js

@@ -186,6 +186,10 @@ var InternalFormRenderer = function InternalFormRenderer(_ref2) {
   window.onpopstate = function () {
     var _formState$page;
 
+    if (document.location.hash) {
+      return;
+    }
+
     setGoingBack(true);
     hooks.onGoingBack();
     clearErrors();

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

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * Additional validator for the Container component type.
+ * @param {object} data the form data
+ * @param {object} config the config for the validation, must contain a property 'base' with the id of the conditionally required component and
+ * a property 'check' which if the corresponding component has a value will turn off the required check for 'base'
+ * @param {object} component the container component
+ * @returns true if the user has entered data into the 'base' field or entered a value into the 'check' field to turn off the validation
+ * otherwise returns false
+ */
+var conditionallyRequired = function conditionallyRequired(data, config, component) {
+  var _data$component$id, _data$component$id2;
+
+  var conditional = (_data$component$id = data[component.id]) === null || _data$component$id === void 0 ? void 0 : _data$component$id[config.base];
+  var checkFieldvalue = (_data$component$id2 = data[component.id]) === null || _data$component$id2 === void 0 ? void 0 : _data$component$id2[config.check];
+  var checkHasValue = checkFieldvalue && (checkFieldvalue === null || checkFieldvalue === void 0 ? void 0 : checkFieldvalue.length) > 0;
+  return !!(conditional || checkHasValue);
+};
+
+var _default = conditionallyRequired;
+exports.default = _default;

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

@@ -0,0 +1,75 @@
+"use strict";
+
+var _conditionallyRequired = _interopRequireDefault(require("./conditionallyRequired"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('additional', function () {
+      describe('conditionallyRequired', function () {
+        var CONFIG = {
+          base: 'componentOne',
+          check: 'componentTwo'
+        };
+        var COMPONENT = {
+          id: 'containerComponent',
+          fieldId: 'containerComponent',
+          type: 'container',
+          components: [{
+            id: 'componentOne',
+            type: 'text',
+            fieldId: 'componentOne'
+          }, {
+            id: 'componentTwo',
+            fieldId: 'componentTwo',
+            type: 'checkboxes'
+          }]
+        };
+        test('should pass if only the base field has a value', function () {
+          var DATA = {
+            containerComponent: {
+              componentOne: 'value'
+            }
+          };
+          expect((0, _conditionallyRequired.default)(DATA, CONFIG, COMPONENT)).toEqual(true);
+        });
+        test('should pass if the base and check fields have values', function () {
+          var DATA = {
+            containerComponent: {
+              componentOne: 'value',
+              componentTwo: 'value'
+            }
+          };
+          expect((0, _conditionallyRequired.default)(DATA, CONFIG, COMPONENT)).toEqual(true);
+        });
+        test('should pass if only the check field has a value', function () {
+          var DATA = {
+            containerComponent: {
+              componentTwo: 'value'
+            }
+          };
+          expect((0, _conditionallyRequired.default)(DATA, CONFIG, COMPONENT)).toEqual(true);
+        });
+        test('should pass if only the check field has a value and that value is an array', function () {
+          var DATA = {
+            containerComponent: {
+              componentTwo: ['value']
+            }
+          };
+          expect((0, _conditionallyRequired.default)(DATA, CONFIG, COMPONENT)).toEqual(true);
+        });
+        test('should fail if neither field has a value', function () {
+          var DATA = {
+            containerComponent: {}
+          };
+          expect((0, _conditionallyRequired.default)(DATA, CONFIG, COMPONENT)).toEqual(false);
+        });
+        test('should fail if there is no data', function () {
+          var DATA = {};
+          expect((0, _conditionallyRequired.default)(DATA, CONFIG, COMPONENT)).toEqual(false);
+        });
+      });
+    });
+  });
+});

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

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _conditionallyRequired = _interopRequireDefault(require("./conditionallyRequired"));
+
 var _mustBeAfter = _interopRequireDefault(require("./mustBeAfter"));
 
 var _mustBeBefore = _interopRequireDefault(require("./mustBeBefore"));
@@ -25,10 +27,13 @@ var _mustBeNumbersOnly = _interopRequireDefault(require("./mustBeNumbersOnly"));
 
 var _mustBeLessThan = _interopRequireDefault(require("./mustBeLessThan"));
 
+var _mustHaveLessThanDecimalPlaces = _interopRequireDefault(require("./mustHaveLessThanDecimalPlaces"));
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 // Local imports
 var functions = {
+  conditionallyRequired: _conditionallyRequired.default,
   mustBeAfter: _mustBeAfter.default,
   mustBeBefore: _mustBeBefore.default,
   mustBeEarlierDateTime: _mustBeEarlierDateTime.default,
@@ -38,7 +43,8 @@ var functions = {
   mustBeShorterThan: _mustBeShorterThan.default,
   mustEnterAtLeastOne: _mustEnterAtLeastOne.default,
   mustBeNumbersOnly: _mustBeNumbersOnly.default,
-  mustBeLessThan: _mustBeLessThan.default
+  mustBeLessThan: _mustBeLessThan.default,
+  mustHaveLessThanDecimalPlaces: _mustHaveLessThanDecimalPlaces.default
 };
 
 var additionalValidation = function additionalValidation(value, config, component) {

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

@@ -17,7 +17,7 @@ var mustBeLessThan = function mustBeLessThan(string, config) {
     return true;
   }
 
-  return string < config.value;
+  return parseFloat(string) < config.value;
 };
 
 var _default = mustBeLessThan;

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

@@ -0,0 +1,22 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * @param {string} string - the string to check
+ * @param {number} config.maxDecimals - the maximum amount of decimal places to allow
+ * @returns true if string has less than maxDecimals decimal places else returns false
+ */
+var mustHaveLessThanDecimalPlaces = function mustHaveLessThanDecimalPlaces(string, config) {
+  if (!string || !string.includes('.')) {
+    return true;
+  }
+
+  return string.split('.')[1].length < config.maxDecimals;
+};
+
+var _default = mustHaveLessThanDecimalPlaces;
+exports.default = _default;

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

@@ -0,0 +1,38 @@
+"use strict";
+
+var _mustHaveLessThanDecimalPlaces = _interopRequireDefault(require("./mustHaveLessThanDecimalPlaces"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('additional', function () {
+      describe('mustHaveLessThanDecimalPlaces', function () {
+        test('should return false given a number with more than the allowed number of decimal places', function () {
+          var result = (0, _mustHaveLessThanDecimalPlaces.default)('999999999.9999', {
+            maxDecimals: 3
+          });
+          expect(result).toEqual(false);
+        });
+        test('should return true given a number with less than the allowed number of decimal places', function () {
+          var result = (0, _mustHaveLessThanDecimalPlaces.default)('999999999.99', {
+            maxDecimals: 3
+          });
+          expect(result).toEqual(true);
+        });
+        test('should return true given a number with no decimal places', function () {
+          var result = (0, _mustHaveLessThanDecimalPlaces.default)('999999999', {
+            maxDecimals: 3
+          });
+          expect(result).toEqual(true);
+        });
+        test('should return true given nothing', function () {
+          var result = (0, _mustHaveLessThanDecimalPlaces.default)(undefined, {
+            maxDecimals: 3
+          });
+          expect(result).toEqual(true);
+        });
+      });
+    });
+  });
+});

package/package.json

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