@ukhomeoffice/cop-react-form-renderer 6.16.3-alpha → 6.16.4

package/dist/utils/Validate/validateComponent.js

@@ -94,7 +94,7 @@ const validateComponent = (component, outerData, formData) => {
         error = (0, _validateMultifile.default)(value, component.custom_errors);
         break;
       case _models.ComponentTypes.TEXT_AREA:
-        error = (0, _validateTextArea.default)(component.label, value, component.showCharacterCount, component.custom_errors, component.maxLength);
+        error = (0, _validateTextArea.default)(component.label, value, component.showCharacterCount, component.custom_errors, component.required, component.maxLength);
         break;
       default:
         break;

package/dist/utils/Validate/validateTextArea.js

@@ -11,15 +11,16 @@ exports.default = void 0;
  * @param {*} value The value to validate.
  * @param {string} showCharacterCount The flag to enable character count validation.
  * @param {array} customErrors An array of custom errors for the component.
+ * @param {boolean} required If the component is required.
  * @param {number} maxLength The maximum allowable number of characters (by default, this is 1000 characters).
  * @returns An error if the value exceeds the maximum allowable number of characters.
  */
-const validateTextArea = function (label, value, showCharacterCount, customErrors) {
-  let maxLength = arguments.length > 4 && arguments[4] !== undefined ? arguments[4] : 1000;
-  if (!showCharacterCount) {
+const validateTextArea = function (label, value, showCharacterCount, customErrors, required) {
+  let maxLength = arguments.length > 5 && arguments[5] !== undefined ? arguments[5] : 1000;
+  if (!showCharacterCount || !required && !value) {
     return undefined;
   }
-  const hasError = !value || value.length > maxLength;
+  const hasError = required && !value || value.length > maxLength;
   if (hasError) {
     if (Array.isArray(customErrors)) {
       const result = customErrors.filter(error => error.type === 'length');

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

@@ -15,31 +15,53 @@ describe('utils', () => {
       }];
       it('should return no error when the character count flag is disabled', () => {
         const VALUE = 'ALPHA BRAVO';
-        expect((0, _validateTextArea.default)(LABEL, VALUE, false, CUSTOM_ERRORS, MAX_LENGTH)).toBeUndefined();
+        expect((0, _validateTextArea.default)(LABEL, VALUE, false, CUSTOM_ERRORS, true, MAX_LENGTH)).toBeUndefined();
       });
       it('should return no error when value length has not exceeded the maximum allowable character length', () => {
         const VALUE = 'ALPHA BRA';
-        expect((0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, MAX_LENGTH)).toBeUndefined();
+        expect((0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, true, MAX_LENGTH)).toBeUndefined();
       });
       it('should return no error when value length has not exceeded the default maximum allowable character length', () => {
         const VALUE = 'ALPHA BRAVO';
-        expect((0, _validateTextArea.default)(LABEL, VALUE, true, undefined)).toBeUndefined();
+        expect((0, _validateTextArea.default)(LABEL, VALUE, true, undefined, true)).toBeUndefined();
       });
       it('should return an error when value length has exceeded the maximum allowable character length', () => {
         const VALUE = 'ALPHA BRAVO';
-        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, undefined, MAX_LENGTH);
+        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, undefined, true, MAX_LENGTH);
         expect(error).toBeDefined();
         expect(error).toEqual(ERROR_MSG);
       });
       it('should return a custom error when one is provided', () => {
         const VALUE = 'ALPHA BRAVO CHARLIE';
-        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, MAX_LENGTH);
+        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, true, MAX_LENGTH);
         expect(error).toBeDefined();
         expect(error).toEqual(CUSTOM_ERROR);
       });
       it('Should return a custom error when one is provided and the value is undefined', () => {
         const VALUE = undefined;
-        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, MAX_LENGTH);
+        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, true, MAX_LENGTH);
+        expect(error).toBeDefined();
+        expect(error).toEqual(CUSTOM_ERROR);
+      });
+      it('Should return undefined when the component is not required and value is undefined', () => {
+        const VALUE = undefined;
+        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, false, MAX_LENGTH);
+        expect(error).toBeUndefined();
+      });
+      it('Should return undefined when component required is undefined and value is undefined', () => {
+        const VALUE = undefined;
+        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, undefined, MAX_LENGTH);
+        expect(error).toBeUndefined();
+      });
+      it('Should return error when component required is false and value is over max length', () => {
+        const VALUE = 'ALPHA BRAVO CHARLIE';
+        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, false, MAX_LENGTH);
+        expect(error).toBeDefined();
+        expect(error).toEqual(CUSTOM_ERROR);
+      });
+      it('Should return error when component is required and value is undefined', () => {
+        const VALUE = undefined;
+        const error = (0, _validateTextArea.default)(LABEL, VALUE, true, CUSTOM_ERRORS, true, MAX_LENGTH);
         expect(error).toBeDefined();
         expect(error).toEqual(CUSTOM_ERROR);
       });

package/package.json

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