express-generator-typescript 1.8.9 → 1.9.2

package/lib/auth-proj/package.json

@@ -5,7 +5,7 @@
     "build": "npx ts-node build.ts",
     "lint": "eslint . --ext .ts",
     "start": "node -r module-alias/register ./dist --env=production",
-    "start:dev": "nodemon",
+    "dev": "nodemon",
     "test": "nodemon --config ./spec/nodemon.json",
     "test:no-reloading": "npx ts-node --files -r tsconfig-paths/register ./spec"
   },
@@ -28,40 +28,6 @@
     "@routes": "dist/routes",
     "@util": "dist/util"
   },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended",
-      "plugin:@typescript-eslint/recommended-requiring-type-checking"
-    ],
-    "parserOptions": {
-      "project": "./tsconfig.json"
-    },
-    "rules": {
-      "max-len": [
-        "error",
-        {
-          "code": 100
-        }
-      ],
-      "no-console": 1,
-      "no-extra-boolean-cast": 0,
-      "@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
-    }
-  },
-  "eslintIgnore": [
-    "src/public/",
-    "build.ts"
-  ],
   "dependencies": {
   },
   "devDependencies": {

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

@@ -1,14 +1,14 @@
 import './pre-start'; // Must be the first import
-import envVars from './shared/env-vars';
 import logger from 'jet-logger';
+
+import envVars from '@shared/env-vars';
 import server from './server';
 
 
 // Constants
-const serverStartMsg = 'Express server started on port: ',
-  port = (envVars.port || 3000);
+const serverStartMsg = 'Express server started on port: ';
 
 // Start server
-server.listen(port, () => {
-  logger.info(serverStartMsg + port);
+server.listen(envVars.port, () => {
+  logger.info(serverStartMsg + envVars.port.toString());
 });

package/lib/auth-proj/src/pre-start/env/development.env

@@ -3,7 +3,7 @@ NODE_ENV=development
 
 
 ## Server ##
-PORT=3000
+PORT=4000
 HOST=localhost
 
 

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

@@ -18,8 +18,9 @@ const jwtNotPresentErr = 'JWT not present in signed cookie.';
  * 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);
@@ -32,9 +33,14 @@ export async function adminMw(req: Request, res: Response, next: NextFunction) {
     } 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

@@ -20,14 +20,14 @@ export const p = {
 } as const;
 
 
-// **** Functions **** //
+// **** Routes **** //
 
 /**
  * Get all users.
  */
 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 } from 'express';
 
 import 'express-async-errors';
 
@@ -41,7 +41,7 @@ if (envVars.nodeEnv === 'production') {
 app.use('/api', BaseRouter);
 
 // Error handling
-app.use((err: Error | CustomError, _: Request, res: Response, __: NextFunction) => {
+app.use((err: Error | CustomError, _: Request, res: Response) => {
   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/env-vars.ts

@@ -1,9 +1,9 @@
 export default {
-  nodeEnv: process.env.NODE_ENV ?? '',
-  port: process.env.PORT ?? 0,
+  nodeEnv: (process.env.NODE_ENV ?? ''),
+  port: (process.env.PORT ?? 0),
   cookieProps: {
     key: 'ExpressGeneratorTs',
-    secret: process.env.COOKIE_SECRET ?? '',
+    secret: (process.env.COOKIE_SECRET ?? ''),
     options: {
       httpOnly: true,
       signed: true,
@@ -14,7 +14,7 @@ export default {
     },
   },
   jwt: {
-    secret: process.env.JWT_SECRET ??  '',
-    exp: process.env.COOKIE_EXP ?? '', // exp at the same time as the cookie
+    secret: (process.env.JWT_SECRET ??  ''),
+    exp: (process.env.COOKIE_EXP ?? ''), // exp at the same time as the cookie
   },
-};
+} as const;

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,22 @@
+import { IUser } from "@models/user-model";
+
+
+declare module 'express' {
+  export interface Request  {
+    signedCookies: Record<string, string>,
+    body: {
+      user?: IUser
+      email?: string;
+      password?: string;
+    };
+  }
+}
+
+// Put this back in the future for middleware stuff
+// declare global {
+//   namespace Express {
+//     export interface Response {
+//         sessionUser: IClientData;
+//     }
+//   }
+// }

package/lib/express-generator-typescript.js

@@ -10,7 +10,6 @@ const childProcess = require('child_process');
 const ncp = require('ncp').ncp;
 
 
-
 /**
  * Entry point
  */
@@ -102,5 +101,6 @@ function downloadNodeModules(destination, depStrings, useYarn) {
 }
 
 
-// Export entry point
+// **** Export entry point **** //
+
 module.exports = expressGenTs;

package/lib/project-files/.eslintignore

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

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

@@ -0,0 +1,35 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking"
+  ],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "max-len": [
+      "error",
+      {
+        "code": 100
+      }
+    ],
+    "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
+  }
+}

package/lib/project-files/package.json

@@ -5,7 +5,7 @@
     "build": "npx ts-node build.ts",
     "lint": "eslint . --ext .ts",
     "start": "node -r module-alias/register ./dist --env=production",
-    "start:dev": "nodemon",
+    "dev": "nodemon",
     "test": "nodemon --config ./spec/nodemon.json",
     "test:no-reloading": "npx ts-node -r tsconfig-paths/register ./spec"
   },
@@ -27,40 +27,6 @@
     "@server": "dist/server",
     "@routes": "dist/routes"
   },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended",
-      "plugin:@typescript-eslint/recommended-requiring-type-checking"
-    ],
-    "parserOptions": {
-      "project": "./tsconfig.json"
-    },
-    "rules": {
-      "max-len": [
-        "error",
-        {
-          "code": 100
-        }
-      ],
-      "no-console": 1,
-      "no-extra-boolean-cast": 0,
-      "@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
-    }
-  },
-  "eslintIgnore": [
-    "src/public/",
-    "build.ts"
-  ],
   "dependencies": {
   },
   "devDependencies": {

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

@@ -1,13 +1,14 @@
 import './pre-start'; // Must be the first import
 import logger from 'jet-logger';
+
+import envVars from '@shared/env-vars';
 import server from './server';
 
 
 // Constants
-const serverStartMsg = 'Express server started on port: ',
-  port = (process.env.PORT || 3000);
+const serverStartMsg = 'Express server started on port: ';
 
 // Start server
-server.listen(port, () => {
-  logger.info(serverStartMsg + port);
+server.listen(envVars.port, () => {
+  logger.info(serverStartMsg + envVars.port);
 });

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

@@ -20,7 +20,7 @@ export const p = {
 } as const;
 
 
-// **** Functions **** //
+// **** Routes **** //
 
 /**
  * Get all users

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

@@ -2,13 +2,14 @@ import cookieParser from 'cookie-parser';
 import morgan from 'morgan';
 import path from 'path';
 import helmet from 'helmet';
+import logger from 'jet-logger';
 
 import express, { NextFunction, Request, Response } from 'express';
 import StatusCodes from 'http-status-codes';
 import 'express-async-errors';
 
-import apiRouter from './routes/api';
-import logger from 'jet-logger';
+import apiRouter from '@routes/api';
+import envVars from '@shared/env-vars';
 import { CustomError } from '@shared/errors';
 
 
@@ -25,12 +26,12 @@ app.use(express.urlencoded({extended: true}));
 app.use(cookieParser());
 
 // Show routes called in console during development
-if (process.env.NODE_ENV === 'development') {
+if (envVars.nodeEnv === 'development') {
   app.use(morgan('dev'));
 }
 
 // Security (helmet recommended in express docs)
-if (process.env.NODE_ENV === 'production') {
+if (envVars.nodeEnv === 'production') {
   app.use(helmet());
 }
 

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

@@ -0,0 +1,4 @@
+export default {
+  nodeEnv: (process.env.NODE_ENV ?? ''),
+  port: (process.env.PORT ?? 0),
+} as const;

package/lib/socket-io/.eslintignore

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

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

@@ -0,0 +1,35 @@
+{
+  "parser": "@typescript-eslint/parser",
+  "plugins": [
+    "@typescript-eslint"
+  ],
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@typescript-eslint/recommended-requiring-type-checking"
+  ],
+  "parserOptions": {
+    "project": "./tsconfig.json"
+  },
+  "rules": {
+    "max-len": [
+      "error",
+      {
+        "code": 100
+      }
+    ],
+    "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
+  }
+}

package/lib/socket-io/package.json

@@ -5,7 +5,7 @@
     "build": "npx ts-node build.ts",
     "lint": "eslint . --ext .ts",
     "start": "node -r module-alias/register ./dist --env=production",
-    "start:dev": "nodemon",
+    "dev": "nodemon",
     "test": "nodemon --config ./spec/nodemon.json",
     "test:no-reloading": "npx ts-node --files -r tsconfig-paths/register ./spec"
   },
@@ -28,82 +28,8 @@
     "@routes": "dist/routes",
     "@util": "dist/util"
   },
-  "eslintConfig": {
-    "parser": "@typescript-eslint/parser",
-    "plugins": [
-      "@typescript-eslint"
-    ],
-    "extends": [
-      "eslint:recommended",
-      "plugin:@typescript-eslint/recommended",
-      "plugin:@typescript-eslint/recommended-requiring-type-checking"
-    ],
-    "parserOptions": {
-      "project": "./tsconfig.json"
-    },
-    "rules": {
-      "max-len": [
-        "error",
-        {
-          "code": 100
-        }
-      ],
-      "no-console": 1,
-      "no-extra-boolean-cast": 0,
-      "@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
-    }
-  },
-  "eslintIgnore": [
-    "src/public/",
-    "build.ts"
-  ],
   "dependencies": {
-    "bcrypt": "^5.0.1",
-    "command-line-args": "^5.2.1",
-    "cookie-parser": "^1.4.6",
-    "dotenv": "^16.0.0",
-    "express": "^4.17.2",
-    "express-async-errors": "^3.1.1",
-    "helmet": "^5.0.2",
-    "http-status-codes": "^2.2.0",
-    "jet-logger": "^1.1.5",
-    "jsonfile": "^6.1.0",
-    "jsonwebtoken": "^8.5.1",
-    "module-alias": "^2.2.2",
-    "morgan": "^1.10.0",
-    "randomstring": "^1.2.2",
-    "socket.io": "^4.4.1"
   },
   "devDependencies": {
-    "@types/bcrypt": "^5.0.0",
-    "@types/command-line-args": "^5.2.0",
-    "@types/cookie-parser": "^1.4.2",
-    "@types/express": "^4.17.13",
-    "@types/find": "^0.2.1",
-    "@types/fs-extra": "^9.0.13",
-    "@types/jasmine": "^3.10.3",
-    "@types/jsonfile": "^6.0.1",
-    "@types/jsonwebtoken": "^8.5.8",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^17.0.15",
-    "@types/randomstring": "^1.1.8",
-    "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.10.2",
-    "@typescript-eslint/parser": "^5.10.2",
-    "eslint": "^8.8.0",
-    "find": "^0.3.0",
-    "fs-extra": "^10.0.0",
-    "jasmine": "^4.0.2",
-    "nodemon": "^2.0.15",
-    "socket.io-client": "^4.4.1",
-    "supertest": "^6.2.2",
-    "ts-node": "^10.4.0",
-    "tsconfig-paths": "^3.12.0",
-    "typescript": "^4.5.5"
   }
 }

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

@@ -1,13 +1,14 @@
 import './pre-start'; // Must be the first import
 import logger from 'jet-logger';
+
 import server from './server';
+import envVars from '@shared/env-vars';
 
 
 // Constants
-const serverStartMsg = 'Express server started on port: ',
-  port = (process.env.PORT || 3000);
+const serverStartMsg = 'Express server started on port: ';
 
 // Start server
-server.listen(port, () => {
-  logger.info(serverStartMsg + port);
+server.listen(envVars.port, () => {
+  logger.info(serverStartMsg + envVars.port);
 });

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

@@ -32,7 +32,7 @@ export const cookieProps = Object.freeze({
 });
 
 
-// **** Functions **** //
+// **** Routes **** //
 
 /**
  * Login a user.

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

@@ -19,7 +19,7 @@ export const p = {
 } as const;
 
 
-// **** Functions **** //
+// **** Routes **** //
 
 /**
  * Connect to socket room.

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

@@ -20,7 +20,7 @@ export const p = {
 } as const;
 
 
-// **** Functions **** //
+// **** Routes **** //
 
 /**
  * Get all users.

package/lib/socket-io/src/shared/env-vars.ts

@@ -1,9 +1,9 @@
 export default {
-  nodeEnv: process.env.NODE_ENV ?? '',
-  port: process.env.PORT ?? 0,
+  nodeEnv: (process.env.NODE_ENV ?? ''),
+  port: (process.env.PORT ?? 0),
   cookieProps: {
     key: 'ExpressGeneratorTs',
-    secret: process.env.COOKIE_SECRET ?? '',
+    secret: (process.env.COOKIE_SECRET ?? ''),
     options: {
       httpOnly: true,
       signed: true,
@@ -14,7 +14,7 @@ export default {
     },
   },
   jwt: {
-    secret: process.env.JWT_SECRET ??  '',
-    exp: process.env.COOKIE_EXP ?? '', // exp at the same time as the cookie
+    secret: (process.env.JWT_SECRET ??  ''),
+    exp: (process.env.COOKIE_EXP ?? ''), // exp at the same time as the cookie
   },
-};
+} as const;

package/package.json

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