express-generator-typescript 1.10.2 → 1.10.3

package/lib/auth-proj/src/routes/api.ts

@@ -1,5 +1,5 @@
 import { Router } from 'express';
-import { adminMw } from './middleware';
+import { authMw } from './middleware';
 import authRouter from './auth-router';
 import userRouter from './user-router';
 
@@ -9,7 +9,7 @@ const apiRouter = Router();
 
 // Add api routes
 apiRouter.use('/auth', authRouter);
-apiRouter.use('/users', adminMw, userRouter);
+apiRouter.use('/users', authMw, userRouter);
 
 
 // **** Export default **** //

package/lib/auth-proj/src/routes/auth-router.ts

@@ -4,6 +4,15 @@ 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 } from 'src/types/express';
+
+
+// **** Types **** //
+
+interface ILogin {
+  email: string;
+  password: string;
+}
 
 
 // **** Variables **** //
@@ -24,7 +33,7 @@ export const p = {
 /**
  * Login a user.
  */
-router.post(p.login, async (req: Request, res: Response) => {
+router.post(p.login, async (req: IReq<ILogin>, res: Response) => {
   // Check email and password present
   const { email, password } = req.body;
   if (!email || !password) {

package/lib/auth-proj/src/routes/middleware.ts

@@ -2,8 +2,8 @@ import StatusCodes from 'http-status-codes';
 import { Request, Response, NextFunction } from 'express';
 import { JwtPayload } from 'jsonwebtoken';
 
-import { IUser, UserRoles } from '@models/user-model';
-import envVars from 'src/shared/env-vars';
+import envVars from '@shared/env-vars';
+import { IUser } from '@models/user-model';
 import jwtUtil from '@util/jwt-util';
 
 
@@ -26,26 +26,24 @@ export interface ISessionUser extends JwtPayload {
 // **** Functions **** //
 
 /**
- * Middleware to verify if user is an admin.
+ * Middleware to verify if user logged in.
  */
-export async function adminMw(req: Request, res: Response, next: NextFunction) {
-  // Try
+export async function authMw(req: Request, res: Response, next: NextFunction) {
   try {
-    // Extract the token
+    // Get json-web-token
     const jwt = req.signedCookies[envVars.cookieProps.key];
     if (!jwt) {
       throw Error(jwtNotPresentErr);
     }
     // Make sure user role is an admin
-    const clientData = await jwtUtil.decode(jwt);
-    if (typeof clientData === 'object' && clientData.role === UserRoles.Admin) {
-      res.locals.sessionUser = clientData as ISessionUser;
+    const clientData = await jwtUtil.decode<ISessionUser>(jwt);
+    if (!!clientData) {
+      res.locals.sessionUser = clientData;
       next();
     } else {
       throw Error(jwtNotPresentErr);
     }
-  // Catch
-  } catch (err: unknown) {
+  } catch (err) {
     let error;
     if (typeof err === 'string') {
       error = err;
@@ -55,4 +53,3 @@ export async function adminMw(req: Request, res: Response, next: NextFunction) {
     return res.status(UNAUTHORIZED).json({ error });
   }
 }
-

package/lib/auth-proj/src/routes/user-router.ts

@@ -3,6 +3,8 @@ import { Request, Response, Router } from 'express';
 
 import userService from '@services/user-service';
 import { ParamMissingError } from '@shared/errors';
+import { IReq } from 'src/types/express';
+import { IUser } from '@models/user-model';
 
 
 // **** Variables **** //
@@ -33,7 +35,7 @@ router.get(p.get, async (_: Request, res: Response) => {
 /**
  * Add one user.
  */
-router.post(p.add, async (req: Request, res: Response) => {
+router.post(p.add, async (req: IReq<{user: IUser}>, res: Response) => {
   const { user } = req.body;
   // Check param
   if (!user) {
@@ -47,7 +49,7 @@ router.post(p.add, async (req: Request, res: Response) => {
 /**
  * Update one user.
  */
-router.put(p.update, async (req: Request, res: Response) => {
+router.put(p.update, async (req: IReq<{user: IUser}>, res: Response) => {
   const { user } = req.body;
   // Check param
   if (!user) {

package/lib/auth-proj/src/types/express/index.d.ts

@@ -1,18 +1,15 @@
-import { IUser } from '@models/user-model';
+import * as e from 'express';
+import 'express';
+
 import { ISessionUser } from '@routes/middleware';
 
 
+// **** Declaration Merging **** //
+
 declare module 'express' {
 
-  export interface Request  {
-    signedCookies: Record<string, string>,
-    body: {
-      user?: IUser
-      email?: string;
-      password?: string;
-      message?: string;
-      socketId?: string;
-    };
+  export interface Request {
+    signedCookies: Record<string, string>;
   }
 
   export interface Response {
@@ -21,3 +18,15 @@ declare module 'express' {
     };
   }
 }
+
+
+// **** Generics for Request Object **** //
+
+export interface IReq<T> extends e.Request {
+  body: T;
+}
+
+export interface IReqQuery<T extends Query, U = void> extends e.Request {
+  query: T;
+  body?: U;
+}

package/lib/auth-proj/src/util/jwt-util.ts

@@ -1,23 +1,17 @@
+import randomString from 'randomstring';
 import jsonwebtoken, { JwtPayload } from 'jsonwebtoken';
-import envVars from '../shared/env-vars';
 
 
 // **** Variables **** //
 
 // Errors
 const errors = {
-  validation: 'JSON-web-token validation failed.',
+    validation: 'JSON-web-token validation failed.',
 } as const;
 
-// Options
-const options = {
-  expiresIn: envVars.jwt.exp,
-};
-
-
-// **** Types **** //
-
-type TDecoded = string | JwtPayload | undefined;
+// Misc
+const secret = (process.env.JWT_SECRET || randomString.generate(100));
+const options = {expiresIn: process.env.COOKIE_EXP};
 
 
 // **** Functions **** //
@@ -27,8 +21,8 @@ type TDecoded = string | JwtPayload | undefined;
  */
 function sign(data: JwtPayload): Promise<string> {
   return new Promise((resolve, reject) => {
-    jsonwebtoken.sign(data, envVars.jwt.secret, options, (err, token) => {
-      err ? reject(err) : resolve(token || '');
+    jsonwebtoken.sign(data, secret, options, (err, token) => {
+      return err ? reject(err) : resolve(token || '');
     });
   });
 }
@@ -36,10 +30,10 @@ function sign(data: JwtPayload): Promise<string> {
 /**
  * Decrypt JWT and extract client data.
  */
-function decode(jwt: string): Promise<TDecoded> {
+function decode<T>(jwt: string): Promise<T> {
   return new Promise((res, rej) => {
-    jsonwebtoken.verify(jwt, envVars.jwt.secret, (err, decoded) => {
-      return err ? rej(errors.validation) : res(decoded);
+    jsonwebtoken.verify(jwt, secret, (err, decoded) => {
+      return err ? rej(errors.validation) : res(decoded as T);
     });
   });
 }

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

@@ -2,7 +2,7 @@
 
 // User schema
 export interface IUser {
-  id: number;
+  id?: number;
   name: string;
   email: string;
 }

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

@@ -3,6 +3,8 @@ import { Request, Response, Router } from 'express';
 
 import userService from '@services/user-service';
 import { ParamMissingError } from '@shared/errors';
+import { IReq } from 'src/types/express';
+import { IUser } from '@models/user-model';
 
 
 // **** Variables **** //
@@ -33,7 +35,7 @@ router.get(p.get, async (_: Request, res: Response) => {
 /**
  * Add one user
  */
-router.post(p.add, async (req: Request, res: Response) => {
+router.post(p.add, async (req: IReq<{user: IUser}>, res: Response) => {
   const { user } = req.body;
   // Check param
   if (!user) {
@@ -47,7 +49,7 @@ router.post(p.add, async (req: Request, res: Response) => {
 /**
  * Update one user
  */
-router.put(p.update, async (req: Request, res: Response) => {
+router.put(p.update, async (req: IReq<{user: IUser}>, res: Response) => {
   const { user } = req.body;
   // Check param
   if (!user) {

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

@@ -23,7 +23,7 @@ function addOne(user: IUser): Promise<void> {
  * Update one user
  */
 async function updateOne(user: IUser): Promise<void> {
-  const persists = await userRepo.persists(user.id);
+  const persists = await userRepo.persists(user.id ?? -1);
   if (!persists) {
     throw new UserNotFoundError();
   }

package/lib/project-files/src/types/express/index.d.ts

@@ -1,12 +1,12 @@
-import { IUser } from "@models/user-model";
+import * as e from 'express';
+import { Query } from 'express-serve-static-core';
 
 
-declare module 'express' {
-  export interface Request  {
-    body: {
-      user?: IUser
-      email?: string;
-    };
-  }
+export interface IReq<T> extends e.Request {
+  body: T;
 }
 
+export interface IReqQuery<T extends Query, U = void> extends e.Request {
+  query: T;
+  body?: U;
+}

package/lib/socket-io/src/routes/auth-router.ts

@@ -1,8 +1,10 @@
+import { Request, Response, Router } from 'express';
+import StatusCodes from 'http-status-codes';
 
 import authService from '@services/auth-service';
+import envVars from '@shared/env-vars';
 import { ParamMissingError } from '@shared/errors';
-import { Request, Response, Router } from 'express';
-import StatusCodes from 'http-status-codes';
+import { IReq } from 'src/types/express';
 
 
 // **** Variables **** //
@@ -17,19 +19,13 @@ export const p = {
   logout: '/logout',
 } as const;
 
-// Cookie Properties
-export const cookieProps = Object.freeze({
-  key: 'ExpressGeneratorTs',
-  secret: process.env.COOKIE_SECRET,
-  options: {
-    httpOnly: true,
-    signed: true,
-    path: (process.env.COOKIE_PATH),
-    maxAge: Number(process.env.COOKIE_EXP),
-    domain: (process.env.COOKIE_DOMAIN),
-    secure: (process.env.SECURE_COOKIE === 'true'),
-  },
-});
+
+// **** Types **** //
+
+interface ILoginReq {
+  email: string;
+  password: string;
+}
 
 
 // **** Routes **** //
@@ -37,7 +33,7 @@ export const cookieProps = Object.freeze({
 /**
  * Login a user.
  */
-router.post(p.login, async (req: Request, res: Response) => {
+router.post(p.login, async (req: IReq<ILoginReq>, res: Response) => {
   // Check email and password present
   const { email, password } = req.body;
   if (!(email && password)) {
@@ -46,7 +42,7 @@ router.post(p.login, async (req: Request, res: Response) => {
   // Get jwt
   const jwt = await authService.login(email, password);
   // Add jwt to cookie
-  const { key, options } = cookieProps;
+  const { key, options } = envVars.cookieProps;
   res.cookie(key, jwt, options);
   // Return
   return res.status(OK).end();
@@ -56,7 +52,7 @@ router.post(p.login, async (req: Request, res: Response) => {
  * Logout the user.
  */
 router.get(p.logout, (_: Request, res: Response) => {
-  const { key, options } = cookieProps;
+  const { key, options } = envVars.cookieProps;
   res.clearCookie(key, options);
   return res.status(OK).end();
 });

package/lib/socket-io/src/routes/chat-router.ts

@@ -3,6 +3,7 @@ import StatusCodes from 'http-status-codes';
 import { Router, Request, Response } from 'express';
 
 import { ParamMissingError, RoomNotFoundError } from '@shared/errors';
+import { IReq } from 'src/types/express';
 
 
 // **** Variables **** //
@@ -20,6 +21,14 @@ export const p = {
 export const socketRoomName = 'jet-logger-chat-room';
 
 
+// **** Types **** //
+
+interface IPostMsg {
+  message: string; 
+  socketId: string;
+}
+
+
 // **** Routes **** //
 
 /**
@@ -45,7 +54,7 @@ router.get(p.connect, async (req: Request, res: Response) => {
 /**
  * Send a chat message.
  */
-router.post(p.emit, (req: Request, res: Response) => {
+router.post(p.emit, (req: IReq<IPostMsg>, res: Response) => {
   const { sessionUser } = res.locals;
   const { message, socketId } = req.body;
   // Check params

package/lib/socket-io/src/routes/middleware.ts

@@ -2,7 +2,7 @@ import StatusCodes from 'http-status-codes';
 import { Request, Response, NextFunction } from 'express';
 import { JwtPayload } from 'jsonwebtoken';
 
-import { cookieProps } from '@routes/auth-router';
+import envVars from '@shared/env-vars';
 import { IUser } from '@models/user-model';
 import jwtUtil from '@util/jwt-util';
 
@@ -26,19 +26,19 @@ export interface ISessionUser extends JwtPayload {
 // **** Functions **** //
 
 /**
- * Middleware to verify if user is an admin.
+ * Middleware to verify if user is logged in.
  */
 export async function authMw(req: Request, res: Response, next: NextFunction) {
   try {
     // Get json-web-token
-    const jwt = req.signedCookies[cookieProps.key];
+    const jwt = req.signedCookies[envVars.cookieProps.key];
     if (!jwt) {
       throw Error(jwtNotPresentErr);
     }
     // Make sure user role is an admin
-    const clientData = await jwtUtil.decode(jwt);
-    if (!!clientData && typeof clientData !== 'string') {
-      res.locals.sessionUser = clientData as ISessionUser;
+    const clientData = await jwtUtil.decode<ISessionUser>(jwt);
+    if (!!clientData) {
+      res.locals.sessionUser = clientData;
       next();
     } else {
       throw Error(jwtNotPresentErr);

package/lib/socket-io/src/routes/user-router.ts

@@ -3,6 +3,8 @@ import { Request, Response, Router } from 'express';
 
 import userService from '@services/user-service';
 import { ParamMissingError } from '@shared/errors';
+import { IReq } from 'src/types/express';
+import { IUser } from '@models/user-model';
 
 
 // **** Variables **** //
@@ -33,7 +35,7 @@ router.get(p.get, async (_: Request, res: Response) => {
 /**
  * Add one user.
  */
-router.post(p.add, async (req: Request, res: Response) => {
+router.post(p.add, async (req: IReq<{user: IUser}>, res: Response) => {
   const { user } = req.body;
   if (!user) {
     throw new ParamMissingError();
@@ -46,7 +48,7 @@ router.post(p.add, async (req: Request, res: Response) => {
 /**
  * Update one user.
  */
-router.put(p.update, async (req: Request, res: Response) => {
+router.put(p.update, async (req: IReq<{user: IUser}>, res: Response) => {
   const { user } = req.body;
   if (!user) {
     throw new ParamMissingError();
@@ -56,7 +58,6 @@ router.put(p.update, async (req: Request, res: Response) => {
   return res.status(OK).end();
 });
 
-
 /**
  * Delete one user.
  */

package/lib/socket-io/src/types/express/index.d.ts

@@ -1,18 +1,17 @@
-import { IUser } from '@models/user-model';
+import 'express';
+import * as e from 'express';
+import { Query } from 'express-serve-static-core';
+
 import { ISessionUser } from '@routes/middleware';
 
 
+
+// **** Declaration Merging **** //
+
 declare module 'express' {
 
-  export interface Request  {
-    signedCookies: Record<string, string>,
-    body: {
-      user?: IUser
-      email?: string;
-      password?: string;
-      message?: string;
-      socketId?: string;
-    };
+  export interface Request {
+    signedCookies: Record<string, string>;
   }
 
   export interface Response {
@@ -20,4 +19,16 @@ declare module 'express' {
       sessionUser: ISessionUser;
     };
   }
-}
+}
+
+
+// **** Generics for Request Object **** //
+
+export interface IReq<T> extends e.Request {
+  body: T;
+}
+
+export interface IReqQuery<T extends Query, U = void> extends e.Request {
+  query: T;
+  body?: U;
+}

package/lib/socket-io/src/util/jwt-util.ts

@@ -14,11 +14,6 @@ const secret = (process.env.JWT_SECRET || randomString.generate(100));
 const options = {expiresIn: process.env.COOKIE_EXP};
 
 
-// **** Types ****  //
-
-type TDecoded = string | JwtPayload | undefined;
-
-
 // **** Functions **** //
 
 /**
@@ -27,7 +22,7 @@ type TDecoded = string | JwtPayload | undefined;
 function sign(data: JwtPayload): Promise<string> {
   return new Promise((resolve, reject) => {
     jsonwebtoken.sign(data, secret, options, (err, token) => {
-      err ? reject(err) : resolve(token || '');
+      return err ? reject(err) : resolve(token || '');
     });
   });
 }
@@ -35,10 +30,10 @@ function sign(data: JwtPayload): Promise<string> {
 /**
  * Decrypt JWT and extract client data.
  */
-function decode(jwt: string): Promise<TDecoded> {
+function decode<T>(jwt: string): Promise<T> {
   return new Promise((res, rej) => {
     jsonwebtoken.verify(jwt, secret, (err, decoded) => {
-      return err ? rej(errors.validation) : res(decoded);
+      return err ? rej(errors.validation) : res(decoded as T);
     });
   });
 }

package/package.json

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