express-generator-typescript 2.1.3 → 2.1.5

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

@@ -7,7 +7,7 @@ import app from '@server';
 import userRepo from '@repos/user-repo';
 import envVars from '@shared/env-vars';
 import User, { UserRoles } from '@models/user-model';
-import { p as paths } from '@routes/auth-router';
+import authRoutes from '@routes/auth-routes';
 import { pwdSaltRounds } from 'spec/support/login-agent';
 import { UnauthorizedError } from '@shared/errors';
 
@@ -15,7 +15,8 @@ import { UnauthorizedError } from '@shared/errors';
 // **** Variables **** //
 
 // Misc
-const authPath = ('/api' + paths.basePath),
+const { paths } = authRoutes,
+  authPath = ('/api' + paths.basePath),
   loginPath = `${authPath}${paths.login}`,
   logoutPath = `${authPath}${paths.logout}`,
   { BAD_REQUEST, OK, UNAUTHORIZED } = StatusCodes;

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

@@ -6,11 +6,10 @@ import logger from 'jet-logger';
 import app from '@server';
 import userRepo from '@repos/user-repo';
 import User, { IUser } from '@models/user-model';
+import userRoutes from '@routes/user-routes';
 
-import { p as userPaths } from '@routes/user-router';
 import {
   ParamInvalidError,
-  // ParamMissingError,
   UserNotFoundError,
   ValidatorFnError,
 } from '@shared/errors';
@@ -20,11 +19,12 @@ import loginAgent from '../support/login-agent';
 // **** Variables **** //
 
 // Misc
-const usersPath = ('/api' + userPaths.basePath),
-  getUsersPath = `${usersPath}${userPaths.get}`,
-  addUsersPath = `${usersPath}${userPaths.add}`,
-  updateUserPath = `${usersPath}${userPaths.update}`,
-  deleteUserPath = `${usersPath}${userPaths.delete}`,
+const { paths } = userRoutes,
+  usersPath = ('/api' + paths.basePath),
+  getUsersPath = `${usersPath}${paths.get}`,
+  addUsersPath = `${usersPath}${paths.add}`,
+  updateUserPath = `${usersPath}${paths.update}`,
+  deleteUserPath = `${usersPath}${paths.delete}`,
   { BAD_REQUEST, CREATED, OK } = StatusCodes;
 
 // Dummy users for GET req

package/lib/project-files/src/pre-start/env/development.env

@@ -3,7 +3,7 @@ NODE_ENV=development
 
 
 ## Server ##
-PORT=3000
+PORT=3001
 HOST=localhost
 
 

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

@@ -1,16 +1,64 @@
 import { Router } from 'express';
-import { adminMw } from './middleware';
 
-import authRouter, { p as authPaths } from './auth-router';
-import userRouter, { p as userPaths } from './user-router';
+import { adminMw, validate } from './middleware';
+import User from '@models/user-model';
+import authRoutes from './auth-routes';
+import userRoutes from './user-routes';
 
 
-// Init
+// **** Init **** //
+
 const apiRouter = Router();
 
-// Add api routes
-apiRouter.use(authPaths.basePath, authRouter);
-apiRouter.use(userPaths.basePath, adminMw, userRouter);
+
+// **** Setup auth routes **** //
+
+const authRouter = Router();
+
+// Login user
+authRouter.post(
+  authRoutes.paths.login,
+  validate('email', 'password'),
+  authRoutes.login,
+);
+
+// Logout user
+authRouter.get(authRoutes.paths.logout, authRoutes.logout);
+
+// Add authRouter
+apiRouter.use(authRoutes.paths.basePath, authRouter);
+
+
+// **** Setup user routes **** //
+
+const userRouter = Router();
+
+// Get all users
+userRouter.get(userRoutes.paths.get, userRoutes.getAll);
+
+// Add one user
+userRouter.post(
+  userRoutes.paths.add,
+  validate(['user', User.instanceOf]),
+  userRoutes.add,
+);
+
+// Update one user
+userRouter.put(
+  userRoutes.paths.update,
+  validate(['user', User.instanceOf]),
+  userRoutes.update,
+);
+
+// Delete one user
+userRouter.delete(
+  userRoutes.paths.delete,
+  validate(['id', 'number', 'params']),
+  userRoutes.delete,
+);
+
+// Add userRouter
+apiRouter.use(userRoutes.paths.basePath, adminMw, userRouter);
 
 
 // **** Export default **** //

package/lib/project-files/src/routes/{auth-router.ts → auth-routes.ts}

@@ -1,10 +1,8 @@
-import { Router } from 'express';
 import StatusCodes from 'http-status-codes';
 
 import authService from '@services/auth-service';
 import envVars from 'src/shared/env-vars';
 import { IReq, IRes } from '@shared/types';
-import { vld } from './middleware';
 
 
 // **** Types **** //
