Allowed email to be empty.

Added typings on returned values by some functions.

Author: crsanti

lib/src/rules/email.ts

@@ -5,10 +5,22 @@ const EMAIL_PATTERN = /^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".
 
 export const email: FieldValidationFunction = (value: string) => {
   const validationResult = new FieldValidationResult();
-  const isValid = EMAIL_PATTERN.test(value);
+  const isValid = isValidEmail(value);
 
   validationResult.succeeded = isValid;
   validationResult.type = 'EMAIL';
   validationResult.errorMessage = isValid ? '' : 'Please enter a valid email address.';
   return validationResult;
 };
+
+function isValidEmail(value): boolean {
+  return isEmptyValue(value) ?
+    true :
+    EMAIL_PATTERN.test(value);
+}
+
+function isEmptyValue(value): boolean {
+  return value === null ||
+    value === undefined ||
+    value === '';
+}

lib/src/rules/maxLength.ts

@@ -19,7 +19,7 @@ export function maxLength(value: string, vm, customParams: LengthParams = DEFAUL
   return validationResult;
 }
 
-function isStringLengthValid(value: string, length: number) {
+function isStringLengthValid(value: string, length: number): boolean {
   return isNaN(length) ?
     false :
     value.length <= length;

lib/src/rules/minLength.ts

@@ -19,6 +19,6 @@ export const minLength: FieldValidationFunction = (value: string, vm, customPara
   return validationResult;
 }
 
-function isStringLengthValid(value: string, length: number) {
+function isStringLengthValid(value: string, length: number): boolean {
   return value.length >= length;
 }

lib/src/rules/pattern.ts

@@ -26,7 +26,7 @@ function parsePattern({ pattern }: PatternParams): RegExp {
   return getRegExp(pattern);
 }
 
-function getRegExp(pattern) {
+function getRegExp(pattern): RegExp {
   return pattern instanceof RegExp ?
     pattern :
     new RegExp(pattern);

lib/src/rules/required.ts

@@ -17,13 +17,7 @@ export const required: FieldValidationFunction = (value, vm, customParams: Requi
 function isValidField(value, trim: boolean): boolean {
   return typeof value === 'string' ?
     isStringValid(value, trim) :
-    isNotFalsy(value);
-}
-
-function isNotFalsy(value) {
-  return value !== null &&
-    value !== undefined &&
-    value !== false;
+    value === true;
 }
 
 function isStringValid(value: string, trim: boolean): boolean {

lib/src/rules/spec/email.spec.ts

@@ -3,7 +3,7 @@ import { FieldValidationResult } from '../../entities';
 
 describe('[email] validation rule tests =>', () => {
   describe('When validating a non string value', () => {
-    it('should return false if value is null', () => {
+    it('should return true if value is null', () => {
       // Arrange
       const value = null;
       const vm = undefined;
@@ -13,12 +13,12 @@ describe('[email] validation rule tests =>', () => {
       const validationResult = email(value, vm, customParams) as FieldValidationResult;
 
       // Assert
-      expect(validationResult.succeeded).to.be.false;
+      expect(validationResult.succeeded).to.be.true;
       expect(validationResult.type).to.be.equals('EMAIL');
-      expect(validationResult.errorMessage).to.be.equals('Please enter a valid email address.');
+      expect(validationResult.errorMessage).to.be.empty;
     });
 
-    it('should return false if value is undefined', () => {
+    it('should return true if value is undefined', () => {
       // Arrange
       const value = undefined;
       const vm = undefined;
@@ -28,9 +28,9 @@ describe('[email] validation rule tests =>', () => {
       const validationResult = email(value, vm, customParams) as FieldValidationResult;
 
       // Assert
-      expect(validationResult.succeeded).to.be.false;
+      expect(validationResult.succeeded).to.be.true;
       expect(validationResult.type).to.be.equals('EMAIL');
-      expect(validationResult.errorMessage).to.be.equals('Please enter a valid email address.');
+      expect(validationResult.errorMessage).to.be.empty;
     });
 
     it('should return false if value is number', () => {

lib/src/rules/spec/maxLength.spec.ts

@@ -15,6 +15,8 @@ describe('[maxLength] validation rule tests =>', () => {
 
       // Assert
       expect(validationResult.succeeded).to.be.true;
+      expect(validationResult.type).to.be.equals('MAX_LENGTH');
+      expect(validationResult.errorMessage).to.be.empty;
     });
 
     it('should return true if value is null', () => {
@@ -28,6 +30,8 @@ describe('[maxLength] validation rule tests =>', () => {
 
       // Assert
       expect(validationResult.succeeded).to.be.true;
+      expect(validationResult.type).to.be.equals('MAX_LENGTH');
+      expect(validationResult.errorMessage).to.be.empty;
     });
   });