express-generator-typescript 2.7.14 → 2.7.16

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

@@ -7,7 +7,7 @@ import server from './server';
                                 Constants
 ******************************************************************************/
 
-const SERVER_START_MSG =
+const SERVER_START_MESSAGE =
   'Express server started on port: ' + EnvVars.Port.toString();
 
 /******************************************************************************
@@ -19,6 +19,6 @@ server.listen(EnvVars.Port, (err) => {
   if (!!err) {
     logger.err(err.message);
   } else {
-    logger.info(SERVER_START_MSG);
+    logger.info(SERVER_START_MESSAGE);
   }
 });

package/lib/project-files/src/models/{User.ts → User.model.ts}

@@ -3,7 +3,7 @@ import { parseObject, Schema, testObject } from 'jet-validators/utils';
 
 import { transformIsDate } from '@src/common/utils/validators';
 
-import { IModel } from './common/IModel';
+import { Entity } from './common/types';
 
 /******************************************************************************
                                  Constants
@@ -30,21 +30,20 @@ const schema: Schema<IUser> = {
 /**
  * @entity users
  */
-export interface IUser extends IModel {
+export interface IUser extends Entity {
   name: string;
   email: string;
-}
+};
 
 /******************************************************************************
                                   Setup
 ******************************************************************************/
 
-
 // Set the "parseUser" function
 const parseUser = parseObject<IUser>(schema);
 
 // For the APIs make sure the right fields are complete