@@ -21,20 +19,13 @@ interface ILoginReq {
 const { OK } = StatusCodes;
 
 // Paths
-export const p = {
+const paths = {
   basePath: '/auth',
   login: '/login',
   logout: '/logout',
 } as const;
 
 
-// **** Setup Router **** //
-
-const router = Router();
-router.post(p.login, vld('email', 'password'), login);
-router.get(p.logout, logout);
-
-
 // **** Functions **** //
 
 /**
@@ -60,6 +51,10 @@ function logout(_: IReq, res: IRes) {
 }
 
 
-// **** Export router **** //
+// **** Export default **** //
 
-export default router;
+export default {
+  paths,
+  login,
+  logout,
+} as const;

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

@@ -69,10 +69,10 @@ export async function adminMw(
 }
 
 /**
- * vld stands for 'validate'. This function returns a middleware-function
- * that validates the parameters provided. Each argument can be a string or 
- * array. If an array the format is:
+ * 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')]
  * 
@@ -85,26 +85,30 @@ export async function adminMw(
  * 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: vld('email', ['user', 'object'], ['id', 'number', 'params']) |
+ * 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: vld('password') | will check that 'password' is a string on
+ * Example 2: validate('password') will check that 'password' is a string on
  *  req.body.
- * Example 3: vld(['isAdmin', 'boolean']) | will check that 'isAdmin' is a 
+ * Example 3: validate(['isAdmin', 'boolean']) will check that 'isAdmin' is a 
  *  boolean on req.body
- * Example 4: vld(['user', isInstanceOfUser]) | will check that 'user' 
+ * Example 4: validate(['user', isInstanceOfUser]) will check that 'user' 
  *  satifies the 'isInstanceOfUser()' function.
- * Example 5: val(['email']), will check that 'email' is a string in req.body,
+ * Example 5: validate(['email']) will check that 'email' is a string in 
+ *  req.body,
  */
-export function vld(...params: Array<string | TParamArr>): RequestHandler {
+export function validate(...params: Array<string | TParamArr>): RequestHandler {
   return (req: Request, _: Response, next: NextFunction) => {
     for (const param of params) {
       // Check params
       if (typeof param !== 'string' && !(param instanceof Array)) {
-        throw Error('vld() arg must be a string or array');
+        throw Error('"validate()" arg must be a string or array');
       }
       // If param is a string, make sure param is of type string on req.body
       if (typeof param === 'string') {
@@ -137,16 +141,25 @@ export function vld(...params: Array<string | TParamArr>): RequestHandler {
         const fn = param[1];
         if (!fn(toValidate)) {
           throw new ValidatorFnError(fn.name);
+        } else {
+          continue;
         }
-      // If type is a number, need to do isNaN() to account for 
-      // number-strings (i.e. '1243') in req.query or req.params. But in
-      // req.body, numbers should be 'typeof toCheck === "number"'
+      // If type is a number, see note above.
       } else if (param[1] === 'number') {
         if (reqObjProp === 'query' || reqObjProp === 'params') {
           if (isNaN(toValidate as number)) {
             throw new ParamInvalidError();
           }
-        } else if (typeof toValidate !== 'number') {
+        } else if (reqObjProp === 'body' && typeof toValidate !== 'number') {
+          throw new ParamInvalidError();
+        }
+      // If type is a boolean, see note above.
+      } else if (param[1] === 'boolean') {
+        if (reqObjProp === 'query' || reqObjProp === 'params') {
+          if (!isBool(toValidate as boolean)) {
+            throw new ParamInvalidError();
+          }
+        } else if (reqObjProp === 'body' && typeof toValidate !== 'boolean') {
           throw new ParamInvalidError();
         }
       // Check the param is the provided type
@@ -158,3 +171,17 @@ export function vld(...params: Array<string | TParamArr>): RequestHandler {
     next();
   };
 }
+
+/**
+ * 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;
+  }
+}

package/lib/project-files/src/routes/{user-router.ts → user-routes.ts}

@@ -1,11 +1,8 @@
 import StatusCodes from 'http-status-codes';
-import { Router } from 'express';
 
 import userService from '@services/user-service';
-import User, { IUser } from '@models/user-model';
+import { IUser } from '@models/user-model';
 import { IReq, IRes } from '@shared/types';
-import { vld } from './middleware';
-
 
 
 // **** Variables **** //
@@ -14,7 +11,7 @@ import { vld } from './middleware';
 const { CREATED, OK } = StatusCodes;
 
 // Paths
-export const p = {
+const paths = {
   basePath: '/users',
   get: '/all',
   add: '/add',
@@ -23,19 +20,6 @@ export const p = {
 } as const;
 
 
-// **** Setup Router **** //
-
-// Validators (place shared or really long ones here)
-const validateUser = vld(['user', User.instanceOf]);
-
-// Add routes to express
-const router = Router();
-router.get(p.get, getAll);
-router.post(p.add, validateUser, add);
-router.put(p.update, validateUser, update);
-router.delete(p.delete, vld(['id', 'number', 'params']), _delete);
-
-
 // **** Functions **** //
 
 /**
@@ -76,4 +60,10 @@ async function _delete(req: IReq, res: IRes) {
 
 // **** Export default **** //
 
-export default router;
+export default {
+  paths,
+  getAll,
+  add,
+  update,
+  delete: _delete,
+} as const;

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

@@ -31,7 +31,7 @@ function sign(data: string | object | Buffer): Promise<string> {
 /**
  * Decrypt JWT and extract client data.
  */
-async function decode<T>(jwt: string): Promise<string | undefined | T> {
+function decode<T>(jwt: string): Promise<string | undefined | T> {
   return new Promise((res, rej) => {
     jsonwebtoken.verify(jwt, envVars.jwt.secret, (err, decoded) => {
       return err ? rej(errors.validation) : res(decoded as T);

package/package.json

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