express-generator-typescript 2.2.6 → 2.2.8

package/lib/express-generator-typescript.js

@@ -26,7 +26,7 @@ const ncpOpts = {
 // Project-folder dependencies
 const dependencies = 'express dotenv morgan cookie-parser jet-logger ' +
   'module-alias command-line-args express-async-errors helmet jsonfile ' + 
-  'bcrypt jsonwebtoken';
+  'bcrypt jsonwebtoken jet-validator';
 
 // Project-folder development dependencies
 const devDependencies = 'ts-node typescript nodemon find jasmine supertest ' +

package/lib/project-files/package.json

@@ -35,6 +35,7 @@
     "express-async-errors": "^3.1.1",
     "helmet": "^6.0.0",
     "jet-logger": "^1.2.3",
+    "jet-validator": "^1.0.3",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",

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

@@ -5,8 +5,8 @@ import app from '@src/server';
 import authRoutes from '@src/routes/auth-routes';
 import userRepo from '@src/repos/user-repo';
 import pwdUtil from '@src/util/pwd-util';
-import EnvVars from '@src/configurations/EnvVars';
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import EnvVars from '@src/declarations/major/EnvVars';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 import User, { UserRoles } from '@src/models/User';
 import { errors as authServiceErrs } from '@src/services/auth-service';
 

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

@@ -1,14 +1,13 @@
-import supertest from 'supertest';
-import { SuperTest, Test, Response } from 'supertest';
+import supertest, { SuperTest, Test, Response } from 'supertest';
+import { defaultErrMsg } from 'jet-validator';
 import logger from 'jet-logger';
 
 import app from '@src/server';
 import userRepo from '@src/repos/user-repo';
 import User, { IUser } from '@src/models/User';
 import userRoutes from '@src/routes/user-routes';
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 import loginAgent from '../support/login-agent';
-import { paramInvalidErr } from '@src/routes/middlware/validate';
 import { userNotFoundErr } from '@src/services/user-service';
 
 
@@ -44,7 +43,7 @@ const msgs = {
   addUserSuccess: 'should return a status code of ' + 
     `"${HttpStatusCodes.CREATED}" if the request was successful.`,
   addUserFailedMissingParam: 'should return a JSON object with an error ' +
-    `message of "${paramInvalidErr}" and a status code of ` +
+    `message of "${defaultErrMsg}" and a status code of ` +
     `"${HttpStatusCodes.BAD_REQUEST}" if the user param was missing.`,
   addUserFallbackErr: 'should return a JSON object with an error message ' + 
     `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the request ` + 
@@ -52,7 +51,7 @@ const msgs = {
   updateSuccess: `should return a status code of "${HttpStatusCodes.OK}" if ` + 
     'the request was successful.',
   updateParamMissing: 'should return a JSON object with an error message ' +
-    `of "${paramInvalidErr}" and a status code of ` + 
+    `of "${defaultErrMsg}" and a status code of ` + 
     `"${HttpStatusCodes.BAD_REQUEST}" if the user param was missing.`,
   updateUserNotFound: 'should return a JSON object with the error message ' +
     `of "${userNotFoundErr}" and a status code of ` +
@@ -160,7 +159,7 @@ describe('user-router', () => {
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          expect(res.body.error).toBe(paramInvalidErr);
+          expect(res.body.error).toBe(defaultErrMsg);
           done();
         });
     });
@@ -208,7 +207,7 @@ describe('user-router', () => {
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          expect(res.body.error).toBe(paramInvalidErr);
+          expect(res.body.error).toBe(defaultErrMsg);
           done();
         });
     });
@@ -280,7 +279,7 @@ describe('user-router', () => {
         .end((err: Error, res: Response) => {
           !!err && logger.err(err);
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          expect(res.body.error).toBe(paramInvalidErr);
+          expect(res.body.error).toBe(defaultErrMsg);
           done();
         });
     });

package/lib/project-files/src/declarations/classes.ts

