express-generator-typescript 2.7.7 → 2.7.8

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

@@ -1,86 +0,0 @@
-import morgan from 'morgan';
-import path from 'path';
-import helmet from 'helmet';
-import express, { Request, Response, NextFunction } from 'express';
-import logger from 'jet-logger';
-
-import BaseRouter from '@src/routes';
-
-import Paths from '@src/common/constants/PATHS';
-import ENV from '@src/common/constants/ENV';
-import HTTP_STATUS_CODES, {
-  HttpStatusCodes,
-} from '@src/common/constants/HTTP_STATUS_CODES';
-import { RouteError } from '@src/common/util/route-errors';
-import { NODE_ENVS } from '@src/common/constants';
-
-
-/******************************************************************************
-                                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 (ENV.NodeEnv === NODE_ENVS.Dev) {
-  app.use(morgan('dev'));
-}
-
-// Security
-if (ENV.NodeEnv === NODE_ENVS.Production) {
-  // eslint-disable-next-line n/no-process-env
-  if (!process.env.DISABLE_HELMET) {
-    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 (ENV.NodeEnv !== NODE_ENVS.Test.valueOf()) {
-    logger.err(err, true);
-  }
-  let status: HttpStatusCodes = HTTP_STATUS_CODES.BadRequest;
-  if (err instanceof RouteError) {
-    status = err.status;
-    res.status(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,70 +0,0 @@
-import { RouteError } from '@src/common/util/route-errors';
-import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
-
-import UserRepo from '@src/repos/UserRepo';
-import { IUser } from '@src/models/User';
-
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-export const USER_NOT_FOUND_ERR = 'User not found';
-
-/******************************************************************************
-                                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(
-      HTTP_STATUS_CODES.NotFound,
-      USER_NOT_FOUND_ERR,
-    );
-  }
-  // Return user
-  return UserRepo.update(user);
-}
-
-/**
- * Delete a user by their id.
- */
-async function _delete(id: number): Promise<void> {
-  const persists = await UserRepo.persists(id);
-  if (!persists) {
-    throw new RouteError(
-      HTTP_STATUS_CODES.NotFound,
-      USER_NOT_FOUND_ERR,
-    );
-  }
-  // Delete user
-  return UserRepo.delete(id);
-}
-
-/******************************************************************************
-                                Export default
-******************************************************************************/
-
-export default {
-  getAll,
-  addOne,
-  updateOne,
-  delete: _delete,
-} as const;

package/lib/project-files/src/views/users.html

@@ -1,132 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-
-  <!-- Head -->
-  <head>
-    <meta charset="UTF-8">
-    <title>Users</title>
-    <link rel="stylesheet" type="text/css" href="/stylesheets/users.css" />
-
-    <!-- Handlebars -->
-    <script src="http://cdnjs.cloudflare.com/ajax/libs/handlebars.js/4.7.8/handlebars.min.js"></script>
-
-    <!-- Bootstrap -->
-    <link
-      href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
-      rel="stylesheet"
-      integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
-      crossorigin="anonymous"
-    />
-    <script
-      src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
-      integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
-      crossorigin="anonymous"
-    ></script>
-  </head>
-
-  <!-- Body -->
-  <body>
-
-    <!-- Add Users -->
-    <div class="users-column add-user-col">
-      <div class="column-header">
-        Add User:
-      </div>
-      <div>
-        <input
-          id="name-input"
-          type="text"
-          class="form-control"
-          placeholder="Name"
-        />
-      </div>
-      <div>
-        <input
-          id="email-input"
-          type="email"
-          class="form-control"
-          placeholder="Email"
-        />
-      </div>
-      <div>
-        <button
-          id="add-user-btn"
-          class="btn btn-success"
-        >
-          Add
-        </button>
-      </div>
-    </div>
-
-    <!-- Display Users -->
-    <div class="users-column">
-      <div class="column-header">
-        Users:
-      </div>
-
-      <div id="all-users-anchor"></div>
-      <script
-        id="all-users-template"
-        type="text/x-handlebars-template"
-      >
-        {{#each users}}
-          <div class="user-display-ele">
-            <div class="normal-view">
-              <div><b>Name:</b> {{name}}</div>
-              <div><b>Email:</b> {{email}}</div>
-              <div><b>Created:</b> {{createdFormatted}}</div>
-              <button
-                type="button"
-                class="btn btn-primary edit-user-btn"
-                data-user-id="{{id}}"
-              >
-                Edit
-              </button>
-              <button
-                class="btn btn-danger delete-user-btn"
-                data-user-id="{{id}}"
-              >
-                Delete
-              </button>
-            </div>
-
-            <div class="edit-view">
-              <div>
-                Name:&nbsp;
-                <input
-                  type="text"
-                  class="form-control name-edit-input"
-                  value="{{name}}"
-                />
-              </div>
-              <div class="email-edit">
-                Email:&nbsp;
-                <input
-                  type="email"
-                  class="form-control email-edit-input"
-                  value="{{email}}"
-                />
-              </div>
-              <button
-                class="btn btn-primary submit-edit-btn"
-                data-user-id="{{id}}"
-                data-user-created="{{created}}"
-              >
-                Submit
-              </button>
-              <button
-                class="btn btn-secondary cancel-edit-btn"
-                data-user-id="{{id}}"
-              >
-                Cancel
-              </button>
-            </div>
-          </div>
-        {{/each}}
-      </script>
-    </div>
-  </body>
-
-  <script src="scripts/http.js"></script>
-  <script src="scripts/users.js"></script>
-</html>

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

@@ -1,16 +0,0 @@
-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;
-}

package/lib/project-files/tests/common/util/index.ts

@@ -1,55 +0,0 @@
-import { IParseObjectError, parseJson } from 'jet-validators/utils';
-import { isString } from 'jet-validators';
-import { IUser } from '@src/models/User';
-
-/******************************************************************************
-                                Types
-******************************************************************************/
-
-type TUserArray = IUser[] | readonly IUser[];
-
-interface IValidationError {
-  message: string;
-  errors: IParseObjectError[];
-}
-
-/******************************************************************************
-                                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);
-}
-
-/**
- * Compare to user arrays. Order does not matter and this assumes the email 
- * field is unique
- */
-export function compareUserArrays(a: TUserArray, b: TUserArray): boolean {
-  if (a.length !== b.length) return false;
-  const aSorted = sortByEmail(a);
-  const bSorted = sortByEmail(b);
-  for (let i = 0; i < aSorted.length; i++) {
-    const a = aSorted[i],
-      b = bSorted[i];
-    if (a.email !== b.email || a.name !== b.name) {
-      return false;
-    }
-  }
-  return true;
-}
-
-/**
- * Sort user array by email.
- */
-function sortByEmail(arr: TUserArray): IUser[] {
-  return [...arr].sort((x, y) => {
-    return x.email.localeCompare(y.email);
-  });
-}

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

@@ -1,26 +0,0 @@
-
-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 };

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

