express-generator-typescript 2.2.0 → 2.2.2

package/lib/project-files/src/routes/middlware/validate.ts

@@ -36,13 +36,19 @@
 
 import { Request, Response, NextFunction, RequestHandler } from 'express';
 
-import { ParamInvalidError, ValidatorFnError } from 'src/declarations/errors';
-import { TAll } from 'src/declarations/types';
+import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import { TAll } from '@src/declarations/types';
+
+
+// **** Variables **** //
+
+export const paramInvalidErr = 'One or more of the required params was ' + 
+  'missing or invalid.';
 
 
 // **** Types **** //
 
-type TLoopFn = (req: Request) => void;
+type TLoopFn = (req: Request) => boolean;
 type TValidatorFn =  ((arg: TAll) => boolean);
 type TReqObjProps = 'body' | 'query' | 'params';
 
@@ -69,7 +75,7 @@ function validate(...params: Array<string | TParamArr>): RequestHandler {
   const loopFns: TLoopFn[] = [];
   for (const param of params) {
     const { paramName, type, reqObjProp } = getParamFields(param);
-    let loopFn: TLoopFn = () => { return; };
+    let loopFn: TLoopFn = () => false;
     if (type === 'string') {
       loopFn = checkStr(reqObjProp, paramName);
     } else if (type === 'number') {
@@ -85,11 +91,15 @@ function validate(...params: Array<string | TParamArr>): RequestHandler {
     loopFns.push(loopFn);
   }
   // Return middlware function
-  return (req: Request, _: Response, next: NextFunction) => {
+  return (req: Request, res: Response, next: NextFunction) => {
     for (const loopFn of loopFns) {
-      loopFn(req);
+      if (!loopFn(req)) {
+        return res
+          .status(HttpStatusCodes.BAD_REQUEST)
+          .json({ error: paramInvalidErr });
+      }
     }
-    next();
+    return next();
   };
 }
 
@@ -139,9 +149,7 @@ function getParamFields(param: string | TParamArr): IParamFields {
  */
 function checkStr(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
   return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    if (typeof toCheck !== 'string') {
-      throw new ParamInvalidError();
-    }
+    return (typeof toCheck === 'string');
   });
 }
 
@@ -151,11 +159,11 @@ function checkStr(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
 function checkNum(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
   return getLoopFn(reqObjProp, paramName, (toCheck) => {
     if (reqObjProp === 'query' || reqObjProp === 'params') {
-      if (isNaN(toCheck as number)) {
-        throw new ParamInvalidError();
-      }
+      return !isNaN(toCheck as number);
     } else if (reqObjProp === 'body' && typeof toCheck !== 'number') {
-      throw new ParamInvalidError();
+      return false;
+    } else {
+      return true;
     }
   });
 }
@@ -166,11 +174,11 @@ function checkNum(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
 function checkBool(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
   return getLoopFn(reqObjProp, paramName, (toCheck) => {
     if (reqObjProp === 'query' || reqObjProp === 'params') {
-      if (!isBool(toCheck as boolean)) {
-        throw new ParamInvalidError();
-      }
+      return isBool(toCheck as boolean);
     } else if (reqObjProp === 'body' && typeof toCheck !== 'boolean') {
-      throw new ParamInvalidError();
+      return false;
+    } else {
+      return true;
     }
   });
 }
@@ -198,9 +206,7 @@ function checkValidatorFn(
   validatorFn: TValidatorFn,
 ) {
   return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    if (!validatorFn(toCheck)) {
-      throw new ValidatorFnError(validatorFn.name);
-    }
+    return validatorFn(toCheck);
   });
 }
 
@@ -213,9 +219,7 @@ function checkDefault(
   type: string,
 ): TLoopFn {
   return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    if (typeof toCheck !== type) {
-      throw new ParamInvalidError();
-    }
+    return (toCheck === type);
   });
 }
 
