express-generator-typescript 2.4.25 → 2.5.1

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

@@ -1,91 +0,0 @@
-/**
- * Setup express server.
- */
-
-import cookieParser from 'cookie-parser';
-import morgan from 'morgan';
-import path from 'path';
-import helmet from 'helmet';
-import express, { Request, Response, NextFunction } from 'express';
-import logger from 'jet-logger';
-
-import 'express-async-errors';
-
-import BaseRouter from '@src/routes';
-
-import Paths from '@src/common/Paths';
-import EnvVars from '@src/common/EnvVars';
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import { NodeEnvs } from '@src/common/misc';
-import { RouteError } from '@src/common/classes';
-import { IReq, IRes } from './routes/common/types';
-
-
-// **** Variables **** //
-
-const app = express();
-
-
-// **** Setup **** //
-
-// Basic middleware
-app.use(express.json());
-app.use(express.urlencoded({extended: true}));
-app.use(cookieParser(EnvVars.CookieProps.Secret));
-
-// Show routes called in console during development
-if (EnvVars.NodeEnv === NodeEnvs.Dev.valueOf()) {
-  app.use(morgan('dev'));
-}
-
-// Security
-if (EnvVars.NodeEnv === NodeEnvs.Production.valueOf()) {
-  app.use(helmet());
-}
-
-// Add APIs, must be after middleware
-app.use(Paths.Base, BaseRouter);
-
-// Add error handler
-app.use((err: Error, _: Request, res: Response, next: NextFunction) => {
-  if (EnvVars.NodeEnv !== NodeEnvs.Test.valueOf()) {
-    logger.err(err, true);
-  }
-  let status = HttpStatusCodes.BAD_REQUEST;
-  if (err instanceof RouteError) {
-    status = err.status;
-    res.status(status).json({ error: err.message });
-  }
-  return next(err);
-});
-
-
-// ** Front-End Content ** //
-
-// Set views directory (html)
-const viewsDir = path.join(__dirname, 'views');
-app.set('views', viewsDir);
-
-// Set static directory (js and css).
-const staticDir = path.join(__dirname, 'public');
-app.use(express.static(staticDir));
-
-// Nav to login pg by default
-app.get('/', (_: Request, res: Response) => {
-  res.sendFile('login.html', { root: viewsDir });
-});
-
-// Redirect to login if not logged in.
-app.get('/users', (req: IReq, res: IRes) => {
-  const jwt = req.signedCookies[EnvVars.CookieProps.Key];
-  if (!jwt) {
-    res.redirect('/');
-  } else {
-    res.sendFile('users.html', {root: viewsDir});
-  }
-});
-
-
-// **** Export default **** //
-
-export default app;

package/lib/project-files-auth/src/services/AuthService.ts

@@ -1,57 +0,0 @@
-import UserRepo from '@src/repos/UserRepo';
-
-import PwdUtil from '@src/util/PwdUtil';
-import { tick } from '@src/util/misc';
-
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import { RouteError } from '@src/common/classes';
-
-import { IUser } from '@src/models/User';
-
-
-// **** Variables **** //
-
-// Errors
-export const Errors = {
-  Unauth: 'Unauthorized',
-  EmailNotFound(email: string) {
-    return `User with email "${email}" not found`;
-  },
-} as const;
-
-
-// **** Functions **** //
-
-/**
- * Login a user.
- */
-async function login(email: string, password: string): Promise<IUser> {
-  // Fetch user
-  const user = await UserRepo.getOne(email);
-  if (!user) {
-    throw new RouteError(
-      HttpStatusCodes.UNAUTHORIZED,
-      Errors.EmailNotFound(email),
-    );
-  }
-  // Check password
-  const hash = (user.pwdHash ?? ''),
-    pwdPassed = await PwdUtil.compare(password, hash);
-  if (!pwdPassed) {
-    // If password failed, wait 500ms this will increase security
-    await tick(500);
-    throw new RouteError(
-      HttpStatusCodes.UNAUTHORIZED, 
-      Errors.Unauth,
-    );
-  }
-  // Return
-  return user;
-}
-
-
-// **** Export default **** //
-
-export default {
-  login,
-} as const;

