feat: enhance cbValidate function to return structured validation results and update tests

Author: gabriel-logan

src/validateUsername.ts

@@ -4,13 +4,12 @@ const defaultErrorMsg: string[] = [
 	"Username cannot be empty",
 	"Username too short",
 	"This username is too long",
-	"Invalid username",
 ];
 
 interface OptionsParams {
 	minLength?: number;
 	maxLength?: number;
-	cbValidate?: (username: string) => boolean;
+	cbValidate?: (username: string) => ValidateFunctions;
 	errorMsg?: (string | null)[];
 }
 
@@ -31,7 +30,7 @@ const defaultOptionsParams: OptionsParams = {
  * @default maxLength number: Infinity
  * @default cbValidate function: undefined
  * @info minLength cannot be greater than maxLength
- * @description This function returns 4 errors in the following order,
+ * @description This function returns 3 errors in the following order,
  *
  * If you want to use a default parameter, use null.
  *
@@ -40,7 +39,6 @@ const defaultOptionsParams: OptionsParams = {
   "Username cannot be empty",
   "Username must be between ${maxLenthUsername} and ${maxLenthUsername} characters",
   "Username must be between ${maxLenthUsername} and ${maxLenthUsername} characters",
-  "Invalid username",
 ];
  *
  * Create a list of errors separated by commas in strings
@@ -101,16 +99,11 @@ function validateUsername(
 		};
 	}
 
-	if (cbValidate && !cbValidate(username)) {
-		return {
-			isValid: false,
-			errorMsg: getErrorMessage(
-				3,
-				errorMsg,
-				minLenthUsername,
-				maxLenthUsername,
-			),
-		};
+	const cbValidateResult: ValidateFunctions | undefined =
+		cbValidate?.(username);
+
+	if (cbValidateResult && !cbValidateResult.isValid) {
+		return cbValidateResult;
 	}
 
 	return {

tests/src/validateUsername.test.ts

@@ -118,14 +118,50 @@ describe("validateUsername", () => {
 		const result = validateUsername("User1232", {
 			minLength: 3,
 			maxLength: 25,
-			cbValidate: (username: string) => username === "User123",
+			cbValidate: (username: string) => {
+				if (username !== "User123") {
+					return {
+						isValid: false,
+						errorMsg: "Invalid username",
+					};
+				}
+
+				return {
+					isValid: true,
+					errorMsg: null,
+				};
+			},
 		});
 		expect(result).toEqual({
 			isValid: false,
 			errorMsg: "Invalid username",
 		});
 	});
 
+	it("should return true based on the cbValidation function", () => {
+		const result = validateUsername("User123", {
+			minLength: 3,
+			maxLength: 25,
+			cbValidate: (username: string) => {
+				if (username !== "User123") {
+					return {
+						isValid: false,
+						errorMsg: "Invalid username",
+					};
+				}
+
+				return {
+					isValid: true,
+					errorMsg: null,
+				};
+			},
+		});
+		expect(result).toEqual({
+			isValid: true,
+			errorMsg: null,
+		});
+	});
+
 	it("should return defaultErrorMsg when passed null to errorMsg index", () => {
 		const result = validateUsername("", {
 			minLength: 3,