express-generator-typescript 2.5.12 → 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,18 +1,26 @@
-import { isValidDate } from 'jet-validators';
-import { traverseObject } from 'jet-validators/utils';
+import { IReqPropErr } from '@src/routes/common';
+import UserRepo from '@src/repos/UserRepo';
 
 
+/******************************************************************************
+                                Types
+******************************************************************************/
+
+export interface IValidationErr {
+  message: string;
+  parameters: IReqPropErr[];
+}
+
+
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
 /**
- * Send a date object over an API will convert it to a string, so for jasmine
- * tests to pass we need to convert them back to date objects.
+ * Delete all records for unit testing.
  */
-export function convertValidDates(toConvert: string | string[]) {
-  if (!Array.isArray(toConvert)) {
-    toConvert = [toConvert];
-  }
-  return traverseObject((prop, value, parentObj) => {
-    if (toConvert.includes(prop) && isValidDate(value)) {
-      parentObj[prop] = new Date(value);
-    }
-  });
+export async function cleanDatabase(): Promise<void> {
+  await Promise.all([
+    UserRepo.deleteAllUsers(),
+  ]);
 }

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

@@ -1,8 +1,6 @@
-import supertest, { Test } from 'supertest';
-import TestAgent from 'supertest/lib/agent';
+import supertest from 'supertest';
 import insertUrlParams from 'inserturlparams';
-import { parseJson } from 'jet-validators/utils';
-import logger from 'jet-logger';
+import { parseJson, customDeepCompare } from 'jet-validators/utils';
 
 import app from '@src/server';
 
@@ -11,191 +9,174 @@ import User, { IUser } from '@src/models/User';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import { IValidationErrFormat, ValidationErr } from '@src/common/route-errors';
+import { ValidationErr } from '@src/common/route-errors';
 
 import Paths from 'spec/support/Paths';
-import { convertValidDates } from 'spec/support';
-import { TApiCb, TRes } from 'spec/types/misc';
+import { cleanDatabase, IValidationErr } from 'spec/support';
 
 
 /******************************************************************************
-                               Setup
+                               Variables
 ******************************************************************************/
 
 // Dummy users for GET req
-const getDummyUsers = () => [
+const DB_USERS = [
   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;
 
-// Convert "created" prop back to Date object
-const createdKeyToDate = convertValidDates('created');
-
-// Setup wrap-callback function
-const wrapCb = (cb: TApiCb) => (err: Error, res: TRes) => {
-  if (!!err) {
-    logger.err(err);
-  }
-  createdKeyToDate(res.body);
-  return cb(res);
-};
+// 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', () => {
 
-  let agent: TestAgent<Test>;
+  const agent = supertest.agent(app);
+  let dbUsers: IUser[] = [];
 
   // Run before all tests
-  beforeAll(done => {
-    agent = supertest.agent(app);
-    done();
+  beforeEach(async () => {
+    await cleanDatabase();
+    dbUsers = await UserRepo.insertMult(DB_USERS);
   });
 
   // Get all users
   describe(`"GET:${Paths.Users.Get}"`, () => {
 
-    // Setup API
-    const api = (cb: TApiCb) => 
-      agent
-        .get(Paths.Users.Get)
-        .end(wrapCb(cb));
-
     // Success
     it('should return a JSON object with all the users and a status code ' + 
     `of "${HttpStatusCodes.OK}" if the request was successful.`, done => {
-      // Add spy
-      const data = getDummyUsers();
-      spyOn(UserRepo, 'getAll').and.resolveTo(data);
-      // Call API
-      api(res => {
-        expect(res.status).toBe(HttpStatusCodes.OK);
-        expect(res.body).toEqual({ users: data });
-        done();
-      });
+      agent
+        .get(Paths.Users.Get)
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.OK);
+          expect(compareUserArrays(res.body.users, DB_USERS)).toBeTruthy();
+          done();
+        });
     });
   });
 
   // Test add user
   describe(`"POST:${Paths.Users.Add}"`, () => {
 
-    const DUMMY_USER = getDummyUsers()[0];
-
-    // Setup API
-    const callApi = (user: IUser | null, cb: TApiCb) => 
-      agent
-        .post(Paths.Users.Add)
-        .send({ user })
-        .end(wrapCb(cb));
-
     // Test add user success
     it(`should return a status code of "${HttpStatusCodes.CREATED}" if the ` + 
     'request was successful.', done => {
-      // Spy
-      spyOn(UserRepo, 'add').and.resolveTo();
-      // Call api
-      callApi(DUMMY_USER, res => {
-        expect(res.status).toBe(HttpStatusCodes.CREATED);
-        done();
-      });
+      const user = User.new({ name: 'a', email: 'a@a.com' });
+      agent
+        .post(Paths.Users.Add)
+        .send({ user })
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.CREATED);
+          done();
+        });
     });
 
     // Missing param
     it('should return a JSON object with an error message of and a status ' + 
       `code of "${HttpStatusCodes.BAD_REQUEST}" if the user param was ` + 
       'missing.', done => {
-      // Call api
-      callApi(null, res => {
-        expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-        const errorObj = parseJson<IValidationErrFormat>(res.body.error);
-        expect(errorObj.error).toBe(ValidationErr.MSG);
-        expect(errorObj.parameter).toBe('user');
-        done();
-      });
+      agent
+        .post(Paths.Users.Add)
+        .send({ user: null })
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
+          const errorObj = parseJson<IValidationErr>(res.body.error);
+          expect(errorObj.message).toBe(ValidationErr.MSG);
+          expect(errorObj.parameters[0].prop).toBe('user');
+          done();
+        });
     });
   });
 
   // Update users
   describe(`"PUT:${Paths.Users.Update}"`, () => {
 
-    const DUMMY_USER = getDummyUsers()[0];
-
-    // Setup API
-    const callApi = (user: IUser | null, cb: TApiCb) => 
-      agent
-        .put(Paths.Users.Update)
-        .send({ user })
-        .end(wrapCb(cb));
-
     // Success
     it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
     'request was successful.', done => {
-      spyOn(UserRepo, 'update').and.resolveTo();
-      spyOn(UserRepo, 'persists').and.resolveTo(true);
-      callApi(DUMMY_USER, res => {
-        expect(res.status).toBe(HttpStatusCodes.OK);
-        done();
-      });
+      const user = DB_USERS[0];
+      user.name = 'Bill';
+      agent
+        .put(Paths.Users.Update)
+        .send({ user })
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.OK);
+          done();
+        });
     });
 
     // Param missing
     it('should return a JSON object with an error message and a status code ' +
     `of "${HttpStatusCodes.BAD_REQUEST}" if the user param was missing`,
     done => {
-      callApi(null, res => {
-        expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-        const errorObj = parseJson<IValidationErrFormat>(res.body.error);
-        expect(errorObj.error).toBe(ValidationErr.MSG);
-        expect(errorObj.parameter).toBe('user');
-        done();
-      });
+      agent
+        .put(Paths.Users.Update)
+        .send({ user: null })
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
+          const errorObj = parseJson<IValidationErr>(res.body.error);
+          expect(errorObj.message).toBe(ValidationErr.MSG);
+          expect(errorObj.parameters[0].prop).toBe('user');
+          done();
+        });
     });
 
     // User not found
     it('should return a JSON object with the error message of ' + 
     `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
     `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, done => {
-      callApi(DUMMY_USER, res => {
-        expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
-        expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-        done();
-      });
+      const user = User.new({ id: 4, name: 'a', email: 'a@a.com' });
+      agent
+        .put(Paths.Users.Update)
+        .send({ user })
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+          expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
+          done();
+        });
     });
   });
 
   // Delete User
   describe(`"DELETE:${Paths.Users.Delete}"`, () => {
 
-    // Call API
-    const callApi = (id: number, cb: TApiCb) => 
-      agent
-        .delete(insertUrlParams(Paths.Users.Delete, { id }))
-        .end(wrapCb(cb));
+    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 => {
-      spyOn(UserRepo, 'delete').and.resolveTo();
-      spyOn(UserRepo, 'persists').and.resolveTo(true);
-      callApi(5, res => {
-        expect(res.status).toBe(HttpStatusCodes.OK);
-        done();
-      });
+      const id = dbUsers[0].id;
+      agent
+        .delete(getPath(id))
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.OK);
+          done();
+        });
     });
 
     // User not found
     it('should return a JSON object with the error message of ' + 
     `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
     `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, done => {
-      callApi(-1, res => {
-        expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
-        expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-        done();
-      });
+      agent
+        .delete(getPath(-1))
+        .end((_, res) => {
+          expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+          expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
+          done();
+        });
     });
   });
 });

