express-generator-typescript 2.0.14 → 2.1.1

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

@@ -14,9 +14,9 @@
   },
   "rules": {
     "max-len": [
-      "error",
+      "warn",
       {
-        "code": 100
+        "code": 80
       }
     ],
     "comma-dangle": ["warn", "always-multiline"],

package/lib/project-files/README.md

@@ -0,0 +1,38 @@
+## About
+
+This project was created with [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript).
+
+
+## Available Scripts
+
+### `npm run dev`
+
+Run the server in development mode.
+
+### `npm test`
+
+Run all unit-tests with hot-reloading.
+
+### `npm test -- --testFile="name of test file" (i.e. --testFile=Users).`
+
+Run a single unit-test.
+
+### `npm run test:no-reloading`
+
+Run all unit-tests without hot-reloading.
+
+### `npm run lint`
+
+Check for linting errors.
+
+### `npm run build`
+
+Build the project for production.
+
+### `npm start`
+
+Run the production build (Must be built first).
+
+### `npm start -- --env="name of env file" (default is production).`
+
+Run production build with a different env file.

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

@@ -1,13 +1,13 @@
 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 userRepo from '@repos/user-repo';
 import envVars from '@shared/env-vars';
 import User, { UserRoles } from '@models/user-model';
 import { p as paths } from '@routes/auth-router';
-import { pErr } from '@shared/functions';
 import { pwdSaltRounds } from 'spec/support/login-agent';
 import { UnauthorizedError } from '@shared/errors';
 
@@ -22,14 +22,15 @@ const authPath = ('/api' + paths.basePath),
 
 // 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.`,
+  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}.`,
 } as const;
 
@@ -37,7 +38,7 @@ const msgs = {
 const loginCreds = {
   email: 'jsmith@gmail.com',
   password: 'Password@1',
-} as const; 
+} as const;
 
 
 // **** Types **** //
@@ -73,7 +74,7 @@ describe('auth-router', () => {
       // Call API
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(OK);
           const cookie = res.headers['set-cookie'][0];
           expect(cookie).toContain(envVars.cookieProps.key);
@@ -86,7 +87,7 @@ describe('auth-router', () => {
       spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(null));
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(UNAUTHORIZED);
           expect(res.body.error).toBe(UnauthorizedError.Msg);
           done();
@@ -102,7 +103,7 @@ describe('auth-router', () => {
       // Call API
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(UNAUTHORIZED);
           expect(res.body.error).toBe(UnauthorizedError.Msg);
           done();
@@ -114,7 +115,7 @@ describe('auth-router', () => {
       spyOn(userRepo, 'getOne').and.throwError('Database query failed.');
       callApi(loginCreds)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(BAD_REQUEST);
           expect(res.body.error).toBeTruthy();
           done();
@@ -129,7 +130,7 @@ describe('auth-router', () => {
     it(msgs.goodLogout, (done) => {
       agent.get(logoutPath)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(OK);
           done();
         });

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

@@ -1,14 +1,19 @@
 import supertest from 'supertest';
 import StatusCodes from 'http-status-codes';
 import { SuperTest, Test, Response } from 'supertest';
+import logger from 'jet-logger';
 
 import app from '@server';
 import userRepo from '@repos/user-repo';
 import User, { IUser } from '@models/user-model';
-import { pErr } from '@shared/functions';
+
 import { p as userPaths } from '@routes/user-router';
+import {
+  ParamMissingError,
+  UserNotFoundError,
+  ValidatorFnError,
+} from '@shared/errors';
 import loginAgent from '../support/login-agent';
-import { ParamMissingError, UserNotFoundError, ValidatorFnError } from '@shared/errors';
 
 
 // **** Variables **** //
@@ -35,31 +40,34 @@ 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 
-    "${ParamMissingError.Msg}" 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.`,
+  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 "${ParamMissingError.Msg}" 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 
-    "${ParamMissingError.Msg}" and a status code of "${BAD_REQUEST}" if the user param was 
-    missing.`,
+    "${ParamMissingError.Msg}" 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.`,
+    ${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.`,
+    ${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.`,
 };
 
 