@@ -1,4 +1,8 @@
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+/**
+ * Miscellaneous shared classes go here.
+ */
+
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 
 
 /**

package/lib/project-files/src/declarations/enums.ts

@@ -1,3 +1,7 @@
+/**
+ * Miscellaneous shared enums go here.
+ */
+
 export enum NodeEnvs {
   Dev = 'development',
   Staging = 'staging',

package/lib/project-files/src/declarations/functions.ts

@@ -1,3 +1,7 @@
+/**
+ * Miscellaneous shared functions go here.
+ */
+
 /**
  * Get a random number between 1 and 1,000,000,000,000
  */

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

@@ -1,7 +1,7 @@
 import './pre-start'; // Must be the first import
 import logger from 'jet-logger';
 
-import EnvVars from '@src/configurations/EnvVars';
+import EnvVars from '@src/declarations/major/EnvVars';
 import server from './server';
 
 

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

@@ -1,4 +1,4 @@
-import { TAll } from '@src/declarations/types';
+import { TAll } from 'jet-validator';
 
 
 // **** Variables **** //

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

@@ -1,7 +1,7 @@
 import { Router } from 'express';
+import jetValidator from 'jet-validator';
 
-import adminMw from './middlware/adminMw';
-import validate from './middlware/validate';
+import adminMw from './shared/adminMw';
 import User from '@src/models/User';
 import authRoutes from './auth-routes';
 import userRoutes from './user-routes';
@@ -9,7 +9,8 @@ import userRoutes from './user-routes';
 
 // **** Init **** //
 
-const apiRouter = Router();
+const apiRouter = Router(),
+  validate = jetValidator();
 
 
 // **** Setup auth routes **** //

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

@@ -1,7 +1,7 @@
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 
 import authService from '@src/services/auth-service';
-import EnvVars from '@src/configurations/EnvVars';
+import EnvVars from '@src/declarations/major/EnvVars';
 import { IReq, IRes } from './shared/types';
 
 

package/lib/project-files/src/routes/{middlware → shared}/adminMw.ts

@@ -5,8 +5,8 @@
 import { Request, Response, NextFunction } from 'express';
 import { JwtPayload } from 'jsonwebtoken';
 
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
-import EnvVars from '@src/configurations/EnvVars';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
+import EnvVars from '@src/declarations/major/EnvVars';
 import jwtUtil from '@src/util/jwt-util';
 import { IUser, UserRoles } from '@src/models/User';
 

package/lib/project-files/src/routes/user-routes.ts

@@ -1,4 +1,4 @@
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 
 import userService from '@src/services/user-service';
 import { IUser } from '@src/models/User';

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

@@ -8,8 +8,8 @@ import 'express-async-errors';
 
 import BaseRouter from './routes/api';
 import logger from 'jet-logger';
-import EnvVars from '@src/configurations/EnvVars';
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import EnvVars from '@src/declarations/major/EnvVars';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 import { NodeEnvs } from '@src/declarations/enums';
 import { RouteError } from '@src/declarations/classes';
 

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

@@ -1,7 +1,7 @@
 import userRepo from '@src/repos/user-repo';
 import jwtUtil from '@src/util/jwt-util';
 import pwdUtil from '@src/util/pwd-util';
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 import { RouteError } from '@src/declarations/classes';
 import { tick } from '@src/declarations/functions';
 

package/lib/project-files/src/services/user-service.ts

@@ -1,7 +1,7 @@
 import userRepo from '@src/repos/user-repo';
 import { IUser } from '@src/models/User';
 import { RouteError } from '@src/declarations/classes';
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
+import HttpStatusCodes from '@src/declarations/major/HttpStatusCodes';
 
 
 // **** Variables **** //

package/lib/project-files/src/util/jwt-util.ts

@@ -1,5 +1,5 @@
 import jsonwebtoken from 'jsonwebtoken';
-import EnvVars from '../configurations/EnvVars';
+import EnvVars from '../declarations/major/EnvVars';
 
 
 // **** Variables **** //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.2.6",
+  "version": "2.2.8",
   "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/src/declarations/types.ts

@@ -1,5 +0,0 @@
-/**
- * Place types shared throughout the application here.
- */
-
-export type TAll = string | number | boolean | null | object;

package/lib/project-files/src/routes/middlware/validate.ts

@@ -1,244 +0,0 @@
-/**
- * This function returns a middleware-function that validates the parameters 
- * provided. Each argument can be a string or array.
- * 
- * If the argument is an array the format is:
- * ['paramName', '(optional) type or validator function (default is string)', 
- * '(optional) property on "req" to extract the value from (default is body')]
- * 
- * If a string, 'validate' makes sure the param is of type string on req.body.
- * For the array, 'validate' makes sure the parameter is of the specified type
- * or that the parameter satifies the validator function. The validator  
- * function must return 'true' or 'false'.
- * 
- * **NOTE**: For numbers, strings which evalute to (!isNaN('string') => true)
- * are valid for req.query and req.params. But on req.body a number should be
- * 'typeof toCheck === "number"'
- * 
- * **NOTE**: For booleans, on req.body must be true or false, on req.query or
- * req.params must be 'true' or 'false'.
- * 
- * Sample argument: ['id', 'number'], id is the incoming variable, 'number' 
- * is the type, and body is where to extract 'id' from.
- * 
- * Example 1: validate('email', ['user', 'object'], ['id', 'number', 'params'])
- *  will check that 'email' is a string in req.body, that user is of type 
- *  object in req.body, and that 'id' is a boolean in req.params.
- * Example 2: validate('password') will check that 'password' is a string on
- *  req.body.
- * Example 3: validate(['isAdmin', 'boolean']) will check that 'isAdmin' is a 
- *  boolean on req.body
- * Example 4: validate(['user', isInstanceOfUser]) will check that 'user' 
- *  satifies the 'isInstanceOfUser()' function.
- * Example 5: validate(['email']) will check that 'email' is a string in 
- *  req.body,
- */
-
-import { Request, Response, NextFunction, RequestHandler } from 'express';
-
-import HttpStatusCodes from '@src/configurations/HttpStatusCodes';
-import { TAll } from '@src/declarations/types';
-
-
-// **** Variables **** //
-
-export const paramInvalidErr = 'One or more of the required params was ' + 
-  'missing or invalid.';
-
-
-// **** Types **** //
-
-type TLoopFn = (req: Request) => boolean;
-type TValidatorFn =  ((arg: TAll) => boolean);
-type TReqObjProps = 'body' | 'query' | 'params';
-
-type TParamArr = {
-  0: string,
-  1?: string | TValidatorFn,
-  2?: TReqObjProps,
-}
-
-interface IParamFields {
-  paramName: string; 
-  type: string; 
-  reqObjProp: TReqObjProps;
-}
-
-
-// **** Functions **** //
-
-/**
- * See comments at beginning of file on usage.
- */
-function validate(...params: Array<string | TParamArr>): RequestHandler {
-  // Setup loop-function array
-  const loopFns: TLoopFn[] = [];
-  for (const param of params) {
-    const { paramName, type, reqObjProp } = getParamFields(param);
-    let loopFn: TLoopFn = () => false;
-    if (type === 'string') {
-      loopFn = checkStr(reqObjProp, paramName);
-    } else if (type === 'number') {
-      loopFn = checkNum(reqObjProp, paramName);
-    } else if (type === 'boolean') {
-      loopFn = checkBool(reqObjProp, paramName);
-    } else if (type === 'function') {
-      const fn = param[1] as TValidatorFn;
-      loopFn = checkValidatorFn(reqObjProp, paramName, fn);
-    } else {
-      loopFn = checkDefault(reqObjProp, paramName, type);
-    }
-    loopFns.push(loopFn);
-  }
-  // Return middlware function
-  return (req: Request, res: Response, next: NextFunction) => {
-    for (const loopFn of loopFns) {
-      if (!loopFn(req)) {
-        return res
-          .status(HttpStatusCodes.BAD_REQUEST)
-          .json({ error: paramInvalidErr });
-      }
-    }
-    return next();
-  };
-}
-
-/**
- * Get the param name, type to check against, and the request object property
- * as well as validating the format of the param.
- */
-function getParamFields(param: string | TParamArr): IParamFields {
-  let paramName = '';
-  let type = 'string';
-  let reqObjProp: TReqObjProps = 'body';
-  // Param is string
-  if (typeof param === 'string') {
-    paramName = param;
-  // Param is array
-  } else if (param instanceof Array) {
-    // Get the param name
-    paramName = param[0];
-    if (typeof paramName !== 'string') {
-      throw Error('param name must be a string');
-    }
-    // Get the type
-    if (typeof param[1] === 'string') {
-      type = param[1];
-    } else if (typeof param[1] === 'function') {
-      type = 'function';
-    } else {
-      throw Error('param[1] must be a string or a validator function');
-    }
-    // Get the request object property
-    const prop = (param.length >= 3 ? param[2] : 'body');
-    if (prop !== 'body' && prop !== 'params' && prop !== 'query') {
-      throw Error('param[2] must be "body", "query", or "params"');
-    } else {
-      reqObjProp = prop;
-    }
-  // Throw error if not string or array
-  } else {
-    throw Error('"validate()" argument must be a string or array');
-  }
-  // Return
-  return { paramName, type, reqObjProp };
-}
-
-/**
- * Check param is a valid string.
- */
-function checkStr(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
-  return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    return (typeof toCheck === 'string');
-  });
-}
-
-/**
- * Check param is a valid number. See notes at beginning of file.
- */
-function checkNum(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
-  return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    if (reqObjProp === 'query' || reqObjProp === 'params') {
-      return !isNaN(toCheck as number);
-    } else if (reqObjProp === 'body' && typeof toCheck !== 'number') {
-      return false;
-    } else {
-      return true;
-    }
-  });
-}
-
-/**
- * Check param is a valid boolean. See notes at beginning of file.
- */
-function checkBool(reqObjProp: TReqObjProps, paramName: string): TLoopFn {
-  return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    if (reqObjProp === 'query' || reqObjProp === 'params') {
-      return isBool(toCheck as boolean);
-    } else if (reqObjProp === 'body' && typeof toCheck !== 'boolean') {
-      return false;
-    } else {
-      return true;
-    }
-  });
-}
-
-/**
- * Checks if arg is a boolean, or a string that is 'true', or 'false'.
- */
-function isBool(arg: string | boolean): boolean {
-  if (typeof arg === 'boolean') {
-    return true;
-  } else if (typeof arg === 'string') {
-    arg = arg.toLowerCase();
-    return (arg === 'true' || arg === 'false');
-  } else {
-    return false;
-  }
-}
-
-/**
- * Make sure the parameter satifies the supplied validator function.
- */
-function checkValidatorFn(
-  reqObjProp: TReqObjProps,
-  paramName: string,
-  validatorFn: TValidatorFn,
-) {
-  return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    return validatorFn(toCheck);
-  });
-}
-
-/**
- * For all other type make sure the param equals the type.
- */
-function checkDefault(
-  reqObjProp: TReqObjProps,
-  paramName: string,
-  type: string,
-): TLoopFn {
-  return getLoopFn(reqObjProp, paramName, (toCheck) => {
-    return (toCheck === type);
-  });
-}
-
-/**
- * Extract the value to check and get the loop function.
- */
-function getLoopFn(
-  reqObjProp: TReqObjProps,
-  paramName: string,
-  cb: (toCheck: TAll) => boolean,
-): TLoopFn {
-  return (req: Request) => {
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
-    const toCheck = req[reqObjProp][paramName] as TAll;
-    return cb(toCheck);
-  };
-}
-
-
-// **** Export Default **** //
-
-export default validate;