express-generator-typescript 1.10.2 → 2.0.1

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

@@ -1,10 +1,16 @@
 // **** Types **** //
 
-// User schema
+export enum UserRoles {
+  Standard,
+  Admin,
+}
+
 export interface IUser {
   id: number;
   name: string;
   email: string;
+  pwdHash: string;
+  role: UserRoles;
 }
 
 
@@ -13,11 +19,18 @@ export interface IUser {
 /**
  * Get a new User object.
  */
-function _new(name: string, email: string): IUser {
+function _new(
+  name: string,
+  email: string,
+  role?: UserRoles,
+  pwdHash?: string,
+): IUser {
   return {
     id: -1,
     email,
     name,
+    role: (role ?? UserRoles.Standard),
+    pwdHash: (pwdHash ?? ''),
   };
 }
 
@@ -29,6 +42,8 @@ function copy(user: IUser): IUser {
     id: user.id,
     email: user.email,
     name: user.name,
+    role: user.role,
+    pwdHash: user.pwdHash,
   };
 }
 

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

@@ -12,3 +12,12 @@ JET_LOGGER_MODE=CONSOLE
 JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
+
+## Authentication ##
+COOKIE_DOMAIN=localhost
+COOKIE_PATH=/
+SECURE_COOKIE=false
+JWT_SECRET=xxxxxxxxxxxxxx
+COOKIE_SECRET=xxxxxxxxxxxxxx
+# expires in 3 days
+COOKIE_EXP=259200000

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

@@ -12,3 +12,13 @@ JET_LOGGER_MODE=FILE
 JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
+
+## Authentication ##
+# SECURE_COOKIE 'false' here for demo-ing. But ideally should be true.
+COOKIE_DOMAIN=localhost
+COOKIE_PATH=/
+SECURE_COOKIE=false
+JWT_SECRET=xxxxxxxxxxxxxx
+COOKIE_SECRET=xxxxxxxxxxxxxx
+# expires in 3 days
+COOKIE_EXP=259200000

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

@@ -12,3 +12,12 @@ JET_LOGGER_MODE=CONSOLE
 JET_LOGGER_FILEPATH=jet-logger.log
 JET_LOGGER_TIMESTAMP=TRUE
 JET_LOGGER_FORMAT=LINE
+
+## Authentication ##
+COOKIE_DOMAIN=localhost
+COOKIE_PATH=/
+SECURE_COOKIE=false
+JWT_SECRET=xxxxxxxxxxxxxx
+COOKIE_SECRET=xxxxxxxxxxxxxx
+# expires in 3 days
+COOKIE_EXP=259200000

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

@@ -36,6 +36,6 @@ function saveDb(db: IDb): Promise<void> {
 // **** Export default **** //
 
 export default {
-    openDb,
-    saveDb,
+  openDb,
+  saveDb,
 } as const;

package/lib/project-files/src/repos/user-repo.ts

@@ -6,7 +6,7 @@ import orm from './mock-orm';
 // **** Functions **** //
 
 /**
- * Get one user
+ * Get one user.
  */
 async function getOne(email: string): Promise<IUser | null> {
   const db = await orm.openDb();

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

@@ -1,14 +1,17 @@
 import { Router } from 'express';
+import { adminMw } from './middleware';
+import authRouter from './auth-router';
 import userRouter from './user-router';
 
 
-// Export the base-router
-const baseRouter = Router();
+// Init
+const apiRouter = Router();
 
-// Setup routers
-baseRouter.use('/users', userRouter);
+// Add api routes
+apiRouter.use('/auth', authRouter);
+apiRouter.use('/users', adminMw, userRouter);
 
 
-// *** Export default **** //
+// **** Export default **** //
 
-export default baseRouter;
+export default apiRouter;

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

@@ -4,13 +4,23 @@ 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 ILoginReq {
+  email: string;
+  password: string;
+}
 
 
 // **** Variables **** //
 
-// Misc
-const router = Router(),
-  { OK } = StatusCodes;
+const router = Router();
+
+// Status codes
+const { OK } = StatusCodes;
 
 // Paths
 export const p = {
@@ -24,15 +34,13 @@ export const p = {
 /**
  * Login a user.
  */
-router.post(p.login, async (req: Request, res: Response) => {
-  // Check email and password present
+router.post(p.login, async (req: IReq<ILoginReq>, res: Response) => {
   const { email, password } = req.body;
   if (!email || !password) {
     throw new ParamMissingError();
   }
-  // Get jwt
-  const jwt = await authService.login(email, password);
   // Add jwt to cookie
+  const jwt = await authService.login(email, password);
   const { key, options } = envVars.cookieProps;
   res.cookie(key, jwt, options);
   // Return

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

@@ -1,10 +1,10 @@
 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 jwtUtil from '@util/jwt-util';
+import { JwtPayload } from 'jsonwebtoken';
 
 
 // **** Variables **** //
@@ -26,25 +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
   try {
     // Extract the token
-    const jwt = req.signedCookies[envVars.cookieProps.key];
+    const cookieName = envVars.cookieProps.key,
+      jwt = req.signedCookies[cookieName];
     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.role === UserRoles.Admin) {
+      res.locals.sessionUser = clientData;
       next();
     } else {
       throw Error(jwtNotPresentErr);
     }
-  // Catch
   } catch (err: unknown) {
     let error;
     if (typeof err === 'string') {

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

@@ -3,13 +3,15 @@ import { Request, Response, Router } from 'express';
 
 import userService from '@services/user-service';
 import { ParamMissingError } from '@shared/errors';
+import { IUser } from '@models/user-model';
+import { IReq } from 'src/types/express';
 
 
 // **** Variables **** //
 
 // Misc
-const router = Router();
-const { CREATED, OK } = StatusCodes;
+const router = Router(),
+  { CREATED, OK } = StatusCodes;
 
 // Paths
 export const p = {
@@ -23,51 +25,45 @@ export const p = {
 // **** Routes **** //
 
 /**
- * Get all users
+ * Get all users.
  */
 router.get(p.get, async (_: Request, res: Response) => {
-    const users = await userService.getAll();
-    return res.status(OK).json({users});
+  const users = await userService.getAll();
+  return res.status(OK).json({ users });
 });
 
 /**
- * Add one user
+ * 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) {
     throw new ParamMissingError();
   }
-  // Fetch data
   await userService.addOne(user);
   return res.status(CREATED).end();
 });
 
 /**
- * Update one user
+ * 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) {
     throw new ParamMissingError();
   }
-  // Fetch data
   await userService.updateOne(user);
   return res.status(OK).end();
 });
 
 /**
- * Delete one user
+ * Delete one user.
  */
 router.delete(p.delete, async (req: Request, res: Response) => {
   const { id } = req.params;
-  // Check param
   if (!id) {
     throw new ParamMissingError();
   }
-  // Fetch data
   await userService.delete(Number(id));
   return res.status(OK).end();
 });

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

@@ -1,73 +1,82 @@
-import cookieParser from 'cookie-parser';
-import morgan from 'morgan';
-import path from 'path';
-import helmet from 'helmet';
-import logger from 'jet-logger';
-
-import express, { Request, Response, NextFunction } from 'express';
-import StatusCodes from 'http-status-codes';
-import 'express-async-errors';
-
-import apiRouter from '@routes/api';
-import envVars from '@shared/env-vars';
-import { CustomError } from '@shared/errors';
-
-
-// **** Variables **** //
-
-const app = express();
-
-
-// **** Set basic express settings ****# //
-
-// Common middlewares
-app.use(express.json());
-app.use(express.urlencoded({extended: true}));
-app.use(cookieParser());
-
-// Show routes called in console during development
-if (envVars.nodeEnv === 'development') {
-  app.use(morgan('dev'));
-}
-
-// Security (helmet recommended in express docs)
-if (envVars.nodeEnv === 'production') {
-  app.use(helmet());
-}
-
-
-// **** Add API Routes ****# //
-
-// Add api router
-app.use('/api', apiRouter);
-
-// Error handling
-// 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({
-    error: err.message,
-  });
-});
-
-
-// **** Serve front-end content **** //
-
-// Set views dir
-const viewsDir = path.join(__dirname, 'views');
-app.set('views', viewsDir);
-
-// Set static dir
-const staticDir = path.join(__dirname, 'public');
-app.use(express.static(staticDir));
-
-// Serve index.html file
-app.get('*', (_: Request, res: Response) => {
-  res.sendFile('index.html', {root: viewsDir});
-});
-
-
-// **** Export default **** //
-
-export default app;
+import cookieParser from 'cookie-parser';
+import morgan from 'morgan';
+import path from 'path';
+import helmet from 'helmet';
+import StatusCodes from 'http-status-codes';
+import express, { Request, Response, NextFunction } from 'express';
+
+import 'express-async-errors';
+
+import BaseRouter from './routes/api';
+import logger from 'jet-logger';
+import { CustomError } from '@shared/errors';
+import envVars from '@shared/env-vars';
+
+
+// **** Init express **** //
+
+const app = express();
+
+
+// **** Set basic express settings **** //
+
+app.use(express.json());
+app.use(express.urlencoded({extended: true}));
+app.use(cookieParser(envVars.cookieProps.secret));
+
+// Show routes called in console during development
+if (envVars.nodeEnv === 'development') {
+  app.use(morgan('dev'));
+}
+
+// Security
+if (envVars.nodeEnv === 'production') {
+  app.use(helmet());
+}
+
+
+// **** Add API routes **** //
+
+// Add APIs
+app.use('/api', BaseRouter);
+
+// Error handling
+// 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({
+    error: err.message,
+  });
+});
+
+
+// **** Serve front-end content **** //
+
+// Set views directory (html)
+const viewsDir = path.join(__dirname, 'views');
+app.set('views', viewsDir);
+
+// Set static directory (js and css).
+const staticDir = path.join(__dirname, 'public');
+app.use(express.static(staticDir));
+
+// Nav to login pg by default
+app.get('/', (_: Request, res: Response) => {
+  res.sendFile('login.html', {root: viewsDir});
+});
+
+// Redirect to login if not logged in.
+app.get('/users', (req: Request, res: Response) => {
+  const jwt = req.signedCookies[envVars.cookieProps.key];
+  if (!jwt) {
+    res.redirect('/');
+  } else {
+    res.sendFile('users.html', {root: viewsDir});
+  }
+});
+
+
+// **** Export default **** //
+
+export default app;

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

@@ -6,21 +6,21 @@ import { UserNotFoundError } from '@shared/errors';
 // **** Functions **** //
 
 /**
- * Get all users
+ * Get all users.
  */
 function getAll(): Promise<IUser[]> {
   return userRepo.getAll();
 }
 
 /**
- * Add one user
+ * Add one user.
  */
 function addOne(user: IUser): Promise<void> {
   return userRepo.add(user);
 }
 
 /**
- * Update one user
+ * Update one user.
  */
 async function updateOne(user: IUser): Promise<void> {
   const persists = await userRepo.persists(user.id);
@@ -31,7 +31,7 @@ async function updateOne(user: IUser): Promise<void> {
 }
 
 /**
- * Delete a user by their id
+ * Delete a user by their id.
  */
 async function _delete(id: number): Promise<void> {
   const persists = await userRepo.persists(id);
@@ -45,8 +45,8 @@ async function _delete(id: number): Promise<void> {
 // **** Export default **** //
 
 export default {
-    getAll,
-    addOne,
-    updateOne,
-    delete: _delete,
+  getAll,
+  addOne,
+  updateOne,
+  delete: _delete,
 } as const;

package/lib/project-files/src/shared/env-vars.ts

@@ -1,4 +1,22 @@
+/* eslint-disable node/no-process-env */
+
 export default {
   nodeEnv: (process.env.NODE_ENV ?? ''),
   port: (process.env.PORT ?? 0),
+  cookieProps: {
+    key: 'ExpressGeneratorTs',
+    secret: (process.env.COOKIE_SECRET ?? ''),
+    options: {
+      httpOnly: true,
+      signed: true,
+      path: (process.env.COOKIE_PATH ?? ''),
+      maxAge: Number(process.env.COOKIE_EXP ?? 0),
+      domain: (process.env.COOKIE_DOMAIN ?? ''),
+      secure: (process.env.SECURE_COOKIE === 'true'),
+    },
+  },
+  jwt: {
+    secret: (process.env.JWT_SECRET ??  ''),
+    exp: (process.env.COOKIE_EXP ?? ''), // exp at the same time as the cookie
+  },
 } as const;

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

@@ -32,3 +32,14 @@ export class UserNotFoundError extends CustomError {
     super(UserNotFoundError.Msg, UserNotFoundError.HttpStatus);
   }
 }
+
+
+export class UnauthorizedError extends CustomError {
+
+  public static readonly Msg = 'Login failed';
+  public static readonly HttpStatus = HttpStatusCodes.UNAUTHORIZED;
+
+  constructor() {
+    super(UnauthorizedError.Msg, UnauthorizedError.HttpStatus);
+  }
+}

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

@@ -1,12 +1,34 @@
-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  {
-    body: {
-      user?: IUser
-      email?: string;
+
+  export interface Request {
+    signedCookies: Record<string, string>;
+  }
+
+  export interface Response {
+    locals: {
+      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/{auth-proj → project-files}/src/util/jwt-util.ts

@@ -15,11 +15,6 @@ const options = {
 };
 
 
-// **** Types **** //
-
-type TDecoded = string | JwtPayload | undefined;
-
-
 // **** Functions **** //
 
 /**
@@ -28,7 +23,7 @@ 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 || '');
+      return err ? reject(err) : resolve(token || '');
     });
   });
 }
@@ -36,10 +31,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);
+      return err ? rej(errors.validation) : res(decoded as T);
     });
   });
 }

package/lib/project-files/tsconfig.json

@@ -83,6 +83,9 @@
       ],
       "@routes/*": [
         "src/routes/*"
+      ],
+      "@util/*": [
+        "src/util/*"
       ]
     },
     "useUnknownInCatchVariables": false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "1.10.2",
+  "version": "2.0.1",
   "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/auth-proj/.eslintignore

@@ -1 +0,0 @@
-src/public/