@@ -1,138 +0,0 @@
-import insertUrlParams from 'inserturlparams';
-
-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/util';
-import { agent } from './support/setup';
-import { TRes } from './common/types';
-
-/******************************************************************************
-                               Constants
-******************************************************************************/
-
-// Dummy users for GET req
-const DB_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;
-
-/******************************************************************************
-                                 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[] = [];
-
-  // Run before all tests
-  beforeEach(async () => {
-    await UserRepo.deleteAllUsers();
-    dbUsers = await UserRepo.insertMult(DB_USERS);
-  });
-
-  // Get all users
-  describe(`"GET:${Paths.Users.Get}"`, () => {
-
-    // Success
-    it('should return a JSON object with all the users and a status code ' + 
-    `of "${HTTP_STATUS_CODES.Ok}" if the request was successful.`, async () => {
-      const res: TRes<{ users: IUser[]}> = await agent.get(Paths.Users.Get);
-      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
-      expect(compareUserArrays(res.body.users, DB_USERS)).toBeTruthy();
-    });
-  });
-
-  // Test add user
-  describe(`"POST:${Paths.Users.Add}"`, () => {
-
-    // Test add user success
-    it(`should return a status code of "${HTTP_STATUS_CODES.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(HTTP_STATUS_CODES.Created);
-    });
-
-    // Missing param
-    it('should return a JSON object with an error message of and a status ' + 
-      `code of "${HTTP_STATUS_CODES.BadRequest}" if the user param was ` + 
-      'missing.', async () => {
-      const res: TRes = await agent.post(Paths.Users.Add).send({ user: null });
-      expect(res.status).toBe(HTTP_STATUS_CODES.BadRequest);
-      const errorObj = parseValidationError(res.body.error);
-      expect(errorObj.message).toBe(ValidationError.MESSAGE);
-      expect(errorObj.errors[0].prop).toBe('user');
-    });
-  });
-
-  // Update users
-  describe(`"PUT:${Paths.Users.Update}"`, () => {
-
-    // Success
-    it(`should return a status code of "${HTTP_STATUS_CODES.Ok}" if the ` + 
-    'request was successful.', async () => {
-      const user = DB_USERS[0];
-      user.name = 'Bill';
-      const res = await agent.put(Paths.Users.Update).send({ user });
-      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
-    });
-
-    // Id is the wrong data type
-    it('should return a JSON object with an error message and a status code ' +
-    `of "${HTTP_STATUS_CODES.BadRequest}" if the user param was missing`, 
-    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(HTTP_STATUS_CODES.BadRequest);
-      const errorObj = parseValidationError(res.body.error);
-      expect(errorObj.message).toBe(ValidationError.MESSAGE);
-      expect(errorObj.errors[0].prop).toBe('user');
-      expect(errorObj.errors[0].children?.[0].prop).toBe('id');
-    });
-
-    // User not found
-    it('should return a JSON object with the error message of ' + 
-    `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
-    `"${HTTP_STATUS_CODES.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(HTTP_STATUS_CODES.NotFound);
-      expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-    });
-  });
-
-  // Delete User
-  describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
-
-    const getPath = (id: number) => insertUrlParams(Paths.Users.Delete({ id}), 
-      { id });
-
-    // Success
-    it(`should return a status code of "${HTTP_STATUS_CODES.Ok}" if the ` + 
-    'request was successful.', async () => {
-      const id = dbUsers[0].id,
-        res = await agent.delete(getPath(id));
-      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
-    });
-
-    // User not found
-    it('should return a JSON object with the error message of ' + 
-    `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
-    `"${HTTP_STATUS_CODES.NotFound}" if the id was not found.`, async () => {
-      const res: TRes = await agent.delete(getPath(-1));
-      expect(res.status).toBe(HTTP_STATUS_CODES.NotFound);
-      expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
-    });
-  });
-});

package/lib/project-files/tsconfig.json

@@ -1,35 +0,0 @@
-{
-  "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 +0,0 @@
-{
-  "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 +0,0 @@
-import { defineConfig } from 'vitest/config';
-import path from 'path';
-
-const config = defineConfig({
-  test: {
-    globals: true,
-    environment: 'node',
-    setupFiles: ['config.ts', './tests/support/setup.ts'],
-    isolate: true,
-  },
-  resolve: {
-    alias: {
-      '@src': path.resolve(__dirname, './src'),
-    },
-  },
-});
-
-export default config;