express-generator-typescript 2.3.7 → 2.4.0

package/lib/project-files-auth/src/public/scripts/users.js

@@ -0,0 +1,164 @@
+// ***** Start **** //
+
+displayUsers();
+
+
+// ***** Fetch and display users **** //
+
+/**
+ * Call api
+ */
+function displayUsers() {
+  Http
+    .get('/api/users/all')
+    .then(resp => resp.json())
+    .then((resp) => {
+      var allUsers = resp.users;
+      // Empty the anchor
+      var allUsersAnchor = document.getElementById('all-users-anchor');
+      allUsersAnchor.innerHTML = '';
+      // Append users to anchor
+      allUsers.forEach((user) => {
+        allUsersAnchor.innerHTML += getUserDisplayEle(user);
+      });
+    });
+}
+
+/**
+ * Get user display element
+ */
+function getUserDisplayEle(user) {
+  return (
+    `<div class="user-display-ele">
+
+      <div class="normal-view">
+        <div>Name: ${user.name}</div>
+        <div>Email: ${user.email}</div>
+        <button class="edit-user-btn" data-user-id="${user.id}" data-user-role="${user.role}">
+          Edit
+        </button>
+        <button class="delete-user-btn" data-user-id="${user.id}">
+          Delete
+        </button>
+      </div>
+
+      <div class="edit-view">
+        <div>
+          Name: <input class="name-edit-input" value="${user.name}">
+        </div>
+        <div>
+          Email: <input class="email-edit-input" value="${user.email}">
+        </div>
+        <button class="submit-edit-btn" data-user-id="${user.id}">
+          Submit
+        </button>
+        <button class="cancel-edit-btn" data-user-id="${user.id}">
+          Cancel
+        </button>
+      </div>
+    </div>`
+  );
+}
+
+
+// **** Add, Edit, and Delete Users **** //
+
+// Setup event listener for button click
+document.addEventListener('click', function (event) {
+  event.preventDefault();
+  var ele = event.target;
+  if (ele.matches('#add-user-btn')) {
+    addUser();
+  } else if (ele.matches('.edit-user-btn')) {
+    showEditView(ele.parentNode.parentNode);
+  } else if (ele.matches('.cancel-edit-btn')) {
+    cancelEdit(ele.parentNode.parentNode);
+  } else if (ele.matches('.submit-edit-btn')) {
+    submitEdit(ele);
+  } else if (ele.matches('.delete-user-btn')) {
+    deleteUser(ele);
+  } else if (ele.matches('#logout-btn')) {
+    logoutUser();
+  }
+}, false);
+
+/**
+ * Add a new user.
+ */
+function addUser() {
+  var nameInput = document.getElementById('name-input');
+  var emailInput = document.getElementById('email-input');
+  var data = {
+    user: {
+      id: -1,
+      name: nameInput.value,
+      email: emailInput.value,
+      role: 0,
+    },
+  };
+  // Call api
+  Http
+    .post('/api/users/add', data)
+    .then(() => displayUsers());
+}
+
+/**
+ * Show edit view.
+ */
+function showEditView(userEle) {
+  var normalView = userEle.getElementsByClassName('normal-view')[0];
+  var editView = userEle.getElementsByClassName('edit-view')[0];
+  normalView.style.display = 'none';
+  editView.style.display = 'block';
+}
+
+/**
+ * Cancel edit.
+ */
+function cancelEdit(userEle) {
+  var normalView = userEle.getElementsByClassName('normal-view')[0];
+  var editView = userEle.getElementsByClassName('edit-view')[0];
+  normalView.style.display = 'block';
+  editView.style.display = 'none';
+}
+
+/**
+ * Submit edit.
+ */
+function submitEdit(ele) {
+  var userEle = ele.parentNode.parentNode;
+  var nameInput = userEle.getElementsByClassName('name-edit-input')[0];
+  var emailInput = userEle.getElementsByClassName('email-edit-input')[0];
+  var id = ele.getAttribute('data-user-id');
+  var role = ele.getAttribute('data-user-role');
+  var data = {
+    user: {
+      id: Number(id),
+      name: nameInput.value,
+      email: emailInput.value,
+      role: Number(role),
+    },
+  };
+	Http
+    .put('/api/users/update', data)
+    .then(() => displayUsers());
+}
+
+/**
+ * Delete a user
+ */
+function deleteUser(ele) {
+  var id = ele.getAttribute('data-user-id');
+	Http
+    .delete('/api/users/delete/' + id)
+    .then(() => displayUsers());
+}
+
+
+// **** Logout **** //
+
+function logoutUser() {
+  Http
+    .get('/api/auth/logout')
+    .then(() => window.location.href = '/');
+}

