express-generator-typescript 1.9.1 → 1.9.4

package/lib/auth-proj/.eslintrc.json

@@ -21,15 +21,6 @@
     "no-console": 1,
     "no-extra-boolean-cast": 0,
     "semi": 1,
-    "@typescript-eslint/restrict-plus-operands": 0,
-    "@typescript-eslint/explicit-module-boundary-types": 0,
-    "@typescript-eslint/no-explicit-any": 0,
-    "@typescript-eslint/no-floating-promises": 0,
-    "@typescript-eslint/no-unsafe-member-access": 0,
-    "@typescript-eslint/no-unsafe-assignment": 0,
-    "@typescript-eslint/no-misused-promises": 0,
-    "@typescript-eslint/no-unsafe-argument": 0,
-    "@typescript-eslint/no-unsafe-return": 0,
-    "@typescript-eslint/no-unsafe-call": 0
+    "@typescript-eslint/no-misused-promises": 0
   }
 }

package/lib/auth-proj/src/index.ts

@@ -10,5 +10,5 @@ const serverStartMsg = 'Express server started on port: ';
 
 // Start server
 server.listen(envVars.port, () => {
-  logger.info(serverStartMsg + envVars.port);
+  logger.info(serverStartMsg + envVars.port.toString());
 });

package/lib/auth-proj/src/pre-start/index.ts

