express-generator-typescript 2.4.14 → 2.4.17

package/lib/express-generator-typescript.js

@@ -20,7 +20,7 @@ const PROJECT_FOLDER_PATH = './project-files';
 // Project-folder dependencies
 const DEPENDENCIES = 'express dotenv morgan cookie-parser jet-logger ' +
   'module-alias express-async-errors helmet jsonfile inserturlparams ' + 
-  'jet-validator ts-command-line-args jet-paths moment',
+  'ts-command-line-args jet-paths moment',
   DEPENDENCIES_AUTH = ' bcrypt jsonwebtoken',
   DEV_DEPENDENCIES = 'ts-node typescript nodemon find jasmine supertest ' +
     '@types/node @types/express @types/jasmine @types/find @types/morgan  ' +

package/lib/project-files/.eslintignore

@@ -1 +1,2 @@
 src/public/
+dotenv.config.js

package/lib/project-files/README.md

@@ -5,22 +5,18 @@ This project was created with [express-generator-typescript](https://github.com/
 
 ## Available Scripts
 
-### `npm run dev`
+### `npm run dev` or `npm run dev:hot` (hot reloading)
 
 Run the server in development mode.
 
-### `npm test`
+### `npm test` or `npm run test:hot` (hot reloading)
 
-Run all unit-tests with hot-reloading.
+Run all unit-tests.
 
 ### `npm test -- --testFile="name of test file" (i.e. --testFile=Users).`
 
 Run a single unit-test.
 
-### `npm run test:no-reloading`
-
-Run all unit-tests without hot-reloading.
-
 ### `npm run lint`
 
 Check for linting errors.
@@ -33,10 +29,6 @@ Build the project for production.
 
 Run the production build (Must be built first).
 
-### `npm start -- --env="name of env file" (default is production).`
-
-Run production build with a different env file.
-
 
 ## Additional Notes
 

package/lib/project-files/dotenv.config.js

@@ -0,0 +1,16 @@
+var dotenv = require('dotenv');
+var path = require('path');
+
+
+// Check the env
+var NODE_ENV = process.env.NODE_ENV || 'development';
+
+// Configure the file
+const result2 = dotenv.config({
+  path: path.join(__dirname, `./env/${NODE_ENV}.env`),
+});
+
+// Check for errors
+if (result2.error) {
+  throw result2.error;
+}

package/lib/project-files/nodemon.json

@@ -0,0 +1,10 @@
+{
+  "watch": [
+    "src"
+  ],
+  "ext": "ts, html",
+  "ignore": [
+    "src/public"
+  ],
+  "exec": "npm run dev"
+}

package/lib/project-files/nodemon.spec.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["spec"],
+  "ext": "spec.ts",
+  "ignore": ["spec/support"],
+  "exec": "npm run test"
+}

package/lib/project-files/package.json