package/lib/project-files-auth/src/public/stylesheets/users.css

@@ -0,0 +1,50 @@
+body {
+  padding: 100px;
+  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
+}
+
+body .users-column {
+  display: inline-block;
+  margin-right: 2em;
+  vertical-align: top;
+}
+
+body .users-column .column-header {
+  padding-bottom: 5px;
+  font-weight: 700;
+  font-size: 1.2em;
+}
+
+
+/** Add User Column **/
+
+body .add-user-col input {
+  margin-bottom: 10px;
+}
+
+body .add-user-col #add-user-btn {
+  margin-top: 2px;
+  margin-bottom: 10px;
+}
+
+body .add-user-col #logout-btn {
+  margin-top: 25px;
+  margin-bottom: 10px;
+  font-size: 15px;
+}
+
+
+/** Users Display Column **/
+
+body .users-column .user-display-ele {
+  padding-bottom: 10px;
+}
+
+body .users-column .user-display-ele button {
+  margin-top: 2px;
+  margin-bottom: 10px;
+}
+
+body .users-column .user-display-ele .edit-view {
+  display: none;
+}

package/lib/project-files-auth/src/repos/MockOrm.ts

@@ -0,0 +1,42 @@
+
+
+import jsonfile from 'jsonfile';
+
+import { IUser } from '@src/models/User';
+
+
+// **** Variables **** //
+
+const DB_FILE_NAME = 'database.json';
+
+
+// **** Types **** //
+
+interface IDb {
+  users: IUser[];
+}
+
+
+// **** Functions **** //
+
+/**
+ * Fetch the json from the file.
+ */
+function openDb(): Promise<IDb> {
+  return jsonfile.readFile(__dirname + '/' + DB_FILE_NAME) as Promise<IDb>;
+}
+
+/**
+ * Update the file.
+ */
+function saveDb(db: IDb): Promise<void> {
+  return jsonfile.writeFile((__dirname + '/' + DB_FILE_NAME), db);
+}
+
+
+// **** Export default **** //
+
+export default {
+  openDb,
+  saveDb,
+} as const;

package/lib/project-files-auth/src/repos/UserRepo.ts

