express-generator-typescript 2.2.9 → 2.3.1

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

@@ -0,0 +1,47 @@
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+
+import AuthService from '@src/services/AuthService';
+import EnvVars from '@src/constants/EnvVars';
+import { IReq, IRes } from './types/express/misc';
+
+
+
+// **** Types **** //
+
+interface ILoginReq {
+  email: string;
+  password: string;
+}
+
+
+// **** Functions **** //
+
+/**
+ * Login a user.
+ */
+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);
+  // Return
+  return res.status(HttpStatusCodes.OK).end();
+}
+
+/**
+ * Logout the user.
+ */
+function logout(_: IReq, res: IRes) {
+  const { Key, Options } = EnvVars.CookieProps;
+  res.clearCookie(Key, Options);
+  return res.status(HttpStatusCodes.OK).end();
+}
+
+
+// **** Export default **** //
+
+export default {
+  login,
+  logout,
+} as const;

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

@@ -0,0 +1,53 @@
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+
+import UserService from '@src/services/UserService';
+import { IUser } from '@src/models/User';
+import { IReq, IRes } from './types/express/misc';
+
+
+// **** Functions **** //
+
+/**
+ * Get all users.
+ */
+async function getAll(_: IReq, res: IRes) {
+  const users = await UserService.getAll();
+  return res.status(HttpStatusCodes.OK).json({ users });
+}
+
+/**
+ * Add one user.
+ */
+async function add(req: IReq<{user: IUser}>, res: IRes) {
+  const { user } = req.body;
+  await UserService.addOne(user);
+  return res.status(HttpStatusCodes.CREATED).end();
+}
+
+/**
+ * Update one user.
+ */
+async function update(req: IReq<{user: IUser}>, res: IRes) {
+  const { user } = req.body;
+  await UserService.updateOne(user);
+  return res.status(HttpStatusCodes.OK).end();
+}
+
+/**
+ * Delete one user.
+ */
+async function delete_(req: IReq, res: IRes) {
+  const id = +req.params.id;
+  await UserService.delete(id);
+  return res.status(HttpStatusCodes.OK).end();
+}
+
+
+// **** Export default **** //
+
+export default {
+  getAll,
+  add,
+  update,
+  delete: delete_,
+} as const;

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

@@ -1,66 +1,73 @@
 import { Router } from 'express';
 import jetValidator from 'jet-validator';
 
-import adminMw from './shared/adminMw';
+import adminMw from './middleware/adminMw';
+import Paths from './constants/Paths';
 import User from '@src/models/User';
-import authRoutes from './auth-routes';
-import userRoutes from './user-routes';
+import AuthRoutes from './AuthRoutes';
+import UserRoutes from './UserRoutes';
 
 
-// **** Init **** //
+// **** Variables **** //
 
 const apiRouter = Router(),
   validate = jetValidator();
 
 
-// **** Setup auth routes **** //
+// **** Setup **** //
 
 const authRouter = Router();
 
 // Login user
 authRouter.post(
-  authRoutes.paths.login,
+  Paths.Auth.Login,
   validate('email', 'password'),
-  authRoutes.login,
+  AuthRoutes.login,
 );
 
 // Logout user
-authRouter.get(authRoutes.paths.logout, authRoutes.logout);
+authRouter.get(
+  Paths.Auth.Logout,
+  AuthRoutes.logout,
+);
 
-// Add authRouter
-apiRouter.use(authRoutes.paths.basePath, authRouter);
+// Add AuthRouter
+apiRouter.use(Paths.Auth.Base, authRouter);
 
 
-// **** Setup user routes **** //
+// ** Add UserRouter ** //
 
 const userRouter = Router();
 
 // Get all users
-userRouter.get(userRoutes.paths.get, userRoutes.getAll);
+userRouter.get(
+  Paths.Users.Get,
+  UserRoutes.getAll,
+);
 
 // Add one user
 userRouter.post(
-  userRoutes.paths.add,
+  Paths.Users.Add,
   validate(['user', User.instanceOf]),
-  userRoutes.add,
+  UserRoutes.add,
 );
 
 // Update one user
 userRouter.put(
-  userRoutes.paths.update,
+  Paths.Users.Update,
   validate(['user', User.instanceOf]),
-  userRoutes.update,
+  UserRoutes.update,
 );
 
 // Delete one user
 userRouter.delete(
-  userRoutes.paths.delete,
+  Paths.Users.Delete,
   validate(['id', 'number', 'params']),
-  userRoutes.delete,
+  UserRoutes.delete,
 );
 
-// Add userRouter
-apiRouter.use(userRoutes.paths.basePath, adminMw, userRouter);
+// Add UserRouter
+apiRouter.use(Paths.Users.Base, adminMw, userRouter);
 
 
 // **** Export default **** //

