express-generator-typescript 1.10.3 → 2.0.2

package/lib/auth-proj/src/pre-start/env/development.env

@@ -1,23 +0,0 @@
-## 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/auth-proj/src/pre-start/env/production.env

@@ -1,24 +0,0 @@
-## 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/auth-proj/src/pre-start/env/test.env

@@ -1,23 +0,0 @@
-## 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/auth-proj/src/pre-start/index.ts

@@ -1,28 +0,0 @@
-/**
- * Pre-start is where we want to place things that must run BEFORE the express server is started.
- * This is useful for environment variables, command-line arguments, and cron-jobs.
- */
-
-import path from 'path';
-import dotenv from 'dotenv';
-import commandLineArgs from 'command-line-args';
-
-
-// Setup command line options
-const options = commandLineArgs([
-  {
-    name: 'env',
-    alias: 'e',
-    defaultValue: 'development',
-    type: String,
-  },
-]);
-
-// Set the env file
-const result2 = dotenv.config({
-  path: path.join(__dirname, `env/${String(options.env)}.env`),
-});
-
-if (result2.error) {
-  throw result2.error;
-}

package/lib/auth-proj/src/repos/database.json

@@ -1 +0,0 @@
-{"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/auth-proj/src/repos/mock-orm.ts

@@ -1,41 +0,0 @@
-/* eslint-disable @typescript-eslint/no-unsafe-return */
-
-import jsonfile from 'jsonfile';
-import { IUser } from '@models/user-model';
-
-
-// **** Variables **** //
-
-const dbFilePath = 'src/repos/database.json';
-
-
-// **** Types **** //
-
-interface IDb {
-  users: IUser[];
-}
-
-
-// **** Functions **** //
-
-/**
- * Fetch the json from the file.
- */
-function openDb(): Promise<IDb> {
-  return jsonfile.readFile(dbFilePath);
-}
-
-/**
- * Update the file.
- */
-function saveDb(db: IDb): Promise<void> {
-  return jsonfile.writeFile(dbFilePath, db);
-}
-
-
-// **** Export default **** //
-
-export default {
-    openDb,
-    saveDb,
-} as const;

package/lib/auth-proj/src/repos/user-repo.ts

@@ -1,88 +0,0 @@
-import { IUser } from '@models/user-model';
-import { getRandomInt } from '@shared/functions';
-import orm from './mock-orm';
-
-
-// **** 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/auth-proj/src/routes/api.ts

@@ -1,17 +0,0 @@
-import { Router } from 'express';
-import { authMw } from './middleware';
-import authRouter from './auth-router';
-import userRouter from './user-router';
-
-
-// Init
-const apiRouter = Router();
-
-// Add api routes
-apiRouter.use('/auth', authRouter);
-apiRouter.use('/users', authMw, userRouter);
-
-
-// **** Export default **** //
-
-export default apiRouter;

package/lib/auth-proj/src/routes/auth-router.ts

@@ -1,63 +0,0 @@
-import { Request, Response, Router } from 'express';
-import StatusCodes from 'http-status-codes';
-
-import authService from '@services/auth-service';
-import { ParamMissingError } from '@shared/errors';
-import envVars from 'src/shared/env-vars';
-import { IReq } from 'src/types/express';
-
-
-// **** Types **** //
-
-interface ILogin {
-  email: string;
-  password: string;
-}
-
-
-// **** Variables **** //
-
-// Misc
-const router = Router(),
-  { OK } = StatusCodes;
-
-// Paths
-export const p = {
-  login: '/login',
-  logout: '/logout',
-} as const;
-
-
-// **** Routes **** //
-
-/**
- * Login a user.
- */
-router.post(p.login, async (req: IReq<ILogin>, 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 } = envVars.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 } = envVars.cookieProps;
-  res.clearCookie(key, options);
-  return res.status(OK).end();
-});
-
-
-// **** Export router **** //
-
-export default router;

package/lib/auth-proj/src/routes/user-router.ts

@@ -1,80 +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';
-import { IReq } from 'src/types/express';
-import { IUser } from '@models/user-model';
-
-
-// **** Variables **** //
-
-// Misc
-const router = Router(),
-  { 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: IReq<{user: IUser}>, res: Response) => {
-  const { user } = req.body;
-  // Check param
-  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: IReq<{user: IUser}>, res: Response) => {
-  const { user } = req.body;
-  // Check param
-  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;
-  // Check param
-  if (!id) {
-    throw new ParamMissingError();
-  }
-  // Fetch data
-  await userService.delete(Number(id));
-  return res.status(OK).end();
-});
-
-
-// **** Export default **** //
-
-export default router;

package/lib/auth-proj/src/server.ts

@@ -1,82 +0,0 @@
-import cookieParser from 'cookie-parser';
-import morgan from 'morgan';
-import path from 'path';
-import helmet from 'helmet';
-import StatusCodes from 'http-status-codes';
-import express, { Request, Response, NextFunction } from 'express';
-
-import 'express-async-errors';
-
-import BaseRouter from './routes/api';
-import logger from 'jet-logger';
-import { CustomError } from '@shared/errors';
-import envVars from '@shared/env-vars';
-
-
-// **** 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 API routes **** //
-
-// 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 **** //
-
-// 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;

package/lib/auth-proj/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/auth-proj/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/auth-proj/src/shared/errors.ts

@@ -1,45 +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);
-  }
-}

package/lib/auth-proj/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/auth-proj/src/types/express/index.d.ts

@@ -1,32 +0,0 @@
-import * as e from 'express';
-import 'express';
-
-import { ISessionUser } from '@routes/middleware';
-
-
-// **** Declaration Merging **** //
-
-declare module 'express' {
-
-  export interface Request {
-    signedCookies: Record<string, string>;
-  }
-
-  export interface Response {
-    locals: {
-      sessionUser: ISessionUser;
-    };
-  }
-}
-
-
-// **** Generics for Request Object **** //
-
-export interface IReq<T> extends e.Request {
-  body: T;
-}
-
-export interface IReqQuery<T extends Query, U = void> extends e.Request {
-  query: T;
-  body?: U;
-}

package/lib/auth-proj/src/util/jwt-util.ts

@@ -1,47 +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};
-
-
-// **** Functions **** //
-
-/**
- * Encrypt data and return jwt.
- */
-function sign(data: JwtPayload): Promise<string> {
-  return new Promise((resolve, reject) => {
-    jsonwebtoken.sign(data, secret, options, (err, token) => {
-      return err ? reject(err) : resolve(token || '');
-    });
-  });
-}
-
-/**
- * Decrypt JWT and extract client data.
- */
-function decode<T>(jwt: string): Promise<T> {
-  return new Promise((res, rej) => {
-    jsonwebtoken.verify(jwt, secret, (err, decoded) => {
-      return err ? rej(errors.validation) : res(decoded as T);
-    });
-  });
-}
-
-
-// **** Export default **** //
-
-export default {
-  sign,
-  decode,
-};