express-generator-typescript 2.7.8 → 2.7.10

package/lib/project-files/src/models/User.ts

@@ -0,0 +1,70 @@
+import { isString, isUnsignedInteger } from 'jet-validators';
+import { parseObject, OnErrorCallback } from 'jet-validators/utils';
+
+import { transformIsDate } from '@src/common/util/validators';
+import { IModel } from './common/types';
+
+/******************************************************************************
+                                 Constants
+******************************************************************************/
+
+const DEFAULT_USER_VALS: IUser = {
+  id: 0,
+  name: '',
+  created: new Date(),
+  email: '',
+} as const;
+
+/******************************************************************************
+                                  Types
+******************************************************************************/
+
+export interface IUser extends IModel {
+  name: string;
+  email: string;
+}
+
+/******************************************************************************
+                                  Setup
+******************************************************************************/
+
+// Initialize the "parseUser" function
+const parseUser = parseObject<IUser>({
+  id: isUnsignedInteger,
+  name: isString,
+  email: isString,
+  created: transformIsDate,
+});
+
+/******************************************************************************
+                                 Functions
+******************************************************************************/
+
+/**
+ * New user object.
+ */
+function __new__(user?: Partial<IUser>): IUser {
+  const defaults = { ...DEFAULT_USER_VALS };
+  defaults.created = new Date();
+  return parseUser({ ...defaults, ...user }, errors => {
+    throw new Error('Setup new user failed ' + JSON.stringify(errors, null, 2));
+  });
+}
+
+/**
+ * Check is a user object. For the route validation.
+ */
+
+// because this isn't marked with the symbol, the errors are not bubbling up
+function test(arg: unknown, errCb?: OnErrorCallback): arg is IUser {
+  return !!parseUser(arg, errCb);
+}
+
+/******************************************************************************
+                                Export default
+******************************************************************************/
+
+export default {
+  new: __new__,
+  test,
+} as const;

package/lib/project-files/src/models/common/types.ts

@@ -0,0 +1,5 @@
+
+export interface IModel {
+  id: number;
+  created: Date;
+}

package/lib/project-files/src/public/stylesheets/users.css

@@ -0,0 +1,48 @@
+body {
+  padding: 100px;
+  font: 14px "Lucida Grande", Helvetica, Arial, sans-serif;
+}
+
+body .users-column {
+  display: inline-block;
+  margin-right: 2em;
+  vertical-align: top;
+}
+
+body .users-column .column-header {
+  padding-bottom: 5px;
+  font-weight: 700;
+  font-size: 1.2em;
+}
+
+
+/** Add User Column **/
+
+body .add-user-col input {
+  margin-bottom: 10px;
+}
+
+body .add-user-col #add-user-btn {
+  margin-top: 2px;
+  margin-bottom: 10px;
+}
+
+
+/** Users Display Column **/
+
+.email-edit {
+  padding-bottom: 8px;
+}
+
+body .users-column .user-display-ele {
+  padding-bottom: 10px;
+}
+
+body .users-column .user-display-ele button {
+  margin-top: 2px;
+  margin-bottom: 10px;
+}
+
+body .users-column .user-display-ele .edit-view {
+  display: none;
+}

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

@@ -0,0 +1,63 @@
+import jsonfile from 'jsonfile';
+
+import ENV from '@src/common/constants/ENV';
+import { NODE_ENVS } from '@src/common/constants';
+import { IUser } from '@src/models/User';
+
+
+/******************************************************************************
+                                Constants
+******************************************************************************/
+
+const DB_FILE_NAME = (
+  ENV.NodeEnv === NODE_ENVS.Test 
+    ? 'database.test.json' 
+    : 'database.json'
+);
+
+
+/******************************************************************************
+                                Types
+******************************************************************************/
+
+interface IDatabase {
+  users: IUser[];
+}
+
+
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
+/**
+ * Fetch the json from the file.
+ */
+function openDb(): Promise<IDatabase> {
+  return jsonfile.readFile(__dirname + '/' + DB_FILE_NAME) as 
+    Promise<IDatabase>;
+}
+
+/**
+ * Update the file.
+ */
+function saveDb(db: IDatabase): Promise<void> {
+  return jsonfile.writeFile((__dirname + '/' + DB_FILE_NAME), db);
+}
+
+/**
+ * Empty the database
+ */
+function cleanDb(): Promise<void> {
+  return jsonfile.writeFile((__dirname + '/' + DB_FILE_NAME), {});
+}
+
+
+/******************************************************************************
+                                Export default
+******************************************************************************/
+
+export default {
+  openDb,
+  saveDb,
+  cleanDb,
+} as const;

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