package/lib/project-files/src/common/route-errors.ts

@@ -1,18 +1,6 @@
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 
-/******************************************************************************
-                                Types
-******************************************************************************/
-
-export interface IValidationErrFormat {
-  error: string;
-  parameter: string;
-  value?: unknown;
-  'more-info'?: string;
-}
-
-
 /******************************************************************************
                               Classes
 ******************************************************************************/
@@ -33,17 +21,13 @@ export class RouteError extends Error {
  * Validation in route layer errors.
  */
 export class ValidationErr extends RouteError {
-  public static MSG = 'The following parameter was missing or invalid.';
-
-  public constructor(parameter: string, value?: unknown, moreInfo?: string) {
-    const msgObj: IValidationErrFormat = {
-      error: ValidationErr.MSG,
-      parameter,
-      value,
-    };
-    if (!!moreInfo) {
-      msgObj['more-info'] = moreInfo;
-    }
-    super(HttpStatusCodes.BAD_REQUEST, JSON.stringify(msgObj));
+  public static MSG = 'One or more parameters were missing or invalid.';
+
+  public constructor(errObj: unknown) {
+    const msg = JSON.stringify({
+      message: ValidationErr.MSG,
+      parameters: errObj,
+    });
+    super(HttpStatusCodes.BAD_REQUEST, msg);
   }
 }

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

@@ -1,6 +1,6 @@
 import logger from 'jet-logger';
 
-import Env from '@src/common/Env';
+import ENV from '@src/common/ENV';
 import server from './server';
 
 
@@ -9,6 +9,6 @@ import server from './server';
 ******************************************************************************/
 
 const SERVER_START_MSG = ('Express server started on port: ' + 
-  Env.Port.toString());
+  ENV.Port.toString());
 
-server.listen(Env.Port, () => logger.info(SERVER_START_MSG));
+server.listen(ENV.Port, () => logger.info(SERVER_START_MSG));

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

@@ -1,5 +1,7 @@
 import jsonfile from 'jsonfile';
 
+import ENV from '@src/common/ENV';
+import { NodeEnvs } from '@src/common/constants';
 import { IUser } from '@src/models/User';
 
 
@@ -7,7 +9,11 @@ import { IUser } from '@src/models/User';
                                 Variables
 ******************************************************************************/
 
-const DB_FILE_NAME = 'database.json';
+const DB_FILE_NAME = (
+  ENV.NodeEnv === NodeEnvs.Test 
+  ? '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';
 
 
@@ -83,6 +84,36 @@ async function delete_(id: number): Promise<void> {
 }
 
 
+// **** Unit-Tests Only **** //
+
+/**
+ * Delete every user record.
+ */
+async function deleteAllUsers(): Promise<void> {
+  const db = await orm.openDb();
+  db.users = [];
+  return orm.saveDb(db);
+}
+
+/**
+ * Insert multiple users. Can't do multiple at once cause using a plain file 
+ * for nmow.
+ */
+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
 ******************************************************************************/
@@ -94,4 +125,6 @@ export default {
   add,
   update,
   delete: delete_,
+  deleteAllUsers,
+  insertMult,
 } as const;

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

@@ -0,0 +1 @@
+{"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/routes/common/index.ts

@@ -1,5 +1,5 @@
 import { Response, Request } from 'express';
-import { isObject } from 'jet-validators';
+import { isObject, isString } from 'jet-validators';
 import { parseObject, TSchema } from 'jet-validators/utils';
 
 import { ValidationErr } from '@src/common/route-errors';
@@ -13,6 +13,12 @@ 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;
+}
+
 
 /******************************************************************************
                                 Functions
@@ -22,27 +28,35 @@ export type IRes = Response<unknown, TRecord>;
  * Parse a Request object property and throw a Validation error if it fails.
  */
 export function parseReq<U extends TSchema>(schema: U) {
-  const parseFn = parseObject<U>(schema, _parseReqOnError);
   return (arg: unknown) => {
+    // Don't alter original object
     if (isObject(arg)) {
       arg = { ...arg };
     }
-    return parseFn(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
+    const retVal = parseObject<U>(schema, errCb)(arg);
+    if (errArr.length > 0) {
+      throw new ValidationErr(errArr);
+    }
+    return retVal;
   };
 }
-
-/**
- * Error handler for the request parse function above.
- */
-function _parseReqOnError(
-  prop = 'undefined',
-  value?: unknown,
-  caughtErr?: unknown,
-): void {
-  if (caughtErr !== undefined) {
-    const moreInfo = JSON.stringify(caughtErr);
-    throw new ValidationErr(prop, value, moreInfo);
-  } else {
-    throw new ValidationErr(prop, value);
-  }
-}

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

@@ -9,7 +9,7 @@ import 'express-async-errors';
 import BaseRouter from '@src/routes';
 
 import Paths from '@src/routes/common/Paths';
-import Env from '@src/common/Env';
+import ENV from '@src/common/ENV';
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import { RouteError } from '@src/common/route-errors';
 import { NodeEnvs } from '@src/common/constants';
@@ -29,12 +29,12 @@ 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.valueOf()) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (Env.NodeEnv === NodeEnvs.Production.valueOf()) {
+if (ENV.NodeEnv === NodeEnvs.Production.valueOf()) {
   app.use(helmet());
 }
 
@@ -43,7 +43,7 @@ app.use(Paths.Base, BaseRouter);
 
 // Add error handler
 app.use((err: Error, _: Request, res: Response, next: NextFunction) => {
-  if (Env.NodeEnv !== NodeEnvs.Test.valueOf()) {
+  if (ENV.NodeEnv !== NodeEnvs.Test.valueOf()) {
     logger.err(err, true);
   }
   let status = HttpStatusCodes.BAD_REQUEST;

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.12",
+  "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",

package/lib/project-files/spec/types/misc.ts

@@ -1,13 +0,0 @@
-import { Response } from 'supertest';
-import { IUser } from '@src/models/User';
-
-
-// Misc
-export type TRes = Omit<Response, 'body'> & {
-  body: {
-    error?: string,
-    user?: IUser,
-    users?: IUser[],
-  },
-};
-export type TApiCb = (res: TRes) => void;

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

@@ -1,14 +0,0 @@
-import { IUser } from '@src/models/User';
-import 'supertest';
-
-
-declare module 'supertest' {
-
-  export interface Response  {
-    headers: Record<string, string[]>;
-    body: {
-      error: string,
-      users: IUser[],
-    };
-  }
-}