package/lib/project-files-auth/src/services/UserService.ts

@@ -1,59 +0,0 @@
-import { RouteError } from '@src/common/classes';
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
-
-import UserRepo from '@src/repos/UserRepo';
-import { IUser } from '@src/models/User';
-
-
-// **** Variables **** //
-
-export const USER_NOT_FOUND_ERR = 'User not found';
-
-
-// **** Functions **** //
-
-/**
- * Get all users.
- */
-function getAll(): Promise<IUser[]> {
-  return UserRepo.getAll();
-}
-
-/**
- * Add one user.
- */
-function addOne(user: IUser): Promise<void> {
-  return UserRepo.add(user);
-}
-
-/**
- * Update one user.
- */
-async function updateOne(user: IUser): Promise<void> {
-  const persists = await UserRepo.persists(user.id);
-  if (!persists) {
-    throw new RouteError(HttpStatusCodes.NOT_FOUND, USER_NOT_FOUND_ERR);
-  }
-  return UserRepo.update(user);
-}
-
-/**
- * Delete a user by their id.
- */
-async function _delete(id: number): Promise<void> {
-  const persists = await UserRepo.persists(id);
-  if (!persists) {
-    throw new RouteError(HttpStatusCodes.NOT_FOUND, USER_NOT_FOUND_ERR);
-  }
-  return UserRepo.delete(id);
-}
-
-
-// **** Export default **** //
-
-export default {
-  getAll,
-  addOne,
-  updateOne,
-  delete: _delete,
-} as const;

package/lib/project-files-auth/src/util/PwdUtil.ts

@@ -1,39 +0,0 @@
-import bcrypt from 'bcrypt';
-
-
-// **** Variables **** //
-
-const SALT_ROUNDS = 12;
-
-
-// **** Functions **** //
-
-/**
- * Get a hash from the password.
- */
-function getHash(pwd: string): Promise<string> {
-  return bcrypt.hash(pwd, SALT_ROUNDS);
-}
-
-/**
- * Useful for testing.
- */
-function hashSync(pwd: string): string {
-  return bcrypt.hashSync(pwd, SALT_ROUNDS);
-}
-
-/**
- * See if a password passes the hash.
- */
-function compare(pwd: string, hash: string): Promise<boolean> {
-  return bcrypt.compare(pwd, hash);
-}
-
-
-// **** Export Default **** //
-
-export default {
-  getHash,
-  hashSync,
-  compare,
-} as const;

package/lib/project-files-auth/src/util/SessionUtil.ts

@@ -1,94 +0,0 @@
-import jsonwebtoken from 'jsonwebtoken';
-
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import { RouteError } from '@src/common/classes';
-import EnvVars from '@src/common/EnvVars';
-import { IReq, IRes } from '@src/routes/common/types';
-
-
-// **** Variables **** //
-
-// Errors
-const Errors = {
-  ParamFalsey: 'Param is falsey',
-  Validation: 'JSON-web-token validation failed.',
-} as const;
-
-// Options
-const Options = {
-  expiresIn: EnvVars.Jwt.Exp,
-};
-
-
-// **** Functions **** //
-
-/**
- * Get session data from request object (i.e. ISessionUser)
- */
-function getSessionData<T>(req: IReq): Promise<string | T | undefined> {
-  const { Key } = EnvVars.CookieProps,
-    jwt = req.signedCookies[Key];
-  return _decode(jwt);
-}
-
-/**
- * Decrypt JWT and extract client data.
- */
-function _decode<T>(jwt: string): Promise<string | undefined | T> {
-  return new Promise((res, rej) => {
-    jsonwebtoken.verify(jwt, EnvVars.Jwt.Secret, (err, decoded) => {
-      if (!!err) {
-        const err = new RouteError(HttpStatusCodes.UNAUTHORIZED, 
-          Errors.Validation);
-        return rej(err);
-      } else {
-        return res(decoded as T);
-      }
-    });
-  });
-}
-
-/**
- * Add a JWT to the response 
- */
-async function addSessionData(
-  res: IRes,
-  data: string | object,
-): Promise<IRes> {
-  if (!res || !data) {
-    throw new RouteError(HttpStatusCodes.BAD_REQUEST, Errors.ParamFalsey);
-  }
-  // Setup JWT
-  const jwt = await _sign(data),
-    { Key, Options } = EnvVars.CookieProps;
-  // Return
-  return res.cookie(Key, jwt, Options);
-}
-
-/**
- * Encrypt data and return jwt.
- */
-function _sign(data: string | object | Buffer): Promise<string> {
-  return new Promise((res, rej) => {
-    jsonwebtoken.sign(data, EnvVars.Jwt.Secret, Options, (err, token) => {
-      return (err ? rej(err) : res(token ?? ''));
-    });
-  });
-}
-
-/**
- * Remove cookie
- */
-function clearCookie(res: IRes): IRes {
-  const { Key, Options } = EnvVars.CookieProps;
-  return res.clearCookie(Key, Options);
-}
-
-
-// **** Export default **** //
-
-export default {
-  addSessionData,
-  getSessionData,
-  clearCookie,
-} as const;

