express-generator-typescript 2.7.14 → 2.7.15

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 → UserModel.ts}

@@ -3,20 +3,20 @@ 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
 ******************************************************************************/
 
-const GetDefaults = (): IUser => ({
+const GetDefaults = (): User => ({
   id: 0,
   name: '',
   email: '',
   created: new Date(),
 });
 
-const schema: Schema<IUser> = {
+const schema: Schema<User> = {
   id: isUnsignedInteger,
   name: isString,
   email: isString,
@@ -30,21 +30,20 @@ const schema: Schema<IUser> = {
 /**
  * @entity users
  */
-export interface IUser extends IModel {
+export type User = Entity & {
   name: string;
   email: string;
-}
+};
 
 /******************************************************************************
                                   Setup
 ******************************************************************************/
 
-
 // Set the "parseUser" function
-const parseUser = parseObject<IUser>(schema);
+const parseUser = parseObject<User>(schema);
 
 // For the APIs make sure the right fields are complete
-const testIsCompleteUser = testObject<IUser>({
+const isCompleteUser = testObject<User>({
   ...schema,
   name: isNonEmptyString,
   email: isNonEmptyString,
@@ -57,7 +56,7 @@ const testIsCompleteUser = testObject<IUser>({
 /**
  * New user object.
  */
-function __new__(user?: Partial<IUser>): IUser {
+function newUser(user?: Partial<User>): User {
   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: newUser,
+  isComplete: isCompleteUser,
 } as const;

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

@@ -1,4 +1,4 @@
-export interface IModel {
+export type 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 { User } from '@src/models/UserModel';
 
 /******************************************************************************
                                 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 {
-  users: IUser[];
-}
+type Database = {
+  users: User[];
+};
 
 /******************************************************************************
                                 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 { User } from '@src/models/UserModel';
 
 import orm from './MockOrm';
 
@@ -10,7 +10,7 @@ import orm from './MockOrm';
 /**
  * Get one user.
  */
-async function getOne(email: string): Promise<IUser | null> {
+async function getOne(email: string): Promise<User | null> {
   const db = await orm.openDb();
   for (const user of db.users) {
     if (user.email === email) {
@@ -36,7 +36,7 @@ async function persists(id: number): Promise<boolean> {
 /**
  * Get all users.
  */
-async function getAll(): Promise<IUser[]> {
+async function getAll(): Promise<User[]> {
   const db = await orm.openDb();
   return db.users;
 }
@@ -44,7 +44,7 @@ async function getAll(): Promise<IUser[]> {
 /**
  * Add one user.
  */
-async function add(user: IUser): Promise<void> {
+async function add(user: User): Promise<void> {
   const db = await orm.openDb();
   user.id = getRandomInt();
   db.users.push(user);
@@ -54,7 +54,7 @@ async function add(user: IUser): Promise<void> {
 /**
  * Update a user.
  */
-async function update(user: IUser): Promise<void> {
+async function update(user: User): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === user.id) {
@@ -86,7 +86,7 @@ async function __delete__(id: number): Promise<void> {
 
 /**
  * @testOnly
- * 
+ *
  * Delete every user record.
  */
 async function deleteAllUsers(): Promise<void> {
@@ -97,13 +97,13 @@ async function deleteAllUsers(): Promise<void> {
 
 /**
  * @testOnly
- * 
+ *
  * Insert multiple users. Can't do multiple at once cause using a plain file
  * for now.
  */
 async function insertMultiple(
-  users: IUser[] | readonly IUser[],
-): Promise<IUser[]> {
+  users: User[] | readonly User[],
+): Promise<User[]> {
   const db = await orm.openDb(),
     usersF = [...users];
   for (const user of usersF) {

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":146631637670,"name":"Bill","email":"sean.maxwell@gmail.com","created":"2026-01-26T00:52:08.804Z"},{"id":498481378998,"name":"John Smith","email":"john.smith@gmail.com","created":"2026-01-26T00:52:08.804Z"},{"id":878476468362,"name":"Gordan Freeman","email":"gordan.freeman@gmail.com","created":"2026-01-26T00:52:08.804Z"}]}

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 UserModel from '@src/models/UserModel';
 import UserService from '@src/services/UserService';
 
 import { IReq, IRes } from './common/express-types';
@@ -12,9 +12,9 @@ import parseReq from './common/parseReq';
                                 Constants
 ******************************************************************************/
 
-const Validators = {
-  add: parseReq({ user: User.isComplete }),
-  update: parseReq({ user: User.isComplete }),
+const reqValidators = {
+  add: parseReq({ user: UserModel.isComplete }),
+  update: parseReq({ user: UserModel.isComplete }),
   delete: parseReq({ id: transform(Number, isNumber) }),
 } as const;
 
@@ -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();
 }
@@ -60,7 +60,7 @@ 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);
+  const { id } = reqValidators.delete(req.params);
   await UserService.delete(id);
   res.status(HttpStatusCodes.OK).end();
 }

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 { User } from '@src/models/UserModel';
 import UserRepo from '@src/repos/UserRepo';
 
 /******************************************************************************
@@ -18,21 +18,21 @@ const Errors = {
 /**
  * Get all users.
  */
-function getAll(): Promise<IUser[]> {
+function getAll(): Promise<User[]> {
   return UserRepo.getAll();
 }
 
 /**
  * Add one user.
  */
-function addOne(user: IUser): Promise<void> {
+function addOne(user: User): Promise<void> {
   return UserRepo.add(user);
 }
 
 /**
  * Update one user.
  */
-async function updateOne(user: IUser): Promise<void> {
+async function updateOne(user: User): Promise<void> {
   const persists = await UserRepo.persists(user.id);
   if (!persists) {
     throw new RouteError(HttpStatusCodes.NOT_FOUND, Errors.USER_NOT_FOUND);
@@ -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,10 +1,10 @@
-import { IUser } from '@src/models/User';
+import { User } from '@src/models/UserModel';
 
 /******************************************************************************
                                 Types
 ******************************************************************************/
 
-type UserArray = IUser[] | readonly IUser[];
+type UserArray = User[] | readonly User[];
 
 /******************************************************************************
                                 Functions
@@ -31,7 +31,7 @@ export function compareUserArrays(a: UserArray, b: UserArray): boolean {
 /**
  * Sort user array by email.
  */
-function sortByEmail(arr: UserArray): IUser[] {
+function sortByEmail(arr: UserArray): User[] {
   return [...arr].sort((x, y) => {
     return x.email.localeCompare(y.email);
   });

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 UserModel, { User } from '@src/models/UserModel';
 import UserRepo from '@src/repos/UserRepo';
 
 import { agent } from './support/agent';
@@ -15,9 +15,9 @@ import { compareUserArrays } from './common/comparators';
 ******************************************************************************/
 
 const DUMMY_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' }),
+  UserModel.new({ name: 'Sean Maxwell', email: 'sean.maxwell@gmail.com' }),
+  UserModel.new({ name: 'John Smith', email: 'john.smith@gmail.com' }),
+  UserModel.new({ name: 'Gordan Freeman', email: 'gordan.freeman@gmail.com' }),
 ] as const;
 
 const { BAD_REQUEST, CREATED, OK, NOT_FOUND } = HttpStatusCodes;
@@ -30,7 +30,7 @@ const { BAD_REQUEST, CREATED, OK, NOT_FOUND } = HttpStatusCodes;
 ******************************************************************************/
 
 describe('UserRouter', () => {
-  let dbUsers: IUser[] = [];
+  let dbUsers: User[] = [];
 
   beforeEach(async () => {
     await UserRepo.deleteAllUsers();
@@ -42,7 +42,7 @@ describe('UserRouter', () => {
       'should return a JSON object with all the users and a status code of ' +
         `"${OK}" if the request was successful.`,
       async () => {
-        const res: IRes<{ users: IUser[] }> = await agent.get(Paths.Users.Get);
+        const res: IRes<{ users: User[] }> = await agent.get(Paths.Users.Get);
         expect(res.status).toBe(OK);
         expect(compareUserArrays(res.body.users, DUMMY_USERS)).toBeTruthy();
       },
@@ -54,7 +54,7 @@ describe('UserRouter', () => {
       `should return a status code of "${CREATED}" if the request was ` +
         'successful.',
       async () => {
-        const user = User.new({ name: 'a', email: 'a@a.com' }),
+        const user = UserModel.new({ name: 'a', email: 'a@a.com' }),
           res = await agent.post(Paths.Users.Add).send({ user });
         expect(res.status).toBe(CREATED);
       },
@@ -87,7 +87,7 @@ describe('UserRouter', () => {
       'should return a JSON object with an error message and a status code ' +
         `of "${BAD_REQUEST}" if id is the wrong data type`,
       async () => {
-        const user = User.new();
+        const user = UserModel.new();
         user.id = '5' as unknown as number;
         const res: IRes = await agent.put(Paths.Users.Update).send({ user });
         expect(res.status).toBe(BAD_REQUEST);
@@ -102,7 +102,7 @@ describe('UserRouter', () => {
         `"${UserService.Errors.USER_NOT_FOUND}" and a status code of ` +
         `"${NOT_FOUND}" if the id was not found.`,
       async () => {
-        const user = User.new({ id: 4, name: 'a', email: 'a@a.com' }),
+        const user = UserModel.new({ id: 4, name: 'a', email: 'a@a.com' }),
           res: IRes = await agent.put(Paths.Users.Update).send({ user });
         expect(res.status).toBe(NOT_FOUND);
         expect(res.body.error).toBe(UserService.Errors.USER_NOT_FOUND);

package/package.json

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