Refactored responses

Author: the-code-genin

src/controllers/auth.ts

@@ -1,6 +1,6 @@
 import { Request, Response } from "express";
 import bcrypt from "bcrypt";
-import { AuthenticationError, ServerError, SuccessResponse } from "../responses";
+import { AuthorizationError, ServerError, SuccessResponse } from "../responses";
 import JWT from "../helpers/jwt";
 import Users, { User } from "../database/users";
 
@@ -16,7 +16,7 @@ export default class AuthController {
                 throw new Error("Email and password combination do not match a user in our system.");
             }
         } catch (e) {
-            return AuthenticationError(res, (e as Error).message);
+            return AuthorizationError(res, (e as Error).message);
         }
 
         return SuccessResponse(res, {

src/middleware/auth.ts

@@ -1,19 +1,19 @@
 import jwt from "../helpers/jwt";
-import { AuthenticationError } from "../responses";
+import { BadRequestError } from "../responses";
 import { NextFunction, Request, Response } from "express";
 import Users, { User } from "../database/users";
 
 export default async function AuthMiddleware(req: Request, res: Response, next: NextFunction) {
     const header = req.get("Authorization") as string;
     if (!/^Bearer (.+)$/i.test(header)) { // Bearer token is not present
-        return AuthenticationError(res, "Bad token.");
+        return BadRequestError(res, "Bad token.");
     }
 
     // Extract user ID from bearer token
     const token = (/^Bearer (.+)$/i.exec(header) as string[])[1].trim();
     const id = jwt.verifyAccessToken(token);
     if (!id) { // Invalid Bearer token
-        return AuthenticationError(res, "Bad/Expired token.");
+        return BadRequestError(res, "Bad/Expired token.");
     }
 
     // Get the user
@@ -26,7 +26,7 @@ export default async function AuthMiddleware(req: Request, res: Response, next:
             throw new Error("Expired auth token.");
         }
     } catch (e) {
-        return AuthenticationError(res, (e as Error).message);
+        return BadRequestError(res, (e as Error).message);
     }
 
     // Pass the user object to the request and execute subsequent requests

src/responses.ts

@@ -6,25 +6,28 @@ export function ApplicationError(res: Response, code: number, type: string, mess
         error: {
             code,
             type,
-            message
-        }
+            message,
+        },
     });
 }
 
-export function InvalidFormDataError(res: Response, message = "Invalid form data!") {
-    return ApplicationError(res, 400, "InvalidFormData", message);
+export function BadRequestError(res: Response, message = "Invalid form data!") {
+    return ApplicationError(res, 400, "BadRequest", message);
 }
 
-export function AuthenticationError(res: Response, message = "User is not Authenticated!") {
-    return ApplicationError(res, 401, "AuthenticationError", message);
+export function AuthorizationError(res: Response, message = "User is not Authenticated!") {
+    return ApplicationError(res, 401, "Authorization", message);
 }
 
 export function ForbiddenError(res: Response, message = "User is forbidden from accessing this resource!") {
-    return ApplicationError(res, 403, "ForbiddenError", message);
+    return ApplicationError(res, 403, "Forbidden", message);
 }
 
-export function NotFoundError(res: Response, message = "The resource you were looking for was not found on this server.") {
-    return ApplicationError(res, 404, "NotFoundError", message);
+export function NotFoundError(
+    res: Response,
+    message = "The resource you were looking for was not found on this server."
+) {
+    return ApplicationError(res, 404, "NotFound", message);
 }
 
 export function ConflictError(res: Response, message = "The resource you are trying to create already exists!") {
@@ -38,6 +41,6 @@ export function ServerError(res: Response, message = "Server Error!") {
 export function SuccessResponse<T>(res: Response, payload: T, status = 200) {
     return res.status(status).json({
         success: true,
-        payload: payload
+        payload: payload,
     });
 }

src/validators/auth.ts

@@ -1,6 +1,6 @@
 import { NextFunction, Request, Response } from "express";
 import Users from "../database/users";
-import { ConflictError, InvalidFormDataError } from "../responses";
+import { ConflictError, BadRequestError } from "../responses";
 import Joi from "joi";
 
 export default class AuthValidator {
@@ -19,7 +19,7 @@ export default class AuthValidator {
         const validationResult = schema.validate(req.body);
 
         if (validationResult.error) {
-            return InvalidFormDataError(res, String(validationResult.error));
+            return BadRequestError(res, String(validationResult.error));
         }
 
         next();
@@ -40,7 +40,7 @@ export default class AuthValidator {
         const validationResult = schema.validate(req.body);
 
         if (validationResult.error) {
-            return InvalidFormDataError(res, String(validationResult.error));
+            return BadRequestError(res, String(validationResult.error));
         } else if (await Users.getUsersWithEmailCount(req.body.email) > 0) {
             return ConflictError(res, "This email is not available.");
         }