Skip to content

docs/add-description-for-auth-controller-function #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mdawoud27 merged 1 commit into from
Mar 29, 2025
Merged

docs/add-description-for-auth-controller-function #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 48 additions & 2 deletions src/controllers/auth.controller.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,12 @@ import {
import { googleVerifyIdToken } from '../utils/googleVerifyToken.utils.js';

/* eslint no-undef:off */
// Authentication Controllers
/**
* @desc Register a new user
* @route /api/auth/signup
* @method POST
* @access public
*/
export const signup = async (req, res, next) => {
try {
const { error } = signupValidation(req.body);
Expand Down Expand Up @@ -83,6 +88,12 @@ export const signup = async (req, res, next) => {
}
};

/**
* @desc Verify user's email address using verification token
* @route /api/auth/verifyEmail
* @method POST
* @access public
*/
export const verifyEmail = async (req, res, next) => {
try {
const { error } = verifyEmailValidation(req.body);
Expand Down Expand Up @@ -124,6 +135,12 @@ export const verifyEmail = async (req, res, next) => {
}
};

/**
* @desc Authenticate user and return access token
* @route /api/auth/signin
* @method POST
* @access public
*/
export const signin = async (req, res, next) => {
try {
const { email, password } = req.body;
Expand Down Expand Up @@ -182,6 +199,12 @@ export const signin = async (req, res, next) => {
}
};

/**
* @desc Initiate password reset process by sending reset token to user's email
* @route /api/auth/forgotPassword
* @method POST
* @access public
*/
export const forgotPassword = async (req, res, next) => {
try {
const { error } = forgotPasswordValidation();
Expand Down Expand Up @@ -229,6 +252,12 @@ export const forgotPassword = async (req, res, next) => {
}
};

/**
* @desc Reset user's password using valid reset token
* @route /api/auth/resetPassword
* @method POST
* @access public
*/
export const resetPassword = async (req, res, next) => {
try {
const { error } = resetPasswordValidation();
Expand Down Expand Up @@ -276,6 +305,12 @@ export const resetPassword = async (req, res, next) => {
}
};

/**
* @desc Generate new access token using refresh token
* @route /api/auth/refreshAccessToken
* @method POST
* @access public
*/
export const refreshAccessToken = async (req, res, next) => {
try {
const { refreshToken } = req.body;
Expand Down Expand Up @@ -310,11 +345,22 @@ export const refreshAccessToken = async (req, res, next) => {
}
};

/**
* @desc Handle Google OAuth callback after successful authentication
* @route /auth/google/callback
* @method GET
* @access public
*/
export const googleOAuthCallback = (req, res) => {
res.status(200).json({ message: 'user signup successfully' });
};

// Google OAuth Login Controller
/**
* @desc Authenticate or register user using Google OAuth (for mobile/SPA)
* @route /auth/google
* @method POST
* @access public
*/
export const googleOAuthLogin = async (req, res) => {
try {
const { idToken } = req.body;
Expand Down