express-generator-typescript 2.3.2 → 2.3.4

package/README.md

@@ -12,6 +12,8 @@
 Creates a new express application similar to the _express-generator_ module. Except this new
 application is configured to use TypeScript instead of plain JavaScript. 
 
+This project complies with Typescript best practices listed <a href="https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md">here</a>.
+
 
 ## Why express-generator-typescript?
 

package/lib/project-files/spec/support/login.ts

@@ -23,7 +23,7 @@ function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
   // Setup dummy data
   const role = UserRoles.Admin,
     pwdHash = PwdUtil.hashSync(LoginCreds.password),
-    loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
+    loginUser = new User('john smith', LoginCreds.email, role, pwdHash);
   // Add spy
   spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
   // Call Login API

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

@@ -50,7 +50,7 @@ describe('AuthRouter', () => {
   // ** Test login ** //
   describe(`"POST:${Login}"`, () => {
 
-    const EMAIL_NOT_FOUND_ERR = Errors.emailNotFound(LoginCreds.email);
+    const EMAIL_NOT_FOUND_ERR = Errors.EmailNotFound(LoginCreds.email);
 
     const callApi = (reqBody: TReqBody) => 
       agent
@@ -64,7 +64,7 @@ describe('AuthRouter', () => {
       // Setup data
       const role = UserRoles.Standard,
         pwdHash = PwdUtil.hashSync(LoginCreds.password),
-        loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
+        loginUser = new User('john smith', LoginCreds.email, role, pwdHash);
       // Add spy
       spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
       // Call API
@@ -99,7 +99,7 @@ describe('AuthRouter', () => {
       // Setup data
       const role = UserRoles.Standard,
         pwdHash = PwdUtil.hashSync('bad password'),
-        loginUser = User.new('john smith', LoginCreds.email, role, pwdHash);
+        loginUser = new User('john smith', LoginCreds.email, role, pwdHash);
       // Add spy
       spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
       // Call API

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

@@ -34,14 +34,14 @@ const {
 
 // Dummy users for GET req
 const DummyGetAllUsers = [
-  User.new('Sean Maxwell', 'sean.maxwell@gmail.com'),
-  User.new('John Smith', 'john.smith@gmail.com'),
-  User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
+  new User('Sean Maxwell', 'sean.maxwell@gmail.com'),
+  new User('John Smith', 'john.smith@gmail.com'),
+  new User('Gordan Freeman', 'gordan.freeman@gmail.com'),
 ] as const;
 
 // Dummy update user
 const DummyUserData = {
-  user: User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
+  user: new User('Gordan Freeman', 'gordan.freeman@gmail.com'),
 } as const;
 
 
@@ -79,7 +79,8 @@ describe('UserRouter', () => {
         .end((_: Error, res: Response) => {
           expect(res.status).toBe(OK);
           for (let i = 0; i < res.body.users.length; i++) {
-            expect(res.body.users[i]).toEqual(DummyGetAllUsers[i]);
+            const user = new User(res.body.users[i]);
+            expect(user).toEqual(DummyGetAllUsers[i]);
           }
           done();
         });

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

@@ -1,8 +1,8 @@
-import { TAll } from 'jet-validator';
-
-
 // **** Variables **** //
 
+const INVALID_CONSTRUCTOR_PARAM = 'nameOrObj arg must a string or an object ' + 
+  'with the appropriate user keys.';
+
 export enum UserRoles {
   Standard,
   Admin,
@@ -27,58 +27,57 @@ export interface ISessionUser {
 }
 
 
-// **** Functions **** //
+// **** User **** //
 
-/**
- * Get a new User object.
- */
-function new_(
-  name: string,
-  email: string,
-  role?: UserRoles,
-  pwdHash?: string,
-): IUser {
-  return {
-    id: -1,
-    email,
-    name,
-    role: (role ?? UserRoles.Standard),
-    pwdHash: (pwdHash ?? ''),
-  };
-}
+class User implements IUser {
 
-/**
- * Copy a user object.
- */
-function copy(user: IUser): IUser {
-  return {
-    id: user.id,
-    email: user.email,
-    name: user.name,
-    role: user.role,
-    pwdHash: user.pwdHash,
-  };
-}
+  public id: number;
+  public name: string;
+  public email: string;
+  public role?: UserRoles;
+  public pwdHash?: string;
+
+  constructor(
+    nameOrObj: string | object,
+    email?: string,
+    role?: UserRoles,
+    pwdHash?: string,
+    id?: number,
+  ) {
+    if (typeof nameOrObj === 'string') {
+      this.name = nameOrObj;
+      this.email = (email ?? '');
+      this.role = (role ?? UserRoles.Standard);
+      this.pwdHash = (pwdHash ?? '');
+      this.id = (id ?? -1);
+    } else if (User.IsUserObj(nameOrObj)) {
+      const o = nameOrObj as IUser;
+      this.name = o.name;
+      this.email = (o.email ?? '');
+      this.role = (o.role ?? UserRoles.Standard);
+      this.pwdHash = (o.pwdHash ?? '');
+      this.id = (o.id ?? -1);
+    } else {
+      throw new Error(INVALID_CONSTRUCTOR_PARAM);
+    }
+  }
 
-/**
- * See if an object is an instance of User.
- */
-function instanceOf(arg: TAll): boolean {
-  return (
-    !!arg &&
-    typeof arg === 'object' &&
-    'id' in arg &&
-    'email' in arg &&
-    'name' in arg &&
-    'role' in arg
-  );
+  /**
+   * Is this an object which contains all the user keys.
+   */
+  public static IsUserObj(this: void, arg: unknown): boolean {
+    return (
+      !!arg &&
+      typeof arg === 'object' &&
+      'id' in arg &&
+      'email' in arg &&
+      'name' in arg &&
+      'role' in arg
+    );
+  }
 }
 
 
 // **** Export default **** //
 
-export default {
-  new: new_,
-  copy,
-  instanceOf,
-} as const;
+export default User;

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

@@ -48,14 +48,14 @@ userRouter.get(
 // Add one user
 userRouter.post(
   Paths.Users.Add,
-  validate(['user', User.instanceOf]),
+  validate(['user', User.IsUserObj]),
   UserRoutes.add,
 );
 
 // Update one user
 userRouter.put(
   Paths.Users.Update,
-  validate(['user', User.instanceOf]),
+  validate(['user', User.IsUserObj]),
   UserRoutes.update,
 );
 

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

@@ -6,7 +6,6 @@ import { Request, Response, NextFunction } from 'express';
 import { JwtPayload } from 'jsonwebtoken';
 
 import HttpStatusCodes from '@src/constants/HttpStatusCodes';
-import EnvVars from '@src/constants/EnvVars';
 
 import SessionUtil from '@src/util/SessionUtil';
 import { ISessionUser, UserRoles } from '@src/models/User';

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

@@ -13,7 +13,9 @@ import { IUser } from '@src/models/User';
 // Errors
 export const Errors = {
   Unauth: 'Unauthorized',
-  emailNotFound: (email: string) => `User with email "${email}" not found`,
+  EmailNotFound(email: string) {
+    return `User with email "${email}" not found`;
+  },
 } as const;
 
 
@@ -28,7 +30,7 @@ async function login(email: string, password: string): Promise<IUser> {
   if (!user) {
     throw new RouteError(
       HttpStatusCodes.UNAUTHORIZED,
-      Errors.emailNotFound(email),
+      Errors.EmailNotFound(email),
     );
   }
   // Check password

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.3.2",
+  "version": "2.3.4",
   "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/routes/user-routes.ts

@@ -1,60 +0,0 @@
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
-
-import userService from '@src/services/user-service';
-import { IUser } from '@src/models/User';
-import { IReq, IRes } from './shared/types';
-
-
-// **** Variables **** //
-
-// Paths
-
-
-
-// **** Functions **** //
-
-/**
- * Get all users.
- */
-async function getAll(_: IReq, res: IRes) {
-  const users = await userService.getAll();
-  return res.status(HttpStatusCodes.OK).json({ users });
-}
-
-/**
- * Add one user.
- */
-async function add(req: IReq<{user: IUser}>, res: IRes) {
-  const { user } = req.body;
-  await userService.addOne(user);
-  return res.status(HttpStatusCodes.CREATED).end();
-}
-
-/**
- * Update one user.
- */
-async function update(req: IReq<{user: IUser}>, res: IRes) {
-  const { user } = req.body;
-  await userService.updateOne(user);
-  return res.status(HttpStatusCodes.OK).end();
-}
-
-/**
- * Delete one user.
- */
-async function _delete(req: IReq, res: IRes) {
-  const id = +req.params.id;
-  await userService.delete(id);
-  return res.status(HttpStatusCodes.OK).end();
-}
-
-
-// **** Export default **** //
-
-export default {
-  paths,
-  getAll,
-  add,
-  update,
-  delete: _delete,
-} as const;