Publishing adjustment version for error return and function typing

.vscode/settings.json

@@ -1,5 +1,5 @@
 {
 	"code-runner.executorMap": {
 		"typescript": "npx ts-node",
-	}
+	},
 }

dist/src/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

dist/src/validateBRPhoneNumber.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var defaultErrorMsg = ['Invalid value passed', 'Invalid phone number', 'Unknown error'];
+var defaultErrorMsg = ['Field phone number cannot be empty', 'Invalid phone number', 'Unknown error'];
 function validateBRPhoneNumber(phoneNumber, errorMsg) {
     if (errorMsg === void 0) { errorMsg = defaultErrorMsg; }
     if (typeof phoneNumber !== 'string')

dist/src/validateEmail.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var isEmail_1 = __importDefault(require("./isEmail"));
 var defaultErrorMsg = [
-    'Invalid value passed',
+    'Email cannot be empty',
     'This e-mail is not valid',
     'Email too big, try again',
     'This email is not valid in the country',
@@ -38,8 +38,12 @@ function validateEmail(email, maxLength, country, errorMsg, validDomains) {
             }
         }
     }
+    var maxEmailLength = maxLength || 400;
     function getErrorMessage(index) {
         var errorMessage = errorMsg[index];
+        if (errorMessage === 'Email too big, try again') {
+            return "Email cannot be greater than ".concat(maxEmailLength, " characters");
+        }
         return errorMessage != null ? errorMessage : defaultErrorMsg[index];
     }
     if (!email) {
@@ -48,7 +52,6 @@ function validateEmail(email, maxLength, country, errorMsg, validDomains) {
             errorMsg: getErrorMessage(0),
         };
     }
