express-generator-typescript 2.4.14 → 2.4.17

package/lib/project-files-auth/spec/index.ts

@@ -1,40 +1,19 @@
-import dotenv from 'dotenv';
 import find from 'find';
 import Jasmine from 'jasmine';
 import { parse } from 'ts-command-line-args';
 import logger from 'jet-logger';
 
 
-// **** Types **** //
-
-interface IArgs {
-  testFile: string;
-}
-
-
-// **** Setup **** //
-
-// ** Init ** //
-
-// NOTE: MUST BE FIRST!! Load env vars
-const result2 = dotenv.config({
-  path: './env/test.env',
-});
-if (result2.error) {
-  throw result2.error;
-}
-
 // Setup command line options. 
-const args = parse<IArgs>({
+const args = parse<{
+  testFile: string;
+}>({
   testFile: {
     type: String,
     defaultValue: '',
   },
 });
 
-
-// ** Start Jasmine ** //
-
 // Init Jasmine
 const jasmine = new Jasmine();
 jasmine.exitOnCompletion = false;

package/lib/project-files-auth/spec/tests/users.spec.ts

@@ -1,6 +1,5 @@
 import supertest, { Test } from 'supertest';
 import TestAgent from 'supertest/lib/agent';
-import { defaultErrMsg as ValidatorErr } from 'jet-validator';
 import insertUrlParams from 'inserturlparams';
 
 import app from '@src/server';
@@ -14,6 +13,7 @@ import Paths from 'spec/support/Paths';
 import apiCb from 'spec/support/apiCb';
 import login from 'spec/support/login';
 import { TApiCb } from 'spec/types/misc';
+import { ValidationErr } from '@src/common/classes';
 
 
 // Dummy users for GET req
@@ -67,7 +67,7 @@ describe('UserRouter', () => {
   // Test add user
   describe(`"POST:${Paths.Users.Add}"`, () => {
 
-    const ERROR_MSG = `${ValidatorErr}"user".`,
+    const ERROR_MSG = ValidationErr.GetMsg('user'),
       DUMMY_USER = getDummyUsers()[0];
 
     // Setup API
@@ -105,7 +105,7 @@ describe('UserRouter', () => {
   // Update users
   describe(`"PUT:${Paths.Users.Update}"`, () => {
 
-    const ERROR_MSG = `${ValidatorErr}"user".`,
+    const ERROR_MSG = ValidationErr.GetMsg('user'),
       DUMMY_USER = getDummyUsers()[0];
 
     // Setup API

package/lib/project-files-auth/src/common/classes.ts

@@ -0,0 +1,31 @@
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+
+
+/**
+ * Error with status code and message.
+ */
+export class RouteError extends Error {
+
+  public status: HttpStatusCodes;
+
+  public constructor(status: HttpStatusCodes, message: string) {
+    super(message);
+    this.status = status;
+  }
+}
+
+/**
+ * If route validation fails.
+ */
+export class ValidationErr extends RouteError {
+
+  public static MSG = 'The follow parameter were missing or invalid "';
+
+  public constructor(paramName: string) {
+    super(HttpStatusCodes.BAD_REQUEST, ValidationErr.GetMsg(paramName));
+  }
+
+  public static GetMsg(param: string) {
+    return ValidationErr.MSG + param + '".';
+  }
+}

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

@@ -1,4 +1,3 @@
-import './pre-start'; // Must be the first import
 import logger from 'jet-logger';
 
 import EnvVars from '@src/common/EnvVars';

package/lib/project-files-auth/src/models/User.ts

@@ -60,14 +60,13 @@ function from(param: object): IUser {
   if (!isUser(param)) {
     throw new Error(INVALID_CONSTRUCTOR_PARAM);
   }
-  const p = param as IUser;
-  return new_(p.name, p.email, p.created, p.id);
+  return new_(param.name, param.email, param.created, param.id);
 }
 
 /**
  * See if the param meets criteria to be a user.
  */
-function isUser(arg: unknown): boolean {
+function isUser(arg: unknown): arg is IUser {
   return (
     !!arg &&
     typeof arg === 'object' &&

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

@@ -3,14 +3,7 @@ import SessionUtil from '@src/util/SessionUtil';
 import AuthService from '@src/services/AuthService';
 
 import { IReq, IRes } from './common/types';
-
-
-// **** Types **** //
-
-interface ILoginReq {
-  email: string;
-  password: string;
-}
+import check from './common/check';
 
 
 // **** Functions **** //
@@ -18,10 +11,9 @@ interface ILoginReq {
 /**
  * Login a user.
  */
-async function login(req: IReq<ILoginReq>, res: IRes) {
-  const { email, password } = req.body;
-  // Login
-  const user = await AuthService.login(email, password);
+async function login(req: IReq, res: IRes) {
+  const [ email, password ] = check.isStr(req.body, ['email', 'password']),
+    user = await AuthService.login(email, password);
   // Setup Admin Cookie
   await SessionUtil.addSessionData(res, {
     id: user.id,

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

@@ -1,8 +1,10 @@
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 import UserService from '@src/services/UserService';
-import { IUser } from '@src/models/User';
+import User from '@src/models/User';
+
 import { IReq, IRes } from './common/types';
+import check from './common/check';
 
 
 // **** Functions **** //
@@ -18,8 +20,8 @@ async function getAll(_: IReq, res: IRes) {
 /**
  * Add one user.
  */
-async function add(req: IReq<{user: IUser}>, res: IRes) {
-  const { user } = req.body;
+async function add(req: IReq, res: IRes) {
+  const user = check.isValid(req.body, 'user', User.isUser);
   await UserService.addOne(user);
   return res.status(HttpStatusCodes.CREATED).end();
 }
@@ -27,8 +29,8 @@ async function add(req: IReq<{user: IUser}>, res: IRes) {
 /**
  * Update one user.
  */
-async function update(req: IReq<{user: IUser}>, res: IRes) {
-  const { user } = req.body;
+async function update(req: IReq, res: IRes) {
+  const user = check.isValid(req.body, 'user', User.isUser);
   await UserService.updateOne(user);
   return res.status(HttpStatusCodes.OK).end();
 }
@@ -37,7 +39,7 @@ async function update(req: IReq<{user: IUser}>, res: IRes) {
  * Delete one user.
  */
 async function delete_(req: IReq, res: IRes) {
-  const id = +req.params.id;
+  const id = check.isNum(req.params, 'id');
   await UserService.delete(id);
   return res.status(HttpStatusCodes.OK).end();
 }

package/lib/project-files-auth/src/routes/common/check.ts

@@ -0,0 +1,143 @@
+import { ValidationErr } from '@src/common/classes';
+
+
+type TReqObj = Record<string, unknown>;
+
+
+/**
+ * Check that param/s is a string
+ */
+function isStr(reqObj: TReqObj, params: string): string;
+function isStr(reqObj: TReqObj, params: ReadonlyArray<string>): string[];
+function isStr(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+): string | string[] {
+  return _checkWrapper(reqObj, params, _checkStr);
+}
+
+/**
+ * Check validator for string
+ */
+function _checkStr(val: unknown): string | undefined {
+  if (!!val && typeof val === 'string') {
+    return val;
+  } else {
+    return undefined;
+  }
+}
+
+/**
+ * Check that param/s is a number.
+ */
+function isNum(reqObj: TReqObj, params: string): number;
+function isNum(reqObj: TReqObj, params: ReadonlyArray<string>): number[];
+function isNum(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+): number | number[] {
+  return _checkWrapper(reqObj, params, _checkNum);
+}
+
+/**
+ * Check validator for string
+ */
+function _checkNum(val: unknown): number | undefined {
+  const valF = Number(val);
+  if (!isNaN(valF)) {
+    return valF;
+  } else {
+    return undefined;
+  }
+}
+
+/**
+ * Check that param/s is a number
+ */
+function isBool(reqObj: TReqObj, params: string): boolean;
+function isBool(reqObj: TReqObj, params: ReadonlyArray<string>): boolean[];
+function isBool(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+): boolean | boolean[] {
+  return _checkWrapper(reqObj, params, _checkBool);
+}
+
+/**
+ * Check validator for string
+ */
+function _checkBool(val: unknown): boolean | undefined {
+  if (typeof val === 'boolean') {
+    return val;
+  } else if (typeof val === 'string') {
+    val = val.toLowerCase();
+    if (val === 'true') {
+      return true;
+    } else if (val === 'false') {
+      return false;
+    } else {
+      return undefined;
+    }
+  } else {
+    return undefined;
+  }
+}
+
+/**
+ * Check that param satisfies the validator function.
+ */
+function isValid<T>(
+  reqObj: TReqObj,
+  param: string,
+  validatorFn: (param: unknown) => param is T,
+): T {
+  const val = reqObj[param];
+  if (validatorFn(val)) {
+    return val;
+  } else {
+    throw new ValidationErr(param);
+  }
+}
+
+
+// **** Shared Helpers **** //
+
+/**
+ * Do stuff based on whether or not params is an array
+ */
+function _checkWrapper<T>(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+  checkFn: (val: unknown) => T | undefined,
+): T | T[] {
+  // If is array
+  if (params instanceof Array) {
+    const retVal: T[] = [];
+    for (const param of params) {
+      const val = checkFn(reqObj[param]);
+      if (val !== undefined) {
+        retVal.push(val);
+      } else {
+        throw new ValidationErr(param);
+      }
+    }
+    return retVal;
+  }
+  // If not an array
+  const val = checkFn(reqObj[params]);
+  if (val !== undefined) {
+    return val;
+  }
+  // Throw error
+  throw new ValidationErr(params);
+}
+
+
+// **** Export Default **** //
+
+export default {
+  isStr,
+  isNum,
+  isBool,
+  isValid,
+} as const;

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

@@ -1,28 +1,3 @@
-// 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;
-//   };
-// }
-
-
-/* eslint-disable max-len */
 /**
  * Shared types for routes.
  */
@@ -33,17 +8,15 @@ import { ISessionUser } from '@src/models/User';
 
 // **** Express **** //
 
-type TPathParams = Record<string, string>;
+type TObj = Record<string, unknown>;
 
-export interface IReq<T = void> extends Request<TPathParams, void, T, TPathParams> {
-  body: T;
+export interface IReq extends Request<TObj, void, TObj, TObj> {
+  signedCookies: Record<string, string>;
 }
 
+
 interface ILocals {
   sessionUser: ISessionUser;
 }
 
-// I know since its a type I should use 'TRes' instead of 'IRes' but I'm
-// leaving it as this cause it looks better alongside 'IReq'
 export type IRes = Response<unknown, ILocals>;
-

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

@@ -1,8 +1,6 @@
 import { Router } from 'express';
-import jetValidator from 'jet-validator';
 
 import Paths from '@src/common/Paths';
-import User from '@src/models/User';
 
 import adminMw from './middleware/adminMw';
 import AuthRoutes from './AuthRoutes';
@@ -11,61 +9,30 @@ import UserRoutes from './UserRoutes';
 
 // **** Variables **** //
 
-const apiRouter = Router(),
-  validate = jetValidator();
+const apiRouter = Router();
 
 
-// **** Add AuthRouter **** //
+// **** 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,
-);
+// Routes
+authRouter.post(Paths.Auth.Login, AuthRoutes.login);
+authRouter.get(Paths.Auth.Logout, AuthRoutes.logout);
 
 // Add AuthRouter
 apiRouter.use(Paths.Auth.Base, authRouter);
 
 
-// ** Add UserRouter ** //
+// **** 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,
-);
+// User Routes
+userRouter.get(Paths.Users.Get, UserRoutes.getAll);
+userRouter.post(Paths.Users.Add, UserRoutes.add);
+userRouter.put(Paths.Users.Update, UserRoutes.update);
+userRouter.delete(Paths.Users.Delete, UserRoutes.delete);
 
 // Add UserRouter
 apiRouter.use(Paths.Users.Base, adminMw, userRouter);

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

@@ -17,8 +17,8 @@ import Paths from '@src/common/Paths';
 import EnvVars from '@src/common/EnvVars';
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import { NodeEnvs } from '@src/common/misc';
-
-import RouteError from '@src/common/RouteError';
+import { RouteError } from '@src/common/classes';
+import { IReq, IRes } from './routes/common/types';
 
 
 // **** Variables **** //
@@ -81,7 +81,7 @@ app.get('/', (_: Request, res: Response) => {
 });
 
 // Redirect to login if not logged in.
-app.get('/users', (req: Request, res: Response) => {
+app.get('/users', (req: IReq, res: IRes) => {
   const jwt = req.signedCookies[EnvVars.CookieProps.Key];
   if (!jwt) {
     res.redirect('/');

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

@@ -4,7 +4,7 @@ import PwdUtil from '@src/util/PwdUtil';
 import { tick } from '@src/util/misc';
 
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import RouteError from '@src/common/RouteError';
+import { RouteError } from '@src/common/classes';
 
 import { IUser } from '@src/models/User';
 

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

@@ -1,4 +1,4 @@
-import RouteError from '@src/common/RouteError';
+import { RouteError } from '@src/common/classes';
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 import UserRepo from '@src/repos/UserRepo';

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

@@ -1,9 +1,9 @@
-import { Request, Response } from 'express';
 import jsonwebtoken from 'jsonwebtoken';
 
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import RouteError from '@src/common/RouteError';
+import { RouteError } from '@src/common/classes';
 import EnvVars from '@src/common/EnvVars';
+import { IReq, IRes } from '@src/routes/common/types';
 
 
 // **** Variables **** //
@@ -25,7 +25,7 @@ const Options = {
 /**
  * Get session data from request object (i.e. ISessionUser)
  */
-function getSessionData<T>(req: Request): Promise<string | T | undefined> {
+function getSessionData<T>(req: IReq): Promise<string | T | undefined> {
   const { Key } = EnvVars.CookieProps,
     jwt = req.signedCookies[Key];
   return _decode(jwt);
@@ -52,9 +52,9 @@ function _decode<T>(jwt: string): Promise<string | undefined | T> {
  * Add a JWT to the response 
  */
 async function addSessionData(
-  res: Response,
+  res: IRes,
   data: string | object,
-): Promise<Response> {
+): Promise<IRes> {
   if (!res || !data) {
     throw new RouteError(HttpStatusCodes.BAD_REQUEST, Errors.ParamFalsey);
   }
@@ -79,7 +79,7 @@ function _sign(data: string | object | Buffer): Promise<string> {
 /**
  * Remove cookie
  */
-function clearCookie(res: Response): Response {
+function clearCookie(res: IRes): IRes {
   const { Key, Options } = EnvVars.CookieProps;
   return res.clearCookie(Key, Options);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.4.14",
+  "version": "2.4.17",
   "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",

package/lib/project-files/spec/nodemon.json

@@ -1,6 +0,0 @@
-{
-  "watch": ["spec"],
-  "ext": "spec.ts",
-  "ignore": ["spec/support"],
-  "exec": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register ./spec"
-}

package/lib/project-files/src/common/RouteError.ts

@@ -1,20 +0,0 @@
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
-
-
-/**
- * Error with status code and message
- */
-class RouteError extends Error {
-
-  public status: HttpStatusCodes;
-
-  public constructor(status: HttpStatusCodes, message: string) {
-    super(message);
-    this.status = status;
-  }
-}
-
-
-// **** Export default **** //
-
-export default RouteError;

package/lib/project-files/src/pre-start.ts

@@ -1,37 +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.
- */
-
-// NOTE: DO NOT IMPORT ANY SOURCE CODE HERE
-import path from 'path';
-import dotenv from 'dotenv';
-import { parse } from 'ts-command-line-args';
-
-
-// **** Types **** //
-
-interface IArgs {
-  env: string;
-}
-
-
-// **** Setup **** //
-
-// Command line arguments
-const args = parse<IArgs>({
-  env: {
-    type: String,
-    defaultValue: 'development',
-    alias: 'e',
-  },
-});
-
-// Set the env file
-const result2 = dotenv.config({
-  path: path.join(__dirname, `../env/${args.env}.env`),
-});
-if (result2.error) {
-  throw result2.error;
-}

package/lib/project-files-auth/src/common/RouteError.ts

@@ -1,20 +0,0 @@
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
-
-
-/**
- * Error with status code and message
- */
-class RouteError extends Error {
-
-  public status: HttpStatusCodes;
-
-  public constructor(status: HttpStatusCodes, message: string) {
-    super(message);
-    this.status = status;
-  }
-}
-
-
-// **** Export default **** //
-
-export default RouteError;