express-generator-typescript 2.0.4 → 2.0.7

package/lib/project-files/src/models/user-model.ts

@@ -9,8 +9,8 @@ export interface IUser {
   id: number;
   name: string;
   email: string;
-  pwdHash: string;
-  role: UserRoles;
+  pwdHash?: string;
+  role?: UserRoles;
 }
 
 
@@ -47,10 +47,24 @@ function copy(user: IUser): IUser {
   };
 }
 
+/**
+ * See if an object is an instance of User.
+ */
+function instanceOf(arg: object): boolean {
+  return (
+    typeof arg === 'object' &&
+    'id' in arg &&
+    'email' in arg &&
+    'name' in arg &&
+    'role' in arg
+  );
+}
+
 
 // **** Export default **** //
 
 export default {
   new: _new,
   copy,
+  instanceOf,
 };

package/lib/project-files/src/public/scripts/users.js

@@ -34,7 +34,7 @@ function getUserDisplayEle(user) {
       <div class="normal-view">
         <div>Name: ${user.name}</div>
         <div>Email: ${user.email}</div>
-        <button class="edit-user-btn" data-user-id="${user.id}">
+        <button class="edit-user-btn" data-user-id="${user.id}" data-user-role="${user.role}">
           Edit
         </button>
         <button class="delete-user-btn" data-user-id="${user.id}">
@@ -90,8 +90,10 @@ function addUser() {
   var emailInput = document.getElementById('email-input');
   var data = {
     user: {
+      id: -1,
       name: nameInput.value,
       email: emailInput.value,
+      role: 0,
     },
   };
   // Call api
@@ -128,11 +130,13 @@ function submitEdit(ele) {
   var nameInput = userEle.getElementsByClassName('name-edit-input')[0];
   var emailInput = userEle.getElementsByClassName('email-edit-input')[0];
   var id = ele.getAttribute('data-user-id');
+  var role = ele.getAttribute('data-user-role');
   var data = {
     user: {
+      id: Number(id),
       name: nameInput.value,
       email: emailInput.value,
-      id: Number(id),
+      role: Number(role),
     },
   };
 	Http

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

@@ -2,9 +2,9 @@ import { 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, IRes } from '@shared/types';
+import validate from './validators';
 
 
 // **** Types **** //
@@ -36,9 +36,7 @@ export const p = {
  */
 router.post(p.login, async (req: IReq<ILoginReq>, res: IRes) => {
   const { email, password } = req.body;
-  if (!email || !password) {
-    throw new ParamMissingError();
-  }
+  validate(email, password);
   // Add jwt to cookie
   const jwt = await authService.login(email, password);
   const { key, options } = envVars.cookieProps;

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

@@ -2,9 +2,9 @@ import StatusCodes from 'http-status-codes';
 import { Router } from 'express';
 
 import userService from '@services/user-service';
-import { ParamMissingError } from '@shared/errors';
-import { IUser } from '@models/user-model';
+import User, { IUser } from '@models/user-model';
 import { IReq, IRes } from '@shared/types';
+import validate from './validators';
 
 
 // **** Variables **** //
@@ -37,9 +37,8 @@ router.get(p.get, async (_: IReq, res: IRes) => {
  */
 router.post(p.add, async (req: IReq<{user: IUser}>, res: IRes) => {
   const { user } = req.body;
-  if (!user) {
-    throw new ParamMissingError();
-  }
+  validate([user, User.instanceOf]);
+  // Add user
   await userService.addOne(user);
   return res.status(CREATED).end();
 });
@@ -49,9 +48,8 @@ router.post(p.add, async (req: IReq<{user: IUser}>, res: IRes) => {
  */
 router.put(p.update, async (req: IReq<{user: IUser}>, res: IRes) => {
   const { user } = req.body;
-  if (!user) {
-    throw new ParamMissingError();
-  }
+  validate([user, User.instanceOf]);
+  // Edit user
   await userService.updateOne(user);
   return res.status(OK).end();
 });
@@ -60,11 +58,10 @@ router.put(p.update, async (req: IReq<{user: IUser}>, res: IRes) => {
  * Delete one user.
  */
 router.delete(p.delete, async (req: IReq, res: IRes) => {
-  const { id } = req.params;
-  if (!id) {
-    throw new ParamMissingError();
-  }
-  await userService.delete(Number(id));
+  const id = Number(req.params.id);
+  validate([id, 'number']);
+  // Delete user
+  await userService.delete(id);
   return res.status(OK).end();
 });
 

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

@@ -0,0 +1,60 @@
+/**
+ * Put other validator functions here too that may be passed to the validate() function
+ */
+
+import { ParamInvalidError } from '@shared/errors';
+
+
+// **** Types **** //
+
+type TParam = string | number | boolean | null | object;
+type TValidatorFn =  ((arg: TParam) => boolean);
+type TParamFull = TParam | TValidatorFn;
+
+
+// **** Functions **** //
+
+/**
+ * Make sure parameter is of the specified type. If the type is not provided then 'string' is
+ * used as the default type. Instead of a type you can also pass a validator function 
+ * which must return 'true' or 'false'. Return false if invalid.
+ * 
+ * Example argument: [id, 'number'], id is the incoming variable, 'number' is the type.
+ * 
+ * Example 1: validate(email, [user, 'object'], [isAdmin, 'boolean'])
+ * Example 2: validate(password) // will check that password is a string
+ * Example 3: validate([isAdmin, 'boolean'])
+ * Example 4: validate([user, isInstanceOfUser])
+ */
+function validate(...params: Array<TParam | TParamFull[]>): void {
+  for (const param of params) {
+    // If param is array check provided type
+    if (param instanceof Array) {
+      // Validator function provided
+      if (typeof param[1] === 'function') {
+        const fn = param[1];
+        if (!fn(param[0])) {
+          throw new Error(`Validator function ${fn.name} failed.`);
+        }
+      // If type is a number, need to do isNaN, cause type NaN is a 'number'. 
+      // This could be an issue if you do Number(undefined)
+      } else if (param[1] === 'number') {
+        if (isNaN(param[0] as number)) {
+          throw new ParamInvalidError();
+        }
+      } else if (typeof param[0] !== param[1]) {
+        throw new ParamInvalidError();
+      }
+    // String is default if type is not provided
+    } else {
+      if (typeof param !== 'string') {
+        throw new ParamInvalidError();
+      }
+    }
+  } 
+}
+
+
+// **** Export default **** //
+
+export default validate;

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

@@ -17,7 +17,8 @@ async function login(email: string, password: string): Promise<string> {
     throw new UnauthorizedError();
   }
   // Check password
-  const pwdPassed = await bcrypt.compare(password, user.pwdHash);
+  const hash = (user.pwdHash ?? '');
+  const pwdPassed = await bcrypt.compare(password, hash);
   if (!pwdPassed) {
     throw new UnauthorizedError();
   }

package/lib/project-files/src/shared/errors.ts

@@ -11,7 +11,6 @@ export abstract class CustomError extends Error {
   }
 }
 
-
 export class ParamMissingError extends CustomError {
 
   public static readonly Msg = 'One or more of the required parameters was missing.';
@@ -22,6 +21,15 @@ export class ParamMissingError extends CustomError {
   }
 }
 
+export class ParamInvalidError extends CustomError {
+
+  public static readonly Msg = 'One or more of the required was missing or invalid.';
+  public static readonly HttpStatus = HttpStatusCodes.BAD_REQUEST;
+
+  constructor() {
+    super(ParamMissingError.Msg, ParamMissingError.HttpStatus);
+  }
+}
 
 export class UserNotFoundError extends CustomError {
 
@@ -33,7 +41,6 @@ export class UserNotFoundError extends CustomError {
   }
 }
 
-
 export class UnauthorizedError extends CustomError {
 
   public static readonly Msg = 'Login failed';
@@ -42,4 +49,4 @@ export class UnauthorizedError extends CustomError {
   constructor() {
     super(UnauthorizedError.Msg, UnauthorizedError.HttpStatus);
   }
-}
+}

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

@@ -1,6 +1,8 @@
 import logger from 'jet-logger';
 
 
+// **** Functions **** //
+
 /**
  * Print an error object if it's truthy. Useful for testing.
  */

package/package.json

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