express-generator-typescript 2.4.25 → 2.5.0

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

@@ -6,23 +6,23 @@ import app from '@src/server';
 
 import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
-import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
+import { safeJsonParse } from '@src/util/validators';
+
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+import { IValidationErrFormat, ValidationErr } from '@src/common/route-errors';
 
 import Paths from 'spec/support/Paths';
 import apiCb from 'spec/support/apiCb';
 import { TApiCb } from 'spec/types/misc';
-import { ValidationErr } from '@src/common/classes';
 
 
 // Dummy users for GET req
-const getDummyUsers = () => {
-  return [
-    User.new('Sean Maxwell', 'sean.maxwell@gmail.com'),
-    User.new('John Smith', 'john.smith@gmail.com'),
-    User.new('Gordan Freeman', 'gordan.freeman@gmail.com'),
-  ];
-};
+const getDummyUsers = () => [
+  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' }),
+];
 
 
 // Tests
@@ -47,7 +47,7 @@ describe('UserRouter', () => {
 
     // Success
     it('should return a JSON object with all the users and a status code ' + 
-    `of "${HttpStatusCodes.OK}" if the request was successful.`, (done) => {
+    `of "${HttpStatusCodes.OK}" if the request was successful.`, done => {
       // Add spy
       const data = getDummyUsers();
       spyOn(UserRepo, 'getAll').and.resolveTo(data);
@@ -63,8 +63,7 @@ describe('UserRouter', () => {
   // Test add user
   describe(`"POST:${Paths.Users.Add}"`, () => {
 
-    const ERROR_MSG = ValidationErr.GetMsg('user'),
-      DUMMY_USER = getDummyUsers()[0];
+    const DUMMY_USER = getDummyUsers()[0];
 
     // Setup API
     const callApi = (user: IUser | null, cb: TApiCb) => 
@@ -75,7 +74,7 @@ describe('UserRouter', () => {
 
     // Test add user success
     it(`should return a status code of "${HttpStatusCodes.CREATED}" if the ` + 
-    'request was successful.', (done) => {
+    'request was successful.', done => {
       // Spy
       spyOn(UserRepo, 'add').and.resolveTo();
       // Call api
@@ -86,13 +85,15 @@ describe('UserRouter', () => {
     });
 
     // Missing param
-    it(`should return a JSON object with an error message of "${ERROR_MSG}" ` + 
-    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the user ` + 
-    'param was missing.', (done) => {
+    it('should return a JSON object with an error message of and a status ' + 
+      `code of "${HttpStatusCodes.BAD_REQUEST}" if the user param was ` + 
+      'missing.', done => {
       // Call api
       callApi(null, res => {
         expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-        expect(res.body.error).toBe(ERROR_MSG);
+        const errorObj = safeJsonParse<IValidationErrFormat>(res.body.error);
+        expect(errorObj.error).toBe(ValidationErr.MSG);
+        expect(errorObj.parameter).toBe('user');
         done();
       });
     });
@@ -101,8 +102,7 @@ describe('UserRouter', () => {
   // Update users
   describe(`"PUT:${Paths.Users.Update}"`, () => {
 
-    const ERROR_MSG =  ValidationErr.GetMsg('user'),
-      DUMMY_USER = getDummyUsers()[0];
+    const DUMMY_USER = getDummyUsers()[0];
 
     // Setup API
     const callApi = (user: IUser | null, cb: TApiCb) => 
@@ -113,11 +113,9 @@ describe('UserRouter', () => {
 
     // Success
     it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
-    'request was successful.', (done) => {
-      // Setup spies
+    'request was successful.', done => {
       spyOn(UserRepo, 'update').and.resolveTo();
       spyOn(UserRepo, 'persists').and.resolveTo(true);
-      // Call api
       callApi(DUMMY_USER, res => {
         expect(res.status).toBe(HttpStatusCodes.OK);
         done();
@@ -125,13 +123,14 @@ describe('UserRouter', () => {
     });
 
     // Param missing
-    it(`should return a JSON object with an error message of "${ERROR_MSG}" ` +
-    `and a status code of "${HttpStatusCodes.BAD_REQUEST}" if the user ` + 
-    'param was missing.', (done) => {
-      // Call api
+    it('should return a JSON object with an error message and a status code ' +
+    `of "${HttpStatusCodes.BAD_REQUEST}" if the user param was missing`,
+    done => {
       callApi(null, res => {
         expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-        expect(res.body.error).toBe(ERROR_MSG);
+        const errorObj = safeJsonParse<IValidationErrFormat>(res.body.error);
+        expect(errorObj.error).toBe(ValidationErr.MSG);
+        expect(errorObj.parameter).toBe('user');
         done();
       });
     });
@@ -139,8 +138,7 @@ describe('UserRouter', () => {
     // User not found
     it('should return a JSON object with the error message of ' + 
     `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
-    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, (done) => {
-      // Call api
+    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, done => {
       callApi(DUMMY_USER, res => {
         expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
         expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
@@ -160,11 +158,9 @@ describe('UserRouter', () => {
 
     // Success
     it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
-    'request was successful.', (done) => {
-      // Setup spies
+    'request was successful.', done => {
       spyOn(UserRepo, 'delete').and.resolveTo();
       spyOn(UserRepo, 'persists').and.resolveTo(true);
-      // Call api
       callApi(5, res => {
         expect(res.status).toBe(HttpStatusCodes.OK);
         done();
@@ -175,7 +171,6 @@ describe('UserRouter', () => {
     it('should return a JSON object with the error message of ' + 
     `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
     `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, done => {
-      // Setup spies
       callApi(-1, res => {
         expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
         expect(res.body.error).toBe(USER_NOT_FOUND_ERR);

package/lib/project-files/spec/types/misc.ts

@@ -3,10 +3,11 @@ import { IUser } from '@src/models/User';
 
 
 // Misc
-export type TReqBody = Record<string, unknown>;
-export type TRes = Omit<Response, 'body'> & { body: {
-  error?: string;
-  user?: IUser
-  users?: IUser[]
-}};
+export type TRes = Omit<Response, 'body'> & {
+  body: {
+    error?: string,
+    user?: IUser,
+    users?: IUser[],
+  },
+};
 export type TApiCb = (res: TRes) => void;

package/lib/project-files/spec/types/supertest/index.d.ts

@@ -7,8 +7,8 @@ declare module 'supertest' {
   export interface Response  {
     headers: Record<string, string[]>;
     body: {
-      error: string;
-      users: IUser[];
+      error: string,
+      users: IUser[],
     };
   }
 }

package/lib/project-files/src/common/Env.ts

@@ -0,0 +1,10 @@
+import jetEnv, { num } from 'jet-env';
+
+import { isEnumVal } from '@src/util/validators';
+import { NodeEnvs } from './constants';
+
+
+export default jetEnv({
+  NodeEnv: isEnumVal(NodeEnvs),
+  Port: num,
+});

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

@@ -0,0 +1,41 @@
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+
+
+export interface IValidationErrFormat {
+  error: string;
+  parameter: string;
+  value?: unknown;
+  'more-info'?: string;
+}
+
+
+/**
+ * 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;
+  }
+}
+
+/**
+ * Validation in route layer errors.
+ */
+export class ValidationErr extends RouteError {
+  public static MSG = 'The following parameter was missing or invalid.';
+
+  public constructor(parameter: string, value?: unknown, moreInfo?: string) {
+    const msgObj: Record<string, unknown> = {
+      error: ValidationErr.MSG,
+      parameter,
+      value,
+    };
+    if (!!moreInfo) {
+      msgObj['more-info'] = moreInfo;
+    }
+    super(HttpStatusCodes.BAD_REQUEST, JSON.stringify(msgObj));
+  }
+}

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

@@ -1,12 +1,12 @@
 import logger from 'jet-logger';
 
-import EnvVars from '@src/common/EnvVars';
+import Env from '@src/common/Env';
 import server from './server';
 
 
 // **** Run **** //
 
 const SERVER_START_MSG = ('Express server started on port: ' + 
-  EnvVars.Port.toString());
+  Env.Port.toString());
 
-server.listen(EnvVars.Port, () => logger.info(SERVER_START_MSG));
+server.listen(Env.Port, () => logger.info(SERVER_START_MSG));

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

@@ -1,14 +1,7 @@
-import moment from 'moment';
+import schema from '@src/util/schema';
+import { isNum, isStr } from '@src/util/validators';
 
 
-// **** Variables **** //
-
-const INVALID_CONSTRUCTOR_PARAM = 'nameOrObj arg must a string or an object ' + 
-  'with the appropriate user keys.';
-
-
-// **** Types **** //
-
 export interface IUser {
   id: number;
   name: string;
@@ -16,55 +9,14 @@ export interface IUser {
   created: Date;
 }
 
-
-// **** Functions **** //
-
-/**
- * Create new User.
- */
-function new_(
-  name?: string,
-  email?: string,
-  created?: Date,
-  id?: number, // id last cause usually set by db
-): IUser {
-  return {
-    id: (id ?? -1),
-    name: (name ?? ''),
-    email: (email ?? ''),
-    created: (created ? new Date(created) : new Date()),
-  };
-}
-
-/**
- * Get user instance from object.
- */
-function from(param: object): IUser {
-  if (isUser(param)) {
-    return new_(param.name, param.email, param.created, param.id);
-  }
-  throw new Error(INVALID_CONSTRUCTOR_PARAM);
-}
-
-/**
- * See if the param meets criteria to be a user.
- */
-function isUser(arg: unknown): arg is IUser {
-  return (
-    !!arg &&
-    typeof arg === 'object' &&
-    'id' in arg && typeof arg.id === 'number' && 
-    'email' in arg && typeof arg.email === 'string' && 
-    'name' in arg && typeof arg.name === 'string' &&
-    'created' in arg && moment(arg.created as string | Date).isValid()
-  );
-}
+const User = schema<IUser>({
+  id: isNum,
+  name: isStr,
+  created: Date,
+  email: isStr,
+});
 
 
 // **** Export default **** //
 
-export default {
-  new: new_,
-  from,
-  isUser,
-} as const;
+export default User;

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

@@ -1,5 +1,3 @@
-
-
 import jsonfile from 'jsonfile';
 
 import { IUser } from '@src/models/User';

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

@@ -1 +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"},{"id":81065793658,"name":"d","email":"a","created":"2024-10-04T00:29:08.847Z"}]}
+{"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/routes/UserRoutes.ts

@@ -1,9 +1,18 @@
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import UserService from '@src/services/UserService';
 import User from '@src/models/User';
+import { isNum, transform } from '@src/util/validators';
 
-import { IReq, IRes } from './common/types';
-import check from './common/check';
+import { reqParse, IReq, IRes } from './common';
+
+
+// **** Variables **** //
+
+const Validators = {
+  add: reqParse({ user: User.test }),
+  update: reqParse({ user: User.test }),
+  delete: reqParse({ id: transform(Number, isNum) }),
+} as const;
 
 
 // **** Functions **** //
@@ -20,7 +29,7 @@ async function getAll(_: IReq, res: IRes) {
  * Add one user.
  */
 async function add(req: IReq, res: IRes) {
-  const user = check.isValid(req.body, 'user', User.isUser);
+  const { user } = Validators.add(req.body);
   await UserService.addOne(user);
   res.status(HttpStatusCodes.CREATED).end();
 }
@@ -29,7 +38,7 @@ async function add(req: IReq, res: IRes) {
  * Update one user.
  */
 async function update(req: IReq, res: IRes) {
-  const user = check.isValid(req.body, 'user', User.isUser);
+  const { user } = Validators.update(req.body);
   await UserService.updateOne(user);
   res.status(HttpStatusCodes.OK).end();
 }
@@ -38,7 +47,7 @@ async function update(req: IReq, res: IRes) {
  * Delete one user.
  */
 async function delete_(req: IReq, res: IRes) {
-  const id = check.isNum(req.params, 'id');
+  const { id } = Validators.delete(req.params);
   await UserService.delete(id);
   res.status(HttpStatusCodes.OK).end();
 }

package/lib/project-files/src/{common → routes/common}/Paths.ts

@@ -1,7 +1,3 @@
-/**
- * Express router paths go here.
- */
-
 
 export default {
   Base: '/api',

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

@@ -0,0 +1,37 @@
+import { Response, Request } from 'express';
+
+import { parseObj, TSchema } from '@src/util/validators';
+import { ValidationErr } from '@src/common/route-errors';
+
+
+// **** Types **** //
+
+type TObj = Record<string, unknown>;
+export type IReq = Request<TObj, void, TObj, TObj>;
+export type IRes = Response<unknown, TObj>;
+
+
+// **** Functions **** //
+
+/**
+ * Parse a Request object property and throw a Validation error if it fails.
+ */
+export function reqParse<U extends TSchema>(schema: U) {
+  return parseObj<U>(schema, reqParseOnError);
+}
+
+/**
+ * Error handler for the request parse function above.
+ */
+function reqParseOnError(
+  prop = 'undefined',
+  value?: unknown,
+  caughtErr?: unknown,
+): void {
+  if (caughtErr !== undefined) {
+    const moreInfo = JSON.stringify(caughtErr);
+    throw new ValidationErr(prop, value, moreInfo);
+  } else {
+    throw new ValidationErr(prop, value);
+  }
+}

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

@@ -1,6 +1,6 @@
 import { Router } from 'express';
 
-import Paths from '../common/Paths';
+import Paths from './common/Paths';
 import UserRoutes from './UserRoutes';
 
 

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

@@ -1,4 +1,3 @@
-import cookieParser from 'cookie-parser';
 import morgan from 'morgan';
 import path from 'path';
 import helmet from 'helmet';
@@ -9,11 +8,11 @@ import 'express-async-errors';
 
 import BaseRouter from '@src/routes';
 
-import Paths from '@src/common/Paths';
-import EnvVars from '@src/common/EnvVars';
+import Paths from '@src/routes/common/Paths';
+import Env from '@src/common/Env';
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import { RouteError } from '@src/common/classes';
-import { NodeEnvs } from '@src/common/misc';
+import { RouteError } from '@src/common/route-errors';
+import { NodeEnvs } from '@src/common/constants';
 
 
 // **** Variables **** //
@@ -26,15 +25,14 @@ const app = express();
 // Basic middleware
 app.use(express.json());
 app.use(express.urlencoded({extended: true}));
-app.use(cookieParser(EnvVars.CookieProps.Secret));
 
 // Show routes called in console during development
-if (EnvVars.NodeEnv === NodeEnvs.Dev.valueOf()) {
+if (Env.NodeEnv === NodeEnvs.Dev.valueOf()) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (EnvVars.NodeEnv === NodeEnvs.Production.valueOf()) {
+if (Env.NodeEnv === NodeEnvs.Production.valueOf()) {
   app.use(helmet());
 }
 
@@ -43,7 +41,7 @@ app.use(Paths.Base, BaseRouter);
 
 // Add error handler
 app.use((err: Error, _: Request, res: Response, next: NextFunction) => {
-  if (EnvVars.NodeEnv !== NodeEnvs.Test.valueOf()) {
+  if (Env.NodeEnv !== NodeEnvs.Test.valueOf()) {
     logger.err(err, true);
   }
   let status = HttpStatusCodes.BAD_REQUEST;

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

@@ -1,4 +1,4 @@
-import { RouteError } from '@src/common/classes';
+import { RouteError } from '@src/common/route-errors';
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 import UserRepo from '@src/repos/UserRepo';

package/lib/project-files/src/util/misc.ts

@@ -1,22 +1,6 @@
-/**
- * Miscellaneous shared functions go here.
- */
-
-
 /**
  * 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);
 }
-
-/**
- * Wait for a certain number of milliseconds.
- */
-export function tick(milliseconds: number): Promise<void> {
-  return new Promise((resolve) => {
-    setTimeout(() => {
-      resolve();
-    }, milliseconds);
-  });
-}

package/lib/project-files/src/util/schema.ts

@@ -0,0 +1,11 @@
+import jetSchema from 'jet-schema';
+import { isBool, isNum, isStr } from './validators';
+
+
+export default jetSchema({
+  globals: [
+    { vf: isNum, default: 0 },
+    { vf: isStr, default: '' },
+    { vf: isBool, default: false },
+  ],
+});