express-generator-typescript 2.7.10 → 2.7.12

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

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

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

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

package/lib/project-files/tests/{aux/setup.ts → support/agent.ts}

@@ -1,26 +1,23 @@
-
-import { beforeAll } from 'vitest';
-import supertest, { Test } from 'supertest';
-import TestAgent from 'supertest/lib/agent';
-
-import app from '@src/server';
-import MockOrm from '@src/repos/MockOrm';
-
-
-/******************************************************************************
-                                    Run
-******************************************************************************/
-
-let agent: TestAgent<Test>;
-
-beforeAll(async () => {
-  agent = supertest.agent(app);
-  await MockOrm.cleanDb();
-});
-
-
-/******************************************************************************
-                                    Export
-******************************************************************************/
-
-export { agent };
+import supertest, { Test } from 'supertest';
+import TestAgent from 'supertest/lib/agent';
+import { beforeAll } from 'vitest';
+
+import MockOrm from '@src/repos/MockOrm';
+import app from '@src/server';
+
+/******************************************************************************
+                                    Run
+******************************************************************************/
+
+let agent: TestAgent<Test>;
+
+beforeAll(async () => {
+  agent = supertest.agent(app);
+  await MockOrm.cleanDb();
+});
+
+/******************************************************************************
+                                    Export
+******************************************************************************/
+
+export { agent };

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

