express-generator-typescript 2.5.14 → 2.5.16

package/lib/project-files/package.json

@@ -27,7 +27,7 @@
     "jet-logger": "^2.0.1",
     "jet-paths": "^1.1.0",
     "jet-schema": "^1.4.2",
-    "jet-validators": "^1.0.9",
+    "jet-validators": "^1.1.0",
     "jsonfile": "^6.1.0",
     "module-alias": "^2.2.2",
     "morgan": "^1.10.0"

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

@@ -1,5 +1,5 @@
 import jetPaths from 'jet-paths';
-import Paths from '@src/routes/common/Paths';
+import Paths from '@src/common/Paths';
 
 
 export default jetPaths(Paths);

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

@@ -1,7 +1,5 @@
-import { isValidDate } from 'jet-validators';
-import { traverseObject } from 'jet-validators/utils';
-
-import { IReqPropErr } from '@src/routes/common';
+import { Response } from 'supertest';
+import { TParseReqErr } from '@src/routes/common';
 import UserRepo from '@src/repos/UserRepo';
 
 
@@ -9,9 +7,19 @@ import UserRepo from '@src/repos/UserRepo';
                                 Types
 ******************************************************************************/
 
+// Use generics to add properties to 'body'
+export type TRes<T = object> = Omit<Response, 'body'> & {
+  body: T & { error?: string | IErrObj },
+};
+
+interface IErrObj {
+  message: string;
+  [key: string]: unknown;
+}
+
 export interface IValidationErr {
   message: string;
-  parameters: IReqPropErr[];
+  parameters: TParseReqErr[];
 }
 
 
@@ -27,14 +35,3 @@ export async function cleanDatabase(): Promise<void> {
     UserRepo.deleteAllUsers(),
   ]);
 }
-
-/**
- * Put things you need to do to modify the resp body object here.
- */
-export function parseResBody(body: unknown) {
-  return traverseObject((key, val, parentObj) => {
-    if (key === 'created' && isValidDate(val)) {
-      parentObj[key] = new Date(val);
-    }
-  })(body);
-}

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

@@ -1,18 +1,19 @@
 import supertest from 'supertest';
 import insertUrlParams from 'inserturlparams';
-import { parseJson } from 'jet-validators/utils';
+import { parseJson, customDeepCompare } from 'jet-validators/utils';
 
 import app from '@src/server';
 
 import UserRepo from '@src/repos/UserRepo';
-import User from '@src/models/User';
+import User, { IUser } from '@src/models/User';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import { ValidationErr } from '@src/common/route-errors';
 
 import Paths from 'spec/support/Paths';