-const testIsCompleteUser = testObject<IUser>({
+const isCompleteUser = testObject<IUser>({
   ...schema,
   name: isNonEmptyString,
   email: isNonEmptyString,
@@ -57,7 +56,7 @@ const testIsCompleteUser = testObject<IUser>({
 /**
  * New user object.
  */
-function __new__(user?: Partial<IUser>): IUser {
+function new_(user?: Partial<IUser>): IUser {
   return parseUser({ ...GetDefaults(), ...user }, (errors) => {
     throw new Error('Setup new user failed ' + JSON.stringify(errors, null, 2));
   });
@@ -68,6 +67,6 @@ function __new__(user?: Partial<IUser>): IUser {
 ******************************************************************************/
 
 export default {
-  new: __new__,
-  isComplete: testIsCompleteUser,
+  new: new_,
+  isComplete: isCompleteUser,
 } as const;

package/lib/project-files/src/models/common/{IModel.ts → types.ts}

@@ -1,4 +1,4 @@
-export interface IModel {
+export interface Entity {
   id: number; // @PK
   created: Date | string; // @audit
 }

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

@@ -1,25 +1,26 @@
 import jsonfile from 'jsonfile';
 
 import EnvVars, { NodeEnvs } from '@src/common/constants/env';
-import { IUser } from '@src/models/User';
+import { IUser } from '@src/models/User.model';
 
 /******************************************************************************
                                 Constants
 ******************************************************************************/
 
-const DATABASE_FILE_PATH = __dirname + '/common' + (
-  EnvVars.NodeEnv === NodeEnvs.TEST 
-  ? '/database.test.json' 
-  : '/database.json'
-);
+const DATABASE_FILE_PATH =
+  __dirname +
+  '/common' +
+  (EnvVars.NodeEnv === NodeEnvs.TEST
+    ? '/database.test.json'
+    : '/database.json');
 
 /******************************************************************************
                                 Types
 ******************************************************************************/
 
-interface IDatabase {
+type Database = {
   users: IUser[];
-}
+};
 
 /******************************************************************************
                                 Functions
@@ -28,14 +29,14 @@ interface IDatabase {
 /**
  * Fetch the json from the file.
  */
-function openDb(): Promise<IDatabase> {
-  return jsonfile.readFile(DATABASE_FILE_PATH) as Promise<IDatabase>;
+function openDb(): Promise<Database> {
+  return jsonfile.readFile(DATABASE_FILE_PATH) as Promise<Database>;
 }
 
 /**
  * Update the file.
  */
-function saveDb(db: IDatabase): Promise<void> {
+function saveDb(db: Database): Promise<void> {
   return jsonfile.writeFile(DATABASE_FILE_PATH, db);
 }
 
@@ -43,7 +44,7 @@ function saveDb(db: IDatabase): Promise<void> {
  * Empty the database
  */
 function cleanDb(): Promise<void> {
-  return jsonfile.writeFile( DATABASE_FILE_PATH, {});
+  return jsonfile.writeFile(DATABASE_FILE_PATH, {});
 }
 
 /******************************************************************************

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

@@ -1,5 +1,5 @@
 import { getRandomInt } from '@src/common/utils/number-utils';
-import { IUser } from '@src/models/User';
+import { IUser } from '@src/models/User.model';
 
 import orm from './MockOrm';
 
@@ -72,7 +72,7 @@ async function update(user: IUser): Promise<void> {
 /**
  * Delete one user.
  */
-async function __delete__(id: number): Promise<void> {
+async function delete_(id: number): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === id) {
@@ -86,7 +86,7 @@ async function __delete__(id: number): Promise<void> {
 
 /**
  * @testOnly
- * 
+ *
  * Delete every user record.
  */
 async function deleteAllUsers(): Promise<void> {
@@ -97,7 +97,7 @@ async function deleteAllUsers(): Promise<void> {
 
 /**
  * @testOnly
- * 
+ *
  * Insert multiple users. Can't do multiple at once cause using a plain file
  * for now.
  */
@@ -125,7 +125,7 @@ export default {
   getAll,
   add,
   update,
-  delete: __delete__,
+  delete: delete_,
   deleteAllUsers,
   insertMultiple,
 } as const;

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

@@ -1 +1,22 @@
-{"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/common/database.test.json

@@ -1 +1 @@
-{"users":[{"id":743599328040,"name":"Bill","email":"sean.maxwell@gmail.com","created":"2026-01-22T02:53:04.104Z"},{"id":366376663219,"name":"John Smith","email":"john.smith@gmail.com","created":"2026-01-22T02:53:04.104Z"},{"id":223776680823,"name":"Gordan Freeman","email":"gordan.freeman@gmail.com","created":"2026-01-22T02:53:04.104Z"}]}
+{"users":[{"id":279249255772,"name":"Bill","email":"sean.maxwell@gmail.com","created":"2026-01-28T05:15:24.564Z"},{"id":374980001180,"name":"John Smith","email":"john.smith@gmail.com","created":"2026-01-28T05:15:24.564Z"},{"id":551114509623,"name":"Gordan Freeman","email":"gordan.freeman@gmail.com","created":"2026-01-28T05:15:24.564Z"}]}

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

@@ -2,7 +2,7 @@ import { isNumber } from 'jet-validators';
 import { transform } from 'jet-validators/utils';
 
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-import User from '@src/models/User';
+import User from '@src/models/User.model';
 import UserService from '@src/services/UserService';
 
 import { IReq, IRes } from './common/express-types';
@@ -12,7 +12,7 @@ import parseReq from './common/parseReq';
                                 Constants
 ******************************************************************************/
 
-const Validators = {
+const reqValidators = {
   add: parseReq({ user: User.isComplete }),
   update: parseReq({ user: User.isComplete }),
   delete: parseReq({ id: transform(Number, isNumber) }),
@@ -38,7 +38,7 @@ async function getAll(_: IReq, res: IRes) {
  * @route POST /api/users/add
  */
 async function add(req: IReq, res: IRes) {
-  const { user } = Validators.add(req.body);
+  const { user } = reqValidators.add(req.body);
   await UserService.addOne(user);
   res.status(HttpStatusCodes.CREATED).end();
 }
@@ -49,7 +49,7 @@ async function add(req: IReq, res: IRes) {
  * @route PUT /api/users/update
  */
 async function update(req: IReq, res: IRes) {
-  const { user } = Validators.update(req.body);
+  const { user } = reqValidators.update(req.body);
   await UserService.updateOne(user);
   res.status(HttpStatusCodes.OK).end();
 }
@@ -59,8 +59,8 @@ async function update(req: IReq, res: IRes) {
  *
  * @route DELETE /api/users/delete/:id
  */
-async function __delete__(req: IReq, res: IRes) {
-  const { id } = Validators.delete(req.params);
+async function delete_(req: IReq, res: IRes) {
+  const { id } = reqValidators.delete(req.params);
   await UserService.delete(id);
   res.status(HttpStatusCodes.OK).end();
 }
@@ -73,5 +73,5 @@ export default {
   getAll,
   add,
   update,
-  delete: __delete__,
+  delete: delete_,
 } as const;

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

@@ -10,7 +10,7 @@ import UserRoutes from './UserRoutes';
 
 const apiRouter = Router();
 
-// ----------------------- Add UserRouter ---------------------------------- //
+// ----------------------- Add UserRouter --------------------------------- //
 
 const userRouter = Router();
 
@@ -22,7 +22,7 @@ userRouter.delete(Paths.Users.Delete, UserRoutes.delete);
 apiRouter.use(Paths.Users._, userRouter);
 
 /******************************************************************************
-                                Export default
+                                Export
 ******************************************************************************/
 
 export default apiRouter;

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

@@ -1,6 +1,6 @@
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
 import { RouteError } from '@src/common/utils/route-errors';
-import { IUser } from '@src/models/User';
+import { IUser } from '@src/models/User.model';
 import UserRepo from '@src/repos/UserRepo';
 
 /******************************************************************************
@@ -43,7 +43,7 @@ async function updateOne(user: IUser): Promise<void> {
 /**
  * Delete a user by their id.
  */
-async function __delete__(id: number): Promise<void> {
+async function deleteOne(id: number): Promise<void> {
   const persists = await UserRepo.persists(id);
   if (!persists) {
     throw new RouteError(HttpStatusCodes.NOT_FOUND, Errors.USER_NOT_FOUND);
@@ -60,5 +60,5 @@ export default {
   getAll,
   addOne,
   updateOne,
-  delete: __delete__,
+  delete: deleteOne,
 } as const;

package/lib/project-files/tests/common/comparators.ts

@@ -1,4 +1,4 @@
-import { IUser } from '@src/models/User';
+import { IUser } from '@src/models/User.model';
 
 /******************************************************************************
                                 Types

package/lib/project-files/tests/common/error-utils.ts

@@ -5,7 +5,7 @@ import { ParseError, parseJson } from 'jet-validators/utils';
                                 Types
 ******************************************************************************/
 
-interface IValidationError {
+type ValidationError = {
   message: string;
   errors: ParseError[];
 }
@@ -17,9 +17,9 @@ interface IValidationError {
 /**
  * JSON parse a validation error.
  */
-export function parseValidationError(arg: unknown): IValidationError {
+export function parseValidationError(arg: unknown): ValidationError {
   if (!isString(arg)) {
     throw new Error('Not a string');
   }
-  return parseJson<IValidationError>(arg);
+  return parseJson<ValidationError>(arg);
 }

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

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

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

@@ -1,7 +1,7 @@
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
 import { JetPaths as Paths } from '@src/common/constants/Paths';
 import { ValidationError } from '@src/common/utils/route-errors';
-import User, { IUser } from '@src/models/User';
+import User, { IUser } from '@src/models/User.model';
 import UserRepo from '@src/repos/UserRepo';
 
 import { agent } from './support/agent';

package/package.json

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