express-generator-typescript 2.0.14 → 2.0.15

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';
 
@@ -37,7 +37,7 @@ const msgs = {
 const loginCreds = {
   email: 'jsmith@gmail.com',
   password: 'Password@1',
-} as const; 
+} as const;
 
 
 // **** Types **** //
@@ -73,7 +73,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 +86,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 +102,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 +114,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 +129,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,11 +1,12 @@
 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 loginAgent from '../support/login-agent';
 import { ParamMissingError, UserNotFoundError, ValidatorFnError } from '@shared/errors';
@@ -98,7 +99,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 +117,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 +140,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 +151,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 +165,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 +188,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 +199,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 +210,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 +225,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 +249,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 +260,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 +275,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/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/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/package.json

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