express-generator-typescript 2.3.7 → 2.4.0

package/lib/project-files-auth/build.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 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/project-files-auth/env/development.env

@@ -0,0 +1,24 @@
+## 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/project-files-auth/env/production.env

@@ -0,0 +1,25 @@
+## 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/project-files-auth/env/test.env

@@ -0,0 +1,24 @@
+## 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/project-files-auth/gitignore

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

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

@@ -0,0 +1,70 @@
+{
+  "name": "express-typescript-example",
+  "version": "0.0.0",
+  "scripts": {
+    "build": "npx ts-node build.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 --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": {
+    "@src": "dist"
+  },
+  "engines": {
+    "node": ">=8.10.0"
+  },
+  "dependencies": {
+    "bcrypt": "^5.0.1",
+    "cookie-parser": "^1.4.6",
+    "dotenv": "^16.0.2",
+    "express": "^4.18.1",
+    "express-async-errors": "^3.1.1",
+    "helmet": "^6.0.0",
+    "inserturlparams": "^1.0.1",
+    "jet-logger": "^1.3.1",
+    "jet-validator": "^1.0.3",
+    "jsonfile": "^6.1.0",
+    "jsonwebtoken": "^8.5.1",
+    "module-alias": "^2.2.2",
+    "morgan": "^1.10.0",
+    "ts-command-line-args": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/bcrypt": "^5.0.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/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",
+    "nodemon": "^2.0.19",
+    "supertest": "^6.2.4",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.1.0",
+    "typescript": "^4.8.2"
+  }
+}

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

@@ -0,0 +1,77 @@
+import dotenv from 'dotenv';
+import find from 'find';
+import Jasmine from 'jasmine';
+import { parse } from 'ts-command-line-args';
+import logger from 'jet-logger';
+
+
+// **** Types **** //
+
+interface IArgs {
+  testFile: string;
+}
+
+
+// **** Setup **** //
+
+// ** Init ** //
+
+// NOTE: MUST BE FIRST!! Load env vars
+const result2 = dotenv.config({
+  path: './env/test.env',
+});
+if (result2.error) {
+  throw result2.error;
+}
+
+// Setup command line options. 
+const args = parse<IArgs>({
+  testFile: {
+    type: String,
+    defaultValue: '',
+  },
+});
+
+
+// ** Start Jasmine ** //
+
+// 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 (args.testFile) {
+  const testFile = args.testFile;
+  find.file(testFile + '.spec.ts', './spec', (files: string[]) => {
+    if (files.length === 1) {
+      jasmine.execute([files[0]]);
+    } 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/project-files-auth/spec/nodemon.json

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

package/lib/project-files-auth/spec/support/jasmine.json

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

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

@@ -23,7 +23,7 @@ function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
   // Setup dummy data
   const role = UserRoles.Admin,
     pwdHash = PwdUtil.hashSync(LoginCreds.password),
-    loginUser = new User('john smith', LoginCreds.email, role, pwdHash);
+    loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
   // Add spy
   spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
   // Call Login API

package/lib/project-files-auth/spec/support/types.ts

@@ -0,0 +1 @@
+export type TReqBody = string | object | undefined;

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

@@ -64,7 +64,7 @@ describe('AuthRouter', () => {
       // Setup data
       const role = UserRoles.Standard,
         pwdHash = PwdUtil.hashSync(LoginCreds.password),
-        loginUser = new User('john smith', LoginCreds.email, role, pwdHash);
+        loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
       // Add spy
       spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
       // Call API
@@ -99,7 +99,7 @@ describe('AuthRouter', () => {
       // Setup data
       const role = UserRoles.Standard,
         pwdHash = PwdUtil.hashSync('bad password'),
-        loginUser = new User('john smith', LoginCreds.email, role, pwdHash);
+        loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
       // Add spy
       spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
       // Call API

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

@@ -0,0 +1,224 @@
+import supertest, { SuperTest, Test, Response } from 'supertest';
+import { defaultErrMsg as ValidatorErr } from 'jet-validator';
+import insertUrlParams from 'inserturlparams';
+
+import app from '@src/server';
+
+import UserRepo from '@src/repos/UserRepo';
+import User from '@src/models/User';
+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';
+
+
+// **** Variables **** //
+
+// Paths
+const {
+  Get,
+  Add,
+  Update,
+  Delete,
+} = FullPaths.Users;
+
+// StatusCodes
+const {
+  OK,
+  CREATED,
+  NOT_FOUND,
+  BAD_REQUEST,
+} = HttpStatusCodes;
+
+// 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;
+
+
+// **** Tests **** //
+
+describe('UserRouter', () => {
+
+  let agent: SuperTest<Test>,
+    jwtCookie: string;
+
+  // Run before all tests
+  beforeAll((done) => {
+    agent = supertest.agent(app);
+    login(agent, (cookie: string) => {
+      jwtCookie = cookie;
+      done();
+    });
+  });
+
+  // ** Get all users ** //
+  describe(`"GET:${Get}"`, () => {
+
+    const callApi = () => 
+      agent
+        .get(Get)
+        .set('Cookie', jwtCookie);
+
+    // Success
+    it('should return a JSON object with all the users and a status code ' + 
+    `of "${OK}" if the request was successful.`, (done) => {
+      // Add spy
+      spyOn(UserRepo, 'getAll').and.resolveTo([...DummyGetAllUsers]);
+      // Call API
+      callApi()
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(OK);
+          for (let i = 0; i < res.body.users.length; i++) {
+            const user = res.body.users[i];
+            expect(user).toEqual(DummyGetAllUsers[i]);
+          }
+          done();
+        });
+    });
+  });
+
+  // Test add user
+  describe(`"POST:${Add}"`, () => {
+
+    const callApi = (reqBody: TReqBody) => 
+      agent
+        .post(Add)
+        .set('Cookie', jwtCookie)
+        .type('form').send(reqBody);
+
+    // Test add user success
+    it(`should return a status code of "${CREATED}" if the request was ` + 
+    'successful.', (done) => {
+      // Spy
+      spyOn(UserRepo, 'add').and.resolveTo();
+      // Call api
+      callApi(DummyUserData)
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(CREATED);
+          expect(res.body.error).toBeUndefined();
+          done();
+        });
+    });
+
+    // Missing param
+    it('should return a JSON object with an error message of ' + 
+    `"${ValidatorErr}" and a status code of "${BAD_REQUEST}" if the user ` + 
+    'param was missing.', (done) => {
+      // Call api
+      callApi({})
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.body.error).toBe(ValidatorErr);
+          done();
+        });
+    });
+  });
+
+  // ** Update users ** //
+  describe(`"PUT:${Update}"`, () => {
+
+    const callApi = (reqBody: TReqBody) => 
+      agent
+        .put(Update)
+        .set('Cookie', jwtCookie)
+        .type('form').send(reqBody);
+
+    // Success
+    it(`should return a status code of "${OK}" if the request was successful.`, 
+      (done) => {
+        // Setup spies
+        spyOn(UserRepo, 'update').and.resolveTo();
+        spyOn(UserRepo, 'persists').and.resolveTo(true);
+        // Call api
+        callApi(DummyUserData)
+          .end((_: Error, res: Response) => {
+            expect(res.status).toBe(OK);
+            expect(res.body.error).toBeUndefined();
+            done();
+          });
+      });
+
+    // Param missing
+    it('should return a JSON object with an error message of ' +
+    `"${ValidatorErr}" and a status code of "${BAD_REQUEST}" if the user ` + 
+    'param was missing.', (done) => {
+      // Call api
+      callApi({})
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.body.error).toBe(ValidatorErr);
+          done();
+        });
+    });
+
+    // User not found
+    it('should return a JSON object with the error message of ' + 
+    `"${USER_NOT_FOUND_ERR}" and a status code of "${NOT_FOUND}" if the id ` + 
+    'was not found.', (done) => {
+      // Call api
+      callApi(DummyUserData)
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(NOT_FOUND);
+          expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
+          done();
+        });
+    });
+  });
+
+  // ** Delete user ** //
+  describe(`"DELETE:${Delete}"`, () => {
+
+    const callApi = (id: number) => 
+      agent
+        .delete(insertUrlParams(Delete, { id }))
+        .set('Cookie', jwtCookie);
+
+    // Success
+    it(`should return a status code of "${OK}" if the request was successful.`, 
+      (done) => {
+        // Setup spies
+        spyOn(UserRepo, 'delete').and.resolveTo();
+        spyOn(UserRepo, 'persists').and.resolveTo(true);
+        // Call api
+        callApi(5)
+          .end((_: Error, res: Response) => {
+            expect(res.status).toBe(OK);
+            expect(res.body.error).toBeUndefined();
+            done();
+          });
+      });
+
+    // User not found
+    it('should return a JSON object with the error message of ' + 
+    `"${USER_NOT_FOUND_ERR}" and a status code of "${NOT_FOUND}" if the id ` + 
+    'was not found.', (done) => {
+      callApi(-1)
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(NOT_FOUND);
+          expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
+          done();
+        });
+    });
+
+    // Invalid param
+    it(`should return a status code of "${BAD_REQUEST}" and return an error ` + 
+    `message of "${ValidatorErr}" if the id was not a valid number`, (done) => {
+      callApi('horse' as unknown as number)
+        .end((_: Error, res: Response) => {
+          expect(res.status).toBe(BAD_REQUEST);
+          expect(res.body.error).toBe(ValidatorErr);
+          done();
+        });
+    });
+  });
+});

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

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

package/lib/project-files-auth/src/constants/EnvVars.ts

@@ -0,0 +1,28 @@
+/**
+ * Environments variables declared here.
+ */
+
+/* eslint-disable node/no-process-env */
+
+
+export default {
+  NodeEnv: (process.env.NODE_ENV ?? ''),
+  Port: (process.env.PORT ?? 0),
+  CookieProps: {
+    Key: 'ExpressGeneratorTs',
+    Secret: (process.env.COOKIE_SECRET ?? ''),
+    // Casing to match express cookie options
+    Options: {
+      httpOnly: true,
+      signed: true,
+      path: (process.env.COOKIE_PATH ?? ''),
+      maxAge: Number(process.env.COOKIE_EXP ?? 0),
+      domain: (process.env.COOKIE_DOMAIN ?? ''),
+      secure: (process.env.SECURE_COOKIE === 'true'),
+    },
+  },
+  Jwt: {
+    Secret: (process.env.JWT_SECRET ??  ''),
+    Exp: (process.env.COOKIE_EXP ?? ''), // exp at the same time as the cookie
+  },
+} as const;