express-generator-typescript 1.10.3 → 2.0.2

package/README.md

@@ -13,7 +13,6 @@ Creates a new express application similar to the _express-generator_ module. Exc
 application is configured to use TypeScript instead of plain JavaScript. 
 
 
-
 ## Why express-generator-typescript?
 
 NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of
@@ -36,24 +35,11 @@ and `_moduleAliases` in _package.json_ if you want to add/edit the relative path
 
 ## Sample-project
 
-When you run _express-generator-typescript_, it sets up a very simple application with routes for
+When you run _express-generator-typescript_, it sets up a simple application with routes for
 adding, updating, deleting, and fetching user objects. This is just to demonstrate how routing is done
-with express.
-
-If you want a fully-secure application, you can pass the `--with-auth` option and you will have an
-application which requires you to login before calling APIs on user objects. The app is 
+with express. You will have to login before calling APIs on user objects. The app is 
 configured with production quality client-side security and uses signed-cookies and jsonwebtokens 
-to store user-session data. If you're new to web-development and still learning about securing websites,
-I highly encourage to use this option.
-
-To have a chat app within your application, use the `--socket-io` option. This option will include 
-everything from the `--with-auth` option, plus will create a mini-chat app which displays the 
-sender name for the message of whoever the logged in user is. Without a login user we can't display 
-a sender name, that's why the `--socket-io` option must used in conjunction with `--with-auth`. 
-To create a socket-io sample app, you can pass `--socket-io` or `--with-auth --socket-io`; it won't
-make a difference.
-
-<img alt='chat-screenshot' src='https://github.com/seanpmaxwell/express-generator-typescript/raw/master/chat-screenshot.png' border='0'>
+to store user-session data. 
 
 
 ## Installation
@@ -75,14 +61,12 @@ Create the app:
 
 ```bash
 $ npx express-generator-typescript "project name (default is express-gen-ts)"
-with all options
-$ npx express-generator-typescript --with-auth --socket-io --use-yarn "project name (default is express-gen-ts)"
 ```
 
 Start your express-generator-typescript app in development mode at `http://localhost:3000/`:
 
 ```bash
-$ cd "project name" && npm run start:dev
+$ cd "project name" && npm run dev
 ```
 
 