package/lib/project-files/src/routes/constants/FullPaths.ts

@@ -0,0 +1,40 @@
+
+/**
+ * Convert paths to full paths.
+ */
+
+import Paths, { TPaths } from './Paths';
+
+
+interface IPathObj {
+  Base: string;
+  [key: string]: string | IPathObj;
+}
+
+/**
+ * The recursive function.
+ */
+function getFullPaths(
+  parent: IPathObj,
+  baseUrl: string,
+): IPathObj {
+  const url = (baseUrl + parent.Base),
+    keys = Object.keys(parent),
+    retVal: IPathObj = { Base: url };
+  // Iterate keys
+  for (const key of keys) {
+    const pval = parent[key];
+    if (key !== 'Base' && typeof pval === 'string') {
+      retVal[key] = (url + pval);
+    } else if (typeof pval === 'object') {
+      retVal[key] = getFullPaths(pval, url);
+    }
+  }
+  // Return
+  return retVal;
+}
+
+
+// **** Export default **** //
+
+export default getFullPaths(Paths, '') as TPaths;

package/lib/project-files/src/routes/constants/Paths.ts

@@ -0,0 +1,28 @@
+/**
+ * Express router paths go here.
+ */
+
+import { Immutable } from '@src/other/types';
+
+
+const Paths = {
+  Base: '/api',
+  Auth: {
+    Base: '/auth',
+    Login: '/login',
+    Logout: '/logout',
+  },
+  Users: {
+    Base: '/users',
+    Get: '/all',
+    Add: '/add',
+    Update: '/update',
+    Delete: '/delete/:id',
+  },
+};
+
+
+// **** Export **** //
+
+export type TPaths = Immutable<typeof Paths>;
+export default Paths as TPaths;

package/lib/project-files/src/routes/{shared → middleware}/adminMw.ts

@@ -5,27 +5,17 @@
 import { Request, Response, NextFunction } from 'express';
 import { JwtPayload } from 'jsonwebtoken';
 
-import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
-import EnvVars from '@src/declarations/major/EnvVars';
-import jwtUtil from '@src/util/jwt-util';
-import { IUser, UserRoles } from '@src/models/User';
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import EnvVars from '@src/constants/EnvVars';
 
-
-// **** Variables **** //
-
-const jwtNotPresentErr = 'JWT not present in signed cookie.',
-  userUnauthErr = 'User not authorized to perform this action';
+import JwtUtil from '@src/util/JwtUtil';
+import { ISessionUser, UserRoles } from '@src/models/User';
 
 
+// **** Variables **** //
 
-// **** Types **** //
-
-export interface ISessionUser extends JwtPayload {
-  id: number;
-  email: string;
-  name: string;
-  role: IUser['role'];
-}
+const JWT_NOT_PRESENT_ERR = 'JWT not present in signed cookie.',
+  USER_UNAUTHORIZED_ERR = 'User not authorized to perform this action';
 
 
 // **** Functions **** //
