Source: api/utility/user.utility.js

  1. /**
  2.  * @module userUtility
  3.  * @description Provides utility functions for user validation.
  4.  */
  6. /**
  7.  * Validates the request body for required fields.
  8.  * @param {Object} body - The request body.
  9.  * @param {string[]} requiredFields - The list of required fields.
  10.  * @throws {Error} - Throws an error if any of the required fields are missing.
  11.  * @memberof module:userUtility
  12.  */
  13. const validateRequestBody = (body, requiredFields) => {
  14. 	for (const field of requiredFields) {
  15. 		if (!body?.[field]) {
  16. 			throw new Error(`Please provide a ${field}`);
  17. 		}
  18. 	}
  19. };
  21. /**
  22.  * Validates the user's name.
  23.  * @param {string} name - The name of the user.
  24.  * @throws {Error} - Throws an error if the name is invalid.
  25.  * @memberof module:userUtility
  26.  */
  27. const validateName = (name) => {
  28. 	if (!name) {
  29. 		throw new Error('Name is required');
  30. 	}
  31. 	if (name.trim().split(' ').length < 2) {
  32. 		throw new Error('Invalid name. Please provide your first and last name');
  33. 	}
  34. };
  36. /**
  37.  * Validates the user's email.
  38.  * @param {string} email - The email of the user.
  39.  * @throws {Error} - Throws an error if the email is invalid.
  40.  * @memberof module:userUtility
  41.  */
  42. const validateEmail = (email) => {
  43. 	if (!email) {
  44. 		throw new Error('Email is required');
  45. 	}
  46. 	const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
  47. 	if (!emailRegex.test(email)) {
  48. 		throw new Error('Invalid email. Please provide a valid email address');
  49. 	}
  50. };
  52. /**
  53.  * Validates the user's password.
  54.  * @param {string} password - The password of the user.
  55.  * @throws {Error} - Throws an error if the password is invalid.
  56.  * @memberof module:userUtility
  57.  */
  58. const validatePassword = (password) => {
  59. 	if (!password) {
  60. 		throw new Error('Password is required');
  61. 	}
  62. 	if (password.length < 5 || !/\d/.test(password)) {
  63. 		throw new Error(
  64. 			'Invalid password. Password must be at least 5 characters long and contain at least one number',
  65. 		);
  66. 	}
  67. };
  69. /**
  70.  * Validates the user's registration data.
  71.  * @param {string} name - The name of the user.
  72.  * @param {string} email - The email of the user.
  73.  * @param {string} password - The password of the user.
  74.  * @throws {Error} - Throws an error if any of the registration data is invalid.
  75.  * @memberof module:userUtility
  76.  */
  77. const validateUserRegistration = (name, email, password) => {
  78. 	validateName(name);
  79. 	validateEmail(email);
  80. 	validatePassword(password);
  81. };
  83. module.exports = {
  84. 	validateRequestBody,
  85. 	validateUserRegistration,
  86. 	validateName,
  87. 	validateEmail,
  88. 	validatePassword,
  89. };