express-generator-typescript 1.10.3 → 2.0.0

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/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,
-};

package/lib/auth-proj/tsconfig.json

@@ -1,100 +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": {
-      "@repos/*": [
-        "src/repos/*"
-      ],
-      "@models/*": [
-        "src/models/*"
-      ],
-      "@shared/*": [
-        "src/shared/*"
-      ],
-      "@server": [
-        "src/server"
-      ],
-      "@services/*": [
-        "src/services/*"
-      ],
-      "@routes/*": [
-        "src/routes/*"
-      ],
-      "@util/*": [
-        "src/util/*"
-      ]
-    },
-    "useUnknownInCatchVariables": false
-  },
-  "include": [
-    "src/**/*.ts",
-    "spec/**/*.ts"
-  ],
-  "exclude": [
-    "src/public/"
-  ]
-}

package/lib/auth-proj/tsconfig.prod.json

@@ -1,11 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "sourceMap": false
-  },
-  "exclude": [
-    "spec",
-    "src/**/*.mock.ts",
-    "src/public/"
-  ]
-}