express-generator-typescript 1.10.1 → 2.0.0

package/lib/socket-io/src/routes/auth-router.ts

@@ -1,67 +0,0 @@
-
-import authService from '@services/auth-service';
-import { ParamMissingError } from '@shared/errors';
-import { Request, Response, Router } from 'express';
-import StatusCodes from 'http-status-codes';
-
-
-// **** Variables **** //
-
-// Misc
-const router = Router();
-const { OK } = StatusCodes;
-
-// Paths
-export const p = {
-  login: '/login',
-  logout: '/logout',
-} as const;
-
-// Cookie Properties
-export const cookieProps = Object.freeze({
-  key: 'ExpressGeneratorTs',
-  secret: process.env.COOKIE_SECRET,
-  options: {
-    httpOnly: true,
-    signed: true,
-    path: (process.env.COOKIE_PATH),
-    maxAge: Number(process.env.COOKIE_EXP),
-    domain: (process.env.COOKIE_DOMAIN),
-    secure: (process.env.SECURE_COOKIE === 'true'),
-  },
-});
-
-
-// **** Routes **** //
-
-/**
- * Login a user.
- */
-router.post(p.login, async (req: Request, res: Response) => {
-  // Check email and password present
-  const { email, password } = req.body;
-  if (!(email && password)) {
-    throw new ParamMissingError();
-  }
-  // Get jwt
-  const jwt = await authService.login(email, password);
-  // Add jwt to cookie
-  const { key, options } = cookieProps;
-  res.cookie(key, jwt, options);
-  // Return
-  return res.status(OK).end();
-});
-
-/**
- * Logout the user.
- */
-router.get(p.logout, (_: Request, res: Response) => {
-  const { key, options } = cookieProps;
-  res.clearCookie(key, options);
-  return res.status(OK).end();
-});
-
-
-// **** Export router **** //
-
-export default router;

package/lib/socket-io/src/routes/chat-router.ts

@@ -1,88 +0,0 @@
-import SocketIO from 'socket.io';
-import StatusCodes from 'http-status-codes';
-import { Router, Request, Response } from 'express';
-
-import { ParamMissingError, RoomNotFoundError } from '@shared/errors';
-
-
-// **** Variables **** //
-
-// Chat router
-const router = Router();
-const { OK } = StatusCodes;
-
-// Paths
-export const p = {
-  connect: '/connect-socket-room/:socketId',
-  emit: '/emit-message',
-} as const;
-
-export const socketRoomName = 'jet-logger-chat-room';
-
-
-// **** Routes **** //
-
-/**
- * Connect to socket room.
- */
-router.get(p.connect, async (req: Request, res: Response) => {
-  const { socketId } = req.params;
-  // Check params
-  if (!socketId) {
-    throw new ParamMissingError();
-  }
-  // Get socket
-  const socket = getSocket(req, socketId);
-  // Connect
-  await Promise.all([
-    socket.leave(socketRoomName),
-    socket.join(socketRoomName),
-  ]);
-  // Return
-  return res.status(OK).end();
-});
-
-/**
- * Send a chat message.
- */
-router.post(p.emit, (req: Request, res: Response) => {
-  const { sessionUser } = res.locals;
-  const { message, socketId } = req.body;
-  // Check params
-  if (!socketId || !message) {
-    throw new ParamMissingError();
-  }
-  // Get socket
-  const socket = getSocket(req, socketId);
-  // Connect
-  const room = socket.to(socketRoomName);
-  room.emit('emit-msg', {
-    timestamp: Date.now(),
-    content: message,
-    senderName: sessionUser.name,
-  });
-  // Return
-  return res.status(OK).json({
-    senderName: sessionUser.name,
-  });
-});
-
-
-// **** Helpers **** //
-
-/**
- * Get the socket from the Express request object.
- */
-function getSocket(req: Request, socketId: string): SocketIO.Socket {
-  const io = req.app.get('socketio') as SocketIO.Server;
-  const socket = io.sockets.sockets.get(socketId);
-  if (!socket) {
-    throw new RoomNotFoundError();
-  }
-  return socket;
-}
-
-
-// **** Export default **** //
-
-export default router;

package/lib/socket-io/src/routes/middleware.ts