@@ -20,7 +20,7 @@ const options = commandLineArgs([
 
 // Set the env file
 const result2 = dotenv.config({
-  path: path.join(__dirname, `env/${options.env}.env`),
+  path: path.join(__dirname, `env/${String(options.env)}.env`),
 });
 
 if (result2.error) {

package/lib/auth-proj/src/repos/mock-orm.ts

@@ -1,24 +1,34 @@
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+
 import jsonfile from 'jsonfile';
+import { IUser } from '@models/user-model';
 
 
-// **** Vars/Constants **** //
+// **** Variables **** //
 
 const dbFilePath = 'src/repos/database.json';
 
 
+// **** Types **** //
+
+interface IDb {
+  users: IUser[];
+}
+
+
 // **** Functions **** //
 
 /**
  * Fetch the json from the file.
  */
-function openDb(): Promise<Record<string, any>> {
+function openDb(): Promise<IDb> {
   return jsonfile.readFile(dbFilePath);
 }
 
 /**
  * Update the file.
  */
-function saveDb(db: Record<string, any>): Promise<void> {
+function saveDb(db: IDb): Promise<void> {
   return jsonfile.writeFile(dbFilePath, db);
 }
 

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

@@ -27,7 +27,7 @@ export const p = {
 router.post(p.login, async (req: Request, res: Response) => {
   // Check email and password present
   const { email, password } = req.body;
-  if (!(email && password)) {
+  if (!email || !password) {
     throw new ParamMissingError();
   }
   // Get jwt

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

@@ -1,7 +1,8 @@
 import StatusCodes from 'http-status-codes';
 import { Request, Response, NextFunction } from 'express';
+import { JwtPayload } from 'jsonwebtoken';
 
-import { UserRoles } from '@models/user-model';
+import { IUser, UserRoles } from '@models/user-model';
 import envVars from 'src/shared/env-vars';
 import jwtUtil from '@util/jwt-util';
 
@@ -12,14 +13,25 @@ const { UNAUTHORIZED } = StatusCodes;
 const jwtNotPresentErr = 'JWT not present in signed cookie.';
 
 
+// **** Types **** //
+
+export interface ISessionUser extends JwtPayload {
+  id: number;
+  email: string;
+  name: string;
+  role: IUser['role'];
+}
+
+
 // **** Functions **** //
 
 /**
  * Middleware to verify if user is an admin.
  */
 export async function adminMw(req: Request, res: Response, next: NextFunction) {
+  // Try
   try {
-    // Get json-web-token
+    // Extract the token
     const jwt = req.signedCookies[envVars.cookieProps.key];
     if (!jwt) {
       throw Error(jwtNotPresentErr);
@@ -27,14 +39,20 @@ export async function adminMw(req: Request, res: Response, next: NextFunction) {
     // 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;
+      res.locals.sessionUser = clientData as ISessionUser;
       next();
     } else {
       throw Error(jwtNotPresentErr);
     }
-  } catch (err) {
-    return res.status(UNAUTHORIZED).json({
-      error: err.message,
-    });
+  // Catch
+  } catch (err: unknown) {
+    let error;
+    if (typeof err === 'string') {
+      error = err;
+    } else if (err instanceof Error) {
+      error = err.message;
+    }
+    return res.status(UNAUTHORIZED).json({ error });
   }
-};
+}
+

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

@@ -27,7 +27,7 @@ export const p = {
  */
 router.get(p.get, async (_: Request, res: Response) => {
   const users = await userService.getAll();
-  return res.status(OK).json({users});
+  return res.status(OK).json({ users });
 });
 
 /**

package/lib/auth-proj/src/server.ts

@@ -3,7 +3,7 @@ import morgan from 'morgan';
 import path from 'path';
 import helmet from 'helmet';
 import StatusCodes from 'http-status-codes';
-import express, { NextFunction, Request, Response } from 'express';
+import express, { Request, Response, NextFunction } from 'express';
 
 import 'express-async-errors';
 
@@ -41,7 +41,8 @@ if (envVars.nodeEnv === 'production') {
 app.use('/api', BaseRouter);
 
 // Error handling
-app.use((err: Error | CustomError, _: Request, res: Response, __: NextFunction) => {
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+app.use((err: Error | CustomError, req: Request, res: Response, _: NextFunction) => {
   logger.err(err, true);
   const status = (err instanceof CustomError ? err.HttpStatus : StatusCodes.BAD_REQUEST);
   return res.status(status).json({

package/lib/auth-proj/src/shared/functions.ts

@@ -8,11 +8,11 @@ export function pErr(err?: Error): void {
   if (!!err) {
     logger.err(err);
   }
-};
+}
 
 /**
  * Get a random number between 1 and 1,000,000,000,000
  */
 export function getRandomInt(): number {
   return Math.floor(Math.random() * 1_000_000_000_000);
-};
+}

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

@@ -0,0 +1,23 @@
+import { IUser } from '@models/user-model';
+import { ISessionUser } from '@routes/middleware';
+
+
+declare module 'express' {
+
+  export interface Request  {
+    signedCookies: Record<string, string>,
+    body: {
+      user?: IUser
+      email?: string;
+      password?: string;
+      message?: string;
+      socketId?: string;
+    };
+  }
+
+  export interface Response {
+    locals: {
+      sessionUser: ISessionUser;
+    };
+  }
+}

package/lib/project-files/.eslintrc.json

@@ -21,15 +21,6 @@
     "no-console": 1,
     "no-extra-boolean-cast": 0,
     "semi": 1,
-    "@typescript-eslint/restrict-plus-operands": 0,
-    "@typescript-eslint/explicit-module-boundary-types": 0,
-    "@typescript-eslint/no-explicit-any": 0,
-    "@typescript-eslint/no-floating-promises": 0,
-    "@typescript-eslint/no-unsafe-member-access": 0,
-    "@typescript-eslint/no-unsafe-assignment": 0,
-    "@typescript-eslint/no-misused-promises": 0,
-    "@typescript-eslint/no-unsafe-argument": 0,
-    "@typescript-eslint/no-unsafe-return": 0,
-    "@typescript-eslint/no-unsafe-call": 0
+    "@typescript-eslint/no-misused-promises": 0
   }
 }

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

@@ -10,5 +10,5 @@ const serverStartMsg = 'Express server started on port: ';
 
 // Start server
 server.listen(envVars.port, () => {
-  logger.info(serverStartMsg + envVars.port);
+  logger.info(serverStartMsg + envVars.port.toString());
 });

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

@@ -20,7 +20,7 @@ const options = commandLineArgs([
 
 // Set the env file
 const result2 = dotenv.config({
-  path: path.join(__dirname, `env/${options.env}.env`),
+  path: path.join(__dirname, `env/${String(options.env)}.env`),
 });
 
 if (result2.error) {

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

@@ -9,8 +9,7 @@ displayUsers();
  * Call api
  */
 function displayUsers() {
-  Http
-    .get('/api/users/all')
+  httpGet('/api/users/all')
     .then(resp => resp.json())
     .then((resp) => {
       var allUsers = resp.users;

package/lib/project-files/src/repos/mock-orm.ts

@@ -1,4 +1,7 @@
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+
 import jsonfile from 'jsonfile';
+import { IUser } from '@models/user-model';
 
 
 // **** Variables **** //
@@ -6,19 +9,26 @@ import jsonfile from 'jsonfile';
 const dbFilePath = 'src/repos/database.json';
 
 
+// **** Types **** //
+
+interface IDb {
+  users: IUser[];
+}
+
+
 // **** Functions **** //
 
 /**
  * Fetch the json from the file.
  */
-function openDb(): Promise<Record<string, any>> {
+function openDb(): Promise<IDb> {
   return jsonfile.readFile(dbFilePath);
 }
 
 /**
  * Update the file.
  */
-function saveDb(db: Record<string, any>): Promise<void> {
+function saveDb(db: IDb): Promise<void> {
   return jsonfile.writeFile(dbFilePath, db);
 }
 

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

@@ -4,7 +4,7 @@ import path from 'path';
 import helmet from 'helmet';
 import logger from 'jet-logger';
 
-import express, { NextFunction, Request, Response } from 'express';
+import express, { Request, Response, NextFunction } from 'express';
 import StatusCodes from 'http-status-codes';
 import 'express-async-errors';
 
@@ -42,7 +42,8 @@ if (envVars.nodeEnv === 'production') {
 app.use('/api', apiRouter);
 
 // Error handling
-app.use((err: Error | CustomError, _: Request, res: Response, __: NextFunction) => {
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+app.use((err: Error | CustomError, req: Request, res: Response, _: NextFunction) => {
   logger.err(err, true);
   const status = (err instanceof CustomError ? err.HttpStatus : StatusCodes.BAD_REQUEST);
   return res.status(status).json({

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

@@ -8,11 +8,11 @@ export function pErr(err?: Error): void {
   if (!!err) {
     logger.err(err);
   }
-};
+}
 
 /**
  * Get a random number between 1 and 1,000,000,000,000
  */
 export function getRandomInt(): number {
   return Math.floor(Math.random() * 1_000_000_000_000);
-};
+}

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

@@ -0,0 +1,12 @@
+import { IUser } from "@models/user-model";
+
+
+declare module 'express' {
+  export interface Request  {
+    body: {
+      user?: IUser
+      email?: string;
+    };
+  }
+}
+

package/lib/socket-io/.eslintrc.json

@@ -21,15 +21,6 @@
     "no-console": 1,
     "no-extra-boolean-cast": 0,
     "semi": 1,
-    "@typescript-eslint/restrict-plus-operands": 0,
-    "@typescript-eslint/explicit-module-boundary-types": 0,
-    "@typescript-eslint/no-explicit-any": 0,
-    "@typescript-eslint/no-floating-promises": 0,
-    "@typescript-eslint/no-unsafe-member-access": 0,
-    "@typescript-eslint/no-unsafe-assignment": 0,
-    "@typescript-eslint/no-misused-promises": 0,
-    "@typescript-eslint/no-unsafe-argument": 0,
-    "@typescript-eslint/no-unsafe-return": 0,
-    "@typescript-eslint/no-unsafe-call": 0
+    "@typescript-eslint/no-misused-promises": 0
   }
 }

package/lib/socket-io/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "chat-app",
+  "name": "socket-io",
   "version": "0.0.0",
   "scripts": {
     "build": "npx ts-node build.ts",

package/lib/socket-io/src/index.ts

@@ -10,5 +10,5 @@ const serverStartMsg = 'Express server started on port: ';
 
 // Start server
 server.listen(envVars.port, () => {
-  logger.info(serverStartMsg + envVars.port);
+  logger.info(serverStartMsg + envVars.port.toString());
 });

package/lib/socket-io/src/pre-start/index.ts

@@ -20,7 +20,7 @@ const options = commandLineArgs([
 
 // Set the env file
 const result2 = dotenv.config({
-  path: path.join(__dirname, `env/${options.env}.env`),
+  path: path.join(__dirname, `env/${String(options.env)}.env`),
 });
 
 if (result2.error) {

package/lib/socket-io/src/repos/mock-orm.ts

@@ -1,4 +1,7 @@
+/* eslint-disable @typescript-eslint/no-unsafe-return */
+
 import jsonfile from 'jsonfile';
+import { IUser } from '@models/user-model';
 
 
 // **** Variables **** //
@@ -6,19 +9,26 @@ import jsonfile from 'jsonfile';
 const dbFilePath = 'src/repos/database.json';
 
 
+// **** Types **** //
+
+interface IDb {
+  users: IUser[];
+}
+
+
 // **** Functions **** //
 
 /**
  * Fetch the json from the file.
  */
-function openDb(): Promise<Record<string, any>> {
+function openDb(): Promise<IDb> {
   return jsonfile.readFile(dbFilePath);
 }
 
 /**
  * Update the file.
  */
-function saveDb(db: Record<string, any>): Promise<void> {
+function saveDb(db: IDb): Promise<void> {
   return jsonfile.writeFile(dbFilePath, db);
 }
 
@@ -26,6 +36,6 @@ function saveDb(db: Record<string, any>): Promise<void> {
 // **** Export default **** //
 
 export default {
-  openDb,
-  saveDb,
-} as const;
+    openDb,
+    saveDb,
+} as const;

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

@@ -11,7 +11,7 @@ const apiRouter = Router();
 // Add api routes
 apiRouter.use('/auth', authRouter);
 apiRouter.use('/users', authMw, userRouter);
-apiRouter.use('/chat', authMw, chatRouter)
+apiRouter.use('/chat', authMw, chatRouter);
 
 
 // **** Export default **** //

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

@@ -2,7 +2,6 @@ import SocketIO from 'socket.io';
 import StatusCodes from 'http-status-codes';
 import { Router, Request, Response } from 'express';
 
-import chatService from '@services/chat-service';
 import { ParamMissingError, RoomNotFoundError } from '@shared/errors';
 
 
@@ -18,26 +17,27 @@ export const p = {
   emit: '/emit-message',
 } as const;
 
+export const socketRoomName = 'jet-logger-chat-room';
+
 
 // **** Routes **** //
 
 /**
  * Connect to socket room.
  */
-router.get(p.connect, (req: Request, res: Response) => {
+router.get(p.connect, async (req: Request, res: Response) => {
   const { socketId } = req.params;
   // Check params
   if (!socketId) {
     throw new ParamMissingError();
   }
-  // Get room
-  const io: SocketIO.Server = req.app.get('socketio');
-  const socket = io.sockets.sockets.get(socketId);
-  if (!socket) {
-    throw new RoomNotFoundError();
-  }
+  // Get socket
+  const socket = getSocket(req, socketId);
   // Connect
-  chatService.connectSocketToRm(socket);
+  await Promise.all([
+    socket.leave(socketRoomName),
+    socket.join(socketRoomName),
+  ]);
   // Return
   return res.status(OK).end();
 });
@@ -52,14 +52,15 @@ router.post(p.emit, (req: Request, res: Response) => {
   if (!socketId || !message) {
     throw new ParamMissingError();
   }
-  // Get room
-  const io: SocketIO.Server = req.app.get('socketio');
-  const socket = io.sockets.sockets.get(socketId);
-  if (!socket) {
-    throw new RoomNotFoundError();
-  }
+  // Get socket
+  const socket = getSocket(req, socketId);
   // Connect
-  chatService.emitMessage(socket, message, sessionUser.name);
+  const room = socket.to(socketRoomName);
+  room.emit('emit-msg', {
+    timestamp: Date.now(),
+    content: message,
+    senderName: sessionUser.name,
+  });
   // Return
   return res.status(OK).json({
     senderName: sessionUser.name,
@@ -67,6 +68,21 @@ router.post(p.emit, (req: Request, res: Response) => {
 });
 
 
+// **** Helpers **** //
+
+/**
+ * Get the socket from the Express request object.
+ */
+function getSocket(req: Request, socketId: string): SocketIO.Socket {
+  const io = req.app.get('socketio') as SocketIO.Server;
+  const socket = io.sockets.sockets.get(socketId);
+  if (!socket) {
+    throw new RoomNotFoundError();
+  }
+  return socket;
+}
+
+
 // **** Export default **** //
 
 export default router;

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

@@ -1,7 +1,9 @@
 import StatusCodes from 'http-status-codes';
 import { Request, Response, NextFunction } from 'express';
+import { JwtPayload } from 'jsonwebtoken';
 
 import { cookieProps } from '@routes/auth-router';
+import { IUser } from '@models/user-model';
 import jwtUtil from '@util/jwt-util';
 
 
@@ -11,6 +13,16 @@ const { UNAUTHORIZED } = StatusCodes;
 const jwtNotPresentErr = 'JWT not present in signed cookie.';
 
 
+// **** Types **** //
+
+export interface ISessionUser extends JwtPayload {
+  id: number;
+  email: string;
+  name: string;
+  role: IUser['role'];
+}
+
+
 // **** Functions **** //
 
 /**
@@ -25,15 +37,19 @@ export async function authMw(req: Request, res: Response, next: NextFunction) {
     }
     // Make sure user role is an admin
     const clientData = await jwtUtil.decode(jwt);
-    if (!!clientData) {
-      res.locals.sessionUser = clientData;
+    if (!!clientData && typeof clientData !== 'string') {
+      res.locals.sessionUser = clientData as ISessionUser;
       next();
     } else {
       throw Error(jwtNotPresentErr);
     }
   } catch (err) {
-    return res.status(UNAUTHORIZED).json({
-      error: err.message,
-    });
+    let error;
+    if (typeof err === 'string') {
+      error = err;
+    } else if (err instanceof Error) {
+      error = err.message;
+    }
+    return res.status(UNAUTHORIZED).json({ error });
   }
-};
+}

package/lib/socket-io/src/server.ts

@@ -40,7 +40,8 @@ if (envVars.nodeEnv === 'production') {
 app.use('/api', BaseRouter);
 
 // Error handling
-app.use((err: Error | CustomError, _: Request, res: Response, __: NextFunction) => {
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+app.use((err: Error | CustomError, req: Request, res: Response, _: NextFunction) => {
   logger.err(err, true);
   const status = (err instanceof CustomError ? err.HttpStatus : StatusCodes.BAD_REQUEST);
   return res.status(status).json({
@@ -57,7 +58,7 @@ const staticDir = path.join(__dirname, 'public');
 app.use(express.static(staticDir));
 
 // Login page
-app.get('/', (req: Request, res: Response) => {
+app.get('/', (_: Request, res: Response) => {
   return res.sendFile('login.html', {root: viewsDir});
 });
 

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

@@ -0,0 +1,23 @@
+import { IUser } from '@models/user-model';
+import { ISessionUser } from '@routes/middleware';
+
+
+declare module 'express' {
+
+  export interface Request  {
+    signedCookies: Record<string, string>,
+    body: {
+      user?: IUser
+      email?: string;
+      password?: string;
+      message?: string;
+      socketId?: string;
+    };
+  }
+
+  export interface Response {
+    locals: {
+      sessionUser: ISessionUser;
+    };
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "1.9.1",
+  "version": "1.9.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/socket-io/src/services/chat-service.ts

@@ -1,42 +0,0 @@
-import SocketIO from 'socket.io';
-
-
-// **** Variables **** //
-
-const socketRoomName = 'jet-logger-chat-room';
-
-
-// **** Functions **** //
-
-/**
- * Connect to socket room.
- */
-export function connectSocketToRm(socket: SocketIO.Socket): void {
-  socket.leave(socketRoomName);
-  socket.join(socketRoomName);
-}
-
-/**
- * Send a chat message.
- */
-export function emitMessage(
-  socket: SocketIO.Socket,
-  message: string,
-  senderName: string,
-): void {
-  // Send a message to the room
-  const room = socket.to(socketRoomName);
-  room.emit('emit-msg', {
-    timestamp: Date.now(),
-    content: message,
-    senderName,
-  });
-}
-
-
-// **** Export default **** //
-
-export default {
-  connectSocketToRm,
-  emitMessage,
-} as const;