express-generator-typescript 2.7.15 → 2.7.16

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

@@ -9,14 +9,14 @@ import { Entity } from './common/types';
                                  Constants
 ******************************************************************************/
 
-const GetDefaults = (): User => ({
+const GetDefaults = (): IUser => ({
   id: 0,
   name: '',
   email: '',
   created: new Date(),
 });
 
-const schema: Schema<User> = {
+const schema: Schema<IUser> = {
   id: isUnsignedInteger,
   name: isString,
   email: isString,
@@ -30,7 +30,7 @@ const schema: Schema<User> = {
 /**
  * @entity users
  */
-export type User = Entity & {
+export interface IUser extends Entity {
   name: string;
   email: string;
 };
@@ -40,10 +40,10 @@ export type User = Entity & {
 ******************************************************************************/
 
 // Set the "parseUser" function
-const parseUser = parseObject<User>(schema);
+const parseUser = parseObject<IUser>(schema);
 
 // For the APIs make sure the right fields are complete
-const isCompleteUser = testObject<User>({
+const isCompleteUser = testObject<IUser>({
   ...schema,
   name: isNonEmptyString,
   email: isNonEmptyString,
@@ -56,7 +56,7 @@ const isCompleteUser = testObject<User>({
 /**
  * New user object.
  */
-function newUser(user?: Partial<User>): User {
+function new_(user?: Partial<IUser>): IUser {
   return parseUser({ ...GetDefaults(), ...user }, (errors) => {
     throw new Error('Setup new user failed ' + JSON.stringify(errors, null, 2));
   });
@@ -67,6 +67,6 @@ function newUser(user?: Partial<User>): User {
 ******************************************************************************/
 
 export default {
-  new: newUser,
+  new: new_,
   isComplete: isCompleteUser,
 } as const;

package/lib/project-files/src/models/common/types.ts

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

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

@@ -1,7 +1,7 @@
 import jsonfile from 'jsonfile';
 
 import EnvVars, { NodeEnvs } from '@src/common/constants/env';
-import { User } from '@src/models/UserModel';
+import { IUser } from '@src/models/User.model';
 
 /******************************************************************************
                                 Constants
@@ -19,7 +19,7 @@ const DATABASE_FILE_PATH =
 ******************************************************************************/
 
 type Database = {
-  users: User[];
+  users: IUser[];
 };
 
 /******************************************************************************

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

@@ -1,5 +1,5 @@
 import { getRandomInt } from '@src/common/utils/number-utils';
-import { User } from '@src/models/UserModel';
+import { IUser } from '@src/models/User.model';
 
 import orm from './MockOrm';
 
@@ -10,7 +10,7 @@ import orm from './MockOrm';
 /**
  * Get one user.
  */
-async function getOne(email: string): Promise<User | null> {
+async function getOne(email: string): Promise<IUser | 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<User[]> {
+async function getAll(): Promise<IUser[]> {
   const db = await orm.openDb();
   return db.users;
 }
@@ -44,7 +44,7 @@ async function getAll(): Promise<User[]> {
 /**
  * Add one user.
  */
-async function add(user: User): Promise<void> {
+async function add(user: IUser): Promise<void> {
   const db = await orm.openDb();
   user.id = getRandomInt();
   db.users.push(user);
@@ -54,7 +54,7 @@ async function add(user: User): Promise<void> {
 /**
  * Update a user.
  */
-async function update(user: User): Promise<void> {
+async function update(user: IUser): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === user.id) {
@@ -72,7 +72,7 @@ async function update(user: User): 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) {
@@ -102,8 +102,8 @@ async function deleteAllUsers(): Promise<void> {
  * for now.
  */
 async function insertMultiple(
-  users: User[] | readonly User[],
-): Promise<User[]> {
+  users: IUser[] | readonly IUser[],
+): Promise<IUser[]> {
   const db = await orm.openDb(),
     usersF = [...users];
   for (const user of usersF) {
@@ -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.test.json

@@ -1 +1 @@
-{"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"}]}
+{"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 UserModel from '@src/models/UserModel';
+import User from '@src/models/User.model';
 import UserService from '@src/services/UserService';
 
 import { IReq, IRes } from './common/express-types';
@@ -13,8 +13,8 @@ import parseReq from './common/parseReq';
 ******************************************************************************/
 
 const reqValidators = {
-  add: parseReq({ user: UserModel.isComplete }),
-  update: parseReq({ user: UserModel.isComplete }),
+  add: parseReq({ user: User.isComplete }),
+  update: parseReq({ user: User.isComplete }),
   delete: parseReq({ id: transform(Number, isNumber) }),
 } as const;
 
@@ -59,7 +59,7 @@ async function update(req: IReq, res: IRes) {
  *
  * @route DELETE /api/users/delete/:id
  */
-async function __delete__(req: IReq, res: IRes) {
+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/services/UserService.ts

@@ -1,6 +1,6 @@
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
 import { RouteError } from '@src/common/utils/route-errors';
-import { User } from '@src/models/UserModel';
+import { IUser } from '@src/models/User.model';
 import UserRepo from '@src/repos/UserRepo';
 
 /******************************************************************************
@@ -18,21 +18,21 @@ const Errors = {
 /**
  * Get all users.
  */
-function getAll(): Promise<User[]> {
+function getAll(): Promise<IUser[]> {
   return UserRepo.getAll();
 }
 
 /**
  * Add one user.
  */
-function addOne(user: User): Promise<void> {
+function addOne(user: IUser): Promise<void> {
   return UserRepo.add(user);
 }
 
 /**
  * Update one user.
  */
-async function updateOne(user: User): Promise<void> {
+async function updateOne(user: IUser): Promise<void> {
   const persists = await UserRepo.persists(user.id);
   if (!persists) {
     throw new RouteError(HttpStatusCodes.NOT_FOUND, Errors.USER_NOT_FOUND);

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

@@ -1,10 +1,10 @@
-import { User } from '@src/models/UserModel';
+import { IUser } from '@src/models/User.model';
 
 /******************************************************************************
                                 Types
 ******************************************************************************/
 
-type UserArray = User[] | readonly User[];
+type UserArray = IUser[] | readonly IUser[];
 
 /******************************************************************************
                                 Functions
@@ -31,7 +31,7 @@ export function compareUserArrays(a: UserArray, b: UserArray): boolean {
 /**
  * Sort user array by email.
  */
-function sortByEmail(arr: UserArray): User[] {
+function sortByEmail(arr: UserArray): IUser[] {
   return [...arr].sort((x, y) => {
     return x.email.localeCompare(y.email);
   });

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 UserModel, { User } from '@src/models/UserModel';
+import User, { IUser } from '@src/models/User.model';
 import UserRepo from '@src/repos/UserRepo';
 
 import { agent } from './support/agent';
@@ -15,9 +15,9 @@ import { compareUserArrays } from './common/comparators';
 ******************************************************************************/
 
 const DUMMY_USERS = [
-  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' }),
+  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;
 
 const { BAD_REQUEST, CREATED, OK, NOT_FOUND } = HttpStatusCodes;
@@ -30,7 +30,7 @@ const { BAD_REQUEST, CREATED, OK, NOT_FOUND } = HttpStatusCodes;
 ******************************************************************************/
 
 describe('UserRouter', () => {
-  let dbUsers: User[] = [];
+  let dbUsers: IUser[] = [];
 
   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: User[] }> = await agent.get(Paths.Users.Get);
+        const res: IRes<{ users: IUser[] }> = 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 = UserModel.new({ name: 'a', email: 'a@a.com' }),
+        const user = User.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 = UserModel.new();
+        const user = User.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 = UserModel.new({ id: 4, name: 'a', email: 'a@a.com' }),
+        const user = User.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.15",
+  "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",