express-generator-typescript 2.2.0 → 2.2.1

package/lib/express-generator-typescript.js

@@ -24,15 +24,17 @@ const ncpOpts = {
 };
 
 // Project-folder dependencies
-const dependencies = 'express dotenv http-status-codes morgan cookie-parser jet-logger ' +
-  'module-alias command-line-args express-async-errors helmet jsonfile bcrypt jsonwebtoken';
+const dependencies = 'express dotenv morgan cookie-parser jet-logger ' +
+  'module-alias command-line-args express-async-errors helmet jsonfile ' + 
+  'bcrypt jsonwebtoken';
 
 // Project-folder development dependencies
 const devDependencies = 'ts-node typescript nodemon find jasmine supertest ' +
-  '@types/node @types/express @types/jasmine @types/find @types/morgan @types/cookie-parser ' +
-  '@types/supertest fs-extra tsconfig-paths @types/jsonfile @types/command-line-args ' +
-  '@typescript-eslint/eslint-plugin @typescript-eslint/parser eslint @types/fs-extra ' +
-  '@types/bcrypt @types/jsonwebtoken eslint-plugin-node';
+  '@types/node @types/express @types/jasmine @types/find @types/morgan  ' +
+  '@types/cookie-parser @types/supertest fs-extra tsconfig-paths ' +
+  '@types/jsonfile @types/command-line-args ' +
+  '@typescript-eslint/eslint-plugin @typescript-eslint/parser eslint ' + 
+  '@types/fs-extra @types/bcrypt @types/jsonwebtoken eslint-plugin-node';
 
 
 // **** Functions **** //