@@ -1,123 +1,131 @@
-import UserRepo from '@src/repos/UserRepo';
-import User, { IUser } from '@src/models/User';
-import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
-
-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 { compareUserArrays, parseValidationError } from './common/utils';
-import { agent } from './aux/setup';
-import { TRes } from './common/types';
-
-/******************************************************************************
-                               Constants
-******************************************************************************/
-
-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' }),
-] as const;
-
-const {
-  BadRequest,
-  Created,
-  Ok: OK,
-  NotFound,
-} = HTTP_STATUS_CODES;
-
-/******************************************************************************
-                                 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 dbUsers: IUser[] = [];
-
-  beforeEach(async () => {
-    await UserRepo.deleteAllUsers();
-    dbUsers = await UserRepo.insertMultiple(DUMMY_USERS);
-  });
-
-  describe(`"GET:${Paths.Users.Get}"`, () => {
-
-    it('should return a JSON object with all the users and a status code of ' + 
-    `"${OK}" if the request was successful.`, async () => {
-      const res: TRes<{ users: IUser[]}> = await agent.get(Paths.Users.Get);
-      expect(res.status).toBe(OK);
-      expect(compareUserArrays(res.body.users, DUMMY_USERS)).toBeTruthy();
-    });
-  });
-
-  describe(`"POST:${Paths.Users.Add}"`, () => {
-
-    it(`should return a status code of "${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(Created);
-    });
-
-    it('should return a JSON object with an error message of and a status ' + 
-      `code of "${BadRequest}" if the user param was missing.`, async () => {
-      const res: TRes = await agent.post(Paths.Users.Add).send({ user: null });
-      expect(res.status).toBe(BadRequest);
-      const errorObject = parseValidationError(res.body.error);
-      expect(errorObject.message).toBe(ValidationError.MESSAGE);
-      expect(errorObject.errors[0].key).toStrictEqual('user');
-    });
-  });
-
-  describe(`"PUT:${Paths.Users.Update}"`, () => {
-
-    it(`should return a status code of "${OK}" if the request was successfull`, 
-      async () => {
-        const user = DUMMY_USERS[0];
-        user.name = 'Bill';
-        const res = await agent.put(Paths.Users.Update).send({ user });
-        expect(res.status).toBe(OK);
-      });
-
-    it('should return a JSON object with an error message and a status code ' +
-    `of "${BadRequest}" if id is the wrong data type`, 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(BadRequest);
-      const errorObj = parseValidationError(res.body.error);
-      expect(errorObj.message).toBe(ValidationError.MESSAGE);
-      expect(errorObj.errors[0].keyPath).toStrictEqual(['user', 'id']);
-    });
-
-    it('should return a JSON object with the error message of ' + 
-    `"${USER_NOT_FOUND_ERR}" and a status code of "${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(NotFound);
-      expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-    });
-  });
-
-  describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
-
-    it(`should return a status code of "${OK}" if the request was successful.`, 
-      async () => {
-        const id = dbUsers[0].id,
-          res = await agent.delete(Paths.Users.Delete(id));
-        expect(res.status).toBe(OK);
-      });
-
-    it('should return a JSON object with the error message of ' + 
-    `"${USER_NOT_FOUND_ERR}" and a status code of "${NotFound}" if the id ` + 
-    'was not found.', async () => {
-      const res: TRes = await agent.delete(Paths.Users.Delete(-1));
-      expect(res.status).toBe(NotFound);
-      expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-    });
-  });
-});
+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 UserRepo from '@src/repos/UserRepo';
+
+import { agent } from './support/agent';
+import { IRes } from './common/supertest-types';
+import { parseValidationError } from './common/error-utils';
+import UserService from '@src/services/UserService';
+import { compareUserArrays } from './common/comparators';
+
+/******************************************************************************
+                               Constants
+******************************************************************************/
+
+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' }),
+] as const;
+
+const { BAD_REQUEST, CREATED, OK, NOT_FOUND } = HttpStatusCodes;
+
+/******************************************************************************
+                                 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 dbUsers: IUser[] = [];
+
+  beforeEach(async () => {
+    await UserRepo.deleteAllUsers();
+    dbUsers = await UserRepo.insertMultiple(DUMMY_USERS);
+  });
+
+  describe(`"GET:${Paths.Users.Get}"`, () => {
+    it(
+      '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);
+        expect(res.status).toBe(OK);
+        expect(compareUserArrays(res.body.users, DUMMY_USERS)).toBeTruthy();
+      },
+    );
+  });
+
+  describe(`"POST:${Paths.Users.Add}"`, () => {
+    it(
+      `should return a status code of "${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(CREATED);
+      },
+    );
+
+    it(
+      'should return a JSON object with an error message of and a status ' +
+        `code of "${BAD_REQUEST}" if the user param was missing.`,
+      async () => {
+        const res: IRes = await agent
+          .post(Paths.Users.Add)
+          .send({ user: null });
+        expect(res.status).toBe(BAD_REQUEST);
+        const errorObject = parseValidationError(res.body.error);
+        expect(errorObject.message).toBe(ValidationError.MESSAGE);
+        expect(errorObject.errors[0].key).toStrictEqual('user');
+      },
+    );
+  });
+
+  describe(`"PUT:${Paths.Users.Update}"`, () => {
+    it(`should return a status code of "${OK}" if the request was successfull`, async () => {
+      const user = DUMMY_USERS[0];
+      user.name = 'Bill';
+      const res = await agent.put(Paths.Users.Update).send({ user });
+      expect(res.status).toBe(OK);
+    });
+
+    it(
+      '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();
+        user.id = '5' as unknown as number;
+        const res: IRes = await agent.put(Paths.Users.Update).send({ user });
+        expect(res.status).toBe(BAD_REQUEST);
+        const errorObj = parseValidationError(res.body.error);
+        expect(errorObj.message).toBe(ValidationError.MESSAGE);
+        expect(errorObj.errors[0].keyPath).toStrictEqual(['user', 'id']);
+      },
+    );
+
+    it(
+      'should return a JSON object with the error message of ' +
+        `"${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' }),
+          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);
+      },
+    );
+  });
+
+  describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
+    it(`should return a status code of "${OK}" if the request was successful.`, async () => {
+      const id = dbUsers[0].id,
+        res = await agent.delete(Paths.Users.Delete(id));
+      expect(res.status).toBe(OK);
+    });
+
+    it(
+      'should return a JSON object with the error message of ' +
+        `"${UserService.Errors.USER_NOT_FOUND}" and a status code of ` +
+        '"${NOT_FOUND}" if the id was not found.',
+      async () => {
+        const res: IRes = await agent.delete(Paths.Users.Delete(-1));
+        expect(res.status).toBe(NOT_FOUND);
+        expect(res.body.error).toBe(UserService.Errors.USER_NOT_FOUND);
+      },
+    );
+  });
+});

package/lib/project-files/tsconfig.json

@@ -1,35 +1,30 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "lib": ["ES2020"],                   
-    "strict": true,
-    "baseUrl": "./",
-    "esModuleInterop": true,                 
-    "skipLibCheck": true,                     
-    "forceConsistentCasingInFileNames": true,
-    "paths": {
-      "@src/*": ["src/*"]
-    },
-    "useUnknownInCatchVariables": false,
-    "types": ["vitest/globals"],
-  },
-  "ts-node": {
-    "swc": true,
-    "require": [
-      "tsconfig-paths/register",
-      "./config.ts"
-    ],
-  },
-  "include": [
-    "src/**/*.ts",
-    "tests/**/*.ts",
-    "config.ts",
-    "scripts",
-    "eslint.config.ts",
-    "vitest.config.mts"
-  ],
-  "exclude": [
-    "src/public/*"
-  ]
-}
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"],
+    "strict": true,
+    "baseUrl": "./",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@src/*": ["src/*"]
+    },
+    "useUnknownInCatchVariables": false,
+    "types": ["vitest/globals"]
+  },
+  "ts-node": {
+    "swc": true,
+    "require": ["tsconfig-paths/register", "./config.ts"]
+  },
+  "include": [
+    "src/**/*.ts",
+    "tests/**/*.ts",
+    "config.ts",
+    "scripts",
+    "eslint.config.ts",
+    "vitest.config.mts"
+  ],
+  "exclude": ["src/public/*"]
+}