-import { cleanDatabase, IValidationErr, parseResBody } from 'spec/support';
+import { cleanDatabase, IValidationErr, TRes } from 'spec/support';
+import { isObject } from 'jet-validators';
 
 
 /******************************************************************************
@@ -21,24 +22,34 @@ import { cleanDatabase, IValidationErr, parseResBody } from 'spec/support';
 
 // Dummy users for GET req
 const DB_USERS = [
-  User.new({ id: 1, name: 'Sean Maxwell', email: 'sean.maxwell@gmail.com' }),
-  User.new({ id: 2, name: 'John Smith', email: 'john.smith@gmail.com' }),
-  User.new({ id: 3, name: 'Gordan Freeman', email: 'gordan.freeman@gmail.com' }),
+  User.new({ name: 'Sean Maxwell', email: 'sean.maxwell@gmail.com' }),
+  User.new({ name: 'John Smith', email: 'john.smith@gmail.com' }),
+  User.new({ name: 'Gordan Freeman', email: 'gordan.freeman@gmail.com' }),
 ] as const;
 
+// Don't compare "id" and "created" cause those are set dynamically by the 
+// database
+const compareUserArrays = customDeepCompare({
+  onlyCompareProps: ['name', 'email'],
+});
+
 
 /******************************************************************************
                                  Tests
+  IMPORTANT: Following TypeScript best practices, we test all scenarios that 
+  can be triggered by a user under normal circumstances. Not all theoretically
+  scenarios (i.e. a failed database connection). 
 ******************************************************************************/
 
 describe('UserRouter', () => {
 
   const agent = supertest.agent(app);
+  let dbUsers: IUser[] = [];
 
   // Run before all tests
   beforeEach(async () => {
     await cleanDatabase();
-    await UserRepo.insertMult(DB_USERS);
+    dbUsers = await UserRepo.insertMult(DB_USERS);
   });
 
   // Get all users
@@ -49,10 +60,9 @@ describe('UserRouter', () => {
     `of "${HttpStatusCodes.OK}" if the request was successful.`, done => {
       agent
         .get(Paths.Users.Get)
-        .end((_, res) => {
-          parseResBody(res.body);
+        .end((_, res: TRes<{ users: IUser[]}>) => {
           expect(res.status).toBe(HttpStatusCodes.OK);
-          expect(res.body).toEqual({ users: DB_USERS });
+          expect(compareUserArrays(res.body.users, DB_USERS)).toBeTruthy();
           done();
         });
     });
@@ -81,11 +91,12 @@ describe('UserRouter', () => {
       agent
         .post(Paths.Users.Add)
         .send({ user: null })
-        .end((_, res) => {
+        .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          const errorObj = parseJson<IValidationErr>(res.body.error);
+          const errorObj = parseJson<IValidationErr>(res.body.error),
+            parseErr = errorObj.parameters[0];
           expect(errorObj.message).toBe(ValidationErr.MSG);
-          expect(errorObj.parameters[0].prop).toBe('user');
+          expect(isObject(parseErr) && parseErr.prop === 'user').toBeTruthy();
           done();
         });
     });
@@ -115,11 +126,12 @@ describe('UserRouter', () => {
       agent
         .put(Paths.Users.Update)
         .send({ user: null })
-        .end((_, res) => {
+        .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          const errorObj = parseJson<IValidationErr>(res.body.error);
+          const errorObj = parseJson<IValidationErr>(res.body.error),
+            parseErr = errorObj.parameters[0];
           expect(errorObj.message).toBe(ValidationErr.MSG);
-          expect(errorObj.parameters[0].prop).toBe('user');
+          expect(isObject(parseErr) && parseErr.prop === 'user').toBeTruthy();
           done();
         });
     });
@@ -132,7 +144,7 @@ describe('UserRouter', () => {
       agent
         .put(Paths.Users.Update)
         .send({ user })
-        .end((_, res) => {
+        .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
           expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
           done();
@@ -143,11 +155,14 @@ describe('UserRouter', () => {
   // Delete User
   describe(`"DELETE:${Paths.Users.Delete}"`, () => {
 
+    const getPath = (id: number) => insertUrlParams(Paths.Users.Delete, { id });
+
     // Success
     it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
     'request was successful.', done => {
+      const id = dbUsers[0].id;
       agent
-        .delete(insertUrlParams(Paths.Users.Delete, { id: 3 }))
+        .delete(getPath(id))
         .end((_, res) => {
           expect(res.status).toBe(HttpStatusCodes.OK);
           done();
@@ -159,8 +174,8 @@ describe('UserRouter', () => {
     `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
     `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, done => {
       agent
-        .delete(insertUrlParams(Paths.Users.Delete, { id: -1 }))
-        .end((_, res) => {
+        .delete(getPath(-1))
+        .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
           expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
           done();

package/lib/project-files/src/common/ENV.ts

@@ -5,10 +5,17 @@ import { NodeEnvs } from './constants';
 
 
 /******************************************************************************
-                            Export default
+                                 Setup
 ******************************************************************************/
 
-export default jetEnv({
+const ENV = jetEnv({
   NodeEnv: isEnumVal(NodeEnvs),
   Port: num,
 });
+
+
+/******************************************************************************
+                            Export default
+******************************************************************************/
+
+export default ENV;

package/lib/project-files/src/common/constants.ts

@@ -3,8 +3,9 @@
                               Enums
 ******************************************************************************/
 
+// NOTE: These need to match the names of your ".env" files
 export enum NodeEnvs {
   Dev = 'development',
   Test = 'test',
   Production = 'production'
-}
+}

package/lib/project-files/src/repos/MockOrm.ts

@@ -11,8 +11,8 @@ import { IUser } from '@src/models/User';
 
 const DB_FILE_NAME = (
   ENV.NodeEnv === NodeEnvs.Test 
-  ? 'database.test.json' 
-  : 'database.json'
+    ? 'database.test.json' 
+    : 'database.json'
 );
 
 

package/lib/project-files/src/repos/UserRepo.ts

@@ -1,5 +1,6 @@
 import { IUser } from '@src/models/User';
 import { getRandomInt } from '@src/util/misc';
+
 import orm from './MockOrm';
 
 
@@ -98,14 +99,21 @@ async function deleteAllUsers(): Promise<void> {
  * Insert multiple users. Can't do multiple at once cause using a plain file 
  * for nmow.
  */
-async function insertMult(users: IUser[] | readonly IUser[]): Promise<void> {
-  const db = await orm.openDb();
-  db.users = [ ...db.users, ...users];
-  return orm.saveDb(db);
+async function insertMult(
+  users: IUser[] | readonly IUser[],
+): Promise<IUser[]> {
+  const db = await orm.openDb(),
+    usersF = [ ...users ];
+  for (const user of usersF) {
+    user.id = getRandomInt();
+    user.created = new Date();
+  }
+  db.users = [ ...db.users, ...users ];
+  await orm.saveDb(db);
+  return usersF;
 }
 
 
-
 /******************************************************************************
                                 Export default
 ******************************************************************************/

package/lib/project-files/src/repos/database.test.json

@@ -1 +1 @@
-{"users":[{"id":1,"name":"Bill","created":"2025-02-10T05:36:18.360Z","email":"sean.maxwell@gmail.com"},{"id":2,"name":"John Smith","created":"2025-02-10T05:36:18.360Z","email":"john.smith@gmail.com"},{"id":3,"name":"Gordan Freeman","created":"2025-02-10T05:36:18.360Z","email":"gordan.freeman@gmail.com"}]}
+{"users":[{"id":833335167307,"name":"Bill","created":"2025-02-21T15:41:21.593Z","email":"sean.maxwell@gmail.com"},{"id":721615734671,"name":"John Smith","created":"2025-02-21T15:41:21.593Z","email":"john.smith@gmail.com"},{"id":531901228132,"name":"Gordan Freeman","created":"2025-02-21T15:41:21.593Z","email":"gordan.freeman@gmail.com"},{"id":811228870992,"name":"a","created":"2025-02-21T15:41:21.594Z","email":"a@a.com"}]}

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

@@ -5,7 +5,6 @@ import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import UserService from '@src/services/UserService';
 import User from '@src/models/User';
 
-
 import { parseReq, IReq, IRes } from './common';
 
 

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

@@ -13,11 +13,11 @@ type TRecord = Record<string, unknown>;
 export type IReq = Request<TRecord, void, TRecord, TRecord>;
 export type IRes = Response<unknown, TRecord>;
 
-export interface IReqPropErr {
-  prop: string;
-  value: unknown;
-  moreInfo?: string;
-}
+export type TParseReqErr = {
+  prop: string,
+  value: unknown,
+  moreInfo?: string,
+} | string;
 
 
 /******************************************************************************
@@ -29,34 +29,50 @@ export interface IReqPropErr {
  */
 export function parseReq<U extends TSchema>(schema: U) {
   return (arg: unknown) => {
-    // Don't alter original object
+    // Don't alter original object (shallow copy is good enough)
     if (isObject(arg)) {
       arg = { ...arg };
     }
-    // Error callback
-    const errArr: IReqPropErr[] = [];
-    const errCb = (
-      prop = 'undefined',
-      value?: unknown,
-      caughtErr?: unknown,
-    ) => {
-      const err: IReqPropErr = { prop, value };
-      if (caughtErr !== undefined) {
-        let moreInfo;
-        if (!isString(caughtErr)) {
-          moreInfo = JSON.stringify(caughtErr);
-        } else {
-          moreInfo = caughtErr;
-        }
-        err.moreInfo = moreInfo;
-      }
-      errArr.push(err);
-    };
-    // Return
+    // Setup error callback
+    const errArr: TParseReqErr[] = [],
+      errCb = setupErrorCb(errArr);
+    // Run Tests
     const retVal = parseObject<U>(schema, errCb)(arg);
     if (errArr.length > 0) {
       throw new ValidationErr(errArr);
     }
+    // Return
     return retVal;
   };
 }
+
+/**
+ * Setup the error callback function for when "parseReq" fires and error.
+ */
+function setupErrorCb(errArr: TParseReqErr[]) {
+  return function (
+    prop = 'undefined',
+    value?: unknown,
+    caughtErr?: unknown,
+  ) {
+    // Initialize err
+    let err: TParseReqErr;
+    if (arguments.length === 1) {
+      err = prop;
+    } else {
+      err = { prop, value };
+    }
+    // Check if there's a "caught error"
+    if (isObject(err) && caughtErr !== undefined) {
+      let moreInfo;
+      if (!isString(caughtErr)) {
+        moreInfo = JSON.stringify(caughtErr);
+      } else {
+        moreInfo = caughtErr;
+      }
+      err.moreInfo = moreInfo;
+    }
+    // Add error to array
+    errArr.push(err);
+  };
+}

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

@@ -1,6 +1,6 @@
 import { Router } from 'express';
 
-import Paths from './common/Paths';
+import Paths from '../common/Paths';
 import UserRoutes from './UserRoutes';
 
 

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

@@ -8,7 +8,7 @@ import 'express-async-errors';
 
 import BaseRouter from '@src/routes';
 
-import Paths from '@src/routes/common/Paths';
+import Paths from '@src/common/Paths';
 import ENV from '@src/common/ENV';
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import { RouteError } from '@src/common/route-errors';
@@ -16,25 +16,25 @@ import { NodeEnvs } from '@src/common/constants';
 
 
 /******************************************************************************
-                                Variables
+                                Setup
 ******************************************************************************/
 
 const app = express();
 
 
-// **** Setup
+// **** Middleware **** //
 
 // Basic middleware
 app.use(express.json());
 app.use(express.urlencoded({extended: true}));
 
 // Show routes called in console during development
-if (ENV.NodeEnv === NodeEnvs.Dev.valueOf()) {
+if (ENV.NodeEnv === NodeEnvs.Dev) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (ENV.NodeEnv === NodeEnvs.Production.valueOf()) {
+if (ENV.NodeEnv === NodeEnvs.Production) {
   app.use(helmet());
 }
 
@@ -55,7 +55,7 @@ app.use((err: Error, _: Request, res: Response, next: NextFunction) => {
 });
 
 
-// **** Front-End Content
+// **** FrontEnd Content **** //
 
 // Set views directory (html)
 const viewsDir = path.join(__dirname, 'views');

package/lib/project-files/src/util/misc.ts

@@ -1,3 +1,4 @@
+
 /**
  * Get a random number between 1 and 1,000,000,000,000
  */

package/package.json

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