package/lib/project-files-auth/src/util/misc.ts

@@ -1,22 +0,0 @@
-/**
- * Miscellaneous shared functions go here.
- */
-
-
-/**
- * Get a random number between 1 and 1,000,000,000,000
- */
-export function getRandomInt(): number {
-  return Math.floor(Math.random() * 1_000_000_000_000);
-}
-
-/**
- * Wait for a certain number of milliseconds.
- */
-export function tick(milliseconds: number): Promise<void> {
-  return new Promise((resolve) => {
-    setTimeout(() => {
-      resolve();
-    }, milliseconds);
-  });
-}

package/lib/project-files-auth/src/views/login.html

@@ -1,58 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-  <!-- Head -->
-  <head>
-    <meta charset="UTF-8">
-    <title>Login</title>
-    <link rel="stylesheet" type="text/css" href="/stylesheets/login.css" />
-
-    <!-- Handlebars -->
-    <script src="http://cdnjs.cloudflare.com/ajax/libs/handlebars.js/4.7.8/handlebars.min.js"></script>
-
-    <!-- Bootstrap -->
-    <link
-      href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
-      rel="stylesheet"
-      integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
-      crossorigin="anonymous"
-    />
-    <script
-      src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
-      integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
-      crossorigin="anonymous"
-    ></script>
-  </head>
-
-  <!-- Body -->
-  <body>
-
-    <div class="login-block">
-      <div class="login-header">Login</div>
-
-      <div class="login-input">
-        Username:<br/>
-        <input id="email-input" type="text" class="form-control"/>
-      </div>
-      
-      <div class="login-input">
-        Password:<br/>
-        <input id="pwd-input" type="password" class="form-control"/>
-      </div>
-
-      <div>
-        <button id="login-btn" class="btn btn-primary">
-          Login
-        </button>
-      </div>
-
-      <div class="default-login-user">
-        // Default admin user (Email: "sean.maxwell@gmail.com", Password: "Password@1")
-      </div>
-    </div>
-
-  </body>
-  
-  <script src="scripts/http.js"></script>
-  <script src="scripts/login.js"></script>
-</html>

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

