express-generator-typescript 2.7.4 → 2.7.6

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

@@ -3,7 +3,6 @@ import { getRandomInt } from '@src/common/util/misc';
 
 import orm from './MockOrm';
 
-
 /******************************************************************************
                                 Functions
 ******************************************************************************/
@@ -88,6 +87,9 @@ async function delete_(id: number): Promise<void> {
 
 /**
  * Delete every user record.
+ * 
+ * @internal
+ * Test-only helper. Do not use in production code.
  */
 async function deleteAllUsers(): Promise<void> {
   const db = await orm.openDb();
@@ -98,6 +100,9 @@ async function deleteAllUsers(): Promise<void> {
 /**
  * Insert multiple users. Can't do multiple at once cause using a plain file 
  * for now.
+ * 
+ * @internal
+ * Test-only helper. Do not use in production code.
  */
 async function insertMult(
   users: IUser[] | readonly IUser[],
@@ -113,7 +118,6 @@ async function insertMult(
   return usersF;
 }
 
-
 /******************************************************************************
                                 Export default
 ******************************************************************************/
@@ -128,4 +132,3 @@ export default {
   deleteAllUsers,
   insertMult,
 } as const;
-

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

@@ -1 +1 @@
-{"users":[{"id":366115170645,"name":"Sean Maxwell","email":"smaxwell@example.com","created":"2024-03-22T05:14:36.252Z"},{"id":310946254456,"name":"John Smith","email":"john.smith@example.com","created":"2024-03-22T05:20:55.079Z"},{"id":143027113460,"name":"Gordan Freeman","email":"nova@prospect.com","created":"2024-03-22T05:42:18.895Z"}]}
+{"users":[{"id":366115170645,"name":"Sean Maxwell","email":"smaxwell@example.com","created":"2024-03-22T05:14:36.252Z"},{"id":310946254456,"name":"John Smith","email":"john.smith@example.com","created":"2024-03-22T05:20:55.079Z"},{"id":143027113460,"name":"Gordan Freeman","email":"nova@prospect.com","created":"2024-03-22T05:42:18.895Z"}]}

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

@@ -1 +1 @@
-{"users":[{"id":497419234357,"name":"Bill","created":"2025-06-09T14:39:52.401Z","email":"sean.maxwell@gmail.com"},{"id":194170887976,"name":"John Smith","created":"2025-06-09T14:39:52.401Z","email":"john.smith@gmail.com"},{"id":893739541148,"name":"Gordan Freeman","created":"2025-06-09T14:39:52.401Z","email":"gordan.freeman@gmail.com"}]}
+{"users":[{"id":967269206317,"name":"Bill","created":"2025-12-17T09:55:17.960Z","email":"sean.maxwell@gmail.com"},{"id":3025435078,"name":"John Smith","created":"2025-12-17T09:55:17.960Z","email":"john.smith@gmail.com"},{"id":786429791732,"name":"Gordan Freeman","created":"2025-12-17T09:55:17.960Z","email":"gordan.freeman@gmail.com"}]}

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

@@ -1,14 +1,13 @@
 import { isNumber } from 'jet-validators';
 import { transform } from 'jet-validators/utils';
 
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
 import UserService from '@src/services/UserService';
 import User from '@src/models/User';
 
 import { IReq, IRes } from './common/types';
 import { parseReq } from './common/util';
 
-
 /******************************************************************************
                                 Constants
 ******************************************************************************/
@@ -19,7 +18,6 @@ const Validators = {
   delete: parseReq({ id: transform(Number, isNumber) }),
 } as const;
 
-
 /******************************************************************************
                                 Functions
 ******************************************************************************/
@@ -29,7 +27,7 @@ const Validators = {
  */
 async function getAll(_: IReq, res: IRes) {
   const users = await UserService.getAll();
-  res.status(HttpStatusCodes.OK).json({ users });
+  res.status(HTTP_STATUS_CODES.Ok).json({ users });
 }
 
 /**
@@ -38,7 +36,7 @@ async function getAll(_: IReq, res: IRes) {
 async function add(req: IReq, res: IRes) {
   const { user } = Validators.add(req.body);
   await UserService.addOne(user);
-  res.status(HttpStatusCodes.CREATED).end();
+  res.status(HTTP_STATUS_CODES.Created).end();
 }
 
 /**
@@ -47,7 +45,7 @@ async function add(req: IReq, res: IRes) {
 async function update(req: IReq, res: IRes) {
   const { user } = Validators.update(req.body);
   await UserService.updateOne(user);
-  res.status(HttpStatusCodes.OK).end();
+  res.status(HTTP_STATUS_CODES.Ok).end();
 }
 
 /**
@@ -56,10 +54,9 @@ async function update(req: IReq, res: IRes) {
 async function delete_(req: IReq, res: IRes) {
   const { id } = Validators.delete(req.params);
   await UserService.delete(id);
-  res.status(HttpStatusCodes.OK).end();
+  res.status(HTTP_STATUS_CODES.Ok).end();
 }
 
-
 /******************************************************************************
                                 Export default
 ******************************************************************************/

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

@@ -1,6 +1,5 @@
 import { Response, Request } from 'express';
 
-
 /******************************************************************************
                                 Types
 ******************************************************************************/

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

@@ -1,8 +1,6 @@
 import { parseObject, TSchema } from 'jet-validators/utils';
-
 import { ValidationError } from '@src/common/util/route-errors';
 
-
 /******************************************************************************
                               Functions
 ******************************************************************************/

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

@@ -1,9 +1,8 @@
 import { Router } from 'express';
 
-import Paths from '@src/common/constants/Paths';
+import PATHS from '@src/common/constants/PATHS';
 import UserRoutes from './UserRoutes';
 
-
 /******************************************************************************
                                 Setup
 ******************************************************************************/
@@ -17,14 +16,13 @@ const apiRouter = Router();
 const userRouter = Router();
 
 // Get all users
-userRouter.get(Paths.Users.Get, UserRoutes.getAll);
-userRouter.post(Paths.Users.Add, UserRoutes.add);
-userRouter.put(Paths.Users.Update, UserRoutes.update);
-userRouter.delete(Paths.Users.Delete, UserRoutes.delete);
+userRouter.get(PATHS.Users.Get, UserRoutes.getAll);
+userRouter.post(PATHS.Users.Add, UserRoutes.add);
+userRouter.put(PATHS.Users.Update, UserRoutes.update);
+userRouter.delete(PATHS.Users.Delete, UserRoutes.delete);
 
 // Add UserRouter
-apiRouter.use(Paths.Users.Base, userRouter);
-
+apiRouter.use(PATHS.Users._, userRouter);
 
 /******************************************************************************
                                 Export default

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

@@ -6,11 +6,13 @@ import logger from 'jet-logger';
 
 import BaseRouter from '@src/routes';
 
-import Paths from '@src/common/constants/Paths';
+import Paths from '@src/common/constants/PATHS';
 import ENV from '@src/common/constants/ENV';
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES, {
+  HttpStatusCodes,
+} from '@src/common/constants/HTTP_STATUS_CODES';
 import { RouteError } from '@src/common/util/route-errors';
-import { NodeEnvs } from '@src/common/constants';
+import { NODE_ENVS } from '@src/common/constants';
 
 
 /******************************************************************************
@@ -27,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) {
+if (ENV.NodeEnv === NODE_ENVS.Dev) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (ENV.NodeEnv === NodeEnvs.Production) {
+if (ENV.NodeEnv === NODE_ENVS.Production) {
   // eslint-disable-next-line n/no-process-env
   if (!process.env.DISABLE_HELMET) {
     app.use(helmet());
@@ -40,14 +42,14 @@ if (ENV.NodeEnv === NodeEnvs.Production) {
 }
 
 // Add APIs, must be after middleware
-app.use(Paths.Base, BaseRouter);
+app.use(Paths._, BaseRouter);
 
 // Add error handler
 app.use((err: Error, _: Request, res: Response, next: NextFunction) => {
-  if (ENV.NodeEnv !== NodeEnvs.Test.valueOf()) {
+  if (ENV.NodeEnv !== NODE_ENVS.Test.valueOf()) {
     logger.err(err, true);
   }
-  let status = HttpStatusCodes.BAD_REQUEST;
+  let status: HttpStatusCodes = HTTP_STATUS_CODES.BadRequest;
   if (err instanceof RouteError) {
     status = err.status;
     res.status(status).json({ error: err.message });

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

@@ -1,17 +1,15 @@
 import { RouteError } from '@src/common/util/route-errors';
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
 
 import UserRepo from '@src/repos/UserRepo';
 import { IUser } from '@src/models/User';
 
-
 /******************************************************************************
                                 Constants
 ******************************************************************************/
 
 export const USER_NOT_FOUND_ERR = 'User not found';
 
-
 /******************************************************************************
                                 Functions
 ******************************************************************************/
@@ -37,7 +35,7 @@ async function updateOne(user: IUser): Promise<void> {
   const persists = await UserRepo.persists(user.id);
   if (!persists) {
     throw new RouteError(
-      HttpStatusCodes.NOT_FOUND,
+      HTTP_STATUS_CODES.NotFound,
       USER_NOT_FOUND_ERR,
     );
   }
@@ -52,7 +50,7 @@ async function _delete(id: number): Promise<void> {
   const persists = await UserRepo.persists(id);
   if (!persists) {
     throw new RouteError(
-      HttpStatusCodes.NOT_FOUND,
+      HTTP_STATUS_CODES.NotFound,
       USER_NOT_FOUND_ERR,
     );
   }
@@ -60,7 +58,6 @@ async function _delete(id: number): Promise<void> {
   return UserRepo.delete(id);
 }
 
-
 /******************************************************************************
                                 Export default
 ******************************************************************************/

package/lib/project-files/tests/common/types/index.ts

@@ -7,10 +7,10 @@ import { Response } from 'supertest';
 
 // Use generics to add properties to 'body'
 export type TRes<T = object> = Omit<Response, 'body'> & {
-  body: T & { error?: string | IErrObj },
+  body: T & { error?: string | IErrorObject },
 };
 
-interface IErrObj {
+interface IErrorObject {
   message: string;
   [key: string]: unknown;
 }

package/lib/project-files/tests/common/util/index.ts

@@ -1,28 +1,18 @@
-import { Response } from 'supertest';
 import { IParseObjectError, parseJson } from 'jet-validators/utils';
 import { isString } from 'jet-validators';
-
+import { IUser } from '@src/models/User';
 
 /******************************************************************************
                                 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;
-}
+type TUserArray = IUser[] | readonly IUser[];
 
-interface IValidationErr {
+interface IValidationError {
   message: string;
   errors: IParseObjectError[];
 }
 
-
 /******************************************************************************
                                 Functions
 ******************************************************************************/
@@ -30,9 +20,36 @@ interface IValidationErr {
 /**
  * JSON parse a validation error.
  */
-export function parseValidationErr(arg: unknown): IValidationErr {
+export function parseValidationError(arg: unknown): IValidationError {
   if (!isString(arg)) {
     throw new Error('Not a string');
   }
-  return parseJson<IValidationErr>(arg);
+  return parseJson<IValidationError>(arg);
+}
+
+/**
+ * Compare to user arrays. Order does not matter and this assumes the email 
+ * field is unique
+ */
+export function compareUserArrays(a: TUserArray, b: TUserArray): boolean {
+  if (a.length !== b.length) return false;
+  const aSorted = sortByEmail(a);
+  const bSorted = sortByEmail(b);
+  for (let i = 0; i < aSorted.length; i++) {
+    const a = aSorted[i],
+      b = bSorted[i];
+    if (a.email !== b.email || a.name !== b.name) {
+      return false;
+    }
+  }
+  return true;
+}
+
+/**
+ * Sort user array by email.
+ */
+function sortByEmail(arr: TUserArray): IUser[] {
+  return [...arr].sort((x, y) => {
+    return x.email.localeCompare(y.email);
+  });
 }

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

@@ -1,17 +1,16 @@
 import insertUrlParams from 'inserturlparams';
-import { customDeepCompare } from 'jet-validators/utils';
 
 import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
 import { ValidationError } from '@src/common/util/route-errors';
+import { JET_PATHS as Paths }  from '@src/common/constants/PATHS';
 
-import Paths from './common/Paths';
-import { parseValidationErr, TRes } from './common/util';
+import { compareUserArrays, parseValidationError } from './common/util';
 import { agent } from './support/setup';
-
+import { TRes } from './common/types';
 
 /******************************************************************************
                                Constants
@@ -24,13 +23,6 @@ const DB_USERS = [
   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 
@@ -53,9 +45,9 @@ 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.`, async () => {
+    `of "${HTTP_STATUS_CODES.Ok}" if the request was successful.`, async () => {
       const res: TRes<{ users: IUser[]}> = await agent.get(Paths.Users.Get);
-      expect(res.status).toBe(HttpStatusCodes.OK);
+      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
       expect(compareUserArrays(res.body.users, DB_USERS)).toBeTruthy();
     });
   });
@@ -64,20 +56,20 @@ describe('UserRouter', () => {
   describe(`"POST:${Paths.Users.Add}"`, () => {
 
     // Test add user success
-    it(`should return a status code of "${HttpStatusCodes.CREATED}" if the ` + 
-    'request was successful.', async () => {
+    it(`should return a status code of "${HTTP_STATUS_CODES.Created}" if ` + 
+    'the request was successful.', async () => {
       const user = User.new({ name: 'a', email: 'a@a.com' }),
         res = await agent.post(Paths.Users.Add).send({ user });
-      expect(res.status).toBe(HttpStatusCodes.CREATED);
+      expect(res.status).toBe(HTTP_STATUS_CODES.Created);
     });
 
     // 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 ` + 
+      `code of "${HTTP_STATUS_CODES.BadRequest}" if the user param was ` + 
       'missing.', async () => {
       const res: TRes = await agent.post(Paths.Users.Add).send({ user: null });
-      expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-      const errorObj = parseValidationErr(res.body.error);
+      expect(res.status).toBe(HTTP_STATUS_CODES.BadRequest);
+      const errorObj = parseValidationError(res.body.error);
       expect(errorObj.message).toBe(ValidationError.MESSAGE);
       expect(errorObj.errors[0].prop).toBe('user');
     });
@@ -87,23 +79,23 @@ describe('UserRouter', () => {
   describe(`"PUT:${Paths.Users.Update}"`, () => {
 
     // Success
-    it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
+    it(`should return a status code of "${HTTP_STATUS_CODES.Ok}" if the ` + 
     'request was successful.', async () => {
       const user = DB_USERS[0];
       user.name = 'Bill';
       const res = await agent.put(Paths.Users.Update).send({ user });
-      expect(res.status).toBe(HttpStatusCodes.OK);
+      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
     });
 
     // Id is the wrong data type
     it('should return a JSON object with an error message and a status code ' +
-    `of "${HttpStatusCodes.BAD_REQUEST}" if the user param was missing`, 
+    `of "${HTTP_STATUS_CODES.BadRequest}" if the user param was missing`, 
     async () => {
       const user = User.new();
       user.id = ('5' as unknown as number);
       const res: TRes = await agent.put(Paths.Users.Update).send({ user });
-      expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-      const errorObj = parseValidationErr(res.body.error);
+      expect(res.status).toBe(HTTP_STATUS_CODES.BadRequest);
+      const errorObj = parseValidationError(res.body.error);
       expect(errorObj.message).toBe(ValidationError.MESSAGE);
       expect(errorObj.errors[0].prop).toBe('user');
       expect(errorObj.errors[0].children?.[0].prop).toBe('id');
@@ -112,34 +104,34 @@ describe('UserRouter', () => {
     // 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.`, async () => {
+    `"${HTTP_STATUS_CODES.NotFound}" if the id was not found.`, async () => {
       const user = User.new({ id: 4, name: 'a', email: 'a@a.com' }),
         res: TRes = await agent.put(Paths.Users.Update).send({ user });
-      expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+      expect(res.status).toBe(HTTP_STATUS_CODES.NotFound);
       expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
     });
   });
 
   // Delete User
-  describe(`"DELETE:${Paths.Users.Delete}"`, () => {
+  describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
 
-    const getPath = (id: number) => insertUrlParams(Paths.Users.Delete, 
+    const getPath = (id: number) => insertUrlParams(Paths.Users.Delete({ id}), 
       { id });
 
     // Success
-    it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
+    it(`should return a status code of "${HTTP_STATUS_CODES.Ok}" if the ` + 
     'request was successful.', async () => {
       const id = dbUsers[0].id,
         res = await agent.delete(getPath(id));
-      expect(res.status).toBe(HttpStatusCodes.OK);
+      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
     });
 
     // 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.`, async () => {
+    `"${HTTP_STATUS_CODES.NotFound}" if the id was not found.`, async () => {
       const res: TRes = await agent.delete(getPath(-1));
-      expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+      expect(res.status).toBe(HTTP_STATUS_CODES.NotFound);
       expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
     });
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.7.4",
+  "version": "2.7.6",
   "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/README-npm

@@ -1,20 +0,0 @@
-<img alt='overnightjs' src='https://github.com/seanpmaxwell/express-generator-typescript/raw/master/express-typescript.png' border='0'>
-
-[Express](https://www.npmjs.com/package/express) with [TypeScript's](https://www.npmjs.com/package/typescript) application generator.
-
-<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/v/express-generator-typescript.svg" alt="NPM Version" /></a>
-<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/l/express-generator-typescript.svg" alt="Package License" /></a>
-<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/dm/express-generator-typescript.svg" alt="NPM Downloads" /></a>
-
-
-## What is it?
-
-Creates a new express application similar to the _express-generator_ module. Except this new application is configured to use TypeScript instead of plain JavaScript. 
-
-This project complies with Typescript best practices listed <a href="https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md">here</a>.
-<br/>
-
-
-## Documenation
-
-Please refer to the official <a href="https://github.com/seanpmaxwell/express-generator-typescript">github repo</a> for the most up-to-date documentation.