express-generator-typescript 2.4.10 → 2.4.12

package/lib/project-files/spec/support/Paths.ts

@@ -4,7 +4,7 @@
 
 import jetPaths from 'jet-paths';
 
-import Paths from '@src/constants/Paths';
+import Paths from '@src/common/Paths';
 
 
 export default jetPaths(Paths);

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

@@ -7,7 +7,7 @@ import app from '@src/server';
 
 import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
 import Paths from 'spec/support/Paths';

package/lib/project-files/src/{other/classes.ts → common/RouteError.ts}

@@ -1,14 +1,10 @@
-/**
- * Miscellaneous shared classes go here.
- */
-
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 
 /**
  * Error with status code and message
  */
-export class RouteError extends Error {
+class RouteError extends Error {
 
   public status: HttpStatusCodes;
 
@@ -17,3 +13,8 @@ export class RouteError extends Error {
     this.status = status;
   }
 }
+
+
+// **** Export default **** //
+
+export default RouteError;

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

@@ -1,7 +1,7 @@
 import './pre-start'; // Must be the first import
 import logger from 'jet-logger';
 
-import EnvVars from '@src/constants/EnvVars';
+import EnvVars from '@src/common/EnvVars';
 import server from './server';
 
 

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

@@ -1,8 +1,8 @@
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 import UserService from '@src/services/UserService';
 import { IUser } from '@src/models/User';
-import { IReq, IRes } from './types/express/misc';
+import { IReq, IRes } from './common/types';
 
 
 // **** Functions **** //

package/lib/project-files/src/routes/common/types.ts

@@ -0,0 +1,33 @@
+/* eslint-disable max-len */
+/**
+ * Shared types for routes.
+ */
+
+import { Response, Request } from 'express';
+
+
+// **** Express Request **** //
+
+type TPathParams = Record<string, string>;
+
+interface QryObj {
+  [key: string]: string | string[] | undefined;
+}
+
+type TQueryParams<U = void> =
+   U extends void 
+    ? QryObj 
+    : U extends QryObj 
+      ? U
+      : never;
+
+
+export interface IReq<T = void, U extends QryObj | void = void> extends Request<TPathParams, void, T, TQueryParams<U>> {
+  body: T;
+}
+
+
+export interface IRes extends Response {
+  locals: Record<string, unknown>;
+}
+

package/lib/project-files/src/routes/{api.ts → index.ts}

@@ -1,7 +1,7 @@
 import { Router } from 'express';
 import jetValidator from 'jet-validator';
 
-import Paths from '../constants/Paths';
+import Paths from '../common/Paths';
 import User from '@src/models/User';
 import UserRoutes from './UserRoutes';
 

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

@@ -11,14 +11,13 @@ import logger from 'jet-logger';
 
 import 'express-async-errors';
 
-import BaseRouter from '@src/routes/api';
-import Paths from '@src/constants/Paths';
+import BaseRouter from '@src/routes';
 
-import EnvVars from '@src/constants/EnvVars';
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
-
-import { NodeEnvs } from '@src/constants/misc';
-import { RouteError } from '@src/other/classes';
+import Paths from '@src/common/Paths';
+import EnvVars from '@src/common/EnvVars';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+import RouteError from '@src/common/RouteError';
+import { NodeEnvs } from '@src/common/misc';
 
 
 // **** Variables **** //
@@ -65,7 +64,7 @@ app.use((
 });
 
 
-// ** Front-End Content ** //
+// **** Front-End Content **** //
 
 // Set views directory (html)
 const viewsDir = path.join(__dirname, 'views');

package/lib/project-files/src/services/UserService.ts

@@ -1,7 +1,8 @@
+import RouteError from '@src/common/RouteError';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+
 import UserRepo from '@src/repos/UserRepo';
 import { IUser } from '@src/models/User';
-import { RouteError } from '@src/other/classes';
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 
 
 // **** Variables **** //

package/lib/project-files-auth/spec/support/Paths.ts

@@ -4,7 +4,7 @@
 
 import jetPaths from 'jet-paths';
 
-import Paths from '@src/constants/Paths';
+import Paths from '@src/common/Paths';
 
 
 export default jetPaths(Paths);

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

@@ -8,8 +8,8 @@ import PwdUtil from '@src/util/PwdUtil';
 import User, { UserRoles } from '@src/models/User';
 import { Errors } from '@src/services/AuthService';
 
-import EnvVars from '@src/constants/EnvVars';
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import EnvVars from '@src/common/EnvVars';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 import Paths from 'spec/support/Paths';
 import apiCb from 'spec/support/apiCb';

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

@@ -7,7 +7,7 @@ import app from '@src/server';
 
 import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
 import Paths from 'spec/support/Paths';
@@ -51,7 +51,7 @@ describe('UserRouter', () => {
 
     // Success
     it('should return a JSON object with all the users and a status code ' + 
-    `of "${HttpStatusCodes.OK}" if the request was successful.`, (done) => {
+    `of "${HttpStatusCodes.OK}" if the request was successful.`, done => {
       // Add spy
       const data = getDummyUsers();
       spyOn(UserRepo, 'getAll').and.resolveTo(data);
@@ -79,7 +79,7 @@ describe('UserRouter', () => {
 
     // Test add user success
     it(`should return a status code of "${HttpStatusCodes.CREATED}" if the ` + 
-    'request was successful.', (done) => {
+    'request was successful.', done => {
       // Spy
       spyOn(UserRepo, 'add').and.resolveTo();
       // Call api
@@ -92,7 +92,7 @@ describe('UserRouter', () => {
     // Missing param
     it(`should return a JSON object with an error message of "${ERROR_MSG}" ` + 
     `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the user ` + 
-    'param was missing.', (done) => {
+    'param was missing.', done => {
       // Call api
       callApi(null, res => {
         expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
@@ -117,7 +117,7 @@ describe('UserRouter', () => {
 
     // Success
     it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
-    'request was successful.', (done) => {
+    'request was successful.', done => {
       // Setup spies
       spyOn(UserRepo, 'update').and.resolveTo();
       spyOn(UserRepo, 'persists').and.resolveTo(true);
@@ -131,7 +131,7 @@ describe('UserRouter', () => {
     // Param missing
     it(`should return a JSON object with an error message of "${ERROR_MSG}" ` +
     `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the user ` + 
-    'param was missing.', (done) => {
+    'param was missing.', done => {
       // Call api
       callApi(null, res => {
         expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);

package/lib/project-files-auth/src/{other/classes.ts → common/RouteError.ts}

@@ -1,14 +1,10 @@
-/**
- * Miscellaneous shared classes go here.
- */
-
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 
 /**
  * Error with status code and message
  */
-export class RouteError extends Error {
+class RouteError extends Error {
 
   public status: HttpStatusCodes;
 
@@ -17,3 +13,8 @@ export class RouteError extends Error {
     this.status = status;
   }
 }
+
+
+// **** Export default **** //
+
+export default RouteError;

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

@@ -1,7 +1,7 @@
 import './pre-start'; // Must be the first import
 import logger from 'jet-logger';
 
-import EnvVars from '@src/constants/EnvVars';
+import EnvVars from '@src/common/EnvVars';
 import server from './server';
 
 

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

@@ -1,8 +1,8 @@
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import SessionUtil from '@src/util/SessionUtil';
 import AuthService from '@src/services/AuthService';
 
-import { IReq, IRes } from './types/express/misc';
+import { IReq, IRes } from './common/types';
 
 
 // **** Types **** //

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

@@ -1,8 +1,8 @@
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 import UserService from '@src/services/UserService';
 import { IUser } from '@src/models/User';
-import { IReq, IRes } from './types/express/misc';
+import { IReq, IRes } from './common/types';
 
 
 // **** Functions **** //

package/lib/project-files-auth/src/routes/common/types.ts

@@ -0,0 +1,64 @@
+// import * as e from 'express';
+// import { Query } from 'express-serve-static-core';
+
+// import { ISessionUser } from '@src/models/User';
+
+
+// // **** Express **** //
+
+// export interface IReq<T = void> extends e.Request {
+//   body: T;
+// }
+
+// export interface IReqQuery<T extends Query, U = void> extends e.Request {
+//   query: T;
+//   body: U;
+// }
+
+// export interface IRes extends e.Response {
+//   locals: {
+//     sessionUser: ISessionUser;
+//   };
+// }
+
+
+/* eslint-disable max-len */
+/**
+ * Shared types for routes.
+ */
+
+import { Response, Request } from 'express';
+import { ISessionUser } from '@src/models/User';
+
+
+// **** Express Request **** //
+
+type TPathParams = Record<string, string>;
+
+interface QryObj {
+  [key: string]: string | string[] | undefined;
+}
+
+type TQueryParams<U = void> =
+   U extends void 
+    ? QryObj 
+    : U extends QryObj 
+      ? U
+      : never;
+
+
+export interface IReq<T = void, U extends QryObj | void = void> extends Request<TPathParams, void, T, TQueryParams<U>> {
+  body: T;
+}
+
+
+// **** Express Response **** //
+
+interface ILocals {
+  sessionUser: ISessionUser;
+}
+
+// I know since its a type I should use 'TRes' instead of 'IRes' but I'm
+// leaving it as this cause it looks better alongside 'IReq'
+export type IRes = Response<unknown, ILocals>;
+

package/lib/project-files-auth/src/routes/{api.ts → index.ts}

@@ -1,9 +1,10 @@
 import { Router } from 'express';
 import jetValidator from 'jet-validator';
 
-import adminMw from './middleware/adminMw';
-import Paths from '../constants/Paths';
+import Paths from '@src/common/Paths';
 import User from '@src/models/User';
+
+import adminMw from './middleware/adminMw';
 import AuthRoutes from './AuthRoutes';
 import UserRoutes from './UserRoutes';
 
@@ -14,7 +15,7 @@ const apiRouter = Router(),
   validate = jetValidator();
 
 
-// **** Setup AuthRouter **** //
+// **** Add AuthRouter **** //
 
 const authRouter = Router();
 

package/lib/project-files-auth/src/routes/middleware/adminMw.ts

@@ -2,33 +2,29 @@
  * Middleware to verify user logged in and is an an admin.
  */
 
-import { Request, Response, NextFunction } from 'express';
+import { NextFunction } from 'express';
 import { JwtPayload } from 'jsonwebtoken';
 
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
-
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import SessionUtil from '@src/util/SessionUtil';
 import { ISessionUser, UserRoles } from '@src/models/User';
 
+import { IReq, IRes } from '../common/types';
+
 
 // **** Variables **** //
 
 const USER_UNAUTHORIZED_ERR = 'User not authorized to perform this action';
 
-
-// **** Types **** //
-
 type TSessionData = ISessionUser & JwtPayload;
 
 
-// **** Functions **** //
-
 /**
  * See note at beginning of file.
  */
 async function adminMw(
-  req: Request,
-  res: Response,
+  req: IReq,
+  res: IRes,
   next: NextFunction,
 ) {
   // Get session data

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

@@ -11,14 +11,14 @@ import logger from 'jet-logger';
 
 import 'express-async-errors';
 
-import BaseRouter from '@src/routes/api';
-import Paths from '@src/constants/Paths';
+import BaseRouter from '@src/routes';
 
-import EnvVars from '@src/constants/EnvVars';
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
+import Paths from '@src/common/Paths';
+import EnvVars from '@src/common/EnvVars';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+import { NodeEnvs } from '@src/common/misc';
 
-import { NodeEnvs } from '@src/constants/misc';
-import { RouteError } from '@src/other/classes';
+import RouteError from '@src/common/RouteError';
 
 
 // **** Variables **** //

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

@@ -3,8 +3,9 @@ import UserRepo from '@src/repos/UserRepo';
 import PwdUtil from '@src/util/PwdUtil';
 import { tick } from '@src/util/misc';
 
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
-import { RouteError } from '@src/other/classes';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+import RouteError from '@src/common/RouteError';
+
 import { IUser } from '@src/models/User';
 
 

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

@@ -1,7 +1,8 @@
+import RouteError from '@src/common/RouteError';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+
 import UserRepo from '@src/repos/UserRepo';
 import { IUser } from '@src/models/User';
-import { RouteError } from '@src/other/classes';
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
 
 
 // **** Variables **** //
@@ -33,7 +34,6 @@ async function updateOne(user: IUser): Promise<void> {
   if (!persists) {
     throw new RouteError(HttpStatusCodes.NOT_FOUND, USER_NOT_FOUND_ERR);
   }
-  // Return user
   return UserRepo.update(user);
 }
 
@@ -45,7 +45,6 @@ async function _delete(id: number): Promise<void> {
   if (!persists) {
     throw new RouteError(HttpStatusCodes.NOT_FOUND, USER_NOT_FOUND_ERR);
   }
-  // Delete user
   return UserRepo.delete(id);
 }
 

package/lib/project-files-auth/src/util/SessionUtil.ts

@@ -1,10 +1,9 @@
 import { Request, Response } from 'express';
-
-import HttpStatusCodes from '@src/constants/HttpStatusCodes';
-import { RouteError } from '@src/other/classes';
 import jsonwebtoken from 'jsonwebtoken';
 
-import EnvVars from '../constants/EnvVars';
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+import RouteError from '@src/common/RouteError';
+import EnvVars from '@src/common/EnvVars';
 
 
 // **** Variables **** //

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.4.10",
+  "version": "2.4.12",
   "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/project-files/src/routes/types/express/index.d.ts

@@ -1,11 +0,0 @@
-import 'express';
-
-
-// **** Declaration Merging **** //
-
-declare module 'express' {
-
-  export interface Request {
-    signedCookies: Record<string, string>;
-  }
-}

package/lib/project-files/src/routes/types/express/misc.ts

@@ -1,12 +0,0 @@
-import * as e from 'express';
-
-
-// **** Express **** //
-
-export interface IReq<T = void> extends e.Request {
-  body: T;
-}
-
-export interface IRes extends e.Response {
-  locals: Record<string, unknown>;
-}

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

@@ -1,14 +0,0 @@
-import * as e from 'express';
-import { Query } from 'express-serve-static-core';
-
-
-// **** Express **** //
-
-export interface IReq<T = void> extends e.Request {
-  body: T;
-}
-
-export interface IReqQuery<T extends Query, U = void> extends e.Request {
-  query: T;
-  body: U;
-}

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

@@ -1,11 +0,0 @@
-import 'express';
-
-
-// **** Declaration Merging **** //
-
-declare module 'express' {
-
-  export interface Request {
-    signedCookies: Record<string, string>;
-  }
-}

package/lib/project-files-auth/src/routes/types/express/misc.ts

@@ -1,16 +0,0 @@
-import * as e from 'express';
-
-import { ISessionUser } from '@src/models/User';
-
-
-// **** Express **** //
-
-export interface IReq<T = void> extends e.Request {
-  body: T;
-}
-
-export interface IRes extends e.Response {
-  locals: {
-    sessionUser?: ISessionUser;
-  };
-}

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

@@ -1,22 +0,0 @@
-import * as e from 'express';
-import { Query } from 'express-serve-static-core';
-
-import { ISessionUser } from '@src/models/User';
-
-
-// **** Express **** //
-
-export interface IReq<T = void> extends e.Request {
-  body: T;
-}
-
-export interface IReqQuery<T extends Query, U = void> extends e.Request {
-  query: T;
-  body: U;
-}
-
-export interface IRes extends e.Response {
-  locals: {
-    sessionUser: ISessionUser;
-  };
-}