@@ -0,0 +1,133 @@
+import { IUser } from '@src/models/User';
+import { getRandomInt } from '@src/common/util/misc';
+
+import orm from './MockOrm';
+
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
+/**
+ * Get one user.
+ */
+async function getOne(email: string): Promise<IUser | null> {
+  const db = await orm.openDb();
+  for (const user of db.users) {
+    if (user.email === email) {
+      return user;
+    }
+  }
+  return null;
+}
+
+/**
+ * See if a user with the given id exists.
+ */
+async function persists(id: number): Promise<boolean> {
+  const db = await orm.openDb();
+  for (const user of db.users) {
+    if (user.id === id) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Get all users.
+ */
+async function getAll(): Promise<IUser[]> {
+  const db = await orm.openDb();
+  return db.users;
+}
+
+/**
+ * Add one user.
+ */
+async function add(user: IUser): Promise<void> {
+  const db = await orm.openDb();
+  user.id = getRandomInt();
+  db.users.push(user);
+  return orm.saveDb(db);
+}
+
+/**
+ * Update a user.
+ */
+async function update(user: IUser): Promise<void> {
+  const db = await orm.openDb();
+  for (let i = 0; i < db.users.length; i++) {
+    if (db.users[i].id === user.id) {
+      const dbUser = db.users[i];
+      db.users[i] = {
+        ...dbUser,
+        name: user.name,
+        email: user.email,
+      };
+      return orm.saveDb(db);
+    }
+  }
+}
+
+/**
+ * Delete one user.
+ */
+async function __delete__(id: number): Promise<void> {
+  const db = await orm.openDb();
+  for (let i = 0; i < db.users.length; i++) {
+    if (db.users[i].id === id) {
+      db.users.splice(i, 1);
+      return orm.saveDb(db);
+    }
+  }
+}
+
+// **** Unit-Tests Only **** //
+
+/**
+ * Delete every user record.
+ * 
+ * @internal
+ * Test-only helper. Do not use in production code.
+ */
+async function deleteAllUsers(): Promise<void> {
+  const db = await orm.openDb();
+  db.users = [];
+  return orm.saveDb(db);
+}
+
+/**
+ * Insert multiple users. Can't do multiple at once cause using a plain file 
+ * for now.
+ * 
+ * @internal
+ * Test-only helper. Do not use in production code.
+ */
+async function insertMultiple(
+  users: IUser[] | readonly IUser[],
+): Promise<IUser[]> {
+  const db = await orm.openDb(),
+    usersF = [ ...users ];
+  for (const user of usersF) {
+    user.id = getRandomInt();
+    user.created = new Date();
+  }
+  db.users = [ ...db.users, ...users ];
+  await orm.saveDb(db);
+  return usersF;
+}
+
+/******************************************************************************
+                                Export default
+******************************************************************************/
+
+export default {
+  getOne,
+  persists,
+  getAll,
+  add,
+  update,
+  delete: __delete__,
+  deleteAllUsers,
+  insertMultiple,
+} as const;

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

@@ -0,0 +1 @@
+{"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/database.test.json

@@ -0,0 +1 @@
+{"users":[{"id":169238117092,"name":"Bill","email":"sean.maxwell@gmail.com","created":"2026-01-01T23:26:38.953Z"},{"id":463030566103,"name":"John Smith","email":"john.smith@gmail.com","created":"2026-01-01T23:26:38.953Z"},{"id":420935775197,"name":"Gordan Freeman","email":"gordan.freeman@gmail.com","created":"2026-01-01T23:26:38.953Z"}]}

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

@@ -0,0 +1,69 @@
+import { isNumber } from 'jet-validators';
+import { transform } from 'jet-validators/utils';
+
+import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
+import UserService from '@src/services/UserService';
+import User from '@src/models/User';
+
+import { IReq, IRes } from './common/types';
+import { parseReq } from './common/util';
+
+/******************************************************************************
+                                Constants
+******************************************************************************/
+
+const Validators = {
+  add: parseReq({ user: User.test }),
+  update: parseReq({ user: User.test }),
+  delete: parseReq({ id: transform(Number, isNumber) }),
+} as const;
+
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
+/**
+ * Get all users.
+ */
+async function getAll(_: IReq, res: IRes) {
+  const users = await UserService.getAll();
+  res.status(HTTP_STATUS_CODES.Ok).json({ users });
+}
+
+/**
+ * Add one user.
+ */
+async function add(req: IReq, res: IRes) {
+  const { user } = Validators.add(req.body);
+  await UserService.addOne(user);
+  res.status(HTTP_STATUS_CODES.Created).end();
+}
+
+/**
+ * Update one user.
+ */
+async function update(req: IReq, res: IRes) {
+  const { user } = Validators.update(req.body);
+  await UserService.updateOne(user);
+  res.status(HTTP_STATUS_CODES.Ok).end();
+}
+
+/**
+ * Delete one user.
+ */
+async function delete_(req: IReq, res: IRes) {
+  const { id } = Validators.delete(req.params);
+  await UserService.delete(id);
+  res.status(HTTP_STATUS_CODES.Ok).end();
+}
+
+/******************************************************************************
+                                Export default
+******************************************************************************/
+
+export default {
+  getAll,
+  add,
+  update,
+  delete: delete_,
+} as const;

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

@@ -0,0 +1,10 @@
+import { Response, Request } from 'express';
+
+/******************************************************************************
+                                Types
+******************************************************************************/
+
+type TRecord = Record<string, unknown>;
+export type IReq = Request<TRecord, void, TRecord, TRecord>;
+export type IRes = Response<unknown, TRecord>;
+

package/lib/project-files/src/routes/common/util/index.ts

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

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

@@ -0,0 +1,31 @@
+import { Router } from 'express';
+
+import PATHS from '@src/common/constants/PATHS';
+import UserRoutes from './UserRoutes';
+
+/******************************************************************************
+                                Setup
+******************************************************************************/
+
+const apiRouter = Router();
+
+
+// ** Add UserRouter ** //
+
+// Init router
+const userRouter = Router();
+
+// Get all users
+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);
+
+// Add UserRouter
+apiRouter.use(PATHS.Users._, userRouter);
+
+/******************************************************************************
+                                Export default
+******************************************************************************/
+
+export default apiRouter;

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

@@ -0,0 +1,86 @@
+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

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