@@ -1,55 +0,0 @@
-import StatusCodes from 'http-status-codes';
-import { Request, Response, NextFunction } from 'express';
-import { JwtPayload } from 'jsonwebtoken';
-
-import { cookieProps } from '@routes/auth-router';
-import { IUser } from '@models/user-model';
-import jwtUtil from '@util/jwt-util';
-
-
-// **** Variables **** //
-
-const { UNAUTHORIZED } = StatusCodes;
-const jwtNotPresentErr = 'JWT not present in signed cookie.';
-
-
-// **** Types **** //
-
-export interface ISessionUser extends JwtPayload {
-  id: number;
-  email: string;
-  name: string;
-  role: IUser['role'];
-}
-
-
-// **** Functions **** //
-
-/**
- * Middleware to verify if user is an admin.
- */
-export async function authMw(req: Request, res: Response, next: NextFunction) {
-  try {
-    // Get json-web-token
-    const jwt = req.signedCookies[cookieProps.key];
-    if (!jwt) {
-      throw Error(jwtNotPresentErr);
-    }
-    // Make sure user role is an admin
-    const clientData = await jwtUtil.decode(jwt);
-    if (!!clientData && typeof clientData !== 'string') {
-      res.locals.sessionUser = clientData as ISessionUser;
-      next();
-    } else {
-      throw Error(jwtNotPresentErr);
-    }
-  } catch (err) {
-    let error;
-    if (typeof err === 'string') {
-      error = err;
-    } else if (err instanceof Error) {
-      error = err.message;
-    }
-    return res.status(UNAUTHORIZED).json({ error });
-  }
-}

package/lib/socket-io/src/routes/user-router.ts

@@ -1,76 +0,0 @@
-import StatusCodes from 'http-status-codes';
-import { Request, Response, Router } from 'express';
-
-import userService from '@services/user-service';
-import { ParamMissingError } from '@shared/errors';
-
-
-// **** Variables **** //
-
-// Constants
-const router = Router();
-const { CREATED, OK } = StatusCodes;
-
-// Paths
-export const p = {
-  get: '/all',
-  add: '/add',
-  update: '/update',
-  delete: '/delete/:id',
-} as const;
-
-
-// **** Routes **** //
-
-/**
- * Get all users.
- */
-router.get(p.get, async (_: Request, res: Response) => {
-  const users = await userService.getAll();
-  return res.status(OK).json({users});
-});
-
-/**
- * Add one user.
- */
-router.post(p.add, async (req: Request, res: Response) => {
-  const { user } = req.body;
-  if (!user) {
-    throw new ParamMissingError();
-  }
-  // Fetch data
-  await userService.addOne(user);
-  return res.status(CREATED).end();
-});
-
-/**
- * Update one user.
- */
-router.put(p.update, async (req: Request, res: Response) => {
-  const { user } = req.body;
-  if (!user) {
-    throw new ParamMissingError();
-  }
-  // Fetch data
-  await userService.updateOne(user);
-  return res.status(OK).end();
-});
-
-
-/**
- * Delete one user.
- */
-router.delete(p.delete, async (req: Request, res: Response) => {
-  const { id } = req.params;
-  if (!id) {
-    throw new ParamMissingError();
-  }
-  // Fetch data
-  await userService.delete(Number(id));
-  return res.status(OK).end();
-});
-
-
-// **** Export default **** //
-
-export default router;

package/lib/socket-io/src/server.ts

@@ -1,100 +0,0 @@
-import cookieParser from 'cookie-parser';
-import morgan from 'morgan';
-import path from 'path';
-import http from 'http';
-import helmet from 'helmet';
-import StatusCodes from 'http-status-codes';
-import { Server as SocketIo } from 'socket.io';
-import express, { NextFunction, Request, Response } from 'express';
-
-import 'express-async-errors';
-
-import BaseRouter from './routes/api';
-import logger from 'jet-logger';
-import envVars from '@shared/env-vars';
-import { CustomError } from '@shared/errors';
-
-
-// **** Init express **** //
-
-const app = express();
-
-
-// **** Set basic express settings **** //
-
-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 === 'development') {
-  app.use(morgan('dev'));
-}
-
-// Security
-if (envVars.nodeEnv === 'production') {
-  app.use(helmet());
-}
-
-// Add APIs
-app.use('/api', BaseRouter);
-
-// Error handling
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-app.use((err: Error | CustomError, req: Request, res: Response, _: NextFunction) => {
-  logger.err(err, true);
-  const status = (err instanceof CustomError ? err.HttpStatus : StatusCodes.BAD_REQUEST);
-  return res.status(status).json({
-    error: err.message,
-  });
-});
-
-
-// **** Serve front-end content **** //
-
-const viewsDir = path.join(__dirname, 'views');
-app.set('views', viewsDir);
-const staticDir = path.join(__dirname, 'public');
-app.use(express.static(staticDir));
-
-// Login page
-app.get('/', (_: Request, res: Response) => {
-  return res.sendFile('login.html', {root: viewsDir});
-});
-
-// Users page
-app.get('/users', (req: Request, res: Response) => {
-  const jwt = req.signedCookies[envVars.cookieProps.key];
-  if (!jwt) {
-    return res.redirect('/');
-  } else {
-    return res.sendFile('users.html', {root: viewsDir});
-  }
-});
-
-// Chat page
-app.get('/chat', (req: Request, res: Response) => {
-  const jwt = req.signedCookies[envVars.cookieProps.key];
-  if (!jwt) {
-    return res.redirect('/');
-  } else {
-    return res.sendFile('chat.html', {root: viewsDir});
-  }
-});
-
-
-// **** Setup Socket.io **** //
-
-// Tutorial used for this: https://www.valentinog.com/blog/socket-react/
-
-const server = http.createServer(app);
-const io = new SocketIo(server);
-
-io.sockets.on('connect', () => {
-  return app.set('socketio', io);
-});
-
-
-// **** Export default **** //
-
-export default server;

