@ukhomeoffice/cop-react-form-renderer 3.0.0 → 3.0.1

package/dist/utils/Component/getComponentTests/getComponent.date.test.js

@@ -94,8 +94,8 @@ describe('utils.Component.get', function () {
       }
     });
 
-    expect(ON_CHANGE_CALLS.length).toEqual(2);
-    expect(ON_CHANGE_CALLS[1]).toMatchObject({
+    expect(ON_CHANGE_CALLS.length).toEqual(1);
+    expect(ON_CHANGE_CALLS[0]).toMatchObject({
       name: FIELD_ID,
       value: '5--'
     }); // And now the month...
@@ -107,8 +107,8 @@ describe('utils.Component.get', function () {
       }
     });
 
-    expect(ON_CHANGE_CALLS.length).toEqual(3);
-    expect(ON_CHANGE_CALLS[2]).toMatchObject({
+    expect(ON_CHANGE_CALLS.length).toEqual(2);
+    expect(ON_CHANGE_CALLS[1]).toMatchObject({
       name: FIELD_ID,
       value: '5-11-'
     }); // And finally the year.
@@ -120,8 +120,8 @@ describe('utils.Component.get', function () {
       }
     });
 
-    expect(ON_CHANGE_CALLS.length).toEqual(4);
-    expect(ON_CHANGE_CALLS[3]).toMatchObject({
+    expect(ON_CHANGE_CALLS.length).toEqual(3);
+    expect(ON_CHANGE_CALLS[2]).toMatchObject({
       name: FIELD_ID,
       value: '5-11-2022'
     });

package/dist/utils/Validate/index.js

@@ -13,6 +13,8 @@ var _validateEmail = _interopRequireDefault(require("./validateEmail"));
 
 var _validatePage = _interopRequireDefault(require("./validatePage"));
 
+var _validateRegex = _interopRequireDefault(require("./validateRegex"));
+
 var _validateRequired = _interopRequireDefault(require("./validateRequired"));
 
 var _validateTime = _interopRequireDefault(require("./validateTime"));
@@ -25,6 +27,7 @@ var Validate = {
   email: _validateEmail.default,
   date: _validateDate.default,
   page: _validatePage.default,
+  regex: _validateRegex.default,
   required: _validateRequired.default,
   time: _validateTime.default
 };

package/dist/utils/Validate/validateComponent.js

@@ -19,6 +19,8 @@ var _validateDate = _interopRequireDefault(require("./validateDate"));
 
 var _validateEmail = _interopRequireDefault(require("./validateEmail"));
 
+var _validateRegex = _interopRequireDefault(require("./validateRegex"));
+
 var _validateRequired = _interopRequireDefault(require("./validateRequired"));
 
 var _validateTime = _interopRequireDefault(require("./validateTime"));
@@ -99,6 +101,10 @@ var validateComponent = function validateComponent(component, formData) {
         break;
     }
 
+    if (!error && component.pattern) {
+      error = (0, _validateRegex.default)(value, component.label, component.pattern, component.custom_errors);
+    }
+
     if (!error && component.additionalValidation) {
       error = (0, _additional.default)(component, value);
 

package/dist/utils/Validate/validateRegex.js

@@ -0,0 +1,56 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+/**
+ * Validates an components value against a given regex pattern.
+ * 
+ * An empty string for value is considered valid as not all components
+ * with pattern validation have to be required. 
+ * @param {*} value The value to validate.
+ * @param {string} label The label to use in the default error message.
+ * @param {string} pattern The regex pattern to validate against.
+ * @param {array} customErrors The array of custom errors for the component.
+ * @returns An error if the value doesn't match the regex pattern.
+ */
+var validateRegex = function validateRegex(value) {
+  var label = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '';
+  var pattern = arguments.length > 2 ? arguments[2] : undefined;
+  var customErrors = arguments.length > 3 ? arguments[3] : undefined;
+
+  if (!value) {
+    return undefined;
+  }
+
+  if (typeof value === 'string') {
+    var regex = new RegExp(pattern);
+
+    if (regex.test(value)) {
+      return undefined;
+    }
+
+    if (Array.isArray(customErrors)) {
+      var _result$;
+
+      var result = customErrors.filter(function (error) {
+        return error.type === 'pattern';
+      });
+
+      if (result !== null && result !== void 0 && (_result$ = result[0]) !== null && _result$ !== void 0 && _result$.message) {
+        return result[0].message;
+      }
+    }
+  }
+
+  if (label === '') {
+    return 'Component failed regex validation';
+  }
+
+  return "".concat(label, " failed regex validation");
+};
+
+var _default = validateRegex;
+exports.default = _default;

package/dist/utils/Validate/validateRegex.test.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _validateRegex = _interopRequireDefault(require("./validateRegex"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+// Local imports
+describe('utils', function () {
+  describe('Validate', function () {
+    describe('regex', function () {
+      var GOOD_VALUE = 'hello';
+      var BAD_VALUE = 'h3llo';
+      var LABEL = 'Component';
+      var PATTERN = '^[a-z]*$';
+      var CUSTOM_ERRORS = [{
+        "type": "pattern",
+        "message": "Regex validation failed for ".concat(LABEL)
+      }];
+      var DEFAULT_ERROR = [{
+        "type": "pattern"
+      }]; // Valid values
+
+      it('should return no error when the value matches the regex pattern', function () {
+        expect((0, _validateRegex.default)(GOOD_VALUE, LABEL, PATTERN, CUSTOM_ERRORS)).toBeUndefined();
+      });
+      it('should return no error when the value is an empty string', function () {
+        expect((0, _validateRegex.default)('', LABEL, PATTERN, CUSTOM_ERRORS)).toBeUndefined();
+      }); // Invalid values
+
+      it('should return a custom error when the value does not match the regex pattern and one is specified', function () {
+        expect((0, _validateRegex.default)(BAD_VALUE, LABEL, PATTERN, CUSTOM_ERRORS)).toEqual(CUSTOM_ERRORS[0].message);
+      });
+      it('should return an error using label when the value does not match the regex pattern and a custom error is not specified', function () {
+        expect((0, _validateRegex.default)(BAD_VALUE, LABEL, PATTERN, DEFAULT_ERROR)).toEqual("".concat(LABEL, " failed regex validation"));
+      });
+      it('should return a default error when the value does not match the regex pattern and both a custom error and label are not specified', function () {
+        expect((0, _validateRegex.default)(BAD_VALUE, '', PATTERN, DEFAULT_ERROR)).toEqual('Component failed regex validation');
+      });
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ukhomeoffice/cop-react-form-renderer",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "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": "1.6.0",
+    "@ukhomeoffice/cop-react-components": "1.7.1",
     "axios": "^0.21.1",
     "dayjs": "^1.11.0",
     "govuk-frontend": "^3.13.0",