@@ -80,11 +82,13 @@ function updatePackageJson(destination) {
  * Because npm does not allow .gitignore to be published.
  */
 function renameGitigoreFile(destination) {
-  return new Promise((res, rej) => {
-    fs.rename(destination + '/gitignore', destination + '/.gitignore', (err) => {
-      return (!!err ? rej(err) : res());
-    });
-  });
+  return new Promise((res, rej) => 
+    fs.rename(
+      (destination + '/gitignore'),
+      (destination + '/.gitignore'),
+      (err => !!err ? rej(err) : res()),
+    )
+  );
 }
 
 /**

package/lib/project-files/package.json

@@ -24,7 +24,8 @@
     "@services": "dist/services",
     "@repos": "dist/repos",
     "@models": "dist/models",
-    "@shared": "dist/shared",
+    "@configurations": "dist/configurations",
+    "@declarations": "dist/declarations",
     "@server": "dist/server",
     "@routes": "dist/routes",
     "@util": "dist/util"
@@ -40,7 +41,6 @@
     "express": "^4.18.1",
     "express-async-errors": "^3.1.1",
     "helmet": "^6.0.0",
-    "http-status-codes": "^2.2.0",
     "jet-logger": "^1.2.3",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "^8.5.1",

package/lib/project-files/spec/support/login-agent.ts

@@ -1,14 +1,12 @@
-import bcrypt from 'bcrypt';
 import { SuperTest, Test, Response } from 'supertest';
 
 import User, { UserRoles } from '@models/User';
 import userRepo from '@repos/user-repo';
+import pwdUtil from '@util/pwd-util';
 
 
 // **** Variables **** //
 
-export const pwdSaltRounds = 12;
-
 const creds = {
   email: 'jsmith@gmail.com',
   password: 'Password@1',
@@ -23,7 +21,7 @@ const creds = {
 function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
   // Setup dummy data
   const role = UserRoles.Admin;
-  const pwdHash = bcrypt.hashSync(creds.password, pwdSaltRounds);
+  const pwdHash = pwdUtil.hashSync(creds.password);
   const loginUser = User.new('john smith', creds.email, role, pwdHash);
   spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
   // Call Login API

package/lib/project-files/spec/tests/auth.spec.ts

@@ -1,15 +1,14 @@
-import bcrypt from 'bcrypt';
-import StatusCodes from 'http-status-codes';
 import supertest, { SuperTest, Test, Response } from 'supertest';
 import logger from 'jet-logger';
 
 import app from '@server';
+import authRoutes from '@routes/auth-routes';
 import userRepo from '@repos/user-repo';
-import EnvVars from 'src/configurations/EnvVars';
+import pwdUtil from '@util/pwd-util';
+import EnvVars from '@configurations/EnvVars';
+import HttpStatusCodes from '@configurations/HttpStatusCodes';
 import User, { UserRoles } from '@models/User';
-import authRoutes from '@routes/auth-routes';
-import { pwdSaltRounds } from 'spec/support/login-agent';
-import { UnauthorizedError } from 'src/declarations/errors';
+import { errors as authServiceErrs } from '@services/auth-service';
 
 
 // **** Variables **** //
@@ -18,21 +17,23 @@ import { UnauthorizedError } from 'src/declarations/errors';
 const { paths } = authRoutes,
   authPath = ('/api' + paths.basePath),
   loginPath = `${authPath}${paths.login}`,
-  logoutPath = `${authPath}${paths.logout}`,
-  { BAD_REQUEST, OK, UNAUTHORIZED } = StatusCodes;
+  logoutPath = `${authPath}${paths.logout}`;
 
 // Test message
 const msgs = {
-  goodLogin: `should return a response with a status of ${OK} and a cookie 
-    with a jwt if the login was successful.`,
-  emailNotFound: `should return a response with a status of ${UNAUTHORIZED} 
-    and a json with the "error ${UnauthorizedError.Msg}" if the email was 
-    not found.`,
-  pwdFailed: `should return a response with a status of ${UNAUTHORIZED} and a 
-    json with the error "${UnauthorizedError.Msg}" if the password failed.`,
-  fallbackErr: `should return a response with a status of ${BAD_REQUEST} and 
-    a json with an error for all other bad responses.`,
-  goodLogout: `should return a response with a status of ${OK}.`,
+  goodLogin: 'should return a response with a status of ' + 
+    `"${HttpStatusCodes.OK}" and a cookie with a jwt if the login was ` + 
+    'successful.',
+  emailNotFound: 'should return a response with a status of ' + 
+    `"${HttpStatusCodes.UNAUTHORIZED}" and a json with an error message if ` + 
+    'the email was not found.',
+  pwdFailed: 'should return a response with a status of ' + 
+    `"${HttpStatusCodes.UNAUTHORIZED}" and a json with the error ` + 
+    `"${authServiceErrs.unauth}" if the password failed.`,
+  fallbackErr: 'should return a response with a status of ' + 
+    `"${HttpStatusCodes.BAD_REQUEST}" and a json with an error for all ` + 
+    'other bad responses.',
+  goodLogout: `should return a response with a status of ${HttpStatusCodes.OK}`,
 } as const;
 
 // Login credentials
@@ -69,14 +70,14 @@ describe('auth-router', () => {
     // Good login
     it(msgs.goodLogin, (done) => {
       const role = UserRoles.Standard;
-      const pwdHash = hashPwd(loginCreds.password);
+      const pwdHash = pwdUtil.hashSync(loginCreds.password);
       const loginUser = User.new('john smith', loginCreds.email, role, pwdHash);
       spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
       // Call API
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(OK);
+          expect(res.status).toBe(HttpStatusCodes.OK);
           const cookie = res.headers['set-cookie'][0];
           expect(cookie).toContain(EnvVars.cookieProps.key);
           done();
@@ -89,8 +90,9 @@ describe('auth-router', () => {
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(UNAUTHORIZED);
-          expect(res.body.error).toBe(UnauthorizedError.Msg);
+          expect(res.status).toBe(HttpStatusCodes.UNAUTHORIZED);
+          const errMsg = authServiceErrs.emailNotFound(loginCreds.email);
+          expect(res.body.error).toBe(errMsg);
           done();
         });
     });
@@ -98,15 +100,15 @@ describe('auth-router', () => {
     // Password failed
     it(msgs.pwdFailed, (done) => {
       const role = UserRoles.Standard;
-      const pwdHash = hashPwd('bad password');
+      const pwdHash = pwdUtil.hashSync('bad password');
       const loginUser = User.new('john smith', loginCreds.email, role, pwdHash);
       spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
       // Call API
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(UNAUTHORIZED);
-          expect(res.body.error).toBe(UnauthorizedError.Msg);
+          expect(res.status).toBe(HttpStatusCodes.UNAUTHORIZED);
+          expect(res.body.error).toBe(authServiceErrs.unauth);
           done();
         });
     });
@@ -117,7 +119,7 @@ describe('auth-router', () => {
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
           expect(res.body.error).toBeTruthy();
           done();
         });
@@ -132,16 +134,9 @@ describe('auth-router', () => {
       agent.get(logoutPath)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(OK);
+          expect(res.status).toBe(HttpStatusCodes.OK);
           done();
         });
     });
   });
 });
-
-
-// **** Helper functions **** //
-
-function hashPwd(pwd: string) {
-  return bcrypt.hashSync(pwd, pwdSaltRounds);
-}

package/lib/project-files/spec/tests/users.spec.ts

@@ -1,5 +1,4 @@
 import supertest from 'supertest';
-import StatusCodes from 'http-status-codes';
 import { SuperTest, Test, Response } from 'supertest';
 import logger from 'jet-logger';
 
@@ -7,13 +6,10 @@ import app from '@server';
 import userRepo from '@repos/user-repo';
 import User, { IUser } from '@models/User';
 import userRoutes from '@routes/user-routes';
-
-import {
-  ParamInvalidError,
-  UserNotFoundError,
-  ValidatorFnError,
-} from 'src/declarations/errors';
+import HttpStatusCodes from '@configurations/HttpStatusCodes';
 import loginAgent from '../support/login-agent';
+import { paramInvalidErr } from '@routes/middlware/validate';
+import { userNotFoundErr } from '@services/user-service';
 
 
 // **** Variables **** //
@@ -24,8 +20,7 @@ const { paths } = userRoutes,
   getUsersPath = `${usersPath}${paths.get}`,
   addUsersPath = `${usersPath}${paths.add}`,
   updateUserPath = `${usersPath}${paths.update}`,
-  deleteUserPath = `${usersPath}${paths.delete}`,
-  { BAD_REQUEST, CREATED, OK } = StatusCodes;
+  deleteUserPath = `${usersPath}${paths.delete}`;
 
 // Dummy users for GET req
 const dummyGetAllUsers = [
@@ -41,35 +36,39 @@ const dummyUserData = {
 
 // Test messages
 const msgs = {
-  getUsersSuccess: `should return a JSON object with all the users and a 
-    status code of "${OK}" if the request was successful.`,
-  getUsersBad: `should return a JSON object containing an error message and a 
-    status code of "${BAD_REQUEST}" if the request was unsuccessful.`,
-  addUserSuccess: `should return a status code of "${CREATED}" if the request 
-    was successful.`,
-  addUserFailedMissingParam: `should return a JSON object with an error 
-    message of "${ValidatorFnError.Msg + 'instanceOf'}" and a status code 
-    of "${BAD_REQUEST}" if the user param was missing.`,
-  addUserFallbackErr: `should return a JSON object with an error message and a 
-    status code of "${BAD_REQUEST}" if the request was unsuccessful.`,
-  updateSuccess: `should return a status code of "${OK}" if the request was 
-    successful.`,
-  updateParamMissing: `should return a JSON object with an error message of 
-    "${ValidatorFnError.Msg + 'instanceOf'}" and a status code of 
-    "${BAD_REQUEST}" if the user param was missing.`,
-  updateUserNotFound: `should return a JSON object with the error message of 
-    ${UserNotFoundError.Msg} and a status code of 
-    "${UserNotFoundError.HttpStatus}" if the id was not found.`,
-  updateFallbackErr: `should return a JSON object with an error message and a 
-    status code of "${BAD_REQUEST}" if the request was unsuccessful.`,
-  deleteSuccessful: `should return a status code of "${OK}" if the request was 
-    successful.`,
-  deleteUserNotFound: `should return a JSON object with the error message of 
-    ${UserNotFoundError.Msg} and a status code of 
-    "${UserNotFoundError.HttpStatus}" if the id was not found.`,
-  deleteFallbackErr: `should return a JSON object with an error message and a 
-    status code of "${BAD_REQUEST}" if the request was unsuccessful.`,
-};
+  getUsersSuccess: 'should return a JSON object with all the users and a ' +
+    `status code of "${HttpStatusCodes.OK}" if the request was successful.`,
+  getUsersBad: 'should return a JSON object containing an error message ' +
+    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the request ` + 
+    'was unsuccessful.',
+  addUserSuccess: 'should return a status code of ' + 
+    `"${HttpStatusCodes.CREATED}" if the request was successful.`,
+  addUserFailedMissingParam: 'should return a JSON object with an error ' +
+    `message of "${paramInvalidErr}" and a status code of ` +
+    `"${HttpStatusCodes.BAD_REQUEST}" if the user param was missing.`,
+  addUserFallbackErr: 'should return a JSON object with an error message ' + 
+    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the request ` + 
+    'was unsuccessful.',
+  updateSuccess: `should return a status code of "${HttpStatusCodes.OK}" if ` + 
+    'the request was successful.',
+  updateParamMissing: 'should return a JSON object with an error message ' +
+    `of "${paramInvalidErr}" and a status code of ` + 
+    `"${HttpStatusCodes.BAD_REQUEST}" if the user param was missing.`,
+  updateUserNotFound: 'should return a JSON object with the error message ' +
+    `of "${userNotFoundErr}" and a status code of ` +
+    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`,
+  updateFallbackErr: 'should return a JSON object with an error message ' +
+    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the request ` + 
+    'was unsuccessful.',
+  deleteSuccessful: `should return a status code of "${HttpStatusCodes.OK}" ` + 
+    'if the request was successful.',
+  deleteUserNotFound: 'should return a JSON object with the error message ' +
+    `of "${userNotFoundErr}" and a status code of ` +
+    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`,
+  deleteFallbackErr: 'should return a JSON object with an error message ' +
+    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the request ` + 
+    'was unsuccessful.',
+} as const;
 
 
 // **** Types **** //
@@ -108,7 +107,7 @@ describe('user-router', () => {
       // Call API
       callApi().end((err: Error, res: Response) => {
         !!err && logger.err(err);
-        expect(res.status).toBe(OK);
+        expect(res.status).toBe(HttpStatusCodes.OK);
         // Caste instance-objects to 'User' objects
         const respUsers = res.body.users;
         const retUsers = respUsers.map((user: IUser) => User.copy(user));
@@ -126,7 +125,7 @@ describe('user-router', () => {
       callApi()
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
           expect(res.body.error).toBe(errMsg);
           done();
         });
@@ -149,7 +148,7 @@ describe('user-router', () => {
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(CREATED);
+          expect(res.status).toBe(HttpStatusCodes.CREATED);
           expect(res.body.error).toBeUndefined();
           done();
         });
@@ -160,8 +159,8 @@ describe('user-router', () => {
       callApi({})
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ValidatorFnError.Msg + 'instanceOf');
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
+          expect(res.body.error).toBe(paramInvalidErr);
           done();
         });
     });
@@ -174,7 +173,7 @@ describe('user-router', () => {
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
           expect(res.body.error).toBe(errMsg);
           done();
         });
@@ -197,7 +196,7 @@ describe('user-router', () => {
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(OK);
+          expect(res.status).toBe(HttpStatusCodes.OK);
           expect(res.body.error).toBeUndefined();
           done();
         });
@@ -208,8 +207,8 @@ describe('user-router', () => {
       callApi({})
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ValidatorFnError.Msg + 'instanceOf');
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
+          expect(res.body.error).toBe(paramInvalidErr);
           done();
         });
     });
@@ -219,8 +218,8 @@ describe('user-router', () => {
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(UserNotFoundError.HttpStatus);
-          expect(res.body.error).toBe(UserNotFoundError.Msg);
+          expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+          expect(res.body.error).toBe(userNotFoundErr);
           done();
         });
     });
@@ -234,7 +233,7 @@ describe('user-router', () => {
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
           expect(res.body.error).toBe(updateErrMsg);
           done();
         });
@@ -258,7 +257,7 @@ describe('user-router', () => {
       callApi(5)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(OK);
+          expect(res.status).toBe(HttpStatusCodes.OK);
           expect(res.body.error).toBeUndefined();
           done();
         });
@@ -269,8 +268,8 @@ describe('user-router', () => {
       callApi(-1)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(UserNotFoundError.HttpStatus);
-          expect(res.body.error).toBe(UserNotFoundError.Msg);
+          expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+          expect(res.body.error).toBe(userNotFoundErr);
           done();
         });
     });
@@ -280,8 +279,8 @@ describe('user-router', () => {
       callApi('horse' as unknown as number)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(ParamInvalidError.HttpStatus);
-          expect(res.body.error).toBe(ParamInvalidError.Msg);
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
+          expect(res.body.error).toBe(paramInvalidErr);
           done();
         });
     });
@@ -295,7 +294,7 @@ describe('user-router', () => {
       callApi(1)
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
-          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
           expect(res.body.error).toBe(deleteErrMsg);
           done();
         });