express-generator-typescript 2.5.14 → 2.5.15

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.0.17",
     "jsonfile": "^6.1.0",
     "module-alias": "^2.2.2",
     "morgan": "^1.10.0"

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

@@ -1,6 +1,3 @@
-import { isValidDate } from 'jet-validators';
-import { traverseObject } from 'jet-validators/utils';
-
 import { IReqPropErr } from '@src/routes/common';
 import UserRepo from '@src/repos/UserRepo';
 
@@ -27,14 +24,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,18 @@
 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 } from 'spec/support';
 
 
 /******************************************************************************
@@ -21,24 +21,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
@@ -50,9 +60,8 @@ describe('UserRouter', () => {
       agent
         .get(Paths.Users.Get)
         .end((_, res) => {
-          parseResBody(res.body);
           expect(res.status).toBe(HttpStatusCodes.OK);
-          expect(res.body).toEqual({ users: DB_USERS });
+          expect(compareUserArrays(res.body.users, DB_USERS)).toBeTruthy();
           done();
         });
     });
@@ -143,11 +152,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,7 +171,7 @@ 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 }))
+        .delete(getPath(-1))
         .end((_, res) => {
           expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
           expect(res.body.error).toBe(USER_NOT_FOUND_ERR);

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":697609403164,"name":"Bill","created":"2025-02-13T19:25:15.288Z","email":"sean.maxwell@gmail.com"},{"id":387041929717,"name":"John Smith","created":"2025-02-13T19:25:15.288Z","email":"john.smith@gmail.com"},{"id":465077000925,"name":"Gordan Freeman","created":"2025-02-13T19:25:15.288Z","email":"gordan.freeman@gmail.com"}]}

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.15",
   "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",