express-generator-typescript 1.10.1 → 2.0.0

package/lib/auth-proj/build.ts

@@ -1,64 +0,0 @@
-/**
- * Remove old files, copy front-end ones.
- */
-
-import fs from 'fs-extra';
-import logger from 'jet-logger';
-import childProcess from 'child_process';
-
-
-// Start
-(async () => {
-  try {
-    // Remove current build
-    await remove('./dist/');
-    // Copy front-end files
-    await copy('./src/public', './dist/public');
-    await copy('./src/views', './dist/views');
-    // Copy production env file
-    await copy('./src/pre-start/env/production.env', './dist/pre-start/env/production.env');
-    // Copy back-end files
-    await exec('tsc --build tsconfig.prod.json', './');
-  } catch (err) {
-    logger.err(err);
-  }
-})();
-
-/**
- * Remove file
- */
-function remove(loc: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return fs.remove(loc, (err) => {
-      return (!!err ? rej(err) : res());
-    });
-  });
-}
-
-/**
- * Copy file.
- */
-function copy(src: string, dest: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return fs.copy(src, dest, (err) => {
-      return (!!err ? rej(err) : res());
-    });
-  });
-}
-
-/**
- * Do command line command.
- */
-function exec(cmd: string, loc: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return childProcess.exec(cmd, {cwd: loc}, (err, stdout, stderr) => {
-      if (!!stdout) {
-        logger.info(stdout);
-      }
-      if (!!stderr) {
-        logger.warn(stderr);
-      }
-      return (!!err ? rej(err) : res());
-    });
-  });
-}

package/lib/auth-proj/gitignore

@@ -1,3 +0,0 @@
-**/node_modules
-dist/
-**/**/*.log

package/lib/auth-proj/package.json

@@ -1,73 +0,0 @@
-{
-  "name": "with-auth",
-  "version": "0.0.0",
-  "scripts": {
-    "build": "npx ts-node build.ts",
-    "lint": "eslint . --ext .ts",
-    "start": "node -r module-alias/register ./dist --env=production",
-    "dev": "nodemon",
-    "test": "nodemon --config ./spec/nodemon.json",
-    "test:no-reloading": "npx ts-node --files -r tsconfig-paths/register ./spec"
-  },
-  "nodemonConfig": {
-    "watch": [
-      "src"
-    ],
-    "ext": "ts, html",
-    "ignore": [
-      "src/public"
-    ],
-    "exec": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register ./src"
-  },
-  "_moduleAliases": {
-    "@services": "dist/services",
-    "@repos": "dist/repos",
-    "@entities": "dist/entities",
-    "@shared": "dist/shared",
-    "@server": "dist/server",
-    "@routes": "dist/routes",
-    "@util": "dist/util"
-  },
-  "dependencies": {
-    "bcrypt": "^5.0.1",
-    "command-line-args": "^5.2.1",
-    "cookie-parser": "^1.4.6",
-    "dotenv": "^16.0.2",
-    "express": "^4.18.1",
-    "express-async-errors": "^3.1.1",
-    "helmet": "^6.0.0",
-    "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",
-    "randomstring": "^1.2.2"
-  },
-  "devDependencies": {
-    "@types/bcrypt": "^5.0.0",
-    "@types/command-line-args": "^5.2.0",
-    "@types/cookie-parser": "^1.4.3",
-    "@types/express": "^4.17.13",
-    "@types/find": "^0.2.1",
-    "@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/randomstring": "^1.1.8",
-    "@types/supertest": "^2.0.12",
-    "@typescript-eslint/eslint-plugin": "^5.36.1",
-    "@typescript-eslint/parser": "^5.36.1",
-    "eslint": "^8.23.0",
-    "find": "^0.3.0",
-    "fs-extra": "^10.1.0",
-    "jasmine": "^4.3.0",
-    "nodemon": "^2.0.19",
-    "supertest": "^6.2.4",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.1.0",
-    "typescript": "^4.8.2"
-  }
-}

package/lib/auth-proj/spec/index.ts

@@ -1,57 +0,0 @@
-import './loadEnv';
-import find from 'find';
-import Jasmine from 'jasmine';
-import commandLineArgs from 'command-line-args';
-import logger from 'jet-logger';
-
-
-// Setup command line options
-const options = commandLineArgs([
-  {
-    name: 'testFile',
-    alias: 'f',
-    type: String,
-  },
-]);
-
-// Init Jasmine
-const jasmine = new Jasmine();
-jasmine.exitOnCompletion = false;
-
-// Set location of test files
-jasmine.loadConfig({
-  random: true,
-  spec_dir: 'spec',
-  spec_files: [
-    './tests/**/*.spec.ts',
-  ],
-  stopSpecOnExpectationFailure: false,
-});
-
-// Run all or a single unit-test
-let execResp: Promise<jasmine.JasmineDoneInfo> | undefined;
-if (options.testFile) {
-  const testFile = options.testFile as string;
-  find.file(testFile + '.spec.ts', './spec', (files: string[]) => {
-    if (files.length === 1) {
-      jasmine.specFiles = [files[0]];
-      jasmine.execute();
-    } else {
-      logger.err('Test file not found!');
-    }
-  });
-} else {
-  execResp = jasmine.execute();
-}
-
-// Wait for tests to finish
-(async () => {
-  if (!!execResp) {
-    const info = await execResp;
-    if (info.overallStatus === 'passed') {
-      logger.info('All tests have passed :)');
-    } else {
-      logger.err('At least one test has failed :(');
-    }
-  }
-})();