@@ -106,6 +90,34 @@ This is located under `nodemonConfig:` in `package.json` for the server and `./s
 unit-testing. For the `exec` property, replace `ts-node` with `node --inspect -r ts-node/register`.
 
 
+## If you don't want authentication:
+
+In previous version of __express-generator-typescript__ you could disregard authentication through the 
+command line options. But maintaining two separate project folders which contained and didn't contain 
+authentication started to get messy.
+
+- Remove the following modules from `package.json`:
+  - `jsonwebtoken`
+  - `@types/jsonwebtoken`
+  - `bcrypt`
+  - `@types/bcrypt`
+  
+- Delete the files:
+  - `src/routes/middleware.ts`
+  - `src/routes/auth-router.ts`
+  - `spec/tests/auth.spec.ts`
+  - `spec/support/login-agent.ts`
+  - `public/scripts/login.js`
+  - `public/stylesheets/login.css`
+  - `public/views/login.html`
+
+- Update the files:
+  - In `src/routes/api`, delete the line: `apiRouter.use('/auth', authRouter);` and
+    remove the `adminMw,` from line 12. Remove the `adminMw` and `authRouter` imports as well.
+  - In `spec/tests/users.spec.ts`, remove all lines containing `loginAgent` and `setCookie`
+  - In `public/views/users.html` remove the `Logout` button.
+
+
 ## Note for VS-Code users
 
 A lot of users have asked about _launch.json_ configurations for running this in VS-Code, so
@@ -136,14 +148,12 @@ VS-Code.
 
 ## Note for windows users
 
-If you use the `--with-auth` option and are on Windows, the `bcrypt` module tends to be fussy. To
-use this module on Windows you need to make sure you have the node Windows build tools installed.
-I don't want to post instructions because they might change frequently. I would search the Microsoft
-docs on how to setup Node for Windows. To be able to debug in VSCODE on windows I also had to install
-the `node-gyp` module globally as well.
-
-Happy web-deving :)
+If you are on Windows, the `bcrypt` module tends to be fussy. To use this module on Windows you 
+need to make sure you have the node Windows build tools installed. I don't want to post instructions 
+because they might change frequently. I would search the Microsoft docs on how to setup Node for Windows. 
+To be able to debug in VSCODE on windows I also had to install the `node-gyp` module globally as well.
 
+Happy web deving :)
 
 
 ## License

package/bin/cli.js

@@ -15,34 +15,21 @@ const expressGenTs = require('../lib/express-generator-typescript');
   // const opts = processOptions(process.argv.slice(2));
   // Process options
   let destination = 'express-gen-ts';
-  let withAuth = false;
   let useYarn = false;
-  let useSocketIo = false;
   const args = process.argv.slice(2);
   let idx = -1;
-  idx = args.indexOf('--with-auth');
-  if (idx > -1) {
-    withAuth = true;
-    args.splice(idx, 1);
-  }
   idx = args.indexOf('--use-yarn');
   if (idx > -1) {
     useYarn = true;
     args.splice(idx, 1);
   }
-  idx = args.indexOf('--socket-io');
-  if (idx > -1) {
-    useSocketIo = true;
-    withAuth = true;
-    args.splice(idx, 1);
-  }
   if (args.length > 0) {
     destination = args[0];
   }
   destination = path.join(process.cwd(), destination);
   // Creating new project finished
-  expressGenTs(destination, withAuth, useYarn, useSocketIo).then(() => {
+  expressGenTs(destination, useYarn).then(() => {
     console.log('Project setup complete!');
   });
- })();
+})();
  

package/lib/cli.js

@@ -10,39 +10,25 @@ const path = require('path');
 const expressGenTs = require('../lib/express-generator-typescript');
 
 
-// Start
 (() => {
   console.log('Setting up new Express/TypeScript project...');
   // const opts = processOptions(process.argv.slice(2));
   // Process options
   let destination = 'express-gen-ts';
-  let withAuth = false;
   let useYarn = false;
-  let useSocketIo = false;
   const args = process.argv.slice(2);
   let idx = -1;
-  idx = args.indexOf('--with-auth');
-  if (idx > -1) {
-    withAuth = true;
-    args.splice(idx, 1);
-  }
   idx = args.indexOf('--use-yarn');
   if (idx > -1) {
     useYarn = true;
     args.splice(idx, 1);
   }
-  idx = args.indexOf('--socket-io');
-  if (idx > -1) {
-    useSocketIo = true;
-    withAuth = true;
-    args.splice(idx, 1);
-  }
   if (args.length > 0) {
     destination = args[0];
   }
   destination = path.join(process.cwd(), destination);
   // Creating new project finished
-  expressGenTs(destination, withAuth, useYarn, useSocketIo).then(() => {
+  expressGenTs(destination, useYarn).then(() => {
     console.log('Project setup complete!');
   });
 })();

package/lib/express-generator-typescript.js

@@ -13,6 +13,8 @@ const fs = require('fs');
 
 // **** Variables **** //
 
+const prjFolder = './project-files';
+
 const ncpOpts = {
   filter: (fileName) => {
     return !(fileName === 'package-lock.json' || fileName === 'node_modules');
@@ -25,12 +27,12 @@ const ncpOpts = {
 /**
  * Entry point
  */
-async function expressGenTs(destination, withAuth, useYarn, useSocketIo) {
+async function expressGenTs(destination, useYarn) {
   try {
-    await copyProjectFiles(destination, withAuth, useSocketIo);
+    await copyProjectFiles(destination);
     updatePackageJson(destination);
     await renameGitigoreFile(destination);
-    const depStrings = getDepStrings(withAuth, useSocketIo);
+    const depStrings = getDepStrings();
     downloadNodeModules(destination, depStrings, useYarn);
   } catch (err) {
     console.error(err);
@@ -40,15 +42,8 @@ async function expressGenTs(destination, withAuth, useYarn, useSocketIo) {
 /**
  * Copy project files
  */
-function copyProjectFiles(destination, withAuth, useSocketIo) {
-  let prjFolder = './project-files';
-  if (useSocketIo) {
-    prjFolder = './socket-io';
-  } else if (withAuth) {
-    prjFolder = './auth-proj';
-  }
+function copyProjectFiles(destination) {
   const source = path.join(__dirname, prjFolder);
-  // Return
   return new Promise((res, rej) => {
     ncp.limit = 16;
     return ncp(source, destination, ncpOpts, (err) => {
@@ -83,21 +78,16 @@ function renameGitigoreFile(destination) {
 /**
  * Setup dependency strings. This way gets you the latest version of everything.
  */
-function getDepStrings(withAuth, useSocketIo) {
+function getDepStrings() {
   let dependencies = 'express dotenv http-status-codes morgan cookie-parser jet-logger ' +
-    'module-alias command-line-args express-async-errors helmet jsonfile';
+    'module-alias command-line-args express-async-errors helmet jsonfile bcrypt ' + 
+    'jsonwebtoken';
   let 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';
-  if (withAuth || useSocketIo) {
-    dependencies += ' bcrypt randomstring jsonwebtoken';
-    devDependencies += ' @types/bcrypt @types/randomstring @types/jsonwebtoken';
-  }
-  if (useSocketIo) {
-    dependencies += ' socket.io socket.io-client';
-  }
+    'eslint @types/fs-extra @types/bcrypt @types/jsonwebtoken ' + 
+    'eslint-plugin-node';
   // Return
   return { dependencies, devDependencies };
 }

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

@@ -6,7 +6,8 @@
   "extends": [
     "eslint:recommended",
     "plugin:@typescript-eslint/recommended",
-    "plugin:@typescript-eslint/recommended-requiring-type-checking"
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:node/recommended"
   ],
   "parserOptions": {
     "project": "./tsconfig.json"
@@ -21,7 +22,20 @@
     "no-console": 1,
     "no-extra-boolean-cast": 0,
     "semi": 1,
+    "indent": ["warn", 2],
     "@typescript-eslint/no-misused-promises": 0,
-    "@typescript-eslint/no-floating-promises": 0
+    "@typescript-eslint/no-floating-promises": 0,
+    "node/no-process-env": 1,
+    "node/no-unsupported-features/es-syntax": [
+      "error",
+      { "ignores" : ["modules"] }
+    ],
+    "node/no-missing-import": 0,
+    "node/no-unpublished-import": 0
+  },
+  "settings": {
+    "node": {
+      "tryExtensions": [".js", ".json", ".node", ".ts"]
+    }
   }
 }

package/lib/project-files/build.ts

@@ -36,7 +36,7 @@ function remove(loc: string): Promise<void> {
 }
 
 /**
- * Copy file
+ * Copy file.
  */
 function copy(src: string, dest: string): Promise<void> {
   return new Promise((res, rej) => {
@@ -47,7 +47,7 @@ function copy(src: string, dest: string): Promise<void> {
 }
 
 /**
- * Execute system command
+ * Do command line command.
  */
 function exec(cmd: string, loc: string): Promise<void> {
   return new Promise((res, rej) => {

package/lib/project-files/package.json

@@ -1,13 +1,14 @@
 {
-  "name": "express-gen-ts",
+  "name": "express-typescript-example",
   "version": "0.0.0",
   "scripts": {
     "build": "npx ts-node build.ts",
-    "lint": "eslint . --ext .ts",
+    "lint": "npx eslint --ext .ts src/",
+    "lint:tests": "npx eslint --ext .ts spec/",
     "start": "node -r module-alias/register ./dist --env=production",
     "dev": "nodemon",
     "test": "nodemon --config ./spec/nodemon.json",
-    "test:no-reloading": "npx ts-node -r tsconfig-paths/register ./spec"
+    "test:no-reloading": "npx ts-node --files -r tsconfig-paths/register ./spec"
   },
   "nodemonConfig": {
     "watch": [
@@ -17,7 +18,7 @@
     "ignore": [
       "src/public"
     ],
-    "exec": "./node_modules/.bin/ts-node -r tsconfig-paths/register ./src"
+    "exec": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register ./src"
   },
   "_moduleAliases": {
     "@services": "dist/services",
@@ -25,9 +26,14 @@
     "@entities": "dist/entities",
     "@shared": "dist/shared",
     "@server": "dist/server",
-    "@routes": "dist/routes"
+    "@routes": "dist/routes",
+    "@util": "dist/util"
+  },
+  "engines": {
+    "node": ">=8.10.0"
   },
   "dependencies": {
+    "bcrypt": "^5.0.1",
     "command-line-args": "^5.2.1",
     "cookie-parser": "^1.4.6",
     "dotenv": "^16.0.2",
@@ -37,10 +43,12 @@
     "http-status-codes": "^2.2.0",
     "jet-logger": "^1.2.3",
     "jsonfile": "^6.1.0",
+    "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",
     "morgan": "^1.10.0"
   },
   "devDependencies": {
+    "@types/bcrypt": "^5.0.0",
     "@types/command-line-args": "^5.2.0",
     "@types/cookie-parser": "^1.4.3",
     "@types/express": "^4.17.13",
@@ -48,12 +56,14 @@
     "@types/fs-extra": "^9.0.13",
     "@types/jasmine": "^4.3.0",
     "@types/jsonfile": "^6.1.0",
+    "@types/jsonwebtoken": "^8.5.9",
     "@types/morgan": "^1.9.3",
     "@types/node": "^18.7.14",
     "@types/supertest": "^2.0.12",
     "@typescript-eslint/eslint-plugin": "^5.36.1",
     "@typescript-eslint/parser": "^5.36.1",
     "eslint": "^8.23.0",
+    "eslint-plugin-node": "^11.1.0",
     "find": "^0.3.0",
     "fs-extra": "^10.1.0",
     "jasmine": "^4.3.0",

package/lib/project-files/spec/nodemon.json

@@ -2,5 +2,5 @@
   "watch": ["spec"],
   "ext": "spec.ts",
   "ignore": ["spec/support"],
-  "exec": "./node_modules/.bin/ts-node -r tsconfig-paths/register ./spec"
+  "exec": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register ./spec"
 }

package/lib/{auth-proj → project-files}/spec/support/login-agent.ts

@@ -1,5 +1,5 @@
 import bcrypt from 'bcrypt';
-import { SuperTest, Test } from 'supertest';
+import { SuperTest, Test, Response } from 'supertest';
 
 import User, { UserRoles } from '@models/user-model';
 import userRepo from '@repos/user-repo';
@@ -19,9 +19,6 @@ const creds = {
 
 /**
  * Login a user.
- * 
- * @param beforeAgent 
- * @param done 
  */
 function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
   // Setup dummy data
@@ -34,17 +31,18 @@ function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
     .post('/api/auth/login')
     .type('form')
     .send(creds)
-    .end((err: Error, res: any) => {
+    .end((err: Error, res: Response) => {
       if (err) {
         throw err;
       }
-      done(res.headers['set-cookie']);
+      const cookie = res.headers['set-cookie'][0];
+      return done(cookie);
     });
-};
+}
 
 
 // **** Export default **** //
 
 export default {
-    login,
+  login,
 } as const;

package/lib/{auth-proj → project-files}/spec/tests/auth.spec.ts

@@ -31,7 +31,13 @@ const msgs = {
   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;
+
+// Login credentials
+const loginCreds = {
+  email: 'jsmith@gmail.com',
+  password: 'Password@1',
+} as const; 
 
 
 // **** Types **** //
@@ -60,35 +66,25 @@ describe('auth-router', () => {
 
     // Good login
     it(msgs.goodLogin, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'Password@1',
-      };
       const role = UserRoles.Standard;
-      const pwdHash = hashPwd(creds.password);
-      const loginUser = User.new('john smith', creds.email, role, pwdHash);
+      const pwdHash = hashPwd(loginCreds.password);
+      const loginUser = User.new('john smith', loginCreds.email, role, pwdHash);
       spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
       // Call API
-      callApi(creds)
+      callApi(loginCreds)
         .end((err: Error, res: Response) => {
           pErr(err);
           expect(res.status).toBe(OK);
-          expect(res.headers['set-cookie'][0]).toContain(envVars.cookieProps.key);
+          const cookie = res.headers['set-cookie'][0];
+          expect(cookie).toContain(envVars.cookieProps.key);
           done();
         });
     });
 
     // Email not found error
     it(msgs.emailNotFound, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'Password@1',
-      };
       spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(null));
-      // Call API
-      callApi(creds)
+      callApi(loginCreds)
         .end((err: Error, res: Response) => {
           pErr(err);
           expect(res.status).toBe(UNAUTHORIZED);
@@ -99,17 +95,12 @@ describe('auth-router', () => {
 
     // Password failed
     it(msgs.pwdFailed, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'someBadPassword',
-      };
       const role = UserRoles.Standard;
-      const pwdHash = hashPwd('Password@1');
-      const loginUser = User.new('john smith', creds.email, role, pwdHash);
+      const pwdHash = hashPwd('bad password');
+      const loginUser = User.new('john smith', loginCreds.email, role, pwdHash);
       spyOn(userRepo, 'getOne').and.returnValue(Promise.resolve(loginUser));
       // Call API
-      callApi(creds)
+      callApi(loginCreds)
         .end((err: Error, res: Response) => {
           pErr(err);
           expect(res.status).toBe(UNAUTHORIZED);
@@ -120,14 +111,8 @@ describe('auth-router', () => {
 
     // Fallback error
     it(msgs.fallbackErr, (done) => {
-      // Setup Dummy Data
-      const creds = {
-        email: 'jsmith@gmail.com',
-        password: 'someBadPassword',
-      };
       spyOn(userRepo, 'getOne').and.throwError('Database query failed.');
-      // Call API
-      callApi(creds)
+      callApi(loginCreds)
         .end((err: Error, res: Response) => {
           pErr(err);
           expect(res.status).toBe(BAD_REQUEST);
@@ -140,6 +125,7 @@ describe('auth-router', () => {
   // Test logout
   describe(`"GET:${logoutPath}"`, () => {
 
+    // Successful logout
     it(msgs.goodLogout, (done) => {
       agent.get(logoutPath)
         .end((err: Error, res: Response) => {

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

@@ -7,6 +7,7 @@ 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 } from '@shared/errors';
 
 
@@ -72,33 +73,40 @@ type TReqBody = string | object | undefined;
 describe('user-router', () => {
 
   let agent: SuperTest<Test>;
+  let jwtCookie: string;
 
 
   // Run before all tests
   beforeAll((done) => {
     agent = supertest.agent(app);
-    done();
+    loginAgent.login(agent, (cookie: string) => {
+      jwtCookie = cookie;
+      done();
+    });
   });
 
-  // Test get users 
+  // Test get users
   describe(`"GET:${getUsersPath}"`, () => {
 
+    const callApi = () => 
+      agent.get(getUsersPath)
+        .set('Cookie', jwtCookie);
+
     // Get all users
     it(msgs.getUsersSuccess, (done) => {
       const ret = Promise.resolve([...dummyGetAllUsers]);
       spyOn(userRepo, 'getAll').and.returnValue(ret);
       // Call API
-      agent.get(getUsersPath)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          // Caste instance-objects to 'User' objects
-          const respUsers = res.body.users;
-          const retUsers: IUser[] = respUsers.map((user: IUser) => User.copy(user));
-          expect(retUsers).toEqual(dummyGetAllUsers);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
+      callApi().end((err: Error, res: Response) => {
+        pErr(err);
+        expect(res.status).toBe(OK);
+        // Caste instance-objects to 'User' objects
+        const respUsers = res.body.users;
+        const retUsers = respUsers.map((user: IUser) => User.copy(user));
+        expect(retUsers).toEqual(dummyGetAllUsers);
+        expect(res.body.error).toBeUndefined();
+        done();
+      });
     });
 
     // Get all users bad
@@ -106,7 +114,7 @@ describe('user-router', () => {
       const errMsg = 'Could not fetch users.';
       spyOn(userRepo, 'getAll').and.throwError(errMsg);
       // Call API
-      agent.get(getUsersPath)
+      callApi()
         .end((err: Error, res: Response) => {
           pErr(err);
           expect(res.status).toBe(BAD_REQUEST);
@@ -119,9 +127,10 @@ describe('user-router', () => {
   // Test add user
   describe(`"POST:${addUsersPath}"`, () => {
 
+    // Consts
     const callApi = (reqBody: TReqBody) => {
-      return agent
-        .post(addUsersPath)
+      return agent.post(addUsersPath)
+        .set('Cookie', jwtCookie)
         .type('form').send(reqBody);
     };
 
@@ -166,11 +175,10 @@ describe('user-router', () => {
   // Test update users
   describe(`"PUT:${updateUserPath}"`, () => {
 
-    const callApi = (reqBody: TReqBody) => {
-      return agent.put(updateUserPath)
-        .type('form')
-        .send(reqBody);
-    };
+    const callApi = (reqBody: TReqBody) => 
+      agent.put(updateUserPath)
+        .set('Cookie', jwtCookie)
+        .type('form').send(reqBody);
 
     // Test updating a user success
     it(msgs.updateSuccess, (done) => {
@@ -229,7 +237,8 @@ describe('user-router', () => {
 
     const callApi = (id: number) => {
       const path = deleteUserPath.replace(':id', id.toString());
-      return agent.delete(path);
+      return agent.delete(path)
+        .set('Cookie', jwtCookie);
     };
 
     // Delete user successful

package/lib/project-files/spec/types/supertest/index.d.ts

@@ -0,0 +1,14 @@
+import { IUser } from '@models/user-model';
+import 'supertest';
+
+
+declare module 'supertest' {
+
+  export interface Response  {
+    headers: Record<string, string[]>;
+    body: {
+      error: string;
+      users: IUser[];
+    };
+  }
+}