@@ -98,7 +106,7 @@ describe('user-router', () => {
       spyOn(userRepo, 'getAll').and.returnValue(ret);
       // Call API
       callApi().end((err: Error, res: Response) => {
-        pErr(err);
+        !!err && logger.err(err);
         expect(res.status).toBe(OK);
         // Caste instance-objects to 'User' objects
         const respUsers = res.body.users;
@@ -116,7 +124,7 @@ describe('user-router', () => {
       // Call API
       callApi()
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(BAD_REQUEST);
           expect(res.body.error).toBe(errMsg);
           done();
@@ -139,7 +147,7 @@ describe('user-router', () => {
       spyOn(userRepo, 'add').and.returnValue(Promise.resolve());
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(CREATED);
           expect(res.body.error).toBeUndefined();
           done();
@@ -150,7 +158,7 @@ describe('user-router', () => {
     it(msgs.addUserFailedMissingParam, (done) => {
       callApi({})
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(BAD_REQUEST);
           expect(res.body.error).toBe(ValidatorFnError.Msg + 'instanceOf');
           done();
@@ -164,7 +172,7 @@ describe('user-router', () => {
       // Call API
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(BAD_REQUEST);
           expect(res.body.error).toBe(errMsg);
           done();
@@ -187,7 +195,7 @@ describe('user-router', () => {
       // Call api
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(OK);
           expect(res.body.error).toBeUndefined();
           done();
@@ -198,7 +206,7 @@ describe('user-router', () => {
     it(msgs.updateParamMissing, (done) => {
       callApi({})
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(BAD_REQUEST);
           expect(res.body.error).toBe(ValidatorFnError.Msg + 'instanceOf');
           done();
@@ -209,7 +217,7 @@ describe('user-router', () => {
     it(msgs.updateUserNotFound, (done) => {
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(UserNotFoundError.HttpStatus);
           expect(res.body.error).toBe(UserNotFoundError.Msg);
           done();
@@ -224,7 +232,7 @@ describe('user-router', () => {
       // Call API
       callApi(dummyUserData)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(BAD_REQUEST);
           expect(res.body.error).toBe(updateErrMsg);
           done();
@@ -248,7 +256,7 @@ describe('user-router', () => {
       // Call api
       callApi(5)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(OK);
           expect(res.body.error).toBeUndefined();
           done();
@@ -259,7 +267,7 @@ describe('user-router', () => {
     it(msgs.deleteUserNotFound, (done) => {
       callApi(-1)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(UserNotFoundError.HttpStatus);
           expect(res.body.error).toBe(UserNotFoundError.Msg);
           done();
@@ -274,7 +282,7 @@ describe('user-router', () => {
       // Call API
       callApi(1)
         .end((err: Error, res: Response) => {
-          pErr(err);
+          !!err && logger.err(err);
           expect(res.status).toBe(BAD_REQUEST);
           expect(res.body.error).toBe(deleteErrMsg);
           done();

package/lib/project-files/src/pre-start/index.ts

@@ -1,6 +1,7 @@
 /**
- * Pre-start is where we want to place things that must run BEFORE the express server is started.
- * This is useful for environment variables, command-line arguments, and cron-jobs.
+ * Pre-start is where we want to place things that must run BEFORE the express 
+ * server is started. This is useful for environment variables, command-line 
+ * arguments, and cron-jobs.
  */
 
 import path from 'path';

package/lib/project-files/src/repos/user-repo.ts

@@ -1,5 +1,5 @@
 import { IUser } from '@models/user-model';
-import { getRandomInt } from '@shared/functions';
+import sharedFns from '@shared/functions';
 import orm from './mock-orm';
 
 
@@ -44,7 +44,7 @@ async function getAll(): Promise<IUser[]> {
  */
 async function add(user: IUser): Promise<void> {
   const db = await orm.openDb();
-  user.id = getRandomInt();
+  user.id = sharedFns.getRandomInt();
   db.users.push(user);
   return orm.saveDb(db);
 }

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

@@ -1,5 +1,6 @@
 /**
- * Put other validator functions here too that may be passed to the validate() function
+ * Put other validator functions here too that may be passed to the validate() 
+ * function.
  */
 
 import { ParamInvalidError, ValidatorFnError } from '@shared/errors';
@@ -15,11 +16,13 @@ type TParamFull = TParam | TValidatorFn;
 // **** Functions **** //
 
 /**
- * Make sure parameter is of the specified type. If the type is not provided then 'string' is
- * used as the default type. Instead of a type you can also pass a validator function 
- * which must return 'true' or 'false'. Return false if invalid.
+ * Make sure parameter is of the specified type. If the type is not provided 
+ * then 'string' is used as the default type. Instead of a type you can also 
+ * pass a validator function which must return 'true' or 'false'. Return false 
+ * if invalid.
  * 
- * Example argument: [id, 'number'], id is the incoming variable, 'number' is the type.
+ * Example argument: [id, 'number'], id is the incoming variable, 'number' is 
+ * the type.
  * 
  * Example 1: validate(email, [user, 'object'], [isAdmin, 'boolean'])
  * Example 2: validate(password) // will check that password is a string

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

@@ -40,11 +40,22 @@ if (envVars.nodeEnv === 'production') {
 // Add APIs
 app.use('/api', BaseRouter);
 
-// Error handling
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-app.use((err: Error | CustomError, req: Request, res: Response, _: NextFunction) => {
+// Setup error handler
+app.use((
+  err: Error | CustomError,
+  _: Request,
+  res: Response,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  __: NextFunction,
+) => {
   logger.err(err, true);
-  const status = (err instanceof CustomError ? err.HttpStatus : StatusCodes.BAD_REQUEST);
+  // Status
+  const status = (
+    err instanceof CustomError 
+      ? err.HttpStatus 
+      : StatusCodes.BAD_REQUEST
+  );
+  // Return
   return res.status(status).json({
     error: err.message,
   });

package/lib/project-files/src/shared/errors.ts

@@ -13,7 +13,8 @@ export abstract class CustomError extends Error {
 
 export class ParamMissingError extends CustomError {
 
-  public static readonly Msg = 'One or more of the required parameters was missing.';
+  public static readonly Msg = 'One or more of the required parameters ' + 
+    'was missing.';
   public static readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
 
   constructor() {
@@ -23,7 +24,8 @@ export class ParamMissingError extends CustomError {
 
 export class ParamInvalidError extends CustomError {
 
-  public static readonly Msg = 'One or more of the required was missing or invalid.';
+  public static readonly Msg = 'One or more of the required was missing ' + 
+    'or invalid.';
   public static readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
 
   constructor() {
@@ -43,7 +45,8 @@ export class ValidatorFnError extends CustomError {
 
 export class UserNotFoundError extends CustomError {
 
-  public static readonly Msg = 'A user with the given id does not exists in the database.';
+  public static readonly Msg = 'A user with the given id does not exists ' + 
+    'in the database.';
   public static readonly HttpStatus = HttpStatusCodes.NOT_FOUND;
 
   constructor() {

package/lib/project-files/src/shared/functions.ts

@@ -1,20 +1,13 @@
-import logger from 'jet-logger';
-
-
-// **** Functions **** //
-
-/**
- * Print an error object if it's truthy. Useful for testing.
- */
-export function pErr(err?: Error): void {
-  if (!!err) {
-    logger.err(err);
-  }
-}
-
 /**
  * Get a random number between 1 and 1,000,000,000,000
  */
-export function getRandomInt(): number {
+function getRandomInt(): number {
   return Math.floor(Math.random() * 1_000_000_000_000);
 }
+
+
+// **** Export default **** //
+
+export default {
+  getRandomInt,
+} as const;

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

@@ -1,4 +1,4 @@
-import jsonwebtoken, { JwtPayload } from 'jsonwebtoken';
+import jsonwebtoken from 'jsonwebtoken';
 import envVars from '../shared/env-vars';
 
 
@@ -31,7 +31,7 @@ function sign(data: string | object | Buffer): Promise<string> {
 /**
  * Decrypt JWT and extract client data.
  */
-async function decode<T extends JwtPayload>(jwt: string): Promise<string | undefined | T> {
+async 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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.0.14",
+  "version": "2.1.1",
   "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",