express-generator-typescript 2.7.11 → 2.7.14

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

@@ -1,84 +1,79 @@
-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 EnvVars from '@src/common/constants/EnvVars';
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-import { RouteError } from '@src/common/utils/route-errors';
-import { NodeEnvs } 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 (EnvVars.NodeEnv === NodeEnvs.DEV) {
-  app.use(morgan('dev'));
-}
-
-// Security
-if (EnvVars.NodeEnv === NodeEnvs.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 (EnvVars.NodeEnv !== NodeEnvs.TEST.valueOf()) {
-    logger.err(err, true);
-  }
-  let status: HttpStatusCodes = HttpStatusCodes.BAD_REQUEST;
-  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;
+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 HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+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) {
+  // eslint-disable-next-line 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 (EnvVars.NodeEnv !== NodeEnvs.TEST.valueOf()) {
+    logger.err(err, true);
+  }
+  let status: HttpStatusCodes = HttpStatusCodes.BAD_REQUEST;
+  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/index.ts → UserService.ts}

@@ -1,58 +1,64 @@
-import { RouteError } from '@src/common/utils/route-errors';
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-
-import UserRepo from '@src/repos/UserRepo';
-import { IUser } from '@src/models/User';
-import { USER_NOT_FOUND_ERROR } from './constants';
-
-/******************************************************************************
-                                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, USER_NOT_FOUND_ERROR);
-  }
-  // 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(HttpStatusCodes.NOT_FOUND, USER_NOT_FOUND_ERROR);
-  }
-  return UserRepo.delete(id);
-}
-
-/******************************************************************************
-                                Export default
-******************************************************************************/
-
-export default {
-  getAll,
-  addOne,
-  updateOne,
-  delete: __delete__,
-} as const;
+import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import { RouteError } from '@src/common/utils/route-errors';
+import { IUser } from '@src/models/User';
+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 __delete__(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: __delete__,
+} as const;

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

@@ -1,132 +1,118 @@
-<!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>
+<!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/{utils.ts → comparators.ts}

@@ -1,55 +1,38 @@
-import { ParseError, 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: 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);
-}
-
-/**
- * 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);
-  });
-}
+import { IUser } from '@src/models/User';
+
+/******************************************************************************
+                                Types
+******************************************************************************/
+
+type UserArray = IUser[] | readonly IUser[];
+
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
+/**
+ * Compare to user arrays. Order does not matter and this assumes the email
+ * field is unique
+ */
+export function compareUserArrays(a: UserArray, b: UserArray): boolean {
+  if (a.length !== b.length) return false;
+  const aSorted = sortByEmail(a),
+    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: UserArray): IUser[] {
+  return [...arr].sort((x, y) => {
+    return x.email.localeCompare(y.email);
+  });
+}