express-generator-typescript 2.7.11 → 2.7.14

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_ERROR } from '@src/services/UserService/constants';
-
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-import { ValidationError } from '@src/common/utils/route-errors';
-import { JetPaths 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 {
-  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: 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 "${BAD_REQUEST}" if the user param was missing.`, async () => {
-      const res: TRes = 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: TRes = 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 ' + 
-    `"${USER_NOT_FOUND_ERROR}" 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: TRes = await agent.put(Paths.Users.Update).send({ user });
-      expect(res.status).toBe(NOT_FOUND);
-      expect(res.body.error).toBe(USER_NOT_FOUND_ERROR);
-    });
-  });
-
-  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_ERROR}" and a status code of "${NOT_FOUND}" if the ` + 
-    'id was not found.', async () => {
-      const res: TRes = await agent.delete(Paths.Users.Delete(-1));
-      expect(res.status).toBe(NOT_FOUND);
-      expect(res.body.error).toBe(USER_NOT_FOUND_ERROR);
-    });
-  });
-});
+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,29 @@
-{
-  "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", "dotenv/config"],
+  },
+  "include": [
+    "src/**/*.ts",
+    "tests/**/*.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": "dist",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@src/*": ["src/*"]
+    },
+    "useUnknownInCatchVariables": false,
+    "sourceMap": false,
+    "removeComments": true
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": [
+    "tests",
+    "src/public/",
+    "scripts",
+    "eslint.config.ts",
+    "vitest.config.js"
+  ]
+}

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

@@ -1,18 +1,21 @@
-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: ['dotenv/config', './tests/support/agent.ts'],
+    isolate: true,
+    env: {
+      DOTENV_CONFIG_PATH: 'config/.env.test',
+    },
+  },
+  resolve: {
+    alias: {
+      '@src': path.resolve(__dirname, './src'),
+    },
+  },
+});
+
+export default config;

package/package.json

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

@@ -1,22 +0,0 @@
-/* eslint-disable n/no-process-env */
-
-import path from 'path';
-import dotenv from 'dotenv';
-import moduleAlias from 'module-alias';
-
-
-// Check the env
-const NODE_ENV = (process.env.NODE_ENV ?? 'development');
-
-// Configure "dotenv"
-const result2 = dotenv.config({
-  path: path.join(__dirname, `./config/.env.${NODE_ENV}`),
-});
-if (result2.error) {
-  throw result2.error;
-}
-
-// Configure moduleAlias
-if (__filename.endsWith('js')) {
-  moduleAlias.addAlias('@src', __dirname + '/dist');
-}

package/lib/project-files/scripts/build.ts

@@ -1,28 +0,0 @@
-import logger from 'jet-logger';
-import { copy, copyFilesRec, exec, remove } from './common/utils';
-
-/******************************************************************************
-                                  Run
-******************************************************************************/
-
-/**
- * Start
- */
-(async () => {
-  try {
-    // Remove current build
-    await remove('./dist/');
-    await exec('npm run lint', '../');
-    await exec('tsc --project tsconfig.prod.json', '../');
-    // Copy
-    await copyFilesRec('./src', './dist', ['.ts']);
-    await copy('./temp/config.js', './config.js');
-    await copy('./temp/src', './dist');
-    await remove('./temp/');
-  } catch (err) {
-    logger.err(err);
-    // eslint-disable-next-line n/no-process-exit
-    process.exit(1);
-  }
-})();
-