express-generator-typescript 2.0.0 → 2.0.3

package/README.md

@@ -13,7 +13,6 @@ Creates a new express application similar to the _express-generator_ module. Exc
 application is configured to use TypeScript instead of plain JavaScript. 
 
 
-
 ## Why express-generator-typescript?
 
 NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of
@@ -97,7 +96,7 @@ In previous version of __express-generator-typescript__ you could disregard auth
 command line options. But maintaining two separate project folders which contained and didn't contain 
 authentication started to get messy.
 
-- Remove following modules from `package.json`:
+- Remove the following modules from `package.json`:
   - `jsonwebtoken`
   - `@types/jsonwebtoken`
   - `bcrypt`
@@ -157,7 +156,6 @@ To be able to debug in VSCODE on windows I also had to install the `node-gyp` mo
 Happy web deving :)
 
 
-
 ## License
 
 [MIT](LICENSE)

package/lib/express-generator-typescript.js

@@ -13,14 +13,27 @@ const fs = require('fs');
 
 // **** Variables **** //
 
+// Misc
 const prjFolder = './project-files';
 
+// ncp options
 const ncpOpts = {
   filter: (fileName) => {
     return !(fileName === 'package-lock.json' || fileName === 'node_modules');
   },
 };
 
+// Project-folder dependencies
+const dependencies = 'express dotenv http-status-codes morgan cookie-parser jet-logger ' +
+  'module-alias command-line-args express-async-errors helmet jsonfile bcrypt jsonwebtoken';
+
+// Project-folder development dependencies
+const devDependencies = 'ts-node typescript nodemon find jasmine supertest ' +
+  '@types/node @types/express @types/jasmine @types/find @types/morgan @types/cookie-parser ' +
+  '@types/supertest fs-extra tsconfig-paths @types/jsonfile @types/command-line-args ' +
+  '@typescript-eslint/eslint-plugin @typescript-eslint/parser eslint @types/fs-extra ' +
+  '@types/bcrypt @types/jsonwebtoken eslint-plugin-node';
+
 
 // **** Functions **** //
 
@@ -32,8 +45,7 @@ async function expressGenTs(destination, useYarn) {
     await copyProjectFiles(destination);
     updatePackageJson(destination);
     await renameGitigoreFile(destination);
-    const depStrings = getDepStrings();
-    downloadNodeModules(destination, depStrings, useYarn);
+    downloadNodeModules(destination, useYarn);
   } catch (err) {
     console.error(err);
   }
@@ -75,36 +87,19 @@ function renameGitigoreFile(destination) {
   });
 }
 
-/**
- * Setup dependency strings. This way gets you the latest version of everything.
- */
-function getDepStrings() {
-  let dependencies = 'express dotenv http-status-codes morgan cookie-parser jet-logger ' +
-    'module-alias command-line-args express-async-errors helmet jsonfile bcrypt ' + 
-    'jsonwebtoken';
-  let devDependencies = 'ts-node typescript nodemon find jasmine supertest ' +
-    '@types/node @types/express @types/jasmine @types/find @types/morgan ' +
-    '@types/cookie-parser @types/supertest fs-extra tsconfig-paths @types/jsonfile ' +
-    '@types/command-line-args @typescript-eslint/eslint-plugin @typescript-eslint/parser ' +
-    'eslint @types/fs-extra @types/bcrypt @types/jsonwebtoken ' + 
-    'eslint-plugin-node';
-  // Return
-  return { dependencies, devDependencies };
-}
-
 /**
  * Download the dependencies.
  */
