express-generator-typescript 2.8.1 → 2.9.0

package/lib/template/tests/users.test.ts

@@ -0,0 +1,205 @@
+import jetid from 'jet-id';
+
+import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import Paths from '@src/common/constants/Paths';
+import { ValidationError } from '@src/common/utils/route-errors';
+import User, { IUser } from '@src/models/User.model';
+import UserRepo from '@src/repos/UserRepo';
+import UserService from '@src/services/UserService';
+
+import { compareUserArrays } from './common/comparators';
+import { TestRes } from './common/supertest-types';
+import { agent } from './support/agent';
+
+// ========================================================================= //
+//                                 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, INTERNAL_SERVER_ERROR, 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);
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+  });
+
+  // ---- `Get`
+  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: TestRes<{ users: IUser[] }> = await agent.get(
+          Paths.Users.Get(),
+        );
+        expect(res.status).toBe(OK);
+        expect(compareUserArrays(res.body.users, DUMMY_USERS)).toBeTruthy();
+      },
+    );
+
+    it(
+      `should return a JSON error and a status code of ` +
+        `"${INTERNAL_SERVER_ERROR}" if an unexpected error is thrown.`,
+      async () => {
+        vi.spyOn(UserService, 'getAll').mockRejectedValueOnce(
+          new Error('boom'),
+        );
+        const res: TestRes = await agent.get(Paths.Users.Get());
+        expect(res.status).toBe(INTERNAL_SERVER_ERROR);
+        expect(res.body.error).toBe('Internal Server Error');
+      },
+    );
+  });
+
+  // ---- `Add`
+  describe(`"POST:${Paths.Users.Add()}"`, () => {
+    it(
+      `should return a status code of "${CREATED}" and persist the user ` +
+        'with a server-generated id if the request was successful.',
+      async () => {
+        // Same payload shape the front-end sends
+        const input = { name: 'a', email: 'a@a.com' };
+        const res: TestRes<{ user: IUser }> = await agent
+          .post(Paths.Users.Add())
+          .send({ user: input });
+        expect(res.status).toBe(CREATED);
+        expect(User.isId(res.body.user.id)).toBe(true);
+        const all = await UserRepo.getAll();
+        expect(all).toHaveLength(DUMMY_USERS.length + 1);
+        expect(all).toContainEqual(res.body.user);
+      },
+    );
+
+    it(
+      'should return a JSON object with an error message and a status ' +
+        `code of "${BAD_REQUEST}" if the user param was missing.`,
+      async () => {
+        const res: TestRes = await agent
+          .post(Paths.Users.Add())
+          .send({ user: null });
+        expect(res.status).toBe(BAD_REQUEST);
+        expect(res.body.error).toBe(ValidationError.MESSAGE);
+        expect(res.body.errors?.[0].key).toStrictEqual('user');
+      },
+    );
+
+    it(
+      `should return a status code of "${BAD_REQUEST}" if the name is ` +
+        'empty.',
+      async () => {
+        const res: TestRes = await agent
+          .post(Paths.Users.Add())
+          .send({ user: { name: '', email: 'a@a.com' } });
+        expect(res.status).toBe(BAD_REQUEST);
+        expect(await UserRepo.getAll()).toHaveLength(DUMMY_USERS.length);
+      },
+    );
+  });
+
+  // ---- `Update`
+  describe(`"PUT:${Paths.Users.Update()}"`, () => {
+    it(
+      `should return a status code of "${OK}" and save the change if the ` +
+        'request was successful.',
+      async () => {
+        const user = { ...dbUsers[0], name: 'Bill' };
+        const res = await agent.put(Paths.Users.Update()).send({ user });
+        expect(res.status).toBe(OK);
+        const saved = (await UserRepo.getAll()).find((u) => u.id === user.id);
+        expect(saved?.name).toBe('Bill');
+      },
+    );
+
+    it(
+      'should return a JSON object with an error message and a status code ' +
+        `of "${BAD_REQUEST}" if id is not a valid id`,
+      async () => {
+        const user = { ...User.new(), name: 'a', email: 'a@a.com', id: '5' };
+        const res: TestRes = await agent
+          .put(Paths.Users.Update())
+          .send({ user });
+        expect(res.status).toBe(BAD_REQUEST);
+        expect(res.body.error).toBe(ValidationError.MESSAGE);
+        expect(res.body.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: jetid(), name: 'a', email: 'a@a.com' }),
+          res: TestRes = await agent.put(Paths.Users.Update()).send({ user });
+        expect(res.status).toBe(NOT_FOUND);
+        expect(res.body.error).toBe(UserService.Errors.USER_NOT_FOUND);
+      },
+    );
+  });
+
+  // ---- `Delete`
+  describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
+    it(
+      `should return a status code of "${OK}" and remove the user if the ` +
+        'request was successful.',
+      async () => {
+        const id = dbUsers[0].id,
+          res = await agent.delete(Paths.Users.Delete({ id }));
+        expect(res.status).toBe(OK);
+        expect(await UserRepo.persists(id)).toBe(false);
+      },
+    );
+
+    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: TestRes = await agent.delete(
+          Paths.Users.Delete({ id: jetid() }),
+        );
+        expect(res.status).toBe(NOT_FOUND);
+        expect(res.body.error).toBe(UserService.Errors.USER_NOT_FOUND);
+      },
+    );
+
+    it(
+      `should return a status code of "${BAD_REQUEST}" if the id is not a ` +
+        'valid id.',
+      async () => {
+        const res = await agent.delete(Paths.Users.Delete({ id: -1 }));
+        expect(res.status).toBe(BAD_REQUEST);
+      },
+    );
+
+    it(
+      `should return a status code of "${BAD_REQUEST}" if the id query ` +
+        'param is missing.',
+      async () => {
+        const res: TestRes = await agent.delete(Paths.Users.Delete());
+        expect(res.status).toBe(BAD_REQUEST);
+        expect(res.body.errors?.[0].key).toStrictEqual('id');
+      },
+    );
+  });
+});