@@ -225,7 +229,7 @@ function checkDefault(
 function getLoopFn(
   reqObjProp: TReqObjProps,
   paramName: string,
-  cb: (toCheck: TAll) => void,
+  cb: (toCheck: TAll) => boolean,
 ): TLoopFn {
   return (req: Request) => {
     // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access

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

@@ -0,0 +1,22 @@
+import * as e from 'express';
+import { Query } from 'express-serve-static-core';
+
+import { ISessionUser } from '@src/routes/middlware/adminMw';
+
+
+// **** Express **** //
+
+export interface IReq<T = void> extends e.Request {
+  body: T;
+}
+
+export interface IReqQuery<T extends Query, U = void> extends e.Request {
+  query: T;
+  body: U;
+}
+
+export interface IRes extends e.Response {
+  locals: {
+    sessionUser: ISessionUser;
+  };
+}

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

@@ -1,15 +1,12 @@
-import StatusCodes from 'http-status-codes';
+import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
 
-import userService from '@services/user-service';
-import { IUser } from '@models/User';
-import { IReq, IRes } from 'src/declarations/types';
+import userService from '@src/services/user-service';
+import { IUser } from '@src/models/User';
+import { IReq, IRes } from './shared/types';
 
 
 // **** Variables **** //
 
-// Misc
-const { CREATED, OK } = StatusCodes;
-
 // Paths
 const paths = {
   basePath: '/users',
@@ -27,7 +24,7 @@ const paths = {
  */
 async function getAll(_: IReq, res: IRes) {
   const users = await userService.getAll();
-  return res.status(OK).json({ users });
+  return res.status(HttpStatusCodes.OK).json({ users });
 }
 
 /**
@@ -36,7 +33,7 @@ async function getAll(_: IReq, res: IRes) {
 async function add(req: IReq<{user: IUser}>, res: IRes) {
   const { user } = req.body;
   await userService.addOne(user);
-  return res.status(CREATED).end();
+  return res.status(HttpStatusCodes.CREATED).end();
 }
 
 /**
@@ -45,7 +42,7 @@ async function add(req: IReq<{user: IUser}>, res: IRes) {
 async function update(req: IReq<{user: IUser}>, res: IRes) {
   const { user } = req.body;
   await userService.updateOne(user);
-  return res.status(OK).end();
+  return res.status(HttpStatusCodes.OK).end();
 }
 
 /**
@@ -54,7 +51,7 @@ async function update(req: IReq<{user: IUser}>, res: IRes) {
 async function _delete(req: IReq, res: IRes) {
   const id = +req.params.id;
   await userService.delete(id);
-  return res.status(OK).end();
+  return res.status(HttpStatusCodes.OK).end();
 }
 
 

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

@@ -2,17 +2,16 @@ import cookieParser from 'cookie-parser';
 import morgan from 'morgan';
 import path from 'path';
 import helmet from 'helmet';
-import StatusCodes from 'http-status-codes';
 import express, { Request, Response, NextFunction } from 'express';
 
 import 'express-async-errors';
 
 import BaseRouter from './routes/api';
 import logger from 'jet-logger';
-import EnvVars from 'src/configurations/EnvVars';
-import { CustomError } from 'src/declarations/errors';
-
-import { NodeEnvs } from 'src/declarations/enums';
+import EnvVars from '@src/configurations/EnvVars';
+import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import { NodeEnvs } from '@src/declarations/enums';
+import { RouteError } from '@src/declarations/classes';
 
 
 // **** Init express **** //
@@ -44,23 +43,18 @@ app.use('/api', BaseRouter);
 
 // Setup error handler
 app.use((
-  err: Error | CustomError,
+  err: Error,
   _: Request,
   res: Response,
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  __: NextFunction,
+  next: NextFunction,
 ) => {
   logger.err(err, true);
-  // Status
-  const status = (
-    err instanceof CustomError 
-      ? err.HttpStatus 
-      : StatusCodes.BAD_REQUEST
-  );
-  // Return
-  return res.status(status).json({
-    error: err.message,
-  });
+  let status = HttpStatusCodes.BAD_REQUEST;
+  if (err instanceof RouteError) {
+    status = err.status;
+  }
+  return res.status(status).json({ error: err.message });
 });
 
 

package/lib/project-files/src/services/auth-service.ts

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

package/lib/project-files/src/services/user-service.ts

@@ -1,6 +1,12 @@
-import userRepo from '@repos/user-repo';
-import { IUser } from '@models/User';
-import { UserNotFoundError } from 'src/declarations/errors';
+import userRepo from '@src/repos/user-repo';
+import { IUser } from '@src/models/User';
+import { RouteError } from '@src/declarations/classes';
+import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+
+
+// **** Variables **** //
+
+export const userNotFoundErr = 'User not found';
 
 
 // **** Functions **** //
@@ -25,8 +31,12 @@ function addOne(user: IUser): Promise<void> {
 async function updateOne(user: IUser): Promise<void> {
   const persists = await userRepo.persists(user.id);
   if (!persists) {
-    throw new UserNotFoundError();
+    throw new RouteError(
+      HttpStatusCodes.NOT_FOUND,
+      userNotFoundErr,
+    );
   }
+  // Return user
   return userRepo.update(user);
 }
 
@@ -36,8 +46,12 @@ async function updateOne(user: IUser): Promise<void> {
 async function _delete(id: number): Promise<void> {
   const persists = await userRepo.persists(id);
   if (!persists) {
-    throw new UserNotFoundError();
+    throw new RouteError(
+      HttpStatusCodes.NOT_FOUND,
+      userNotFoundErr,
+    );
   }
+  // Delete user
   return userRepo.delete(id);
 }
 

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

@@ -0,0 +1,39 @@
+import bcrypt from 'bcrypt';
+
+
+// **** Variables **** //
+
+const saltRounds = 12;
+
+
+// **** Functions **** //
+
+/**
+ * Get a hash from the password.
+ */
+function getHash(pwd: string): Promise<string> {
+  return bcrypt.hash(pwd, saltRounds);
+}
+
+/**
+ * Useful for testing.
+ */
+function hashSync(pwd: string): string {
+  return bcrypt.hashSync(pwd, saltRounds);
+}
+
+/**
+ * See if a password passes the hash.
+ */
+function compare(pwd: string, hash: string): Promise<boolean> {
+  return bcrypt.compare(pwd, hash);
+}
+
+
+// **** Export Default **** //
+
+export default {
+  getHash,
+  hashSync,
+  compare,
+} as const;

package/lib/project-files/tsconfig.json

@@ -66,27 +66,9 @@
     "skipLibCheck": true,                     /* Skip type checking of declaration files. */
     "forceConsistentCasingInFileNames": true,  /* Disallow inconsistently-cased references to the same file. */
     "paths": {
-      "@repos/*": [
-        "src/repos/*"
+      "@src/*": [
+        "src/*"
       ],
-      "@models/*": [
-        "src/models/*"
-      ],
-      "@shared/*": [
-        "src/declarations/*"
-      ],
-      "@server": [
-        "src/server"
-      ],
-      "@services/*": [
-        "src/services/*"
-      ],
-      "@routes/*": [
-        "src/routes/*"
-      ],
-      "@util/*": [
-        "src/util/*"
-      ]
     },
     "useUnknownInCatchVariables": false
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.2.0",
+  "version": "2.2.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/declarations/errors.ts

@@ -1,54 +0,0 @@
-import HttpStatusCodes from 'http-status-codes';
-
-
-export abstract class CustomError extends Error {
-
-  public readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
-
-  constructor(msg: string, httpStatus: number) {
-    super(msg);
-    this.HttpStatus = httpStatus;
-  }
-}
-
-export class ParamInvalidError extends CustomError {
-
-  public static readonly Msg = 'One or more of the required was missing ' + 
-    'or invalid.';
-  public static readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
-
-  constructor() {
-    super(ParamInvalidError.Msg, ParamInvalidError.HttpStatus);
-  }
-}
-
-export class ValidatorFnError extends CustomError {
-
-  public static readonly Msg = 'Validator function failed. function name: ';
-  public static readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
-
-  constructor(fnName: string) {
-    super(ValidatorFnError.Msg + fnName, ValidatorFnError.HttpStatus);
-  }
-}
-
-export class UserNotFoundError extends CustomError {
-
-  public static readonly Msg = 'A user with the given id does not exists ' + 
-    'in the database.';
-  public static readonly HttpStatus = HttpStatusCodes.NOT_FOUND;
-
-  constructor() {
-    super(UserNotFoundError.Msg, UserNotFoundError.HttpStatus);
-  }
-}
-
-export class UnauthorizedError extends CustomError {
-
-  public static readonly Msg = 'Login failed';
-  public static readonly HttpStatus = HttpStatusCodes.UNAUTHORIZED;
-
-  constructor() {
-    super(UnauthorizedError.Msg, UnauthorizedError.HttpStatus);
-  }
-}