package/lib/socket-io/src/services/auth-service.ts

@@ -1,38 +0,0 @@
-import bcrypt from 'bcrypt';
-
-import userRepo from '@repos/user-repo';
-import jwtUtil from '@util/jwt-util';
-import { UnauthorizedError } from '@shared/errors';
-
-
-// **** Functions **** //
-
-/**
- * Login
- */
-async function login(email: string, password: string): Promise<string> {
-  // Fetch user
-  const user = await userRepo.getOne(email);
-  if (!user) {
-    throw new UnauthorizedError();
-  }
-  // Check password
-  const pwdPassed = await bcrypt.compare(password, user.pwdHash);
-  if (!pwdPassed) {
-    throw new UnauthorizedError();
-  }
-  // Setup Admin Cookie
-  return jwtUtil.sign({
-    id: user.id,
-    email: user.name,
-    name: user.name,
-    role: user.role,
-  });
-}
-
-
-// **** Export default **** //
-
-export default {
-  login,
-} as const;

package/lib/socket-io/src/services/user-service.ts

@@ -1,52 +0,0 @@
-import userRepo from '@repos/user-repo';
-import { IUser } from '@models/user-model';
-import { UserNotFoundError } from '@shared/errors';
-
-
-// **** 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 UserNotFoundError();
-  }
-  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 UserNotFoundError();
-  }
-  return userRepo.delete(id);
-}
-
-
-// **** Export default **** //
-
-export default {
-  getAll,
-  addOne,
-  updateOne,
-  delete: _delete,
-} as const;

package/lib/socket-io/src/shared/env-vars.ts

