express-generator-typescript 2.8.1 → 2.9.1

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

@@ -1,63 +0,0 @@
-import jsonfile from 'jsonfile';
-import tspo from 'tspo';
-
-import EnvVars, { NodeEnvs } from '@src/common/constants/env';
-import { IUser } from '@src/models/User.model';
-
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-const DATABASE_FILE_PATH =
-  __dirname +
-  '/common' +
-  (EnvVars.NodeEnv === NodeEnvs.TEST
-    ? '/database.test.json'
-    : '/database.json');
-
-/******************************************************************************
-                                Types
-******************************************************************************/
-
-type Database = {
-  users: IUser[];
-};
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Fetch the json from the file.
- */
-async function openDb(): Promise<Database> {
-  const db = await (jsonfile.readFile(DATABASE_FILE_PATH) as Promise<Database>);
-  if (!('users' in db)) {
-    return tspo.addEntry(db, ['users', []]);
-  }
-  return db;
-}
-
-/**
- * Update the file.
- */
-function saveDb(db: Database): Promise<void> {
-  return jsonfile.writeFile(DATABASE_FILE_PATH, db);
-}
-
-/**
- * Empty the database
- */
-function cleanDb(): Promise<void> {
-  return jsonfile.writeFile(DATABASE_FILE_PATH, {});
-}
-
-/******************************************************************************
-                                Export default
-******************************************************************************/
-
-export default {
-  openDb,
-  saveDb,
-  cleanDb,
-} as const;

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