package/lib/{project-files → template}/tsconfig.json

@@ -4,12 +4,11 @@
     "module": "commonjs",
     "lib": ["ES2020"],
     "strict": true,
-    "baseUrl": "./",
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "paths": {
-      "@src/*": ["src/*"]
+      "@src/*": ["./src/*"]
     },
     "useUnknownInCatchVariables": false,
     "types": ["vitest/globals"]
@@ -21,7 +20,6 @@
   "include": [
     "src/**/*.ts",
     "tests/**/*.ts",
-    "scripts",
     "eslint.config.ts",
     "vitest.config.mts"
   ],

package/lib/{project-files → template}/tsconfig.prod.json

@@ -4,24 +4,18 @@
     "module": "CommonJS",
     "lib": ["ES2020"],
     "strict": true,
-    "baseUrl": "./",
+    "rootDir": "./src",
     "outDir": "dist",
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "paths": {
-      "@src/*": ["src/*"]
+      "@src/*": ["./src/*"]
     },
     "useUnknownInCatchVariables": false,
     "sourceMap": false,
     "removeComments": true
   },
   "include": ["src/**/*.ts"],
-  "exclude": [
-    "tests",
-    "src/public/",
-    "scripts",
-    "eslint.config.ts",
-    "vitest.config.js"
-  ]
+  "exclude": ["src/public/"]
 }

package/lib/{project-files → template}/vitest.config.mts