@@ -1,140 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-  <!-- Head -->
-  <head>
-    <meta charset="UTF-8">
-    <title>Users</title>
-    <link rel="stylesheet" type="text/css" href="/stylesheets/users.css" />
-
-    <!-- Handlebars -->
-    <script src="http://cdnjs.cloudflare.com/ajax/libs/handlebars.js/4.7.8/handlebars.min.js"></script>
-
-    <!-- Bootstrap -->
-    <link
-      href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
-      rel="stylesheet"
-      integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
-      crossorigin="anonymous"
-    />
-    <script
-      src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
-      integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
-      crossorigin="anonymous"
-    ></script>
-  </head>
-
-  <!-- Body -->
-  <body>
-
-    <!-- Add Users -->
-    <div class="users-column add-user-col">
-      <div class="column-header">
-        Add User:
-      </div>
-      <div>
-        <input
-          id="name-input"
-          type="text"
-          class="form-control"
-          placeholder="Name"
-        />
-      </div>
-      <div>
-        <input
-          id="email-input"
-          type="email"
-          class="form-control"
-          placeholder="Email"
-        />
-      </div>
-      <div>
-        <button
-          id="add-user-btn"
-          class="btn btn-success"
-        >
-          Add
-        </button>
-        <button
-          id="logout-btn"
-          class="btn btn-secondary"
-        >
-          Logout
-        </button>
-      </div>
-    </div>
-
-    <!-- Display Users -->
-    <div class="users-column">
-      <div class="column-header">
-        Users:
-      </div>
-
-      <div id="all-users-anchor"></div>
-      <script
-        id="all-users-template"
-        type="text/x-handlebars-template"
-      >
-        {{#each users}}
-          <div class="user-display-ele">
-            <div class="normal-view">
-              <div class="display-wrapper">
-                <div><b>Name:</b> {{name}}</div>
-                <div><b>Email:</b> {{email}}</div>
-                <div><b>Created:</b> {{createdFormatted}}</div>
-              </div>
-              <button
-                type="button"
-                class="btn btn-primary edit-user-btn"
-                data-user-id="{{id}}"
-              >
-                Edit
-              </button>
-              <button
-                class="btn btn-danger delete-user-btn"
-                data-user-id="{{id}}"
-              >
-                Delete
-              </button>
-            </div>
-
-            <div class="edit-view">
-              <div>
-                Name:&nbsp;
-                <input
-                  type="text"
-                  class="form-control name-edit-input"
-                  value="{{name}}"
-                />
-              </div>
-              <div class="email-edit">
-                Email:&nbsp;
-                <input
-                  type="email"
-                  class="form-control email-edit-input"
-                  value="{{email}}"
-                />
-              </div>
-              <button
-                class="btn btn-primary submit-edit-btn"
-                data-user-id="{{id}}"
-                data-user-created="{{created}}"
-              >
-                Submit
-              </button>
-              <button
-                class="btn btn-secondary cancel-edit-btn"
-                data-user-id="{{id}}"
-              >
-                Cancel
-              </button>
-            </div>
-          </div>
-        {{/each}}
-      </script>
-    </div>
-  </body>
-
-  <script src="scripts/http.js"></script>
-  <script src="scripts/users.js"></script>
-</html>

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

@@ -1,87 +0,0 @@
-{
-  "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-
-    /* Basic Options */
-    // "incremental": true,                   /* Enable incremental compilation */
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                             /* Specify library files to be included in the compilation. */
-    // "allowJs": true,                       /* Allow javascript files to be compiled. */
-    // "checkJs": true,                       /* Report errors in .js files. */
-    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
-    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
-    // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "dist",                        /* Redirect output structure to the directory. */
-    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    // "composite": true,                     /* Enable project compilation */
-    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
-    // "removeComments": true,                /* Do not emit comments to output. */
-    // "noEmit": true,                        /* Do not emit outputs. */
-    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-
-    /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
-    // "strictNullChecks": true,              /* Enable strict null checks. */
-    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
-    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
-    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
-    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
-
-    /* Additional Checks */
-    // "noUnusedLocals": true,                /* Report errors on unused locals. */
-    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
-    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
-    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
-
-    /* Module Resolution Options */
-    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
-
-    /* Source Map Options */
-    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-
-    /* Experimental Options */
-    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
-
-    /* Advanced Options */
-    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true,  /* Disallow inconsistently-cased references to the same file. */
-    "paths": {
-      "@src/*": [
-        "src/*"
-      ],
-    },
-    "useUnknownInCatchVariables": false
-  },
-  "ts-node": {
-    "require": ["tsconfig-paths/register", "./preload.js"]
-  },
-  "include": [
-    "src/**/*.ts",
-    "spec/**/*.ts",
-    "scripts",
-    "preload.js"
-  ],
-  "exclude": [
-    "src/public/*"
-  ]
-}

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

@@ -1,12 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "sourceMap": false,
-    "removeComments": true
-  },
-  "exclude": [
-    "spec",
-    "src/public/",
-    "scripts"
-  ]
-}