-function downloadNodeModules(destination, depStrings, useYarn) {
+function downloadNodeModules(destination, useYarn) {
   const options = {cwd: destination};
   let downloadLibCmd;
   let downloadDepCmd;
   if (useYarn) {
-    downloadLibCmd = 'yarn add ' + depStrings.dependencies;
-    downloadDepCmd = 'yarn add ' + depStrings.devDependencies + ' -D';
+    downloadLibCmd = 'yarn add ' + dependencies;
+    downloadDepCmd = 'yarn add ' + devDependencies + ' -D';
   } else {
-    downloadLibCmd = 'npm i -s ' + depStrings.dependencies;
-    downloadDepCmd = 'npm i -D ' + depStrings.devDependencies;
+    downloadLibCmd = 'npm i -s ' + dependencies;
+    downloadDepCmd = 'npm i -D ' + devDependencies;
   }
   childProcess.execSync(downloadLibCmd, options);
   childProcess.execSync(downloadDepCmd, options);

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

@@ -22,6 +22,7 @@
     "no-console": 1,
     "no-extra-boolean-cast": 0,
     "semi": 1,
+    "indent": ["warn", 2],
     "@typescript-eslint/no-misused-promises": 0,
     "@typescript-eslint/no-floating-promises": 0,
     "node/no-process-env": 1,

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

@@ -1,5 +1,5 @@
 import bcrypt from 'bcrypt';
-import { SuperTest, Test } from 'supertest';
+import { SuperTest, Test, Response } from 'supertest';
 
 import User, { UserRoles } from '@models/user-model';
 import userRepo from '@repos/user-repo';
@@ -19,9 +19,6 @@ const creds = {
 
 /**
  * Login a user.
- * 
- * @param beforeAgent 
- * @param done 
  */
 function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
   // Setup dummy data
@@ -34,17 +31,18 @@ function login(beforeAgent: SuperTest<Test>, done: (arg: string) => void) {
     .post('/api/auth/login')
     .type('form')
     .send(creds)
-    .end((err: Error, res: any) => {
+    .end((err: Error, res: Response) => {
       if (err) {
         throw err;
       }
-      done(res.headers['set-cookie']);
+      const cookie = res.headers['set-cookie'][0];
+      return done(cookie);
     });
-};
+}
 
 
 // **** Export default **** //
 
 export default {
-    login,
+  login,
 } as const;

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

@@ -90,7 +90,7 @@ describe('user-router', () => {
 
     const callApi = () => 
       agent.get(getUsersPath)
-      .set('Cookie', jwtCookie);
+        .set('Cookie', jwtCookie);
 
     // Get all users
     it(msgs.getUsersSuccess, (done) => {

package/lib/project-files/spec/types/supertest/index.d.ts

@@ -5,10 +5,10 @@ import 'supertest';
 declare module 'supertest' {
 
   export interface Response  {
-    headers: Record<string, string | string[]>;
+    headers: Record<string, string[]>;
     body: {
       error: string;
-      users: IUser[]
+      users: IUser[];
     };
   }
 }

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

@@ -79,10 +79,10 @@ async function _delete(id: number): Promise<void> {
 // **** Export default **** //
 
 export default {
-    getOne,
-    persists,
-    getAll,
-    add,
-    update,
-    delete: _delete,
+  getOne,
+  persists,
+  getAll,
+  add,
+  update,
+  delete: _delete,
 } as const;

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

@@ -4,7 +4,7 @@ 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';
+import { IReq } from '@shared/types';
 
 
 // **** Types **** //
@@ -17,9 +17,10 @@ interface ILoginReq {
 
 // **** Variables **** //
 
-// Misc
-const router = Router(),
-  { OK } = StatusCodes;
+const router = Router();
+
+// Status codes
+const { OK } = StatusCodes;
 
 // Paths
 export const p = {

package/lib/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 **** //
@@ -38,7 +38,7 @@ export async function adminMw(req: Request, res: Response, next: NextFunction) {
     }
     // Make sure user role is an admin
     const clientData = await jwtUtil.decode<ISessionUser>(jwt);
-    if (clientData.role === UserRoles.Admin) {
+    if (typeof clientData === 'object' && clientData.role === UserRoles.Admin) {
       res.locals.sessionUser = clientData;
       next();
     } else {

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

@@ -4,7 +4,7 @@ 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';
+import { IReq } from '@shared/types';
 
 
 // **** Variables **** //

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

@@ -8,7 +8,7 @@ import { UnauthorizedError } from '@shared/errors';
 // **** Functions **** //
 
 /**
- * Login()
+ * Login a user.
  */
 async function login(email: string, password: string): Promise<string> {
   // Fetch user

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

@@ -0,0 +1,14 @@
+import * as e from 'express';
+import { Query } from 'express-serve-static-core';
+
+
+// **** 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/project-files/src/types/express/index.d.ts

@@ -1,6 +1,4 @@
 import 'express';
-import * as e from 'express';
-import { Query } from 'express-serve-static-core';
 
 import { ISessionUser } from '@routes/middleware';
 
@@ -20,15 +18,3 @@ 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/project-files/src/util/jwt-util.ts

@@ -6,7 +6,7 @@ import envVars from '../shared/env-vars';
 
 // Errors
 const errors = {
-    validation: 'JSON-web-token validation failed.',
+  validation: 'JSON-web-token validation failed.',
 } as const;
 
 // Options
@@ -20,10 +20,10 @@ const options = {
 /**
  * Encrypt data and return jwt.
  */
-function sign(data: JwtPayload): Promise<string> {
-  return new Promise((resolve, reject) => {
+function sign(data: string | object | Buffer): Promise<string> {
+  return new Promise((res, rej) => {
     jsonwebtoken.sign(data, envVars.jwt.secret, options, (err, token) => {
-      return err ? reject(err) : resolve(token || '');
+      return err ? rej(err) : res(token || '');
     });
   });
 }
@@ -31,7 +31,7 @@ function sign(data: JwtPayload): Promise<string> {
 /**
  * Decrypt JWT and extract client data.
  */
-function decode<T>(jwt: string): Promise<T> {
+async function decode<T extends JwtPayload>(jwt: string): Promise<string | undefined | T> {
   return new Promise((res, rej) => {
     jsonwebtoken.verify(jwt, envVars.jwt.secret, (err, decoded) => {
       return err ? rej(errors.validation) : res(decoded as T);

package/package.json

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