@@ -7,6 +7,8 @@ const config = defineConfig({
     environment: 'node',
     setupFiles: ['dotenv/config', './tests/support/agent.ts'],
     isolate: true,
+    // All test files share one JSON database file, so run them one at a time
+    fileParallelism: false,
     env: {
       DOTENV_CONFIG_PATH: 'config/.env.test',
     },

package/package.json

@@ -1,52 +1,69 @@
-{
-  "name": "express-generator-typescript",
-  "version": "2.8.1",
-  "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",
-    "pre-publish": "mv README.md README-git && mv README-npm README.md",
-    "post-publish": "mv README.md README-npm && mv README-git README.md",
-    "start": "node bin/cli.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "main": "lib/cli.js",
-  "bin": {
-    "express-generator-typescript": "bin/cli.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/seanpmaxwell/express-generator-typescript.git"
-  },
-  "keywords": [
-    "express",
-    "express-generator",
-    "express-generator-typescript",
-    "typescript",
-    "typescript-express",
-    "api",
-    "rest",
-    "rest-api",
-    "scaffold",
-    "scaffolding",
-    "cli",
-    "generator",
-    "nodejs",
-    "backend",
-    "boilerplate",
-    "starter",
-    "template",
-    "express-ts",
-    "server",
-    "tooling"
-  ],
-  "author": "sean maxwell",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/seanpmaxwell/express-generator-typescript/issues"
-  },
-  "homepage": "https://github.com/seanpmaxwell/express-generator-typescript#readme",
-  "dependencies": {
-    "edit-json-file": "^1.7.0",
-    "ncp": "^2.0.0"
-  }
-}
+{
+  "name": "express-generator-typescript",
+  "version": "2.9.0",
+  "description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
+  "scripts": {
+    "commit": "git add -A && git commit -m \"dev commit\"",
+    "commit:push": "npm run commit && git push",
+    "install:clean": "rm -rf node_modules && rm -rf package-lock.json && npm i",
+    "prepack": "npm run readme:swap",
+    "postpack": "npm run readme:restore",
+    "readme:swap": "node scripts/readme.js swap",
+    "readme:restore": "node scripts/readme.js restore",
+    "test": "node --test \"tests/**/*.test.js\"",
+    "test:e2e": "node scripts/e2e.js"
+  },
+  "main": "lib/express-generator-typescript.js",
+  "bin": {
+    "express-generator-typescript": "bin/cli.js"
+  },
+  "files": [
+    "bin/",
+    "lib/",
+    "!lib/template/node_modules/",
+    "!lib/template/package-lock.json",
+    "!lib/template/dist/",
+    "!lib/template/.vscode/",
+    "!lib/template/tsconfig.tsbuildinfo",
+    "!lib/template/**/*.log",
+    "!lib/template/src/repos/common/database.test.json"
+  ],
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/seanpmaxwell/express-generator-typescript.git"
+  },
+  "keywords": [
+    "express",
+    "express-generator",
+    "express-generator-typescript",
+    "typescript",
+    "typescript-express",
+    "api",
+    "rest",
+    "rest-api",
+    "scaffold",
+    "scaffolding",
+    "cli",
+    "generator",
+    "nodejs",
+    "backend",
+    "boilerplate",
+    "starter",
+    "template",
+    "express-ts",
+    "express5",
+    "server",
+    "tooling",
+    "vitest",
+    "eslint"
+  ],
+  "author": "sean maxwell",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/seanpmaxwell/express-generator-typescript/issues"
+  },
+  "homepage": "https://github.com/seanpmaxwell/express-generator-typescript#readme"
+}

package/lib/cli.js

@@ -1,33 +0,0 @@
-#!/usr/bin/env node
-
-const path = require('path'),
-  expressGenTs = require('../lib/express-generator-typescript');
-
-
-/******************************************************************************
-                                 Run
-******************************************************************************/
-
-// Init
-console.log('Setting up new Express/TypeScript project...');
-const args = process.argv.slice(2);
-
-// Setup use yarn
-let useYarn = false;
-const useYarnIdx = args.indexOf('--use-yarn');
-if (useYarnIdx > -1) {
-  useYarn = true;
-  args.splice(useYarnIdx, 1);
-}
-
-// Setup destination
-let destination = 'express-gen-ts';
-if (args.length > 0) {
-  destination = args[0];
-}
-destination = path.join(process.cwd(), destination);
-
-// Creating new project finished
-expressGenTs(destination, useYarn).then(() => {
-  console.log('Project setup complete!');
-});

package/lib/project-files/README.md