package/lib/auth-proj/spec/loadEnv.ts

@@ -1,10 +0,0 @@
-import dotenv from 'dotenv';
-
-
-const result2 = dotenv.config({
-  path: `./src/pre-start/env/test.env`,
-});
-
-if (result2.error) {
-  throw result2.error;
-}

package/lib/auth-proj/spec/nodemon.json

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

package/lib/auth-proj/spec/support/jasmine.json

@@ -1,11 +0,0 @@
-{
-  "spec_dir": "spec",
-  "spec_files": [
-    "**/*[sS]pec.ts"
-  ],
-  "helpers": [
-    "helpers/**/*.js"
-  ],
-  "stopSpecOnExpectationFailure": false,
-  "random": true
-}

package/lib/auth-proj/spec/tests/users.spec.ts

@@ -1,283 +0,0 @@
-import supertest from 'supertest';
-import StatusCodes from 'http-status-codes';
-import { SuperTest, Test, Response } from 'supertest';
-
-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 } from '@shared/errors';
-
-
-// **** Variables **** //
-
-// Misc
-const usersPath = '/api/users',
-  getUsersPath = `${usersPath}${userPaths.get}`,
-  addUsersPath = `${usersPath}${userPaths.add}`,
-  updateUserPath = `${usersPath}${userPaths.update}`,
-  deleteUserPath = `${usersPath}${userPaths.delete}`,
-  { BAD_REQUEST, CREATED, OK } = StatusCodes;
-
-// Dummy users for GET req
-const dummyGetAllUsers = [
-  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: User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
-} as const;
-
-// 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.`,
-  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.`,
-  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.`,
-  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.`,
-};
-
-
-// **** Types **** //
-
-type TReqBody = string | object | undefined;
-
-
-// **** Tests **** //
-
-describe('user-router', () => {
-
-  let agent: SuperTest<Test>;
-  let jwtCookie: string;
-
-
-  // Run before all tests
-  beforeAll((done) => {
-    agent = supertest.agent(app);
-    loginAgent.login(agent, (cookie: string) => {
-      jwtCookie = cookie;
-      done();
-    });
-  });
-
-  // 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
-      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: IUser[] = respUsers.map((user: IUser) => User.copy(user));
-        expect(retUsers).toEqual(dummyGetAllUsers);
-        expect(res.body.error).toBeUndefined();
-        done();
-      });
-    });
-
-    // Get all users bad
-    it(msgs.getUsersBad, (done) => {
-      const errMsg = 'Could not fetch users.';
-      spyOn(userRepo, 'getAll').and.throwError(errMsg);
-      // Call API
-      callApi()
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(errMsg);
-          done();
-        });
-    });
-  });
-
-  // Test add user
-  describe(`"POST:${addUsersPath}"`, () => {
-
-    // Consts
-    const callApi = (reqBody: TReqBody) => {
-      return agent.post(addUsersPath)
-        .set('Cookie', jwtCookie)
-        .type('form').send(reqBody);
-    };
-
-    // Test add user success
-    it(msgs.addUserSuccess, (done) => {
-      spyOn(userRepo, 'add').and.returnValue(Promise.resolve());
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(CREATED);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
-    });
-
-    // Test add user failed due to missing param
-    it(msgs.addUserFailedMissingParam, (done) => {
-      callApi({})
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ParamMissingError.Msg);
-          done();
-        });
-    });
-
-    // Default error
-    it(msgs.addUserFallbackErr, (done) => {
-      const errMsg = 'Could not add user.';
-      spyOn(userRepo, 'add').and.throwError(errMsg);
-      // Call API
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(errMsg);
-          done();
-        });
-    });
-  });
-
-  // Test update users
-  describe(`"PUT:${updateUserPath}"`, () => {
-
-    const callApi = (reqBody: TReqBody) => 
-      agent.put(updateUserPath)
-        .set('Cookie', jwtCookie)
-        .type('form').send(reqBody);
-
-    // Test updating a user success
-    it(msgs.updateSuccess, (done) => {
-      spyOn(userRepo, 'update').and.returnValue(Promise.resolve());
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      // Call api
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
-    });
-
-    // Test updating a user failed because a param was missing
-    it(msgs.updateParamMissing, (done) => {
-      callApi({})
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(ParamMissingError.Msg);
-          done();
-        });
-    });
-
-    // Update user not found
-    it(msgs.updateUserNotFound, (done) => {
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(UserNotFoundError.HttpStatus);
-          expect(res.body.error).toBe(UserNotFoundError.Msg);
-          done();
-        });
-    });
-
-    // Update fallback error
-    it(msgs.updateFallbackErr, (done) => {
-      const updateErrMsg = 'Could not update user.';
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      spyOn(userRepo, 'update').and.throwError(updateErrMsg);
-      // Call API
-      callApi(dummyUserData)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(updateErrMsg);
-          done();
-        });
-    });
-  });
-
-  // Test delete user
-  describe(`"DELETE:${deleteUserPath}"`, () => {
-
-    const callApi = (id: number) => {
-      const path = deleteUserPath.replace(':id', id.toString());
-      return agent.delete(path).set('Cookie', jwtCookie);
-    };
-
-    // Delete user successful
-    it(msgs.deleteSuccessful, (done) => {
-      spyOn(userRepo, 'delete').and.returnValue(Promise.resolve());
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      // Call api
-      callApi(5)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(OK);
-          expect(res.body.error).toBeUndefined();
-          done();
-        });
-    });
-
-    // Delete, user not found error
-    it(msgs.deleteUserNotFound, (done) => {
-      callApi(-1)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(UserNotFoundError.HttpStatus);
-          expect(res.body.error).toBe(UserNotFoundError.Msg);
-          done();
-        });
-    });
-
-    // Delete user fallback error
-    it(msgs.deleteFallbackErr, (done) => {
-      spyOn(userRepo, 'persists').and.returnValue(Promise.resolve(true));
-      const deleteErrMsg = 'Could not delete user.';
-      spyOn(userRepo, 'delete').and.throwError(deleteErrMsg);
-      // Call API
-      callApi(1)
-        .end((err: Error, res: Response) => {
-          pErr(err);
-          expect(res.status).toBe(BAD_REQUEST);
-          expect(res.body.error).toBe(deleteErrMsg);
-          done();
-        });
-    });
-  });
-});

package/lib/auth-proj/src/index.ts

@@ -1,14 +0,0 @@
-import './pre-start'; // Must be the first import
-import logger from 'jet-logger';
-
-import envVars from '@shared/env-vars';
-import server from './server';
-
-
-// Constants
-const serverStartMsg = 'Express server started on port: ';
-
-// Start server
-server.listen(envVars.port, () => {
-  logger.info(serverStartMsg + envVars.port.toString());
-});

package/lib/auth-proj/src/models/user-model.ts

@@ -1,56 +0,0 @@
-// **** Types **** //
-
-export enum UserRoles {
-  Standard,
-  Admin,
-}
-
-export interface IUser {
-  id: number;
-  name: string;
-  email: string;
-  pwdHash: string;
-  role: UserRoles;
-}
-
-
-// **** Functions **** //
-
-/**
- * Get a new User object.
- */
-function _new(
-  name: string,
-  email: string,
-  role?: UserRoles,
-  pwdHash?: string,
-): IUser {
-  return {
-    id: -1,
-    email,
-    name,
-    role: (role ?? UserRoles.Standard),
-    pwdHash: (pwdHash ?? ''),
-  };
-}
-
-/**
- * Copy a user object.
- */
-function copy(user: IUser): IUser {
-  return {
-    id: user.id,
-    email: user.email,
-    name: user.name,
-    role: user.role,
-    pwdHash: user.pwdHash,
-  };
-}
-
-
-// **** Export default **** //
-
-export default {
-  new: _new,
-  copy,
-};

package/lib/auth-proj/src/pre-start/env/development.env

@@ -1,23 +0,0 @@
-## Environment ##
-NODE_ENV=development
-
-
-## Server ##
-PORT=3000
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=CONSOLE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE
-
-## Authentication ##
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000

package/lib/auth-proj/src/pre-start/env/production.env

@@ -1,24 +0,0 @@
-## Environment ##
-NODE_ENV=production
-
-
-## Server ##
-PORT=8081
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=FILE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE
-
-## Authentication ##
-# SECURE_COOKIE 'false' here for demo-ing. But ideally should be true.
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000

package/lib/auth-proj/src/pre-start/env/test.env

@@ -1,23 +0,0 @@
-## Environment ##
-NODE_ENV=test
-
-
-## Server ##
-PORT=4000
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=CONSOLE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE
-
-## Authentication ##
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000

package/lib/auth-proj/src/pre-start/index.ts

@@ -1,28 +0,0 @@
-/**
- * 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';
-import dotenv from 'dotenv';
-import commandLineArgs from 'command-line-args';
-
-
-// Setup command line options
-const options = commandLineArgs([
-  {
-    name: 'env',
-    alias: 'e',
-    defaultValue: 'development',
-    type: String,
-  },
-]);
-
-// Set the env file
-const result2 = dotenv.config({
-  path: path.join(__dirname, `env/${String(options.env)}.env`),
-});
-
-if (result2.error) {
-  throw result2.error;
-}

package/lib/auth-proj/src/repos/database.json

@@ -1 +0,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}]}