express-generator-typescript 2.3.0 → 2.3.2

package/lib/project-files/src/routes/AuthRoutes.ts

@@ -1,9 +1,8 @@
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';
-
+import SessionUtil from '@src/util/SessionUtil';
 import AuthService from '@src/services/AuthService';
-import EnvVars from '@src/constants/EnvVars';
-import { IReq, IRes } from './types/express/misc';
 
+import { IReq, IRes } from './types/express/misc';
 
 
 // **** Types **** //
@@ -21,10 +20,15 @@ interface ILoginReq {
  */
 async function login(req: IReq<ILoginReq>, res: IRes) {
   const { email, password } = req.body;
-  // Add jwt to cookie
-  const jwt = await AuthService.getJwt(email, password);
-  const { Key, Options } = EnvVars.CookieProps;
-  res.cookie(Key, jwt, Options);
+  // Login
+  const user = await AuthService.login(email, password);
+  // Setup Admin Cookie
+  await SessionUtil.addSessionData(res, {
+    id: user.id,
+    email: user.name,
+    name: user.name,
+    role: user.role,
+  });
   // Return
   return res.status(HttpStatusCodes.OK).end();
 }
@@ -33,8 +37,7 @@ async function login(req: IReq<ILoginReq>, res: IRes) {
  * Logout the user.
  */
 function logout(_: IReq, res: IRes) {
-  const { Key, Options } = EnvVars.CookieProps;
-  res.clearCookie(Key, Options);
+  SessionUtil.clearCookie(res);
   return res.status(HttpStatusCodes.OK).end();
 }
 

package/lib/project-files/src/routes/middleware/adminMw.ts

@@ -8,14 +8,18 @@ import { JwtPayload } from 'jsonwebtoken';
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 import EnvVars from '@src/constants/EnvVars';
 
-import JwtUtil from '@src/util/JwtUtil';
+import SessionUtil from '@src/util/SessionUtil';
 import { ISessionUser, UserRoles } from '@src/models/User';
 
 
 // **** Variables **** //
 
-const JWT_NOT_PRESENT_ERR = 'JWT not present in signed cookie.',
-  USER_UNAUTHORIZED_ERR = 'User not authorized to perform this action';
+const USER_UNAUTHORIZED_ERR = 'User not authorized to perform this action';
+
+
+// **** Types **** //
+
+type TSessionData = ISessionUser & JwtPayload;
 
 
 // **** Functions **** //
@@ -28,21 +32,14 @@ async function adminMw(
   res: Response,
   next: NextFunction,
 ) {
-  // Extract the token
-  const { Key } = EnvVars.CookieProps,
-    jwt = req.signedCookies[Key];
-  if (!jwt) {
-    return res
-      .status(HttpStatusCodes.UNAUTHORIZED)
-      .json({ error: JWT_NOT_PRESENT_ERR });
-  }
-  // Make sure user role is an admin
-  const clientData = await JwtUtil.decode<ISessionUser & JwtPayload>(jwt);
+  // Get session data
+  const sessionData = await SessionUtil.getSessionData<TSessionData>(req);
+  // Set session data to locals
   if (
-    typeof clientData === 'object' &&
-    clientData.role === UserRoles.Admin
+    typeof sessionData === 'object' &&
+    sessionData?.role === UserRoles.Admin
   ) {
-    res.locals.sessionUser = clientData;
+    res.locals.sessionUser = sessionData;
     return next();
   // Return an unauth error if user is not an admin
   } else {

package/lib/project-files/src/routes/types/express/misc.ts

@@ -11,6 +11,6 @@ export interface IReq<T = void> extends e.Request {
 
 export interface IRes extends e.Response {
   locals: {
-    sessionUser: ISessionUser;
+    sessionUser?: ISessionUser;
   };
 }

package/lib/project-files/src/services/AuthService.ts

@@ -1,11 +1,11 @@
 import UserRepo from '@src/repos/UserRepo';
 
-import JwtUtil from '@src/util/JwtUtil';
 import PwdUtil from '@src/util/PwdUtil';
 import { tick } from '@src/util/misc';
 
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 import { RouteError } from '@src/other/classes';
+import { IUser } from '@src/models/User';
 
 
 // **** Variables **** //
@@ -22,7 +22,7 @@ export const Errors = {
 /**
  * Login a user.
  */
-async function getJwt(email: string, password: string): Promise<string> {
+async function login(email: string, password: string): Promise<IUser> {
   // Fetch user
   const user = await UserRepo.getOne(email);
   if (!user) {
@@ -42,18 +42,13 @@ async function getJwt(email: string, password: string): Promise<string> {
       Errors.Unauth,
     );
   }
-  // Setup Admin Cookie
-  return JwtUtil.sign({
-    id: user.id,
-    email: user.name,
-    name: user.name,
-    role: user.role,
-  });
+  // Return
+  return user;
 }
 
 
 // **** Export default **** //
 
 export default {
-  getJwt,
+  login,
 } as const;

package/lib/project-files/src/util/SessionUtil.ts

@@ -0,0 +1,92 @@
+import { Request, Response } from 'express';
+
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import { RouteError } from '@src/other/classes';
+import jsonwebtoken from 'jsonwebtoken';
+
+import EnvVars from '../constants/EnvVars';
+
+
+// **** Variables **** //
+
+// Errors
+const Errors = {
+  ParamFalsey: 'Param is falsey',
+  Validation: 'JSON-web-token validation failed.',
+} as const;
+
+// Options
+const Options = {
+  expiresIn: EnvVars.Jwt.Exp,
+};
+
+
+// **** Functions **** //
+
+/**
+ * Get session data from request object (i.e. ISessionUser)
+ */
+function getSessionData<T>(req: Request): Promise<string | T | undefined> {
+  const { Key } = EnvVars.CookieProps,
+    jwt = req.signedCookies[Key];
+  return _decode(jwt);
+}
+
+/**
+ * Add a JWT to the response 
+ */
+async function addSessionData(
+  res: Response,
+  data: string | object,
+): Promise<Response> {
+  if (!res || !data) {
+    throw new RouteError(HttpStatusCodes.BAD_REQUEST, Errors.ParamFalsey);
+  }
+  // Setup JWT
+  const jwt = await _sign(data),
+    { Key, Options } = EnvVars.CookieProps;
+  // Return
+  return res.cookie(Key, jwt, Options);
+}
+
+/**
+ * Remove cookie
+ */
+function clearCookie(res: Response): Response {
+  const { Key, Options } = EnvVars.CookieProps;
+  return res.clearCookie(Key, Options);
+}
+
+
+// **** Helper Functions **** //
+
+/**
+ * Encrypt data and return jwt.
+ */
+function _sign(data: string | object | Buffer): Promise<string> {
+  return new Promise((res, rej) => {
+    jsonwebtoken.sign(data, EnvVars.Jwt.Secret, Options, (err, token) => {
+      return err ? rej(err) : res(token || '');
+    });
+  });
+}
+
+/**
+ * Decrypt JWT and extract client data.
+ */
+function _decode<T>(jwt: string): Promise<string | undefined | T> {
+  return new Promise((res, rej) => {
+    jsonwebtoken.verify(jwt, EnvVars.Jwt.Secret, (err, decoded) => {
+      return err ? rej(Errors.Validation) : res(decoded as T);
+    });
+  });
+}
+
+
+// **** Export default **** //
+
+export default {
+  addSessionData,
+  getSessionData,
+  clearCookie,
+} as const;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
   "scripts": {
     "express-generator-typescript": "node bin/cli.js",

package/lib/project-files/src/util/JwtUtil.ts

@@ -1,48 +0,0 @@
-import jsonwebtoken from 'jsonwebtoken';
-import EnvVars from '../constants/EnvVars';
-
-
-// **** Variables **** //
-
-// Errors
-const Errors = {
-  Validation: 'JSON-web-token validation failed.',
-} as const;
-
-// Options
-const Options = {
-  expiresIn: EnvVars.Jwt.Exp,
-};
-
-
-// **** Functions **** //
-
-/**
- * Encrypt data and return jwt.
- */
-function sign(data: string | object | Buffer): Promise<string> {
-  return new Promise((res, rej) => {
-    jsonwebtoken.sign(data, EnvVars.Jwt.Secret, Options, (err, token) => {
-      return err ? rej(err) : res(token || '');
-    });
-  });
-}
-
-/**
- * Decrypt JWT and extract client data.
- */
-function decode<T>(jwt: string): Promise<string | undefined | T> {
-  return new Promise((res, rej) => {
-    jsonwebtoken.verify(jwt, EnvVars.Jwt.Secret, (err, decoded) => {
-      return err ? rej(Errors.Validation) : res(decoded as T);
-    });
-  });
-}
-
-
-// **** Export default **** //
-
-export default {
-  sign,
-  decode,
-} as const;