package/lib/project-files/tsconfig.prod.json

@@ -1,30 +1,27 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "CommonJS",
-    "lib": ["ES2020"],                        
-    "strict": true,
-    "baseUrl": "./",
-    "outDir": "temp",
-    "esModuleInterop": true,                 
-    "skipLibCheck": true,                     
-    "forceConsistentCasingInFileNames": true,
-    "paths": {
-      "@src/*": ["src/*"]
-    },
-    "useUnknownInCatchVariables": false,
-    "sourceMap": false,
-    "removeComments": true
-  },
-  "include": [
-    "src/**/*.ts",
-    "config.ts"
-  ],
-  "exclude": [
-    "tests",
-    "src/public/",
-    "scripts",
-    "eslint.config.ts",
-    "vitest.config.js"
-  ]
-}
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "lib": ["ES2020"],
+    "strict": true,
+    "baseUrl": "./",
+    "outDir": "temp",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@src/*": ["src/*"]
+    },
+    "useUnknownInCatchVariables": false,
+    "sourceMap": false,
+    "removeComments": true
+  },
+  "include": ["src/**/*.ts", "config.ts"],
+  "exclude": [
+    "tests",
+    "src/public/",
+    "scripts",
+    "eslint.config.ts",
+    "vitest.config.js"
+  ]
+}

package/lib/project-files/vitest.config.mts

@@ -1,18 +1,18 @@
-import { defineConfig } from 'vitest/config';
-import path from 'path';
-
-const config = defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    setupFiles: ['config.ts', './tests/aux/setup.ts'],
-    isolate: true,
-  },
-  resolve: {
-    alias: {
-      '@src': path.resolve(__dirname, './src'),
-    },
-  },
-});
-
-export default config;
+import path from 'path';
+import { defineConfig } from 'vitest/config';
+
+const config = defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    setupFiles: ['config.ts', './tests/support/agent.ts'],
+    isolate: true,
+  },
+  resolve: {
+    alias: {
+      '@src': path.resolve(__dirname, './src'),
+    },
+  },
+});
+
+export default config;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.7.10",
+  "version": "2.7.12",
   "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/src/common/constants/HTTP_STATUS_CODES.ts

