express-generator-typescript 2.3.7 → 2.4.0

package/README.md

@@ -39,9 +39,9 @@ and `_moduleAliases` in _package.json_ if you want to add/edit the relative path
 
 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. 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. 
+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 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.
 
 
 ## Installation
@@ -60,10 +60,9 @@ If you don't specify a project name, the default _express-gen-ts_ will be used i
 want to use `yarn` instead of `npm`, pass the option `--use-yarn`.
 
 Create the app:
+With no options: `$ npx express-generator-typescript`
+With all options (order doesn't matter): `$ npx express-generator-typescript --with-auth --use-yarn "project name"`
 
-```bash
-$ npx express-generator-typescript "project name (default is express-gen-ts)"
-```
 
 Start your express-generator-typescript app in development mode at `http://localhost:3000/`:
 
@@ -92,34 +91,6 @@ 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

package/bin/cli.js

@@ -10,17 +10,29 @@ const path = require('path');
 const expressGenTs = require('../lib/express-generator-typescript');
 
 
-// Start
+//  **** Start **** //
+
 console.log('Setting up new Express/TypeScript project...');
 
+
+// **** Process Options **** //
+
+const args = process.argv.slice(2);
+
 // Setup use yarn
 let useYarn = false;
-const args = process.argv.slice(2);
-let idx = -1;
-idx = args.indexOf('--use-yarn');
-if (idx > -1) {
+const useYarnIdx = args.indexOf('--use-yarn');
+if (useYarnIdx > -1) {
   useYarn = true;
-  args.splice(idx, 1);
+  args.splice(useYarnIdx, 1);
+}
+
+// Setup include authentication
+let withAuth = false;
+const withAuthIdx = args.indexOf('--with-auth');
+if (withAuthIdx > -1) {
+  withAuth = true;
+  args.splice(withAuthIdx, 1);
 }
 
 // Setup destination
@@ -30,7 +42,10 @@ if (args.length > 0) {
 }
 destination = path.join(process.cwd(), destination);
 
+
+// **** Call the generator script **** //
+
 // Creating new project finished
-expressGenTs(destination, useYarn).then(() => {
+expressGenTs(destination, useYarn, withAuth).then(() => {
   console.log('Project setup complete!');
 });

package/lib/cli.js

@@ -10,17 +10,29 @@ const path = require('path');
 const expressGenTs = require('../lib/express-generator-typescript');
 
 
-// Start
+//  **** Start **** //
+
 console.log('Setting up new Express/TypeScript project...');
 
+
+// **** Process Options **** //
+
+const args = process.argv.slice(2);
+
 // Setup use yarn
 let useYarn = false;
-const args = process.argv.slice(2);
-let idx = -1;
-idx = args.indexOf('--use-yarn');
-if (idx > -1) {
+const useYarnIdx = args.indexOf('--use-yarn');
+if (useYarnIdx > -1) {
   useYarn = true;
-  args.splice(idx, 1);
+  args.splice(useYarnIdx, 1);
+}
+
+// Setup include authentication
+let withAuth = false;
+const withAuthIdx = args.indexOf('--with-auth');
+if (withAuthIdx > -1) {
+  withAuth = true;
+  args.splice(withAuthIdx, 1);
 }
 
 // Setup destination
@@ -30,7 +42,10 @@ if (args.length > 0) {
 }
 destination = path.join(process.cwd(), destination);
 
+
+// **** Call the generator script **** //
+
 // Creating new project finished
-expressGenTs(destination, useYarn).then(() => {
+expressGenTs(destination, useYarn, withAuth).then(() => {
   console.log('Project setup complete!');
 });

package/lib/express-generator-typescript.js

@@ -13,41 +13,41 @@ const path = require('path'),
 
 // **** Variables **** //
 
-// Misc
+// Project folder paths
 const PROJECT_FOLDER_PATH = './project-files';
+  PROJECT_FOLDER_PATH_AUTH = './project-files-auth';
 
-// ncp options
+// 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',
+  DEPENDENCIES_AUTH = ' bcrypt jsonwebtoken',
+  DEV_DEPENDENCIES = '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 @typescript-eslint/eslint-plugin eslint ' +
+    '@typescript-eslint/parser @types/fs-extra eslint-plugin-node',
+  DEV_DEPENDENCIES_AUTH = ' @types/bcrypt @types/jsonwebtoken';
+
+// "ncp" options
 const ncpOpts = {
   filter: (fileName) => {
     return !(fileName === 'package-lock.json' || fileName === 'node_modules');
   },
 };
 
-// Project-folder dependencies
-const dependencies = 'express dotenv morgan cookie-parser jet-logger ' +
-  '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 @typescript-eslint/eslint-plugin eslint ' +
-  '@typescript-eslint/parser @types/fs-extra @types/bcrypt ' + 
-  '@types/jsonwebtoken eslint-plugin-node';
-
 
 // **** Functions **** //
 
 /**
  * Entry point
  */
-async function expressGenTs(destination, useYarn) {
+async function expressGenTs(destination, useYarn, withAuth) {
   try {
-    await copyProjectFiles(destination);
+    await copyProjectFiles(destination, withAuth);
     updatePackageJson(destination);
     await renameGitigoreFile(destination);
-    downloadNodeModules(destination, useYarn);
+    downloadNodeModules(destination, useYarn, withAuth);
   } catch (err) {
     console.error(err);
   }
@@ -56,8 +56,9 @@ async function expressGenTs(destination, useYarn) {
 /**
  * Copy project files
  */
-function copyProjectFiles(destination) {
-  const source = path.join(__dirname, PROJECT_FOLDER_PATH);
+function copyProjectFiles(destination, withAuth) {
+  const folder = (withAuth ? PROJECT_FOLDER_PATH_AUTH : PROJECT_FOLDER_PATH),
+    source = path.join(__dirname, folder);
   return new Promise((res, rej) => {
     ncp.limit = 16;
     return ncp(source, destination, ncpOpts, (err) => {
@@ -94,17 +95,26 @@ function renameGitigoreFile(destination) {
 /**
  * Download the dependencies.
  */
-function downloadNodeModules(destination, useYarn) {
-  const options = {cwd: destination};
-  let downloadLibCmd;
-  let downloadDepCmd;
+function downloadNodeModules(destination, useYarn, withAuth) {
+  const options = { cwd: destination };
+  // Setup dependencies string
+  let depStr = DEPENDENCIES,
+    devDepStr = DEV_DEPENDENCIES;
+  if (withAuth) {
+    depStr += DEPENDENCIES_AUTH;
+    devDepStr += DEV_DEPENDENCIES_AUTH;
+  }
+  // Setup download command
+  let downloadLibCmd,
+    downloadDepCmd;
   if (useYarn) {
-    downloadLibCmd = 'yarn add ' + dependencies;
-    downloadDepCmd = 'yarn add ' + devDependencies + ' -D';
+    downloadLibCmd = 'yarn add ' + depStr;
+    downloadDepCmd = 'yarn add ' + devDepStr + ' -D';
   } else {
-    downloadLibCmd = 'npm i -s ' + dependencies;
-    downloadDepCmd = 'npm i -D ' + devDependencies;
+    downloadLibCmd = 'npm i -s ' + depStr;
+    downloadDepCmd = 'npm i -D ' + devDepStr;
   }
+  // Execute command
   childProcess.execSync(downloadLibCmd, options);
   childProcess.execSync(downloadDepCmd, options);
 }

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

@@ -10,7 +10,6 @@ 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 { TReqBody } from 'spec/support/types';
 
 
@@ -34,14 +33,14 @@ const {
 
 // Dummy users for GET req
 const DummyGetAllUsers = [
-  new User('Sean Maxwell', 'sean.maxwell@gmail.com'),
-  new User('John Smith', 'john.smith@gmail.com'),
-  new User('Gordan Freeman', 'gordan.freeman@gmail.com'),
+  User.new('Sean Maxwell', 'sean.maxwell@gmail.com'),
+  User.new('John Smith', 'john.smith@gmail.com'),
+  User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
 ] as const;
 
 // Dummy update user
 const DummyUserData = {
-  user: new User('Gordan Freeman', 'gordan.freeman@gmail.com'),
+  user: User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
 } as const;
 
 
@@ -49,25 +48,18 @@ const DummyUserData = {
 
 describe('UserRouter', () => {
 
-  let agent: SuperTest<Test>,
-    jwtCookie: string;
+  let agent: SuperTest<Test>;
 
   // Run before all tests
   beforeAll((done) => {
     agent = supertest.agent(app);
-    login(agent, (cookie: string) => {
-      jwtCookie = cookie;
-      done();
-    });
+    done();
   });
 
   // ** Get all users ** //
   describe(`"GET:${Get}"`, () => {
 
-    const callApi = () => 
-      agent
-        .get(Get)
-        .set('Cookie', jwtCookie);
+    const callApi = () => agent.get(Get);
 
     // Success
     it('should return a JSON object with all the users and a status code ' + 
@@ -79,7 +71,7 @@ describe('UserRouter', () => {
         .end((_: Error, res: Response) => {
           expect(res.status).toBe(OK);
           for (let i = 0; i < res.body.users.length; i++) {
-            const user = User.from(res.body.users[i]);
+            const user = res.body.users[i];
             expect(user).toEqual(DummyGetAllUsers[i]);
           }
           done();
@@ -93,7 +85,6 @@ describe('UserRouter', () => {
     const callApi = (reqBody: TReqBody) => 
       agent
         .post(Add)
-        .set('Cookie', jwtCookie)
         .type('form').send(reqBody);
 
     // Test add user success
@@ -130,7 +121,6 @@ describe('UserRouter', () => {
     const callApi = (reqBody: TReqBody) => 
       agent
         .put(Update)
-        .set('Cookie', jwtCookie)
         .type('form').send(reqBody);
 
     // Success
@@ -180,8 +170,7 @@ describe('UserRouter', () => {
 
     const callApi = (id: number) => 
       agent
-        .delete(insertUrlParams(Delete, { id }))
-        .set('Cookie', jwtCookie);
+        .delete(insertUrlParams(Delete, { id }));
 
     // Success
     it(`should return a status code of "${OK}" if the request was successful.`, 

package/lib/project-files/src/models/User.ts

@@ -1,7 +1,7 @@
 // **** Variables **** //
 
-const INVALID_CONSTRUCTOR_PARAM = 'nameOrObj arg must a string or an object ' + 
-  'with the appropriate user keys.';
+const INVALID_CONSTRUCTOR_PARAM = 'nameOrObj arg must a string or an ' + 
+  'object with the appropriate user keys.';
 
 export enum UserRoles {
   Standard,
@@ -27,62 +27,59 @@ export interface ISessionUser {
 }
 
 
-// **** User **** //
-
-class User implements IUser {
-
-  public id: number;
-  public name: string;
-  public email: string;
-  public role?: UserRoles;
-  public pwdHash?: string;
-
-  /**
-   * Constructor()
-   */
-  public constructor(
-    name?: string,
-    email?: string,
-    role?: UserRoles,
-    pwdHash?: string,
-    id?: number, // id last cause usually set by db
-  ) {
-    this.name = (name ?? '');
-    this.email = (email ?? '');
-    this.role = (role ?? UserRoles.Standard);
-    this.pwdHash = (pwdHash ?? '');
-    this.id = (id ?? -1);
-  }
+// **** Functions **** //
+
+/**
+ * Create new User.
+ */
+function new_(
+  name?: string,
+  email?: string,
+  role?: UserRoles,
+  pwdHash?: string,
+  id?: number, // id last cause usually set by db
+): IUser {
+  return {
+    id: (id ?? -1),
+    name: (name ?? ''),
+    email: (email ?? ''),
+    role: (role ?? UserRoles.Standard),
+    pwdHash: (pwdHash ?? ''),
+  };
+}
 
-  /**
-   * Get user instance from object.
-   */
-  public static from(param: object): User {
-    // Check is user
-    if (!User.isUser(param)) {
-      throw new Error(INVALID_CONSTRUCTOR_PARAM);
-    }
-    // Get user instance
-    const p = param as IUser;
-    return new User(p.name, p.email, p.role, p.pwdHash, p.id);
+/**
+ * Get user instance from object.
+ */
+function from(param: object): IUser {
+  // Check is user
+  if (!isUser(param)) {
+    throw new Error(INVALID_CONSTRUCTOR_PARAM);
   }
+  // Get user instance
+  const p = param as IUser;
+  return new_(p.name, p.email, p.role, p.pwdHash, p.id);
+}
 
-  /**
-   * Is this an object which contains all the user keys.
-   */
-  public static isUser(this: void, arg: unknown): boolean {
-    return (
-      !!arg &&
-      typeof arg === 'object' &&
-      'id' in arg &&
-      'email' in arg &&
-      'name' in arg &&
-      'role' in arg
-    );
-  }
+/**
+ * See if the param meets criteria to be a user.
+ */
+function isUser(arg: unknown): boolean {
+  return (
+    !!arg &&
+    typeof arg === 'object' &&
+    'id' in arg &&
+    'email' in arg &&
+    'name' in arg &&
+    'role' in arg
+  );
 }
 
 
 // **** Export default **** //
 
-export default User;
+export default {
+  new: new_,
+  from,
+  isUser,
+} 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}]}
+{"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}]}

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

@@ -1,10 +1,8 @@
 import { Router } from 'express';
 import jetValidator from 'jet-validator';
 
-import adminMw from './middleware/adminMw';
 import Paths from './constants/Paths';
 import User from '@src/models/User';
-import AuthRoutes from './AuthRoutes';
 import UserRoutes from './UserRoutes';
 
 
@@ -14,27 +12,6 @@ const apiRouter = Router(),
   validate = jetValidator();
 
 
-// **** Setup **** //
-
-const authRouter = Router();
-
-// Login user
-authRouter.post(
-  Paths.Auth.Login,
-  validate('email', 'password'),
-  AuthRoutes.login,
-);
-
-// Logout user
-authRouter.get(
-  Paths.Auth.Logout,
-  AuthRoutes.logout,
-);
-
-// Add AuthRouter
-apiRouter.use(Paths.Auth.Base, authRouter);
-
-
 // ** Add UserRouter ** //
 
 const userRouter = Router();
@@ -67,7 +44,7 @@ userRouter.delete(
 );
 
 // Add UserRouter
-apiRouter.use(Paths.Users.Base, adminMw, userRouter);
+apiRouter.use(Paths.Users.Base, userRouter);
 
 
 // **** Export default **** //

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

@@ -7,11 +7,6 @@ import { Immutable } from '@src/other/types';
 
 const Paths = {
   Base: '/api',
-  Auth: {
-    Base: '/auth',
-    Login: '/login',
-    Logout: '/logout',
-  },
   Users: {
     Base: '/users',
     Get: '/all',

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

@@ -75,19 +75,14 @@ app.set('views', viewsDir);
 const staticDir = path.join(__dirname, 'public');
 app.use(express.static(staticDir));
 
-// Nav to login pg by default
+// Nav to users pg by default
 app.get('/', (_: Request, res: Response) => {
-  res.sendFile('login.html', { root: viewsDir });
+  return res.redirect('/users');
 });
 
 // Redirect to login if not logged in.
-app.get('/users', (req: Request, res: Response) => {
-  const jwt = req.signedCookies[EnvVars.CookieProps.Key];
-  if (!jwt) {
-    res.redirect('/');
-  } else {
-    res.sendFile('users.html', {root: viewsDir});
-  }
+app.get('/users', (_: Request, res: Response) => {
+  return res.sendFile('users.html', { root: viewsDir });
 });
 
 

package/lib/project-files/src/views/users.html

@@ -23,11 +23,6 @@
           Add
         </button>
       </div>
-      <div>
-        <button id="logout-btn">
-          Logout
-        </button>
-      </div>
     </div>
 
     <!-- Display Users -->

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

@@ -0,0 +1 @@
+src/public/

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

@@ -0,0 +1,44 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking",
+    "plugin:node/recommended"
+  ],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "@typescript-eslint/explicit-member-accessibility": "warn",
+    "@typescript-eslint/no-misused-promises": 0,
+    "@typescript-eslint/no-floating-promises": 0,
+    "max-len": [
+      "warn",
+      {
+        "code": 80
+      }
+    ],
+    "comma-dangle": ["warn", "always-multiline"],
+    "no-console": 1,
+    "no-extra-boolean-cast": 0,
+    "semi": 1,
+    "indent": ["warn", 2],
+    "quotes": ["warn", "single"],
+    "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-auth/README.md

@@ -0,0 +1,43 @@
+## 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.
+
+
+## Additional Notes
+
+- If `npm run dev` gives you issues with bcrypt on MacOS you may need to run: `npm rebuild bcrypt --build-from-source`.