express-generator-typescript 2.2.9 → 2.3.0

package/lib/express-generator-typescript.js

@@ -4,17 +4,17 @@
  * created by Sean Maxwell, 5/31/2019
  */
 
-const path = require('path');
-const editJsonFile = require('edit-json-file');
-const childProcess = require('child_process');
-const ncp = require('ncp').ncp;
-const fs = require('fs');
+const path = require('path'),
+  editJsonFile = require('edit-json-file'),
+  childProcess = require('child_process'),
+  ncp = require('ncp').ncp,
+  fs = require('fs');
 
 
 // **** Variables **** //
 
 // Misc
-const prjFolder = './project-files';
+const PROJECT_FOLDER_PATH = './project-files';
 
 // ncp options
 const ncpOpts = {
@@ -25,16 +25,16 @@ const ncpOpts = {
 
 // Project-folder dependencies
 const dependencies = 'express dotenv morgan cookie-parser jet-logger ' +
-  'module-alias command-line-args express-async-errors helmet jsonfile ' + 
-  'bcrypt jsonwebtoken jet-validator';
+  'module-alias express-async-errors helmet jsonfile inserturlparams ' + 
+  'bcrypt jsonwebtoken jet-validator ts-command-line-args';
 
 // 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/jsonfile @typescript-eslint/eslint-plugin eslint ' +
+  '@typescript-eslint/parser @types/fs-extra @types/bcrypt ' + 
+  '@types/jsonwebtoken eslint-plugin-node';
 
 
 // **** Functions **** //
@@ -57,7 +57,7 @@ async function expressGenTs(destination, useYarn) {
  * Copy project files
  */
 function copyProjectFiles(destination) {
-  const source = path.join(__dirname, prjFolder);
+  const source = path.join(__dirname, PROJECT_FOLDER_PATH);
   return new Promise((res, rej) => {
     ncp.limit = 16;
     return ncp(source, destination, ncpOpts, (err) => {

package/lib/project-files/.eslintrc.json

@@ -24,6 +24,7 @@
     "no-extra-boolean-cast": 0,
     "semi": 1,
     "indent": ["warn", 2],
+    "quotes": ["warn", "single"],
     "@typescript-eslint/no-misused-promises": 0,
     "@typescript-eslint/no-floating-promises": 0,
     "node/no-process-env": 1,

package/lib/project-files/env/development.env

@@ -13,6 +13,7 @@ JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
 
+
 ## Authentication ##
 COOKIE_DOMAIN=localhost
 COOKIE_PATH=/

package/lib/project-files/env/production.env

@@ -13,6 +13,7 @@ JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
 
+
 ## Authentication ##
 # SECURE_COOKIE 'false' here for demo-ing. But ideally should be true.
 COOKIE_DOMAIN=localhost

package/lib/project-files/env/test.env

@@ -13,6 +13,7 @@ JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
 
+
 ## Authentication ##
 COOKIE_DOMAIN=localhost
 COOKIE_PATH=/

package/lib/project-files/package.json

@@ -28,22 +28,22 @@
   },
   "dependencies": {
     "bcrypt": "^5.0.1",
-    "command-line-args": "^5.2.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.0.2",
     "express": "^4.18.1",
     "express-async-errors": "^3.1.1",
     "helmet": "^6.0.0",
-    "jet-logger": "^1.2.3",
+    "inserturlparams": "^1.0.1",
+    "jet-logger": "^1.3.1",
     "jet-validator": "^1.0.3",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",
-    "morgan": "^1.10.0"
+    "morgan": "^1.10.0",
+    "ts-command-line-args": "^2.4.2"
   },
   "devDependencies": {
     "@types/bcrypt": "^5.0.0",
-    "@types/command-line-args": "^5.2.0",
     "@types/cookie-parser": "^1.4.3",
     "@types/express": "^4.17.13",
     "@types/find": "^0.2.1",

package/lib/project-files/spec/index.ts

@@ -1,18 +1,39 @@
-import './load-env';
+import dotenv from 'dotenv';
 import find from 'find';
 import Jasmine from 'jasmine';
-import commandLineArgs from 'command-line-args';
+import { parse } from 'ts-command-line-args';
 import logger from 'jet-logger';
 
 
-// Setup command line options
-const options = commandLineArgs([
-  {
-    name: 'testFile',
-    alias: 'f',
+// **** Types **** //
+
+interface IArgs {
+  testFile: string;
+}
+
+
+// **** Setup **** //
+
+// ** Init ** //
+
+// NOTE: MUST BE FIRST!! Load env vars
+const result2 = dotenv.config({
+  path: './env/test.env',
+});
+if (result2.error) {
+  throw result2.error;
+}
+
+// Setup command line options. 
+const args = parse<IArgs>({
+  testFile: {
     type: String,
+    defaultValue: '',
   },
-]);
+});
+
+
+// ** Start Jasmine ** //
 
 // Init Jasmine
 const jasmine = new Jasmine();
@@ -30,12 +51,11 @@ jasmine.loadConfig({
 
 // Run all or a single unit-test
 let execResp: Promise<jasmine.JasmineDoneInfo> | undefined;
-if (options.testFile) {
-  const testFile = options.testFile as string;
+if (args.testFile) {
+  const testFile = args.testFile;
   find.file(testFile + '.spec.ts', './spec', (files: string[]) => {
     if (files.length === 1) {
-      jasmine.specFiles = [files[0]];
-      jasmine.execute();
+      jasmine.execute([files[0]]);
     } else {
       logger.err('Test file not found!');
     }

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

@@ -0,0 +1,43 @@
+import { SuperTest, Test, Response } from 'supertest';
+
+import User, { UserRoles } from '@src/models/User';
+import UserRepo from '@src/repos/UserRepo';
+import PwdUtil from '@src/util/PwdUtil';
+import FullPaths from '@src/routes/constants/FullPaths';
+
+
+// **** Variables **** //
+
+const LoginCreds = {
+  email: 'jsmith@gmail.com',
+  password: 'Password@1',
+} as const;
+
+
+// **** Functions **** //
+
+/**
+ * Login a user.
+ */
+function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
+  // Setup dummy data
+  const role = UserRoles.Admin,
+    pwdHash = PwdUtil.hashSync(LoginCreds.password),
+    loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
+  // Add spy
+  spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
+  // Call Login API
+  beforeAgent
+    .post(FullPaths.Auth.Login)
+    .type('form')
+    .send(LoginCreds)
+    .end((_: Error, res: Response) => {
+      const cookie = res.headers['set-cookie'][0];
+      return done(cookie);
+    });
+}
+
+
+// **** Export default **** //
+
+export default login;

package/lib/project-files/spec/support/types.ts

@@ -0,0 +1 @@
+export type TReqBody = string | object | undefined;

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

@@ -1,56 +1,43 @@
 import supertest, { SuperTest, Test, Response } from 'supertest';
-import logger from 'jet-logger';
 
 import app from '@src/server';
-import authRoutes from '@src/routes/auth-routes';
-import userRepo from '@src/repos/user-repo';
-import pwdUtil from '@src/util/pwd-util';
-import EnvVars from '@src/declarations/major/EnvVars';
-import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
+
+import UserRepo from '@src/repos/UserRepo';
+import PwdUtil from '@src/util/PwdUtil';
 import User, { UserRoles } from '@src/models/User';
-import { errors as authServiceErrs } from '@src/services/auth-service';
+import { Errors } from '@src/services/AuthService';
+
+import FullPaths from '@src/routes/constants/FullPaths';
+import EnvVars from '@src/constants/EnvVars';
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+
+import { TReqBody } from 'spec/support/types';
 
 
 // **** Variables **** //
 
-// Misc
-const { paths } = authRoutes,
-  authPath = ('/api' + paths.basePath),
-  loginPath = `${authPath}${paths.login}`,
-  logoutPath = `${authPath}${paths.logout}`;
-
-// Test message
-const msgs = {
-  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;
+// Paths
+const {
+  Login,
+  Logout,
+} = FullPaths.Auth;
+
+// StatusCodes
+const {
+  OK,
+  UNAUTHORIZED,
+} = HttpStatusCodes;
 
 // Login credentials
-const loginCreds = {
+const LoginCreds = {
   email: 'jsmith@gmail.com',
   password: 'Password@1',
 } as const;
 
 
-// **** Types **** //
-
-type TReqBody = string | object | undefined;
-
-
 // **** Tests **** //
 
-describe('auth-router', () => {
+describe('AuthRouter', () => {
 
   let agent: SuperTest<Test>;
 
@@ -60,80 +47,79 @@ describe('auth-router', () => {
     done();
   });
 
-  // Test login
-  describe(`"POST:${loginPath}"`, () => {
-
-    const callApi = (reqBody: TReqBody) => {
-      return agent.post(loginPath).type('form').send(reqBody);
-    };
-
-    // Good login
-    it(msgs.goodLogin, (done) => {
-      const role = UserRoles.Standard;
-      const pwdHash = pwdUtil.hashSync(loginCreds.password);
-      const loginUser = User.new('john smith', loginCreds.email, role, pwdHash);
-      spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
+  // ** Test login ** //
+  describe(`"POST:${Login}"`, () => {
+
+    const EMAIL_NOT_FOUND_ERR = Errors.emailNotFound(LoginCreds.email);
+
+    const callApi = (reqBody: TReqBody) => 
+      agent
+        .post(Login)
+        .type('form')
+        .send(reqBody);
+
+    // Success
+    it(`should return a response with a status of "${OK}" and a cookie with ` + 
+      'a jwt if the login was successful.', (done) => {
+      // Setup data
+      const role = UserRoles.Standard,
+        pwdHash = PwdUtil.hashSync(LoginCreds.password),
+        loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
+      // Add spy
+      spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
       // Call API
-      callApi(loginCreds)
-        .end((err: Error, res: Response) => {
-          !!err && logger.err(err);
-          expect(res.status).toBe(HttpStatusCodes.OK);
+      callApi(LoginCreds)
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(OK);
           const cookie = res.headers['set-cookie'][0];
-          expect(cookie).toContain(EnvVars.cookieProps.key);
+          expect(cookie).toContain(EnvVars.CookieProps.Key);
           done();
         });
     });
 
     // Email not found error
-    it(msgs.emailNotFound, (done) => {
-      spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(null));
-      callApi(loginCreds)
-        .end((err: Error, res: Response) => {
-          !!err && logger.err(err);
-          expect(res.status).toBe(HttpStatusCodes.UNAUTHORIZED);
-          const errMsg = authServiceErrs.emailNotFound(loginCreds.email);
-          expect(res.body.error).toBe(errMsg);
+    it(`should return a response with a status of "${UNAUTHORIZED}" and a ` + 
+    `json with an error message of "${EMAIL_NOT_FOUND_ERR}" if the email ` + 
+    'was not found.', (done) => {
+      // Spy
+      spyOn(UserRepo, 'getOne').and.resolveTo(null);
+      // Call
+      callApi(LoginCreds)
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(UNAUTHORIZED);
+          expect(res.body.error).toBe(EMAIL_NOT_FOUND_ERR);
           done();
         });
     });
 
     // Password failed
-    it(msgs.pwdFailed, (done) => {
-      const role = UserRoles.Standard;
-      const pwdHash = pwdUtil.hashSync('bad password');
-      const loginUser = User.new('john smith', loginCreds.email, role, pwdHash);
-      spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
+    it(`should return a response with a status of "${UNAUTHORIZED}" and a ` + 
+    `json with the error "${Errors.Unauth}" if the password failed.`, 
+    (done) => {
+      // Setup data
+      const role = UserRoles.Standard,
+        pwdHash = PwdUtil.hashSync('bad password'),
+        loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
+      // Add spy
+      spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
       // Call API
-      callApi(loginCreds)
-        .end((err: Error, res: Response) => {
-          !!err && logger.err(err);
-          expect(res.status).toBe(HttpStatusCodes.UNAUTHORIZED);
-          expect(res.body.error).toBe(authServiceErrs.unauth);
+      callApi(LoginCreds)
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(UNAUTHORIZED);
+          expect(res.body.error).toBe(Errors.Unauth);
           done();
         });
     });
 
-    // Fallback error
-    it(msgs.fallbackErr, (done) => {
-      spyOn(userRepo, 'getOne').and.throwError('Database query failed.');
-      callApi(loginCreds)
-        .end((err: Error, res: Response) => {
-          !!err && logger.err(err);
-          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          expect(res.body.error).toBeTruthy();
-          done();
-        });
-    });
   });
 
-  // Test logout
-  describe(`"GET:${logoutPath}"`, () => {
+  // ** Test logout ** //
+  describe(`"GET:${Logout}"`, () => {
 
     // Successful logout
-    it(msgs.goodLogout, (done) => {
-      agent.get(logoutPath)
-        .end((err: Error, res: Response) => {
-          !!err && logger.err(err);
+    it(`should return a response with a status of ${OK}`, (done) => {
+      agent.get(Logout)
+        .end((_: Error, res: Response) => {
           expect(res.status).toBe(HttpStatusCodes.OK);
           done();
         });