@@ -1,20 +0,0 @@
-export default {
-  nodeEnv: (process.env.NODE_ENV ?? ''),
-  port: (process.env.PORT ?? 0),
-  cookieProps: {
-    key: 'ExpressGeneratorTs',
-    secret: (process.env.COOKIE_SECRET ?? ''),
-    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;

package/lib/socket-io/src/shared/errors.ts

@@ -1,56 +0,0 @@
-import HttpStatusCodes from 'http-status-codes';
-
-
-export abstract class CustomError extends Error {
-
-  public readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
-
-  constructor(msg: string, httpStatus: number) {
-    super(msg);
-    this.HttpStatus = httpStatus;
-  }
-}
-
-
-export class ParamMissingError extends CustomError {
-
-  public static readonly Msg = 'One or more of the required parameters was missing.';
-  public static readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
-
-  constructor() {
-    super(ParamMissingError.Msg, ParamMissingError.HttpStatus);
-  }
-}
-
-
-export class UserNotFoundError extends CustomError {
-
-  public static readonly Msg = 'A user with the given id does not exists in the database.';
-  public static readonly HttpStatus = HttpStatusCodes.NOT_FOUND;
-
-  constructor() {
-    super(UserNotFoundError.Msg, UserNotFoundError.HttpStatus);
-  }
-}
-
-
-export class UnauthorizedError extends CustomError {
-
-  public static readonly Msg = 'Login failed';
-  public static readonly HttpStatus = HttpStatusCodes.UNAUTHORIZED;
-
-  constructor() {
-    super(UnauthorizedError.Msg, UnauthorizedError.HttpStatus);
-  }
-}
-
-
-export class RoomNotFoundError extends CustomError {
-
-  public static readonly Msg = 'socket room not found on socket server.';
-  public static readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
-
-  constructor() {
-    super(RoomNotFoundError.Msg, RoomNotFoundError.HttpStatus);
-  }
-}

package/lib/socket-io/src/shared/functions.ts

@@ -1,18 +0,0 @@
-import logger from 'jet-logger';
-
-
-/**
- * Print an error object if it's truthy. Useful for testing.
- */
-export function pErr(err?: Error): void {
-  if (!!err) {
-    logger.err(err);
-  }
-}
-
-/**
- * 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);
-}

package/lib/socket-io/src/types/express/index.d.ts

@@ -1,23 +0,0 @@
-import { IUser } from '@models/user-model';
-import { ISessionUser } from '@routes/middleware';
-
-
-declare module 'express' {
-
-  export interface Request  {
-    signedCookies: Record<string, string>,
-    body: {
-      user?: IUser
-      email?: string;
-      password?: string;
-      message?: string;
-      socketId?: string;
-    };
-  }
-
-  export interface Response {
-    locals: {
-      sessionUser: ISessionUser;
-    };
-  }
-}

package/lib/socket-io/src/util/jwt-util.ts

@@ -1,52 +0,0 @@
-import randomString from 'randomstring';
-import jsonwebtoken, { JwtPayload } from 'jsonwebtoken';
-
-
-// **** Variables **** //
-
-// Errors
-const errors = {
-    validation: 'JSON-web-token validation failed.',
-} as const;
-
-// Misc
-const secret = (process.env.JWT_SECRET || randomString.generate(100));
-const options = {expiresIn: process.env.COOKIE_EXP};
-
-
-// **** Types ****  //
-
-type TDecoded = string | JwtPayload | undefined;
-
-
-// **** Functions **** //
-
-/**
- * Encrypt data and return jwt.
- */
-function sign(data: JwtPayload): Promise<string> {
-  return new Promise((resolve, reject) => {
-    jsonwebtoken.sign(data, secret, options, (err, token) => {
-      err ? reject(err) : resolve(token || '');
-    });
-  });
-}
-
-/**
- * Decrypt JWT and extract client data.
- */
-function decode(jwt: string): Promise<TDecoded> {
-  return new Promise((res, rej) => {
-    jsonwebtoken.verify(jwt, secret, (err, decoded) => {
-      return err ? rej(errors.validation) : res(decoded);
-    });
-  });
-}
-
-
-// **** Export default **** //
-
-export default {
-  sign,
-  decode,
-};

package/lib/socket-io/src/views/chat.html

@@ -1,51 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8">
-    <title>Users</title>
-    <link rel="stylesheet" type="text/css" href="/stylesheets/index.css" />
-    <link rel="stylesheet" type="text/css" href="/stylesheets/chat.css" />
-    <script
-      src="https://cdn.socket.io/3.1.3/socket.io.min.js"
-      integrity="sha384-cPwlPLvBTa3sKAgddT6krw0cJat7egBga3DJepJyrLl4Q9/5WLra3rrnMcyTyOnh" 
-      crossorigin="anonymous"
-    ></script>
-    <script 
-      src="https://cdnjs.cloudflare.com/ajax/libs/moment.js/2.29.1/moment.min.js"
-      integrity="sha512-qTXRIMyZIFb8iQcfjXWCO8+M5Tbc38Qi5WzdPOYZHIlZpzBHG3L3by84BBBOiRGiEb7KKtAOAs5qYdUiZiQNNQ==" 
-      crossorigin="anonymous" 
-      referrerpolicy="no-referrer"
-    ></script>
-    <script src="scripts/http.js"></script>
-  </head>
-  <body>
-
-    <!-- Header -->
-    <div class="main-header">
-      <button class="header-button nav-users-btn">
-        Users
-      </button>
-      <button class="header-button nav-chat-btn">
-        Chat
-      </button>
-      <button class="header-button logout-btn">
-        Logout
-      </button>
-    </div>
-
-    <!-- Chat Window -->
-    <div id="window-wrapper">
-      Chat Window
-      <div id="chat-window"></div>
-
-      <div id="send-msg-wrapper">
-        <input id="send-msg-input"/>
-        <button id="send-msg-btn">
-          Send
-        </button>
-      </div>
-    </div>
-  </body>
-  <script src="scripts/index.js"></script>
-  <script src="scripts/chat.js"></script>
-</html>