@@ -39,15 +29,15 @@ async function adminMw(
   next: NextFunction,
 ) {
   // Extract the token
-  const cookieName = EnvVars.cookieProps.key,
-    jwt = req.signedCookies[cookieName];
+  const { Key } = EnvVars.CookieProps,
+    jwt = req.signedCookies[Key];
   if (!jwt) {
     return res
       .status(HttpStatusCodes.UNAUTHORIZED)
-      .json({ error: jwtNotPresentErr });
+      .json({ error: JWT_NOT_PRESENT_ERR });
   }
   // Make sure user role is an admin
-  const clientData = await jwtUtil.decode<ISessionUser>(jwt);
+  const clientData = await JwtUtil.decode<ISessionUser & JwtPayload>(jwt);
   if (
     typeof clientData === 'object' &&
     clientData.role === UserRoles.Admin
@@ -58,7 +48,7 @@ async function adminMw(
   } else {
     return res
       .status(HttpStatusCodes.UNAUTHORIZED)
-      .json({ error: userUnauthErr });
+      .json({ error: USER_UNAUTHORIZED_ERR });
   }
 }
 

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

@@ -0,0 +1,16 @@
+import * as e from 'express';
+
+import { ISessionUser } from '@src/models/User';
+
+
+// **** Express **** //
+
+export interface IReq<T = void> extends e.Request {
+  body: T;
+}
+
+export interface IRes extends e.Response {
+  locals: {
+    sessionUser?: ISessionUser;
+  };
+}

package/lib/project-files/src/routes/{shared → types}/types.ts

@@ -1,7 +1,7 @@
 import * as e from 'express';
 import { Query } from 'express-serve-static-core';
 
-import { ISessionUser } from '@src/routes/shared/adminMw';
+import { ISessionUser } from '@src/models/User';
 
 
 // **** Express **** //

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

@@ -1,4 +1,4 @@
-import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 
 import userService from '@src/services/user-service';
 import { IUser } from '@src/models/User';
@@ -8,13 +8,7 @@ import { IReq, IRes } from './shared/types';
 // **** Variables **** //
 
 // Paths
-const paths = {
-  basePath: '/users',
-  get: '/all',
-  add: '/add',
-  update: '/update',
-  delete: '/delete/:id',
-} as const;
+
 
 
 // **** Functions **** //

package/lib/project-files/src/server.ts

@@ -1,47 +1,52 @@
+/**
+ * Setup express server.
+ */
+
 import cookieParser from 'cookie-parser';
 import morgan from 'morgan';
 import path from 'path';
 import helmet from 'helmet';
 import express, { Request, Response, NextFunction } from 'express';
+import logger from 'jet-logger';
 
 import 'express-async-errors';
 
-import BaseRouter from './routes/api';
-import logger from 'jet-logger';
-import EnvVars from '@src/declarations/major/EnvVars';
-import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
-import { NodeEnvs } from '@src/declarations/enums';
-import { RouteError } from '@src/declarations/classes';
+import BaseRouter from '@src/routes/api';
+import Paths from '@src/routes/constants/Paths';
+
+import EnvVars from '@src/constants/EnvVars';
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 
+import { NodeEnvs } from '@src/constants/misc';
+import { RouteError } from '@src/other/classes';
 
-// **** Init express **** //
+
+// **** Variables **** //
 
 const app = express();
 
 
-// **** Set basic express settings **** //
+// **** Setup **** //
 
+// Basic middleware
 app.use(express.json());
 app.use(express.urlencoded({extended: true}));
-app.use(cookieParser(EnvVars.cookieProps.secret));
+app.use(cookieParser(EnvVars.CookieProps.Secret));
 
 // Show routes called in console during development
-if (EnvVars.nodeEnv === NodeEnvs.Dev) {
+if (EnvVars.NodeEnv === NodeEnvs.Dev) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (EnvVars.nodeEnv === NodeEnvs.Production) {
+if (EnvVars.NodeEnv === NodeEnvs.Production) {
   app.use(helmet());
 }
 
+// Add APIs, must be after middleware
+app.use(Paths.Base, BaseRouter);
 
-// **** Add API routes **** //
-
-// Add APIs
-app.use('/api', BaseRouter);
-
-// Setup error handler
+// Add error handler
 app.use((
   err: Error,
   _: Request,
@@ -49,7 +54,9 @@ app.use((
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   next: NextFunction,
 ) => {
-  logger.err(err, true);
+  if (EnvVars.NodeEnv !== NodeEnvs.Test) {
+    logger.err(err, true);
+  }
   let status = HttpStatusCodes.BAD_REQUEST;
   if (err instanceof RouteError) {
     status = err.status;
@@ -58,7 +65,7 @@ app.use((
 });
 
 
-// **** Serve front-end content **** //
+// ** Front-End Content ** //
 
 // Set views directory (html)
 const viewsDir = path.join(__dirname, 'views');
@@ -70,12 +77,12 @@ app.use(express.static(staticDir));
 
 // Nav to login pg by default
 app.get('/', (_: Request, res: Response) => {
-  res.sendFile('login.html', {root: viewsDir});
+  res.sendFile('login.html', { root: viewsDir });
 });
 
 // Redirect to login if not logged in.
 app.get('/users', (req: Request, res: Response) => {
-  const jwt = req.signedCookies[EnvVars.cookieProps.key];
+  const jwt = req.signedCookies[EnvVars.CookieProps.Key];
   if (!jwt) {
     res.redirect('/');
   } else {

package/lib/project-files/src/services/{auth-service.ts → AuthService.ts}

@@ -1,16 +1,18 @@
-import userRepo from '@src/repos/user-repo';
-import jwtUtil from '@src/util/jwt-util';
-import pwdUtil from '@src/util/pwd-util';
-import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
-import { RouteError } from '@src/declarations/classes';
-import { tick } from '@src/declarations/functions';
+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';
 
 
 // **** Variables **** //
 
 // Errors
-export const errors = {
-  unauth: 'Unauthorized',
+export const Errors = {
+  Unauth: 'Unauthorized',
   emailNotFound: (email: string) => `User with email "${email}" not found`,
 } as const;
 
@@ -22,26 +24,26 @@ export const errors = {
  */
 async function getJwt(email: string, password: string): Promise<string> {
   // Fetch user
-  const user = await userRepo.getOne(email);
+  const user = await UserRepo.getOne(email);
   if (!user) {
     throw new RouteError(
       HttpStatusCodes.UNAUTHORIZED,
-      errors.emailNotFound(email),
+      Errors.emailNotFound(email),
     );
   }
   // Check password
-  const hash = (user.pwdHash ?? '');
-  const pwdPassed = await pwdUtil.compare(password, hash);
+  const hash = (user.pwdHash ?? ''),
+    pwdPassed = await PwdUtil.compare(password, hash);
   if (!pwdPassed) {
     // If password failed, wait 500ms this will increase security
     await tick(500);
     throw new RouteError(
       HttpStatusCodes.UNAUTHORIZED, 
-      errors.unauth,
+      Errors.Unauth,
     );
   }
   // Setup Admin Cookie
-  return jwtUtil.sign({
+  return JwtUtil.sign({
     id: user.id,
     email: user.name,
     name: user.name,

package/lib/project-files/src/services/{user-service.ts → UserService.ts}

@@ -1,12 +1,12 @@
-import userRepo from '@src/repos/user-repo';
+import UserRepo from '@src/repos/UserRepo';
 import { IUser } from '@src/models/User';
-import { RouteError } from '@src/declarations/classes';
-import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
+import { RouteError } from '@src/other/classes';
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 
 
 // **** Variables **** //
 
-export const userNotFoundErr = 'User not found';
+export const USER_NOT_FOUND_ERR = 'User not found';
 
 
 // **** Functions **** //
@@ -15,44 +15,44 @@ export const userNotFoundErr = 'User not found';
  * Get all users.
  */
 function getAll(): Promise<IUser[]> {
-  return userRepo.getAll();
+  return UserRepo.getAll();
 }
 
 /**
  * Add one user.
  */
 function addOne(user: IUser): Promise<void> {
-  return userRepo.add(user);
+  return UserRepo.add(user);
 }
 
 /**
  * Update one user.
  */
 async function updateOne(user: IUser): Promise<void> {
-  const persists = await userRepo.persists(user.id);
+  const persists = await UserRepo.persists(user.id);
   if (!persists) {
     throw new RouteError(
       HttpStatusCodes.NOT_FOUND,
-      userNotFoundErr,
+      USER_NOT_FOUND_ERR,
     );
   }
   // Return user
-  return userRepo.update(user);
+  return UserRepo.update(user);
 }
 
 /**
  * Delete a user by their id.
  */
 async function _delete(id: number): Promise<void> {
-  const persists = await userRepo.persists(id);
+  const persists = await UserRepo.persists(id);
   if (!persists) {
     throw new RouteError(
       HttpStatusCodes.NOT_FOUND,
-      userNotFoundErr,
+      USER_NOT_FOUND_ERR,
     );
   }
   // Delete user
-  return userRepo.delete(id);
+  return UserRepo.delete(id);
 }
 
 

package/lib/project-files/src/util/{jwt-util.ts → JwtUtil.ts}

@@ -1,17 +1,17 @@
 import jsonwebtoken from 'jsonwebtoken';
-import EnvVars from '../declarations/major/EnvVars';
+import EnvVars from '../constants/EnvVars';
 
 
 // **** Variables **** //
 
 // Errors
-const errors = {
-  validation: 'JSON-web-token validation failed.',
+const Errors = {
+  Validation: 'JSON-web-token validation failed.',
 } as const;
 
 // Options
-const options = {
-  expiresIn: EnvVars.jwt.exp,
+const Options = {
+  expiresIn: EnvVars.Jwt.Exp,
 };
 
 
@@ -22,7 +22,7 @@ const options = {
  */
 function sign(data: string | object | Buffer): Promise<string> {
   return new Promise((res, rej) => {
-    jsonwebtoken.sign(data, EnvVars.jwt.secret, options, (err, token) => {
+    jsonwebtoken.sign(data, EnvVars.Jwt.Secret, Options, (err, token) => {
       return err ? rej(err) : res(token || '');
     });
   });
@@ -33,8 +33,8 @@ function sign(data: string | object | Buffer): Promise<string> {
  */
 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);
+    jsonwebtoken.verify(jwt, EnvVars.Jwt.Secret, (err, decoded) => {
+      return err ? rej(Errors.Validation) : res(decoded as T);
     });
   });
 }

package/lib/project-files/src/util/{pwd-util.ts → PwdUtil.ts}

@@ -3,7 +3,7 @@ import bcrypt from 'bcrypt';
 
 // **** Variables **** //
 
-const saltRounds = 12;
+const SALT_ROUNDS = 12;
 
 
 // **** Functions **** //
@@ -12,14 +12,14 @@ const saltRounds = 12;
  * Get a hash from the password.
  */
 function getHash(pwd: string): Promise<string> {
-  return bcrypt.hash(pwd, saltRounds);
+  return bcrypt.hash(pwd, SALT_ROUNDS);
 }
 
 /**
  * Useful for testing.
  */
 function hashSync(pwd: string): string {
-  return bcrypt.hashSync(pwd, saltRounds);
+  return bcrypt.hashSync(pwd, SALT_ROUNDS);
 }
 
 /**