-    var maxEmailLength = maxLength || 400;
     if (maxEmailLength < 1 || typeof maxEmailLength !== 'number')
         throw new Error('maxLength must be a number and cannot be less than 1');
     try {

dist/src/validateName.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var defaultErrorMsg = [
-    'Invalid value passed',
+    'Name cannot be empty',
     'Name cannot contain numbers', 'Name cannot contain special characters',
     'This name is not valid',
     'Name too big, try again',

dist/src/validatePassword.js

@@ -3,10 +3,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var defaultErrorMsg = [
     'This password is too long',
     'password too short',
-    'Requires at least one capital letter',
-    'Requires at least one special character',
-    'Requires at least one number',
-    'Requires at least one letter',
+    'Password requires at least one capital letter',
+    'Password requires at least one special character',
+    'Password requires at least one number',
+    'Password requires at least one letter',
     'Unknown error',
 ];
 function validatePassword(password, minLength, maxLength, options, errorMsg) {
@@ -28,12 +28,20 @@ function validatePassword(password, minLength, maxLength, options, errorMsg) {
             }
         }
     }
+    var minLenthPassword = minLength || 1;
+    var maxLenthPassword = maxLength || Infinity;
     function getErrorMessage(index) {
         var errorMessage = errorMsg[index];
+        if (errorMessage === 'This password is too long' || errorMessage === 'password too short') {
+            if (maxLenthPassword === Infinity) {
+                return "Password must be greater than ".concat(minLenthPassword, " characters");
+            }
+            else {
+                return "Password must be between ".concat(minLenthPassword, " and ").concat(maxLenthPassword, " characters");
+            }
+        }
         return errorMessage != null ? errorMessage : defaultErrorMsg[index];
     }
-    var minLenthPassword = minLength || 1;
-    var maxLenthPassword = maxLength || Infinity;
     if (typeof minLenthPassword !== 'number' || typeof maxLenthPassword !== 'number') {
         throw new Error('maxLength and/or minLength must be a number');
     }

dist/src/validatePhoneNumber.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var defaultErrorMsg = ['Invalid value passed', 'Invalid phone number', 'Unknown error'];
+var defaultErrorMsg = ['Phone number cannot be empty', 'Invalid phone number', 'Unknown error'];
 function validatePhoneNumber(phoneNumber, errorMsg) {
     if (errorMsg === void 0) { errorMsg = defaultErrorMsg; }
     if (typeof phoneNumber !== 'string')

dist/src/validateSurname.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var defaultErrorMsg = [
-    'Invalid value passed',
+    'Surname cannot be empty',
     'Surname cannot contain numbers', 'Surname cannot contain special characters',
     'This surname is not valid',
     'Surname too big, try again',

dist/src/validateTextarea.js

@@ -19,11 +19,14 @@ function validateTextarea(textarea, isRequired, maxLength, errorMsg) {
             }
         }
     }
+    var maxTextAreaLength = maxLength || 50;
     function getErrorMessage(index) {
         var errorMessage = errorMsg[index];
+        if (errorMessage === 'This textarea is too big') {
+            return "Textarea cannot exceed ".concat(maxTextAreaLength, " characters");
+        }
         return errorMessage != null ? errorMessage : defaultErrorMsg[index];
     }
-    var maxTextAreaLength = maxLength || 50;
     if (maxTextAreaLength < 1 || typeof maxTextAreaLength !== 'number') {
         throw new Error('maxLength or minLength must be a number and cannot be less than 1');
     }

dist/src/validateUSPhoneNumber.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var defaultErrorMsg = ['Invalid value passed', 'Invalid phone number', 'Unknown error'];
+var defaultErrorMsg = ['US phone number cannot be empty', 'Invalid phone number', 'Unknown error'];
 function validateUSPhoneNumber(phoneNumber, errorMsg) {
     if (errorMsg === void 0) { errorMsg = defaultErrorMsg; }
     if (typeof phoneNumber !== 'string')

dist/src/validateUsername.js

@@ -4,7 +4,7 @@ var regexHasSpaces = /\s/;
 var regexOnlyNumbers = /^\d+$/;
 var regexStartsWithNumber = /^\d/;
 var defaultErrorMsg = [
-    'Invalid value passed',
+    'Username cannot be empty',
     'username too short',
     'This username is too long',
     'Username cannot contain spaces',
@@ -25,8 +25,18 @@ function validateUsername(username, minLength, maxLength, errorMsg) {
             }
         }
     }
+    var minLenthUsername = minLength || 1;
+    var maxLenthUsername = maxLength || Infinity;
     function getErrorMessage(index) {
         var errorMessage = errorMsg[index];
+        if (errorMessage === 'username too short' || errorMessage === 'This username is too long') {
+            if (maxLenthUsername === Infinity) {
+                return "Username must be greater than ".concat(maxLenthUsername, " characters");
+            }
+            else {
+                return "Username must be between ".concat(maxLenthUsername, " and ").concat(maxLenthUsername, " characters");
+            }
+        }
         return errorMessage != null ? errorMessage : defaultErrorMsg[index];
     }
     if (!username) {
@@ -35,8 +45,6 @@ function validateUsername(username, minLength, maxLength, errorMsg) {
             errorMsg: getErrorMessage(0),
         };
     }
-    var minLenthUsername = minLength || 1;
-    var maxLenthUsername = maxLength || Infinity;
     if (typeof minLenthUsername !== 'number' || typeof maxLenthUsername !== 'number') {
         throw new Error('maxLength or minLength must be a number');
     }

index.ts

@@ -27,6 +27,7 @@ import passwordStrengthTester from './src/passwordStrengthTester';
 import validateSurname from './src/validateSurname';
 import validateName from './src/validateName';
 import validateTextarea from './src/validateTextarea';
+import { ValidateFunctions, IsValidFunctions } from './src/types';
 
 export {
 	cpfIsValid,
@@ -57,5 +58,7 @@ export {
   passwordStrengthTester,
   validateName,
   validateSurname,
-  validateTextarea
+  validateTextarea,
+	ValidateFunctions,
+	IsValidFunctions
 };

package.json

@@ -1,6 +1,6 @@
 {
   "name": "multiform-validator",
-  "version": "1.0.26",
+  "version": "1.0.27",
   "description": "Javascript library made to validate, several form fields, such as: email, phone, password, cpf etc.",
   "main": "./dist/index.js",
   "types": "./types/index.d.ts",

src/types/index.ts

@@ -0,0 +1,6 @@
+export interface ValidateFunctions {
+	isValid: boolean;
+	errorMsg: string | null;
+}
+
+export type IsValidFunctions = boolean

src/validateBRPhoneNumber.ts

@@ -1,4 +1,4 @@
-const defaultErrorMsg: string[] = ['Invalid value passed', 'Invalid phone number', 'Unknown error'];
+const defaultErrorMsg: string[] = ['Field phone number cannot be empty', 'Invalid phone number', 'Unknown error'];
 /**
  * @param phoneNumber
  * @param errorMsg optional
@@ -7,7 +7,7 @@ const defaultErrorMsg: string[] = ['Invalid value passed', 'Invalid phone number
  * @description This function returns three errors in the following order:
  *
  * Default:
- * ['Invalid value passed', 'Invalid phone number', 'Unknown error']
+ * ['Field phone number cannot be empty', 'Invalid phone number', 'Unknown error']
  *
  * Create a list of errors separated by commas in strings
  * @returns An object with 'isValid' (boolean) and 'errorMsg' (string) properties.

src/validateEmail.ts

@@ -1,7 +1,7 @@
 import isEmail from './isEmail';
 
 const defaultErrorMsg: string[] = [
-  'Invalid value passed',
+  'Email cannot be empty',
   'This e-mail is not valid',
   'Email too big, try again',
   'This email is not valid in the country',
@@ -29,7 +29,7 @@ const validDomainsDefault: string[] = ['@gmail.com', '@outlook.com', '@yahoo.com
  * If you want to use a default parameter, use null.
  *
  * Default:
- * ['Invalid value passed', 'This e-mail is not valid', 'Email too big, try again', 'This email is not valid in the country','Email domain is not allowed.', 'Unknown error']
+ * ['Email cannot be empty', 'This e-mail is not valid', 'Email cannot be greater than ${maxEmailLength} characters', 'This email is not valid in the country','Email domain is not allowed.', 'Unknown error']
  *
  * Create a list of errors separated by commas in strings
  *
@@ -71,9 +71,15 @@ function validateEmail(email: string, maxLength?: number|null, country: string|n
     }
   }
 
+	const maxEmailLength: number = maxLength || 400;
+
+
   // Função interna para obter a mensagem de erro
   function getErrorMessage(index: number): string {
 		const errorMessage: string|null = errorMsg[index];
+		if(errorMessage === 'Email too big, try again'){
+			return `Email cannot be greater than ${maxEmailLength} characters`;
+		}
 		return errorMessage != null ? errorMessage : defaultErrorMsg[index];
   }
 
@@ -83,7 +89,6 @@ function validateEmail(email: string, maxLength?: number|null, country: string|n
       errorMsg: getErrorMessage(0),
     };
   }
-	const maxEmailLength: number = maxLength || 400;
 
 	if (maxEmailLength < 1 || typeof maxEmailLength !== 'number') throw new Error('maxLength must be a number and cannot be less than 1');
 

src/validateName.ts

@@ -1,5 +1,5 @@
 const defaultErrorMsg: string[] = [
-  'Invalid value passed',
+  'Name cannot be empty',
   'Name cannot contain numbers', 'Name cannot contain special characters',
   'This name is not valid',
   'Name too big, try again',
@@ -19,7 +19,7 @@ const defaultErrorMsg: string[] = [
  * default:
  *
  * [
-  'Invalid value passed',
+  'Name cannot be empty',
   'Name cannot contain numbers',
   'Name cannot contain special characters',
   'This name is not valid',

src/validatePassword.ts

@@ -1,10 +1,10 @@
 const defaultErrorMsg: string[] = [
   'This password is too long',
   'password too short',
-  'Requires at least one capital letter',
-  'Requires at least one special character',
-  'Requires at least one number',
-  'Requires at least one letter',
+  'Password requires at least one capital letter',
+  'Password requires at least one special character',
+  'Password requires at least one number',
+  'Password requires at least one letter',
   'Unknown error',
 ];
 interface Options {
@@ -39,8 +39,8 @@ interface Options {
  *
  * Default:
  *   [
-  'This password is too long',
-  'password too short',
+  'This password is too long',// Password must be between ${minLenthPassword} and ${maxLenthPassword} characters
+  'password too short',// Password must be between ${minLenthPassword} and ${maxLenthPassword} characters
   'Requires at least one capital letter',
   'Requires at least one special character',
   'Requires at least one number',
@@ -72,15 +72,24 @@ function validatePassword(password: string, minLength?: number|null, maxLength?:
     }
   }
 
+	const minLenthPassword: number = minLength || 1;
+  const maxLenthPassword: number = maxLength || Infinity;
+
 
   // Função interna para obter a mensagem de erro
   function getErrorMessage(index: number): string {
 		const errorMessage: string|null = errorMsg[index];
+		if(errorMessage === 'This password is too long' || errorMessage === 'password too short'){
+			if(maxLenthPassword === Infinity){
+				return `Password must be greater than ${minLenthPassword} characters`;
+			}else{
+				return `Password must be between ${minLenthPassword} and ${maxLenthPassword} characters`;
+			}
+		}
 		return errorMessage != null ? errorMessage : defaultErrorMsg[index];
   }
 
-  const minLenthPassword: number = minLength || 1;
-  const maxLenthPassword: number = maxLength || Infinity;
+
 
 	if (typeof minLenthPassword !== 'number' || typeof maxLenthPassword !== 'number') {
 		throw new Error('maxLength and/or minLength must be a number');

src/validatePhoneNumber.ts

@@ -1,10 +1,10 @@
-const defaultErrorMsg: string[] = ['Invalid value passed', 'Invalid phone number', 'Unknown error'];
+const defaultErrorMsg: string[] = ['Phone number cannot be empty', 'Invalid phone number', 'Unknown error'];
 /**
  * @param phoneNumber
  * @param errorMsg optional
  * @example validatePhoneNumber('555-123-4567');
  * @example validatePhoneNumber('(555) 123-4567', [null, 'Custom error 2']);
- * @default {errorMsg} ['Invalid value passed', 'Invalid phone number', 'Unknown error']
+ * @default {errorMsg} ['Phone number cannot be empty', 'Invalid phone number', 'Unknown error']
  * @description This function is a generic phone number validator. It can validate phone numbers in various formats depending on the specific implementation.
  * @returns An object with 'isValid' (boolean) and 'errorMsg' (string) properties.
  */

src/validateSurname.ts

@@ -1,5 +1,5 @@
 const defaultErrorMsg: string[] = [
-  'Invalid value passed',
+  'Surname cannot be empty',
   'Surname cannot contain numbers', 'Surname cannot contain special characters',
   'This surname is not valid',
   'Surname too big, try again',
@@ -19,7 +19,7 @@ const defaultErrorMsg: string[] = [
  * default:
  *
  * [
-  'Invalid value passed',
+  'Surname cannot be empty',
   'Surname cannot contain numbers',
   'Surname cannot contain special characters',
   'This surname is not valid',

src/validateTextarea.ts

@@ -10,7 +10,7 @@ const defaultErrorMsg: string[] = [
  *
  * default:
  * [
-  'This textarea is too big',
+  'Textarea cannot exceed ${maxTextAreaLength} characters',
   'Can not be empty',
   'Unknown error',
 ];
@@ -32,13 +32,18 @@ function validateTextarea(textarea: string, isRequired: boolean = false, maxLeng
     }
   }
 
+	const maxTextAreaLength: number = maxLength || 50;
+
+
   // Função interna para obter a mensagem de erro
   function getErrorMessage(index: number): string {
 		const errorMessage: string|null = errorMsg[index];
+		if(errorMessage === 'This textarea is too big'){
+			return `Textarea cannot exceed ${maxTextAreaLength} characters`;
+		}
 		return errorMessage != null ? errorMessage : defaultErrorMsg[index];
   }
 
-	const maxTextAreaLength: number = maxLength || 50;
 
 	if (maxTextAreaLength < 1 || typeof maxTextAreaLength !== 'number') {
 		throw new Error('maxLength or minLength must be a number and cannot be less than 1');