(react-hooks) feat: add phone number validation (#31)

This pull request introduces a new phone number validation feature to
the `@magnidev/react-hooks` package and improves code maintainability
and documentation. The main changes include adding a
`phoneNumberSchema`, implementing a `useValidatePhoneNumber` hook,
updating exports for easier usage, and enhancing documentation for
validation hooks.

### Phone Number Validation

* Added a new `phoneNumberSchema` to `auth-schema.ts` for validating
phone numbers, supporting international formats and length checks.
* Implemented a new `useValidatePhoneNumber` React hook in
`use-validations.ts` to validate phone numbers using the new schema.
* Exported `phoneNumberSchema` and `useValidatePhoneNumber` for use in
other modules.
[[1]](diffhunk://#diff-22e8fc7bf75946e4c7e38e1e5e564c5495734705a91fb49f8f9d85be24f7abe0R195)
[[2]](diffhunk://#diff-32f91bd59d518355999d9c413973fa10bffb51c75d3bc3f05984058a92f0fdc1L70-R82)

### Code Organization and Exports

* Updated `index.ts` to use wildcard exports for both hooks and schemas,
simplifying imports for library consumers.

### Documentation Improvements

* Added JSDoc-style comments to all validation hooks in
`use-validations.ts` to clarify their usage and parameters.
[[1]](diffhunk://#diff-22e8fc7bf75946e4c7e38e1e5e564c5495734705a91fb49f8f9d85be24f7abe0R16-R20)
[[2]](diffhunk://#diff-22e8fc7bf75946e4c7e38e1e5e564c5495734705a91fb49f8f9d85be24f7abe0R43-R47)
[[3]](diffhunk://#diff-22e8fc7bf75946e4c7e38e1e5e564c5495734705a91fb49f8f9d85be24f7abe0R70-R73)
[[4]](diffhunk://#diff-22e8fc7bf75946e4c7e38e1e5e564c5495734705a91fb49f8f9d85be24f7abe0R96-R100)
[[5]](diffhunk://#diff-22e8fc7bf75946e4c7e38e1e5e564c5495734705a91fb49f8f9d85be24f7abe0R132-R162)

### Version Update

* Bumped the package version from `1.0.1` to `1.1.0` to reflect the
addition of new features.

Author: fermeridamagni

packages/react-hooks/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magnidev/react-hooks",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "description": "A collection of reusable React hooks for modern web development, designed to simplify state management, validation, and other common patterns in React applications.",
   "keywords": [
     "react",

packages/react-hooks/src/hooks/use-validations.ts

@@ -4,6 +4,7 @@ import {
   emailSchema,
   nameSchema,
   passwordSchema,
+  phoneNumberSchema,
   usernameSchema,
 } from "../schemas/auth-schema";
 
@@ -12,6 +13,11 @@ type ValidationResult = {
   errors: string[];
 };
 
+/**
+ * Validates an email address.
+ * @param email - The email address to validate.
+ * @returns An object containing the validation result and any error messages.
+ */
 const useValidateEmail = (email?: string): ValidationResult =>
   useMemo(() => {
     const { success, error } = emailSchema().safeParse(email);
@@ -34,6 +40,11 @@ const useValidateEmail = (email?: string): ValidationResult =>
     };
   }, [email]);
 
+/**
+ * Validates a password.
+ * @param password - The password to validate.
+ * @returns An object containing the validation result and any error messages.
+ */
 const useValidatePassword = (password?: string): ValidationResult =>
   useMemo(() => {
     const { success, error } = passwordSchema().safeParse(password);
@@ -56,6 +67,10 @@ const useValidatePassword = (password?: string): ValidationResult =>
     };
   }, [password]);
 
+/** * Validates a name.
+ * @param name - The name to validate.
+ * @returns An object containing the validation result and any error messages.
+ */
 const useValidateName = (name?: string): ValidationResult =>
   useMemo(() => {
     const { success, error } = nameSchema().safeParse(name);
@@ -78,6 +93,11 @@ const useValidateName = (name?: string): ValidationResult =>
     };
   }, [name]);
 
+/** * Validates a username.
+ * @param username - The username to validate.
+ * @param options - Optional settings for validation.
+ * @returns An object containing the validation result and any error messages.
+ */
 const useValidateUsername = (
   username?: string,
   options?: {
@@ -109,6 +129,37 @@ const useValidateUsername = (
     };
   }, [username, options]);
 
+/** * Validates a phone number.
+ * @param phoneNumber - The phone number to validate.
+ * @returns An object containing the validation result and any error messages.
+ */
+const useValidatePhoneNumber = (phoneNumber?: string): ValidationResult =>
+  useMemo(() => {
+    const { success, error } = phoneNumberSchema.safeParse(phoneNumber);
+
+    if (success) {
+      return { isValid: true, errors: [] };
+    }
+
+    const errors: string[] = [];
+
+    if (error.issues.length > 0) {
+      for (const issue of error.issues) {
+        errors.push(issue.message);
+      }
+    }
+
+    return {
+      isValid: errors.length === 0,
+      errors,
+    };
+  }, [phoneNumber]);
+
+/** * Validates text against a provided schema.
+ * @param text - The text to validate.
+ * @param schema - The Zod schema to validate against.
+ * @returns An object containing the validation result and any error messages.
+ */
 const useValidateText = (text: string, schema: z.ZodType): ValidationResult => {
   if (!schema) {
     throw new Error("Schema is required for validation");
@@ -141,6 +192,7 @@ export {
   useValidatePassword,
   useValidateName,
   useValidateUsername,
+  useValidatePhoneNumber,
   useValidateText,
   type ValidationResult,
 };

packages/react-hooks/src/index.ts

@@ -1,16 +1,4 @@
 // biome-ignore lint/performance/noBarrelFile: This is a library entry point, not a barrel file
-export {
-  useValidateEmail,
-  useValidateName,
-  useValidatePassword,
-  useValidateText,
-  useValidateUsername,
-  type ValidationResult,
-} from "./hooks/use-validations";
+export * from "./hooks/use-validations";
 
-export {
-  emailSchema,
-  nameSchema,
-  passwordSchema,
-  usernameSchema,
-} from "./schemas/auth-schema";
+export * from "./schemas/auth-schema";

packages/react-hooks/src/schemas/auth-schema.ts

@@ -67,4 +67,16 @@ const passwordSchema = (): z.ZodType =>
       error: "Must include at least one special character",
     });
 
-export { nameSchema, usernameSchema, emailSchema, passwordSchema };
+const phoneNumberSchema = z
+  .string()
+  .min(10, "Phone number must be at least 10 digits")
+  .max(15, "Phone number must be at most 15 digits")
+  .regex(/^\+?[1-9]\d{1,14}$/, "Invalid phone number format");
+
+export {
+  nameSchema,
+  usernameSchema,
+  emailSchema,
+  passwordSchema,
+  phoneNumberSchema,
+};