@@ -1,39 +0,0 @@
-## About
-
-This project was created with [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript).
-
-## Available Scripts
-
-### `npm run clean-install`
-
-Remove the existing `node_modules/` folder, `package-lock.json`, and reinstall all library modules.
-
-### `npm run dev` 
-
-Run the server in development with hot reloading and browser refresh (see `package.json` for all `npm run dev` variations)<br/>
-
-**IMPORTANT** development mode uses `swc` for performance reasons which DOES NOT check for typescript errors. Run `npm run type-check` to check for type errors. NOTE: you should use your IDE to prevent most type errors.
-
-### `npm test`
-
-Run unit-tests with <a href="https://vitest.dev/guide/">vitest</a>.
-
-### `npm run lint`
-
-Check for linting errors.
-
-### `npm run build`
-
-Build the project for production.
-
-### `npm start`
-
-Run the production build (Must be built first).
-
-### `npm run type-check`
-
-Check for typescript errors.
-
-## Additional Notes
-
-- If `npm run dev` gives you issues with bcrypt on MacOS you may need to run: `npm rebuild bcrypt --build-from-source`.

package/lib/project-files/gitignore

@@ -1,4 +0,0 @@
-**/node_modules
-dist/
-**/**/*.log
-tsconfig.tsbuildinfo

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

@@ -1,15 +0,0 @@
-import jetPaths from 'jet-paths';
-
-const Paths = {
-  _: '/api',
-  Users: {
-    _: '/users',
-    Get: '/all',
-    Add: '/add',
-    Update: '/update',
-    Delete: '/delete/:id',
-  },
-} as const;
-
-export const JetPaths = jetPaths(Paths);
-export default Paths;

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

@@ -1,28 +0,0 @@
-import jetEnv, { num } from 'jet-env';
-import tspo from 'tspo';
-
-/******************************************************************************
-                                 Constants
-******************************************************************************/
-
-// NOTE: These need to match the names of your ".env" files
-export const NodeEnvs = {
-  DEV: 'development',
-  TEST: 'test',
-  PRODUCTION: 'production',
-} as const;
-
-/******************************************************************************
-                                 Setup
-******************************************************************************/
-
-const EnvVars = jetEnv({
-  NodeEnv: (v) => tspo.isValue(NodeEnvs, v),
-  Port: num,
-});
-
-/******************************************************************************
-                            Export default
-******************************************************************************/
-
-export default EnvVars;

package/lib/project-files/src/common/types/structure-utils.ts

@@ -1,2 +0,0 @@
-export type ValueOf<T> = T[keyof T];
- 

package/lib/project-files/src/common/utils/number-utils.ts

@@ -1,10 +0,0 @@
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Get a random number between 1 and 1,000,000,000,000
- */
-export function getRandomInt(): number {
-  return Math.floor(Math.random() * 1_000_000_000_000);
-}

package/lib/project-files/src/common/utils/route-errors.ts

@@ -1,35 +0,0 @@
-import { ParseError } from 'jet-validators/utils';
-
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-
-/******************************************************************************
-                                 Classes
-******************************************************************************/
-
-/**
- * Error with status code and message.
- */
-export class RouteError extends Error {
-  public status: HttpStatusCodes;
-
-  public constructor(status: HttpStatusCodes, message: string) {
-    super(message);
-    this.status = status;
-  }
-}
-
-/**
- * Handle "parseObj" errors.
- */
-export class ValidationError extends RouteError {
-  public static MESSAGE =
-    'The parseObj() function discovered one or ' + 'more errors.';
-
-  public constructor(errors: ParseError[]) {
-    const msg = JSON.stringify({
-      message: ValidationError.MESSAGE,
-      errors,
-    });
-    super(HttpStatusCodes.BAD_REQUEST, msg);
-  }
-}

package/lib/project-files/src/common/utils/validators.ts

@@ -1,14 +0,0 @@
-import { isDate } from 'jet-validators';
-import { transform } from 'jet-validators/utils';
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Convert to date object then check is a validate date.
- */
-export const transformIsDate = transform(
-  (arg) => new Date(arg as string),
-  (arg) => isDate(arg),
-);

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

@@ -1,24 +0,0 @@
-import logger from 'jet-logger';
-
-import EnvVars from './common/constants/env';
-import server from './server';
-
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-const SERVER_START_MESSAGE =
-  'Express server started on port: ' + EnvVars.Port.toString();
-
-/******************************************************************************
-                                  Run
-******************************************************************************/
-
-// Start the server
-server.listen(EnvVars.Port, (err) => {
-  if (!!err) {
-    logger.err(err.message);
-  } else {
-    logger.info(SERVER_START_MESSAGE);
-  }
-});