@@ -1,81 +0,0 @@
-/* eslint-disable max-len */
-
-import { ValueOf } from 'jet-validators';
-
-
-/**
- * Hypertext Transfer Protocol (HTTP) response status codes.
- * @see {@link https://en.wikipedia.org/wiki/List_of_HTTP_status_codes}
- * 
- * This file was copied from here: https://gist.github.com/scokmen/f813c904ef79022e84ab2409574d1b45
- */
-const HTTP_STATUS_CODES = {
-  Continue: 100,
-  SwitchingProtocols: 101,
-  Processing: 102,
-  Ok: 200,
-  Created: 201,
-  Accepted: 202,
-  NonAuthoritativeInformation: 203,
-  NoContent: 204,
-  ResetContent: 205,
-  PartialContent: 206,
-  MultiStatus: 207,
-  AlreadyReported: 208,
-  ImUsed: 226,
-  MultipleChoices: 300,
-  MovedPermanently: 301,
-  Found: 302,
-  SeeOther: 303,
-  NotModified: 304,
-  UseProxy: 305,
-  SwitchProxy: 306,
-  TemporaryRedirect: 307,
-  PermanentRedirect: 308,
-  BadRequest: 400,
-  Unauthorized: 401,
-  PaymentRequired: 402,
-  Forbidden: 403,
-  NotFound: 404,
-  MethodNotAllowed: 405,
-  NotAcceptable: 406,
-  ProxyAuthenticationRequired: 407,
-  RequestTimeout: 408,
-  Conflict: 409,
-  Gone: 410,
-  LengthRequired: 411,
-  PreconditionFailed: 412,
-  PayloadTooLarge: 413,
-  UriTooLong: 414,
-  UnsupportedMediaType: 415,
-  RangeNotSatisfiable: 416,
-  ExpectationFailed: 417,
-  IamaTeapot: 418,
-  MisdirectedRequest: 421,
-  UnprocessableEntity: 422,
-  Locked: 423,
-  FailedDependency: 424,
-  UpgradeRequired: 426,
-  PreconditionRequired: 428,
-  TooManyRequests: 429,
-  RequestHeaderFieldsTooLarge: 431,
-  UnavailableForLegalReasons: 451,
-  InternalServerError: 500,
-  NotImplemented: 501,
-  BadGateway: 502,
-  ServiceUnavailable: 503,
-  GatewayTimeout: 504,
-  HttpVersionNotSupported: 505,
-  VariantAlsoNegotiates: 506,
-  InsuffientStorage: 507,
-  LoopDetected: 508,
-  NotExtended: 510,
-  NetworkAuthenticationRequired: 511,
-} as const;
-
-/******************************************************************************
-                            Export default
-******************************************************************************/
-
-export type HttpStatusCodes = ValueOf<typeof HTTP_STATUS_CODES>;
-export default HTTP_STATUS_CODES;

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

@@ -1,11 +0,0 @@
-
-/******************************************************************************
-                              Constants
-******************************************************************************/
-
-// NOTE: These need to match the names of your ".env" files
-export const NODE_ENVS = {
-  Dev: 'development',
-  Test: 'test',
-  Production: 'production',
-} as const;

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

@@ -1 +0,0 @@
-{"users":[{"id":169238117092,"name":"Bill","email":"sean.maxwell@gmail.com","created":"2026-01-01T23:26:38.953Z"},{"id":463030566103,"name":"John Smith","email":"john.smith@gmail.com","created":"2026-01-01T23:26:38.953Z"},{"id":420935775197,"name":"Gordan Freeman","email":"gordan.freeman@gmail.com","created":"2026-01-01T23:26:38.953Z"}]}

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

@@ -1,10 +0,0 @@
-import { Response, Request } from 'express';
-
-/******************************************************************************
-                                Types
-******************************************************************************/
-
-type TRecord = Record<string, unknown>;
-export type IReq = Request<TRecord, void, TRecord, TRecord>;
-export type IRes = Response<unknown, TRecord>;
-