express-generator-typescript 2.4.3 → 2.4.6

package/lib/express-generator-typescript.js

@@ -20,7 +20,7 @@ const PROJECT_FOLDER_PATH = './project-files';
 // Project-folder dependencies
 const DEPENDENCIES = 'express dotenv morgan cookie-parser jet-logger ' +
   'module-alias express-async-errors helmet jsonfile inserturlparams ' + 
-  'jet-validator ts-command-line-args',
+  'jet-validator ts-command-line-args jet-paths',
   DEPENDENCIES_AUTH = ' bcrypt jsonwebtoken',
   DEV_DEPENDENCIES = 'ts-node typescript nodemon find jasmine supertest ' +
     '@types/node @types/express @types/jasmine @types/find @types/morgan  ' +

package/lib/project-files/package.json

@@ -36,6 +36,7 @@
     "inserturlparams": "^1.0.1",
     "jet-logger": "^1.3.1",
     "jet-validator": "^1.0.3",
+    "jet-paths": "^1.0.5",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",

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

@@ -0,0 +1,10 @@
+/**
+ * Convert paths to full for testing.
+ */
+
+import jetPaths from 'jet-paths';
+
+import Paths from '@src/constants/Paths';
+
+
+export default jetPaths(Paths);

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

@@ -8,21 +8,13 @@ import UserRepo from '@src/repos/UserRepo';
 import User from '@src/models/User';
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
-import FullPaths from '@src/routes/constants/FullPaths';
 
+import Paths from 'spec/support/Paths';
 import { TReqBody } from 'spec/support/types';
 
 
 // **** Variables **** //
 