@@ -0,0 +1,88 @@
+import { IUser } from '@src/models/User';
+import { getRandomInt } from '@src/util/misc';
+import orm from './MockOrm';
+
+
+// **** Functions **** //
+
+/**
+ * Get one user.
+ */
+async function getOne(email: string): Promise<IUser | null> {
+  const db = await orm.openDb();
+  for (const user of db.users) {
+    if (user.email === email) {
+      return user;
+    }
+  }
+  return null;
+}
+
+/**
+ * See if a user with the given id exists.
+ */
+async function persists(id: number): Promise<boolean> {
+  const db = await orm.openDb();
+  for (const user of db.users) {
+    if (user.id === id) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Get all users.
+ */
+async function getAll(): Promise<IUser[]> {
+  const db = await orm.openDb();
+  return db.users;
+}
+
+/**
+ * Add one user.
+ */
+async function add(user: IUser): Promise<void> {
+  const db = await orm.openDb();
+  user.id = getRandomInt();
+  db.users.push(user);
+  return orm.saveDb(db);
+}
+
+/**
+ * Update a user.
+ */
+async function update(user: IUser): Promise<void> {
+  const db = await orm.openDb();
+  for (let i = 0; i < db.users.length; i++) {
+    if (db.users[i].id === user.id) {
+      db.users[i] = user;
+      return orm.saveDb(db);
+    }
+  }
+}
+
+/**
+ * Delete one user.
+ */
+async function delete_(id: number): Promise<void> {
+  const db = await orm.openDb();
+  for (let i = 0; i < db.users.length; i++) {
+    if (db.users[i].id === id) {
+      db.users.splice(i, 1);
+      return orm.saveDb(db);
+    }
+  }
+}
+
+
+// **** Export default **** //
+
+export default {
+  getOne,
+  persists,
+  getAll,
+  add,
+  update,
+  delete: delete_,
+} as const;

package/lib/project-files-auth/src/repos/database.json

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

package/lib/project-files-auth/src/routes/UserRoutes.ts

@@ -0,0 +1,53 @@
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+
+import UserService from '@src/services/UserService';
+import { IUser } from '@src/models/User';
+import { IReq, IRes } from './types/express/misc';
+
+
+// **** Functions **** //
+
+/**
+ * Get all users.
+ */
+async function getAll(_: IReq, res: IRes) {
+  const users = await UserService.getAll();
+  return res.status(HttpStatusCodes.OK).json({ users });
+}
+
+/**
+ * Add one user.
+ */
+async function add(req: IReq<{user: IUser}>, res: IRes) {
+  const { user } = req.body;
+  await UserService.addOne(user);
+  return res.status(HttpStatusCodes.CREATED).end();
+}
+
+/**
+ * Update one user.
+ */
+async function update(req: IReq<{user: IUser}>, res: IRes) {
+  const { user } = req.body;
+  await UserService.updateOne(user);
+  return res.status(HttpStatusCodes.OK).end();
+}
+
+/**
+ * Delete one user.
+ */
+async function delete_(req: IReq, res: IRes) {
+  const id = +req.params.id;
+  await UserService.delete(id);
+  return res.status(HttpStatusCodes.OK).end();
+}
+
+
+// **** Export default **** //
+
+export default {
+  getAll,
+  add,
+  update,
+  delete: delete_,
+} as const;

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

@@ -0,0 +1,75 @@
+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';
+
+
+// **** Variables **** //
+
+const apiRouter = Router(),
+  validate = jetValidator();
+
+
+// **** Setup AuthRouter **** //
+
+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();
+
+// Get all users
+userRouter.get(
+  Paths.Users.Get,
+  UserRoutes.getAll,
+);
+
+// Add one user
+userRouter.post(
+  Paths.Users.Add,
+  validate(['user', User.isUser]),
+  UserRoutes.add,
+);
+
+// Update one user
+userRouter.put(
+  Paths.Users.Update,
+  validate(['user', User.isUser]),
+  UserRoutes.update,
+);
+
+// Delete one user
+userRouter.delete(
+  Paths.Users.Delete,
+  validate(['id', 'number', 'params']),
+  UserRoutes.delete,
+);
+
+// Add UserRouter
+apiRouter.use(Paths.Users.Base, adminMw, userRouter);
+
+
+// **** Export default **** //
+
+export default apiRouter;

package/lib/project-files-auth/src/routes/constants/FullPaths.ts

@@ -0,0 +1,40 @@
+
+/**
+ * Convert paths to full paths.
+ */
+
+import Paths, { TPaths } from './Paths';
+
+
+interface IPathObj {
+  Base: string;
+  [key: string]: string | IPathObj;
+}
+
+/**
+ * The recursive function.
+ */
+function getFullPaths(
+  parent: IPathObj,
+  baseUrl: string,
+): IPathObj {
+  const url = (baseUrl + parent.Base),
+    keys = Object.keys(parent),
+    retVal: IPathObj = { Base: url };
+  // Iterate keys
+  for (const key of keys) {
+    const pval = parent[key];
+    if (key !== 'Base' && typeof pval === 'string') {
+      retVal[key] = (url + pval);
+    } else if (typeof pval === 'object') {
+      retVal[key] = getFullPaths(pval, url);
+    }
+  }
+  // Return
+  return retVal;
+}
+
+
+// **** Export default **** //
+
+export default getFullPaths(Paths, '') as TPaths;

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

@@ -0,0 +1,28 @@
+/**
+ * Express router paths go here.
+ */
+
+import { Immutable } from '@src/other/types';
+
+
+const Paths = {
+  Base: '/api',
+  Auth: {
+    Base: '/auth',
+    Login: '/login',
+    Logout: '/logout',
+  },
+  Users: {
+    Base: '/users',
+    Get: '/all',
+    Add: '/add',
+    Update: '/update',
+    Delete: '/delete/:id',
+  },
+};
+
+
+// **** Export **** //
+
+export type TPaths = Immutable<typeof Paths>;
+export default Paths as TPaths;

package/lib/project-files-auth/src/routes/types/express/index.d.ts

@@ -0,0 +1,11 @@
+import 'express';
+
+
+// **** Declaration Merging **** //
+
+declare module 'express' {
+
+  export interface Request {
+    signedCookies: Record<string, string>;
+  }
+}

package/lib/project-files-auth/src/routes/types/express/misc.ts

@@ -0,0 +1,16 @@
+import * as e from 'express';
+
+import { ISessionUser } from '@src/models/User';
+
+
+// **** Express **** //
+
+export interface IReq<T = void> extends e.Request {
+  body: T;
+}
+
+export interface IRes extends e.Response {
+  locals: {
+    sessionUser?: ISessionUser;
+  };
+}

package/lib/project-files-auth/src/routes/types/types.ts

@@ -0,0 +1,22 @@
+import * as e from 'express';
+import { Query } from 'express-serve-static-core';
+
+import { ISessionUser } from '@src/models/User';
+
+
+// **** Express **** //
+
+export interface IReq<T = void> extends e.Request {
+  body: T;
+}
+
+export interface IReqQuery<T extends Query, U = void> extends e.Request {
+  query: T;
+  body: U;
+}
+
+export interface IRes extends e.Response {
+  locals: {
+    sessionUser: ISessionUser;
+  };
+}

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

@@ -0,0 +1,96 @@
+/**
+ * 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/api';
+import Paths from '@src/routes/constants/Paths';
+
+import EnvVars from '@src/constants/EnvVars';
+import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+
+import { NodeEnvs } from '@src/constants/misc';
+import { RouteError } from '@src/other/classes';
+
+
+// **** 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) {
+  app.use(morgan('dev'));
+}
+
+// Security
+if (EnvVars.NodeEnv === NodeEnvs.Production) {
+  app.use(helmet());
+}
+
+// Add APIs, must be after middleware
+app.use(Paths.Base, BaseRouter);
+
+// Add error handler
+app.use((
+  err: Error,
+  _: Request,
+  res: Response,
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  next: NextFunction,
+) => {
+  if (EnvVars.NodeEnv !== NodeEnvs.Test) {
+    logger.err(err, true);
+  }
+  let status = HttpStatusCodes.BAD_REQUEST;
+  if (err instanceof RouteError) {
+    status = err.status;
+  }
+  return res.status(status).json({ error: err.message });
+});
+
+
+// ** 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: Request, res: Response) => {
+  const jwt = req.signedCookies[EnvVars.CookieProps.Key];
+  if (!jwt) {
+    res.redirect('/');
+  } else {
+    res.sendFile('users.html', {root: viewsDir});
+  }
+});
+
+
+// **** Export default **** //
+
+export default app;