@@ -2,23 +2,15 @@
   "name": "express-typescript-example",
   "version": "0.0.0",
   "scripts": {
+    "_ts": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register -r ./dotenv.config.js",
     "build": "npx ts-node build.ts",
+    "dev": "npm run _ts -- ./src",
+    "dev:hot": "nodemon",
     "lint": "npx eslint --ext .ts src/",
     "lint:tests": "npx eslint --ext .ts spec/",
-    "start": "node -r module-alias/register ./dist --env=production",
-    "dev": "nodemon",
-    "test": "nodemon --config ./spec/nodemon.json",
-    "test:no-reloading": "npx ts-node --files -r tsconfig-paths/register ./spec"
-  },
-  "nodemonConfig": {
-    "watch": [
-      "src"
-    ],
-    "ext": "ts, html",
-    "ignore": [
-      "src/public"
-    ],
-    "exec": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register ./src"
+    "start": "NODE_ENV=production node -r module-alias/register -r ./dotenv.config.js ./dist",
+    "test": "NODE_ENV=test npm run _ts -- ./spec",
+    "test:hot": "nodemon --config ./nodemon.spec.json"
   },
   "_moduleAliases": {
     "@src": "dist"
@@ -36,7 +28,6 @@
     "inserturlparams": "^1.0.1",
     "jet-logger": "^1.3.1",
     "jet-paths": "^1.0.5",
-    "jet-validator": "^1.0.3",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",

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

@@ -1,40 +1,19 @@
-import dotenv from 'dotenv';
 import find from 'find';
 import Jasmine from 'jasmine';
 import { parse } from 'ts-command-line-args';
 import logger from 'jet-logger';
 
 
-// **** Types **** //
-
-interface IArgs {
-  testFile: string;
-}
-
-
-// **** Setup **** //
-
-// ** Init ** //
-
-// NOTE: MUST BE FIRST!! Load env vars
-const result2 = dotenv.config({
-  path: './env/test.env',
-});
-if (result2.error) {
-  throw result2.error;
-}
-
 // Setup command line options. 
-const args = parse<IArgs>({
+const args = parse<{
+  testFile: string;
+}>({
   testFile: {
     type: String,
     defaultValue: '',
   },
 });
 
-
-// ** Start Jasmine ** //
-
 // Init Jasmine
 const jasmine = new Jasmine();
 jasmine.exitOnCompletion = false;

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

@@ -1,6 +1,5 @@
 import supertest, { Test } from 'supertest';
 import TestAgent from 'supertest/lib/agent';
-import { defaultErrMsg as ValidatorErr } from 'jet-validator';
 import insertUrlParams from 'inserturlparams';
 
 import app from '@src/server';
@@ -13,6 +12,7 @@ import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 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
@@ -63,7 +63,7 @@ describe('UserRouter', () => {
   // Test add user
   describe(`"POST:${Paths.Users.Add}"`, () => {
 
-    const ERROR_MSG = `${ValidatorErr}"user".`,
+    const ERROR_MSG = ValidationErr.GetMsg('user'),
       DUMMY_USER = getDummyUsers()[0];
 
     // Setup API
@@ -101,7 +101,7 @@ describe('UserRouter', () => {
   // Update users
   describe(`"PUT:${Paths.Users.Update}"`, () => {
 
-    const ERROR_MSG = `${ValidatorErr}"user".`,
+    const ERROR_MSG =  ValidationErr.GetMsg('user'),
       DUMMY_USER = getDummyUsers()[0];
 
     // Setup API

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

@@ -0,0 +1,32 @@
+import HttpStatusCodes from '@src/common/HttpStatusCodes';
+
+
+/**
+ * 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;
+  }
+}
+
+/**
+ * If route validation fails.
+ */
+export class ValidationErr extends RouteError {
+
+  public static MSG = 'The follow parameter were missing or invalid "';
+
+  public constructor(paramName: string) {
+    super(HttpStatusCodes.BAD_REQUEST, ValidationErr.GetMsg(paramName));
+  }
+
+  public static GetMsg(param: string) {
+    return ValidationErr.MSG + param + '".';
+  }
+}
+

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

@@ -1,4 +1,3 @@
-import './pre-start'; // Must be the first import
 import logger from 'jet-logger';
 
 import EnvVars from '@src/common/EnvVars';

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

@@ -40,17 +40,16 @@ function new_(
  * Get user instance from object.
  */
 function from(param: object): IUser {
-  if (!isUser(param)) {
-    throw new Error(INVALID_CONSTRUCTOR_PARAM);
+  if (isUser(param)) {
+    return new_(param.name, param.email, param.created, param.id);
   }
-  const p = param as IUser;
-  return new_(p.name, p.email, p.created, p.id);
+  throw new Error(INVALID_CONSTRUCTOR_PARAM);
 }
 
 /**
  * See if the param meets criteria to be a user.
  */
-function isUser(arg: unknown): boolean {
+function isUser(arg: unknown): arg is IUser {
   return (
     !!arg &&
     typeof arg === 'object' &&

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

@@ -1,8 +1,9 @@
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
-
 import UserService from '@src/services/UserService';
-import { IUser } from '@src/models/User';
+import User from '@src/models/User';
+
 import { IReq, IRes } from './common/types';
+import check from './common/check';
 
 
 // **** Functions **** //
@@ -18,8 +19,8 @@ async function getAll(_: IReq, res: IRes) {
 /**
  * Add one user.
  */
-async function add(req: IReq<{user: IUser}>, res: IRes) {
-  const { user } = req.body;
+async function add(req: IReq, res: IRes) {
+  const user = check.isValid(req.body, 'user', User.isUser);
   await UserService.addOne(user);
   return res.status(HttpStatusCodes.CREATED).end();
 }
@@ -27,8 +28,8 @@ async function add(req: IReq<{user: IUser}>, res: IRes) {
 /**
  * Update one user.
  */
-async function update(req: IReq<{user: IUser}>, res: IRes) {
-  const { user } = req.body;
+async function update(req: IReq, res: IRes) {
+  const user = check.isValid(req.body, 'user', User.isUser);
   await UserService.updateOne(user);
   return res.status(HttpStatusCodes.OK).end();
 }
@@ -37,7 +38,7 @@ async function update(req: IReq<{user: IUser}>, res: IRes) {
  * Delete one user.
  */
 async function delete_(req: IReq, res: IRes) {
-  const id = +req.params.id;
+  const id = check.isNum(req.params, 'id');
   await UserService.delete(id);
   return res.status(HttpStatusCodes.OK).end();
 }

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

@@ -0,0 +1,143 @@
+import { ValidationErr } from '@src/common/classes';
+
+
+type TReqObj = Record<string, unknown>;
+
+
+/**
+ * Check that param/s is a string
+ */
+function isStr(reqObj: TReqObj, params: string): string;
+function isStr(reqObj: TReqObj, params: ReadonlyArray<string>): string[];
+function isStr(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+): string | string[] {
+  return _checkWrapper(reqObj, params, _checkStr);
+}
+
+/**
+ * Check validator for string
+ */
+function _checkStr(val: unknown): string | undefined {
+  if (!!val && typeof val === 'string') {
+    return val;
+  } else {
+    return undefined;
+  }
+}
+
+/**
+ * Check that param/s is a number.
+ */
+function isNum(reqObj: TReqObj, params: string): number;
+function isNum(reqObj: TReqObj, params: ReadonlyArray<string>): number[];
+function isNum(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+): number | number[] {
+  return _checkWrapper(reqObj, params, _checkNum);
+}
+
+/**
+ * Check validator for string
+ */
+function _checkNum(val: unknown): number | undefined {
+  const valF = Number(val);
+  if (!isNaN(valF)) {
+    return valF;
+  } else {
+    return undefined;
+  }
+}
+
+/**
+ * Check that param/s is a number
+ */
+function isBool(reqObj: TReqObj, params: string): boolean;
+function isBool(reqObj: TReqObj, params: ReadonlyArray<string>): boolean[];
+function isBool(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+): boolean | boolean[] {
+  return _checkWrapper(reqObj, params, _checkBool);
+}
+
+/**
+ * Check validator for string
+ */
+function _checkBool(val: unknown): boolean | undefined {
+  if (typeof val === 'boolean') {
+    return val;
+  } else if (typeof val === 'string') {
+    val = val.toLowerCase();
+    if (val === 'true') {
+      return true;
+    } else if (val === 'false') {
+      return false;
+    } else {
+      return undefined;
+    }
+  } else {
+    return undefined;
+  }
+}
+
+/**
+ * Check that param satisfies the validator function.
+ */
+function isValid<T>(
+  reqObj: TReqObj,
+  param: string,
+  validatorFn: (param: unknown) => param is T,
+): T {
+  const val = reqObj[param];
+  if (validatorFn(val)) {
+    return val;
+  } else {
+    throw new ValidationErr(param);
+  }
+}
+
+
+// **** Shared Helpers **** //
+
+/**
+ * Do stuff based on whether or not params is an array
+ */
+function _checkWrapper<T>(
+  reqObj: TReqObj,
+  params: string | ReadonlyArray<string>,
+  checkFn: (val: unknown) => T | undefined,
+): T | T[] {
+  // If is array
+  if (params instanceof Array) {
+    const retVal: T[] = [];
+    for (const param of params) {
+      const val = checkFn(reqObj[param]);
+      if (val !== undefined) {
+        retVal.push(val);
+      } else {
+        throw new ValidationErr(param);
+      }
+    }
+    return retVal;
+  }
+  // If not an array
+  const val = checkFn(reqObj[params]);
+  if (val !== undefined) {
+    return val;
+  }
+  // Throw error
+  throw new ValidationErr(params);
+}
+
+
+// **** Export Default **** //
+
+export default {
+  isStr,
+  isNum,
+  isBool,
+  isValid,
+} as const;

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

@@ -8,13 +8,9 @@ import { Response, Request } from 'express';
 
 // **** Express **** //
 
-type TPathParams = Record<string, string>;
+type TObj = Record<string, unknown>;
 
-export interface IReq<T = void> extends Request<TPathParams, void, T, TPathParams> {
-  body: T;
-}
+export type IReq = Request<TObj, void, TObj, TObj>;
 
-export interface IRes extends Response {
-  locals: Record<string, unknown>;
-}
+export type IRes = Response<unknown, TObj>
 

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

@@ -1,47 +1,24 @@
 import { Router } from 'express';
-import jetValidator from 'jet-validator';
 
 import Paths from '../common/Paths';
-import User from '@src/models/User';
 import UserRoutes from './UserRoutes';
 
 
 // **** Variables **** //
 
-const apiRouter = Router(),
-  validate = jetValidator();
+const apiRouter = Router();
 
 
 // ** Add UserRouter ** //
 
+// Init router
 const userRouter = Router();
 
 // Get all users
-userRouter.get(
-  Paths.Users.Get,
-  UserRoutes.getAll,
-);
-
-// Add one user
-userRouter.post(
-  Paths.Users.Add,
-  validate(['user', User.isUser]),
-  UserRoutes.add,
-);
-
-// Update one user
-userRouter.put(
-  Paths.Users.Update,
-  validate(['user', User.isUser]),
-  UserRoutes.update,
-);
-
-// Delete one user
-userRouter.delete(
-  Paths.Users.Delete,
-  validate(['id', 'number', 'params']),
-  UserRoutes.delete,
-);
+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.Base, userRouter);

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

@@ -16,7 +16,7 @@ import BaseRouter from '@src/routes';
 import Paths from '@src/common/Paths';
 import EnvVars from '@src/common/EnvVars';
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import RouteError from '@src/common/RouteError';
+import { RouteError } from '@src/common/classes';
 import { NodeEnvs } from '@src/common/misc';
 
 

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

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

package/lib/project-files-auth/.eslintignore

@@ -1 +1,2 @@
 src/public/
+dotenv.config.js

package/lib/project-files-auth/README.md

@@ -5,22 +5,18 @@ This project was created with [express-generator-typescript](https://github.com/
 
 ## Available Scripts
 
-### `npm run dev`
+### `npm run dev` or `npm run dev:hot` (hot reloading)
 
 Run the server in development mode.
 
-### `npm test`
+### `npm test` or `npm run test:hot` (hot reloading)
 
-Run all unit-tests with hot-reloading.
+Run all unit-tests.
 
 ### `npm test -- --testFile="name of test file" (i.e. --testFile=Users).`
 
 Run a single unit-test.
 
-### `npm run test:no-reloading`
-
-Run all unit-tests without hot-reloading.
-
 ### `npm run lint`
 
 Check for linting errors.
@@ -33,10 +29,6 @@ Build the project for production.
 
 Run the production build (Must be built first).
 
-### `npm start -- --env="name of env file" (default is production).`
-
-Run production build with a different env file.
-
 
 ## Additional Notes
 

package/lib/project-files-auth/build.ts

@@ -14,11 +14,11 @@ import childProcess from 'child_process';
   try {
     // Remove current build
     await remove('./dist/');
+    // Copy back-end files
+    await exec('tsc --build tsconfig.prod.json', './');
     // Copy front-end files
     await copy('./src/public', './dist/public');
     await copy('./src/views', './dist/views');
-    // Copy back-end files
-    await exec('tsc --build tsconfig.prod.json', './');
   } catch (err) {
     logger.err(err);
     process.exit(1);

package/lib/project-files-auth/dotenv.config.js

@@ -0,0 +1,16 @@
+var dotenv = require('dotenv');
+var path = require('path');
+
+
+// Check the env
+var NODE_ENV = process.env.NODE_ENV || 'development';
+
+// Configure the file
+const result2 = dotenv.config({
+  path: path.join(__dirname, `./env/${NODE_ENV}.env`),
+});
+
+// Check for errors
+if (result2.error) {
+  throw result2.error;
+}

package/lib/project-files-auth/nodemon.json

@@ -0,0 +1,10 @@
+{
+  "watch": [
+    "src"
+  ],
+  "ext": "ts, html",
+  "ignore": [
+    "src/public"
+  ],
+  "exec": "npm run dev"
+}

package/lib/project-files-auth/nodemon.spec.json

@@ -0,0 +1,6 @@
+{
+  "watch": ["spec"],
+  "ext": "spec.ts",
+  "ignore": ["spec/support"],
+  "exec": "npm run test"
+}

package/lib/project-files-auth/package.json

@@ -2,23 +2,15 @@
   "name": "express-typescript-example",
   "version": "0.0.0",
   "scripts": {
+    "_ts": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register -r ./dotenv.config.js",
     "build": "npx ts-node build.ts",
+    "dev": "npm run _ts -- ./src",
+    "dev:hot": "nodemon",
     "lint": "npx eslint --ext .ts src/",
     "lint:tests": "npx eslint --ext .ts spec/",
-    "start": "node -r module-alias/register ./dist --env=production",
-    "dev": "nodemon",
-    "test": "nodemon --config ./spec/nodemon.json",
-    "test:no-reloading": "npx ts-node --files -r tsconfig-paths/register ./spec"
-  },
-  "nodemonConfig": {
-    "watch": [
-      "src"
-    ],
-    "ext": "ts, html",
-    "ignore": [
-      "src/public"
-    ],
-    "exec": "./node_modules/.bin/ts-node --files -r tsconfig-paths/register ./src"
+    "start": "NODE_ENV=production node -r module-alias/register -r ./dotenv.config.js ./dist",
+    "test": "NODE_ENV=test npm run _ts -- ./spec",
+    "test:hot": "nodemon --config ./nodemon.spec.json"
   },
   "_moduleAliases": {
     "@src": "dist"
@@ -36,7 +28,6 @@
     "inserturlparams": "^1.0.1",
     "jet-logger": "^1.3.1",
     "jet-paths": "^1.0.5",
-    "jet-validator": "^1.0.3",
     "jsonfile": "^6.1.0",
     "jsonwebtoken": "^8.5.1",
     "module-alias": "^2.2.2",