@@ -1 +0,0 @@
-{"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 +0,0 @@
-{"users":[{"id":8930741536,"name":"Bill","email":"sean.maxwell@gmail.com","created":"2026-03-21T05:35:26.766Z"},{"id":59836411208,"name":"John Smith","email":"john.smith@gmail.com","created":"2026-03-21T05:35:26.766Z"},{"id":924320326056,"name":"Gordan Freeman","email":"gordan.freeman@gmail.com","created":"2026-03-21T05:35:26.766Z"}]}

package/lib/project-files/src/routes/apiRouter.ts

@@ -1,28 +0,0 @@
-import { Router } from 'express';
-
-import Paths from '@src/common/constants/Paths';
-
-import UserRoutes from './UserRoutes';
-
-/******************************************************************************
-                                Setup
-******************************************************************************/
-
-const apiRouter = Router();
-
-// ----------------------- Add UserRouter --------------------------------- //
-
-const userRouter = Router();
-
-userRouter.get(Paths.Users.Get, UserRoutes.getAll);
-userRouter.post(Paths.Users.Add, UserRoutes.add);
-userRouter.put(Paths.Users.Update, UserRoutes.update);
-userRouter.delete(Paths.Users.Delete, UserRoutes.delete);
-
-apiRouter.use(Paths.Users._, userRouter);
-
-/******************************************************************************
-                                Export
-******************************************************************************/
-
-export default apiRouter;

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

@@ -1,8 +0,0 @@
-import { Request, Response } from 'express';
-
-/******************************************************************************
-                                Types
-******************************************************************************/
-
-export type Req = Request<Record<string, string>, void, Record<string, string>>;
-export type Res = Response;

package/lib/project-files/src/routes/common/parseReq.ts

@@ -1,19 +0,0 @@
-import { parseObject, Schema } from 'jet-validators/utils';
-
-import { ValidationError } from '@src/common/utils/route-errors';
-
-/******************************************************************************
-                              Functions
-******************************************************************************/
-
-/**
- * Throw a "ParseObjError" when "parseObject" fails. Also extract a nested
- * "ParseObjError" and add it to the nestedErrors array.
- */
-function parseReq<U extends Schema>(schema: U) {
-  return parseObject(schema, (errors) => {
-    throw new ValidationError(errors);
-  });
-}
-
-export default parseReq;

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

@@ -1,73 +0,0 @@
-import express, { NextFunction, Request, Response } from 'express';
-import helmet from 'helmet';
-import logger from 'jet-logger';
-import morgan from 'morgan';
-import path from 'path';
-
-import Paths from '@src/common/constants/Paths';
-import { RouteError } from '@src/common/utils/route-errors';
-import BaseRouter from '@src/routes/apiRouter';
-
-import EnvVars, { NodeEnvs } from './common/constants/env';
-
-/******************************************************************************
-                                Setup
-******************************************************************************/
-
-const app = express();
-
-// **** Middleware **** //
-
-// Basic middleware
-app.use(express.json());
-app.use(express.urlencoded({ extended: true }));
-
-// Show routes called in console during development
-if (EnvVars.NodeEnv === NodeEnvs.DEV) {
-  app.use(morgan('dev'));
-}
-
-// Security
-if (EnvVars.NodeEnv === NodeEnvs.PRODUCTION) {
-  app.use(helmet());
-}
-
-// Add APIs, must be after middleware
-app.use(Paths._, BaseRouter);
-
-// Add error handler
-app.use((err: Error, _: Request, res: Response, next: NextFunction) => {
-  if (EnvVars.NodeEnv !== NodeEnvs.TEST.valueOf()) {
-    logger.err(err, true);
-  }
-  if (err instanceof RouteError) {
-    res.status(err.status).json({ error: err.message });
-  }
-  return next(err);
-});
-
-// **** FrontEnd Content **** //
-
-// Set views directory (html)
-const viewsDir = path.join(__dirname, 'views');
-app.set('views', viewsDir);
-
-// Set static directory (js and css).
-const staticDir = path.join(__dirname, 'public');
-app.use(express.static(staticDir));
-
-// Nav to users pg by default
-app.get('/', (_: Request, res: Response) => {
-  return res.redirect('/users');
-});
-
-// Redirect to login if not logged in.
-app.get('/users', (_: Request, res: Response) => {
-  return res.sendFile('users.html', { root: viewsDir });
-});
-
-/******************************************************************************
-                                Export default
-******************************************************************************/
-
-export default app;

package/lib/project-files/src/services/UserService.ts

@@ -1,64 +0,0 @@
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-import { RouteError } from '@src/common/utils/route-errors';
-import { IUser } from '@src/models/User.model';
-import UserRepo from '@src/repos/UserRepo';
-
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-const Errors = {
-  USER_NOT_FOUND: 'User not found',
-} as const;
-
-/******************************************************************************
-                                Functions
-******************************************************************************/
-
-/**
- * Get all users.
- */
-function getAll(): Promise<IUser[]> {
-  return UserRepo.getAll();
-}
-
-/**
- * Add one user.
- */
-function addOne(user: IUser): Promise<void> {
-  return UserRepo.add(user);
-}
-
-/**
- * Update one user.
- */
-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);
-  }
-  return UserRepo.update(user);
-}
-
-/**
- * Delete a user by their id.
- */
-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);
-  }
-  return UserRepo.delete(id);
-}
-
-/******************************************************************************
-                                Export default
-******************************************************************************/
-
-export default {
-  Errors,
-  getAll,
-  addOne,
-  updateOne,
-  delete: deleteOne,
-} as const;

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

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

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

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

package/lib/project-files/tests/support/agent.ts

@@ -1,23 +0,0 @@
-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,131 +0,0 @@
-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.model';
-import UserRepo from '@src/repos/UserRepo';
-
-import { agent } from './support/agent';
-import { TestRes } 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: TestRes<{ 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: TestRes = 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: TestRes = 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: 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);
-      },
-    );
-  });
-
-  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: TestRes = await agent.delete(Paths.Users.Delete({ id: -1 }));
-        expect(res.status).toBe(NOT_FOUND);
-        expect(res.body.error).toBe(UserService.Errors.USER_NOT_FOUND);
-      },
-    );
-  });
-});