express-generator-typescript 2.3.7 → 2.4.0

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

@@ -0,0 +1,56 @@
+import UserRepo from '@src/repos/UserRepo';
+
+import PwdUtil from '@src/util/PwdUtil';
+import { tick } from '@src/util/misc';
+
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import { RouteError } from '@src/other/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

@@ -0,0 +1,66 @@
+import UserRepo from '@src/repos/UserRepo';
+import { IUser } from '@src/models/User';
+import { RouteError } from '@src/other/classes';
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+
+
+// **** 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 user
+  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,
+    );
+  }
+  // Delete user
+  return UserRepo.delete(id);
+}
+
+
+// **** Export default **** //
+
+export default {
+  getAll,
+  addOne,
+  updateOne,
+  delete: _delete,
+} as const;

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

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

@@ -0,0 +1,92 @@
+import { Request, Response } from 'express';
+
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import { RouteError } from '@src/other/classes';
+import jsonwebtoken from 'jsonwebtoken';
+
+import EnvVars from '../constants/EnvVars';
+
+
+// **** 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: Request): Promise<string | T | undefined> {
+  const { Key } = EnvVars.CookieProps,
+    jwt = req.signedCookies[Key];
+  return _decode(jwt);
+}
+
+/**
+ * Add a JWT to the response 
+ */
+async function addSessionData(
+  res: Response,
+  data: string | object,
+): Promise<Response> {
+  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);
+}
+
+/**
+ * Remove cookie
+ */
+function clearCookie(res: Response): Response {
+  const { Key, Options } = EnvVars.CookieProps;
+  return res.clearCookie(Key, Options);
+}
+
+
+// **** Helper Functions **** //
+
+/**
+ * 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 || '');
+    });
+  });
+}
+
+/**
+ * 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) => {
+      return err ? rej(Errors.Validation) : res(decoded as T);
+    });
+  });
+}
+
+
+// **** Export default **** //
+
+export default {
+  addSessionData,
+  getSessionData,
+  clearCookie,
+} as const;

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

@@ -0,0 +1,22 @@
+/**
+ * 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/users.html

@@ -0,0 +1,42 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <title>Users</title>
+    <link rel="stylesheet" type="text/css" href="/stylesheets/users.css" />
+  </head>
+  <body>
+
+    <!-- Add Users -->
+    <div class="users-column add-user-col">
+      <div class="column-header">
+        Add User:
+      </div>
+      <div>
+        <input id="name-input" placeholder="Name" />
+      </div>
+      <div>
+        <input id="email-input" placeholder="Email" />
+      </div>
+      <div>
+        <button id="add-user-btn">
+          Add
+        </button>
+      </div>
+      <div>
+        <button id="logout-btn">
+          Logout
+        </button>
+      </div>
+    </div>
+
+    <!-- Display Users -->
+    <div class="users-column">
+      <div class="column-header">Users:</div>
+      <div id="all-users-anchor"></div>
+    </div>
+
+  </body>
+  <script src="scripts/http.js"></script>
+  <script src="scripts/users.js"></script>
+</html>

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

@@ -0,0 +1,83 @@
+{
+  "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
+  },
+  "include": [
+    "src/**/*.ts",
+    "spec/**/*.ts",
+    "build.ts"
+  ],
+  "exclude": [
+    "src/public/"
+  ]
+}

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.3.7",
+  "version": "2.4.0",
   "description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
   "scripts": {
     "express-generator-typescript": "node bin/cli.js",