-// Paths
-const {
-  Get,
-  Add,
-  Update,
-  Delete,
-} = FullPaths.Users;
-
 // StatusCodes
 const {
   OK,
@@ -57,9 +49,9 @@ describe('UserRouter', () => {
   });
 
   // ** Get all users ** //
-  describe(`"GET:${Get}"`, () => {
+  describe(`"GET:${Paths.Users.Get}"`, () => {
 
-    const callApi = () => agent.get(Get);
+    const callApi = () => agent.get(Paths.Users.Get);
 
     // Success
     it('should return a JSON object with all the users and a status code ' + 
@@ -80,13 +72,13 @@ describe('UserRouter', () => {
   });
 
   // Test add user
-  describe(`"POST:${Add}"`, () => {
+  describe(`"POST:${Paths.Users.Add}"`, () => {
 
     const ERROR_MSG = `${ValidatorErr}"user".`;
 
     const callApi = (reqBody: TReqBody) => 
       agent
-        .post(Add)
+        .post(Paths.Users.Add)
         .type('form').send(reqBody);
 
     // Test add user success
@@ -118,13 +110,13 @@ describe('UserRouter', () => {
   });
 
   // ** Update users ** //
-  describe(`"PUT:${Update}"`, () => {
+  describe(`"PUT:${Paths.Users.Update}"`, () => {
 
     const ERROR_MSG = `${ValidatorErr}"user".`;
 
     const callApi = (reqBody: TReqBody) => 
       agent
-        .put(Update)
+        .put(Paths.Users.Update)
         .type('form').send(reqBody);
 
     // Success
@@ -170,13 +162,13 @@ describe('UserRouter', () => {
   });
 
   // ** Delete user ** //
-  describe(`"DELETE:${Delete}"`, () => {
+  describe(`"DELETE:${Paths.Users.Delete}"`, () => {
 
     const VALIDATOR_ERR = `${ValidatorErr}"id".`;
 
     const callApi = (id: number) => 
       agent
-        .delete(insertUrlParams(Delete, { id }));
+        .delete(insertUrlParams(Paths.Users.Delete, { id }));
 
     // Success
     it(`should return a status code of "${OK}" if the request was successful.`, 

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

@@ -2,10 +2,8 @@
  * Express router paths go here.
  */
 
-import { Immutable } from '@src/other/types';
 
-
-const Paths = {
+export default {
   Base: '/api',
   Users: {
     Base: '/users',
@@ -14,10 +12,4 @@ const Paths = {
     Update: '/update',
     Delete: '/delete/:id',
   },
-};
-
-
-// **** Export **** //
-
-export type TPaths = Immutable<typeof Paths>;
-export default Paths as TPaths;
+} as const;

package/lib/project-files/src/repos/database.json

@@ -1 +1 @@
-{"users":[{"name":"Sean Maxwell","email":"sean.maxwell@gmail.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":1,"id":159123164363},{"name":"Gordan Freeman","email":"gordan.freeman@halflife.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":0,"id":906524522143},{"name":"John Smith","email":"jsmith@yahoo.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":0,"id":357437875835},{"id":75800032258,"name":"asdf","email":"asdfasdf","role":0}]}
+{"users":[{"name":"Sean Maxwell","email":"sean.maxwell@gmail.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":1,"id":159123164363},{"name":"Gordan Freeman","email":"gordan.freeman@halflife.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":0,"id":906524522143},{"name":"John Smith","email":"jsmith@yahoo.com","pwdHash":"$2b$12$1mE2OI9hMS/rgH9Mi0s85OM2V5gzm7aF3gJIWH1y0S1MqVBueyjsy","role":0,"id":357437875835}]}

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

@@ -1,7 +1,7 @@
 import { Router } from 'express';
 import jetValidator from 'jet-validator';
 
-import Paths from './constants/Paths';
+import Paths from '../constants/Paths';
 import User from '@src/models/User';
 import UserRoutes from './UserRoutes';
 

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

@@ -12,7 +12,7 @@ import logger from 'jet-logger';
 import 'express-async-errors';
 
 import BaseRouter from '@src/routes/api';
-import Paths from '@src/routes/constants/Paths';
+import Paths from '@src/constants/Paths';
 
 import EnvVars from '@src/constants/EnvVars';
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';

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

@@ -36,6 +36,7 @@
     "inserturlparams": "^1.0.1",
     "jet-logger": "^1.3.1",
     "jet-validator": "^1.0.3",
+    "jet-paths": "^1.0.5",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",

package/lib/project-files-auth/spec/support/Paths.ts

@@ -0,0 +1,10 @@
+/**
+ * Convert paths to full for testing.
+ */
+
+import jetPaths from 'jet-paths';
+
+import Paths from '@src/constants/Paths';
+
+
+export default jetPaths(Paths);

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

@@ -3,7 +3,8 @@ 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';
+
+import Paths from './Paths';
 
 
 // **** Variables **** //
@@ -28,7 +29,7 @@ function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
   spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
   // Call Login API
   beforeAgent
-    .post(FullPaths.Auth.Login)
+    .post(Paths.Auth.Login)
     .type('form')
     .send(LoginCreds)
     .end((_: Error, res: Response) => {

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

@@ -7,21 +7,15 @@ import PwdUtil from '@src/util/PwdUtil';
 import User, { UserRoles } from '@src/models/User';
 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 Paths from 'spec/support/Paths';
 import { TReqBody } from 'spec/support/types';
 
 
 // **** Variables **** //
 
-// Paths
-const {
-  Login,
-  Logout,
-} = FullPaths.Auth;
-
 // StatusCodes
 const {
   OK,
@@ -48,13 +42,13 @@ describe('AuthRouter', () => {
   });
 
   // ** Test login ** //
-  describe(`"POST:${Login}"`, () => {
+  describe(`"POST:${Paths.Auth.Login}"`, () => {
 
     const EMAIL_NOT_FOUND_ERR = Errors.EmailNotFound(LoginCreds.email);
 
     const callApi = (reqBody: TReqBody) => 
       agent
-        .post(Login)
+        .post(Paths.Auth.Login)
         .type('form')
         .send(reqBody);
 
@@ -114,11 +108,11 @@ describe('AuthRouter', () => {
   });
 
   // ** Test logout ** //
-  describe(`"GET:${Logout}"`, () => {
+  describe(`"GET:${Paths.Auth.Logout}"`, () => {
 
     // Successful logout
     it(`should return a response with a status of ${OK}`, (done) => {
-      agent.get(Logout)
+      agent.get(Paths.Auth.Logout)
         .end((_: Error, res: Response) => {
           expect(res.status).toBe(HttpStatusCodes.OK);
           done();

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

@@ -8,22 +8,14 @@ import UserRepo from '@src/repos/UserRepo';
 import User from '@src/models/User';
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
-import FullPaths from '@src/routes/constants/FullPaths';
 
 import login from '../support/login';
+import Paths from 'spec/support/Paths';
 import { TReqBody } from 'spec/support/types';
 
 
 // **** Variables **** //
 
-// Paths
-const {
-  Get,
-  Add,
-  Update,
-  Delete,
-} = FullPaths.Users;
-
 // StatusCodes
 const {
   OK,
@@ -62,11 +54,11 @@ describe('UserRouter', () => {
   });
 
   // ** Get all users ** //
-  describe(`"GET:${Get}"`, () => {
+  describe(`"GET:${Paths.Users.Get}"`, () => {
 
     const callApi = () => 
       agent
-        .get(Get)
+        .get(Paths.Users.Get)
         .set('Cookie', jwtCookie);
 
     // Success
@@ -88,13 +80,13 @@ describe('UserRouter', () => {
   });
 
   // Test add user
-  describe(`"POST:${Add}"`, () => {
+  describe(`"POST:${Paths.Users.Add}"`, () => {
 
     const ERROR_MSG = `${ValidatorErr}"user".`;
 
     const callApi = (reqBody: TReqBody) => 
       agent
-        .post(Add)
+        .post(Paths.Users.Add)
         .set('Cookie', jwtCookie)
         .type('form').send(reqBody);
 
@@ -127,13 +119,13 @@ describe('UserRouter', () => {
   });
 
   // ** Update users ** //
-  describe(`"PUT:${Update}"`, () => {
+  describe(`"PUT:${Paths.Users.Update}"`, () => {
 
     const ERROR_MSG = `${ValidatorErr}"user".`;
 
     const callApi = (reqBody: TReqBody) => 
       agent
-        .put(Update)
+        .put(Paths.Users.Update)
         .set('Cookie', jwtCookie)
         .type('form').send(reqBody);
 
@@ -180,13 +172,13 @@ describe('UserRouter', () => {
   });
 
   // ** Delete user ** //
-  describe(`"DELETE:${Delete}"`, () => {
+  describe(`"DELETE:${Paths.Users.Delete}"`, () => {
 
     const VALIDATOR_ERR = `${ValidatorErr}"id".`;
 
     const callApi = (id: number) => 
       agent
-        .delete(insertUrlParams(Delete, { id }))
+        .delete(insertUrlParams(Paths.Users.Delete, { id }))
         .set('Cookie', jwtCookie);
 
     // Success

package/lib/project-files-auth/src/{routes/constants → constants}/Paths.ts

@@ -2,10 +2,8 @@
  * Express router paths go here.
  */
 
-import { Immutable } from '@src/other/types';
 
-
-const Paths = {
+export default {
   Base: '/api',
   Auth: {
     Base: '/auth',
@@ -19,10 +17,4 @@ const Paths = {
     Update: '/update',
     Delete: '/delete/:id',
   },
-};
-
-
-// **** Export **** //
-
-export type TPaths = Immutable<typeof Paths>;
-export default Paths as TPaths;
+} as const;

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

@@ -2,7 +2,7 @@ import { Router } from 'express';
 import jetValidator from 'jet-validator';
 
 import adminMw from './middleware/adminMw';
-import Paths from './constants/Paths';
+import Paths from '../constants/Paths';
 import User from '@src/models/User';
 import AuthRoutes from './AuthRoutes';
 import UserRoutes from './UserRoutes';

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

@@ -12,7 +12,7 @@ import logger from 'jet-logger';
 import 'express-async-errors';
 
 import BaseRouter from '@src/routes/api';
-import Paths from '@src/routes/constants/Paths';
+import Paths from '@src/constants/Paths';
 
 import EnvVars from '@src/constants/EnvVars';
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.4.3",
+  "version": "2.4.6",
   "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/other/types.ts

@@ -1,4 +0,0 @@
-
-export type Immutable<T> = {
-  readonly [K in keyof T]: Immutable<T[K]>;
-};

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

@@ -1,40 +0,0 @@
-
-/**
- * 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/services/AuthService.ts

@@ -1,56 +0,0 @@
-import UserRepo from '@src/repos/UserRepo';
-
-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 **** //
-
-// Errors
-export const Errors = {
-  Unauth: 'Unauthorized',
-  EmailNotFound(email: string) {
-    return `User with email "${email}" not found`;
-  },
-} as const;
-
-
-// **** Functions **** //
-
-/**
- * Login a user.
- */
-async function login(email: string, password: string): Promise<IUser> {
-  // Fetch user
-  const user = await UserRepo.getOne(email);
-  if (!user) {
-    throw new RouteError(
-      HttpStatusCodes.UNAUTHORIZED,
-      Errors.EmailNotFound(email),
-    );
-  }
-  // Check password
-  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,
-    );
-  }
-  // Return
-  return user;
-}
-
-
-// **** Export default **** //
-
-export default {
-  login,
-} as const;

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

@@ -1,39 +0,0 @@
-import bcrypt from 'bcrypt';
-
-
-// **** Variables **** //
-
-const SALT_ROUNDS = 12;
-
-
-// **** Functions **** //
-
-/**
- * Get a hash from the password.
- */
-function getHash(pwd: string): Promise<string> {
-  return bcrypt.hash(pwd, SALT_ROUNDS);
-}
-
-/**
- * Useful for testing.
- */
-function hashSync(pwd: string): string {
-  return bcrypt.hashSync(pwd, SALT_ROUNDS);
-}
-
-/**
- * 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/src/util/SessionUtil.ts

@@ -1,92 +0,0 @@
-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/lib/project-files-auth/src/other/types.ts

@@ -1,4 +0,0 @@
-
-export type Immutable<T> = {
-  readonly [K in keyof T]: Immutable<T[K]>;
-};

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

@@ -1,40 +0,0 @@
-
-/**
- * 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;