express-generator-typescript 2.4.25 → 2.5.1

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

@@ -1,143 +0,0 @@
-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: readonly string[]): string[];
-function isStr(
-  reqObj: TReqObj,
-  params: string | readonly 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: readonly string[]): number[];
-function isNum(
-  reqObj: TReqObj,
-  params: string | readonly 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: readonly string[]): boolean[];
-function isBool(
-  reqObj: TReqObj,
-  params: string | readonly 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 | readonly 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

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

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

@@ -1,35 +0,0 @@
-## About
-
-This project was created with [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript).
-
-
-## Available Scripts
-
-### `npm run dev` or `npm run dev:hot` (hot reloading)
-
-Run the server in development mode.
-
-### `npm test` or `npm run test:hot` (hot reloading)
-
-Run all unit-tests.
-
-### `npm test -- "name of test file" (i.e. Users).`
-
-Run a single unit-test.
-
-### `npm run lint`
-
-Check for linting errors.
-
-### `npm run build`
-
-Build the project for production.
-
-### `npm start`
-
-Run the production build (Must be built first).
-
-
-## Additional Notes
-
-- If `npm run dev` gives you issues with bcrypt on MacOS you may need to run: `npm rebuild bcrypt --build-from-source`. 

package/lib/project-files-auth/env/production.env

@@ -1,25 +0,0 @@
-## Environment ##
-NODE_ENV=production
-
-
-## Server ##
-PORT=8081
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=FILE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE
-
-
-## Authentication ##
-# SECURE_COOKIE 'false' here for demo-ing. But ideally should be true.
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000

package/lib/project-files-auth/env/test.env

@@ -1,24 +0,0 @@
-## Environment ##
-NODE_ENV=test
-
-
-## Server ##
-PORT=4000
-HOST=localhost
-
-
-## Setup jet-logger ##
-JET_LOGGER_MODE=CONSOLE
-JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=TRUE
-JET_LOGGER_FORMAT=LINE
-
-
-## Authentication ##
-COOKIE_DOMAIN=localhost
-COOKIE_PATH=/
-SECURE_COOKIE=false
-JWT_SECRET=xxxxxxxxxxxxxx
-COOKIE_SECRET=xxxxxxxxxxxxxx
-# expires in 3 days
-COOKIE_EXP=259200000

package/lib/project-files-auth/eslint.config.mjs

@@ -1,58 +0,0 @@
-import eslint from '@eslint/js';
-import tseslint from 'typescript-eslint';
-import stylisticTs from '@stylistic/eslint-plugin-ts';
-import nodePlugin from 'eslint-plugin-n';
-
-
-export default tseslint.config(
-  eslint.configs.recommended,
-  nodePlugin.configs['flat/recommended-script'],
-  ...tseslint.configs.strictTypeChecked,
-  ...tseslint.configs.stylisticTypeChecked,
-  { 
-    ignores: [
-      '**/node_modules/*',
-      '**/*.mjs',
-      '**/*.js',
-    ],
-  },
-  {
-    languageOptions: {
-      parserOptions: {
-        project: './tsconfig.json',
-        warnOnUnsupportedTypeScriptVersion: false,
-      },
-    },
-  },
-  {
-    plugins: {
-      '@stylistic/ts': stylisticTs,
-    }
-  },
-  { files: ['**/*.ts'] },
-  {
-    rules: {
-      '@typescript-eslint/explicit-member-accessibility': 'warn',
-      '@typescript-eslint/no-misused-promises': 0,
-      '@typescript-eslint/no-floating-promises': 0,
-      '@typescript-eslint/no-confusing-void-expression': 0,
-      '@typescript-eslint/no-unnecessary-condition': 0,
-      '@typescript-eslint/restrict-template-expressions': [ 'error', { allowNumber: true }],
-      'max-len': [
-        'warn',
-        {
-          'code': 80
-        }
-      ],
-      '@stylistic/ts/semi': ['warn'],
-      'comma-dangle': ['warn', 'always-multiline'],
-      'no-console': 1,
-      'no-extra-boolean-cast': 0,
-      'indent': ['warn', 2],
-      'quotes': ['warn', 'single'],
-      'n/no-process-env': 1,
-      'n/no-missing-import': 0,
-      'n/no-unpublished-import': 0
-    },
-  },
-)

package/lib/project-files-auth/gitignore

@@ -1,3 +0,0 @@
-**/node_modules
-dist/
-**/**/*.log

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

@@ -1,60 +0,0 @@
-{
-  "name": "express-typescript-example",
-  "version": "0.0.0",
-  "scripts": {
-    "build": "npx ts-node ./scripts/build.ts",
-    "dev": "NODE_ENV=development npx ts-node ./src",
-    "dev:hot": "nodemon --exec \"npm run dev\" --watch ./src -e ts",
-    "lint": "npx eslint ./src",
-    "lint:tests": "npx eslint ./spec",
-    "start": "NODE_ENV=production node -r ./preload.js ./dist",
-    "test": "NODE_ENV=test npx ts-node ./spec",
-    "test:hot": "nodemon --exec \"npm run test\" --watch ./src --watch ./spec -e ts"
-  },
-  "engines": {
-    "node": ">=16.0.0"
-  },
-  "dependencies": {
-    "bcrypt": "^5.0.1",
-    "cookie-parser": "^1.4.6",
-    "dotenv": "^16.0.2",
-    "express": "^4.18.1",
-    "express-async-errors": "^3.1.1",
-    "helmet": "^6.0.0",
-    "inserturlparams": "^1.0.1",
-    "jet-logger": "^1.3.1",
-    "jet-paths": "^1.0.5",
-    "jsonfile": "^6.1.0",
-    "jsonwebtoken": "^8.5.1",
-    "module-alias": "^2.2.2",
-    "moment": "^2.30.1",
-    "morgan": "^1.10.0"
-  },
-  "devDependencies": {
-    "@types/bcrypt": "^5.0.0",
-    "@eslint/js": "^9.11.1",
-    "@stylistic/eslint-plugin-ts": "^2.8.0",
-    "@types/cookie-parser": "^1.4.3",
-    "@types/eslint__js": "^8.42.3",
-    "@types/express": "^4.17.13",
-    "@types/find": "^0.2.1",
-    "@types/fs-extra": "^9.0.13",
-    "@types/jasmine": "^4.3.0",
-    "@types/jsonfile": "^6.1.0",
-    "@types/jsonwebtoken": "^8.5.9",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^18.7.14",
-    "@types/supertest": "^6.0.2",
-    "eslint": "^9.11.1",
-    "eslint-plugin-n": "^17.10.3",
-    "find": "^0.3.0",
-    "fs-extra": "^10.1.0",
-    "jasmine": "^4.3.0",
-    "nodemon": "^2.0.19",
-    "supertest": "^6.3.4",
-    "ts-node": "^10.9.1",
-    "tsconfig-paths": "^4.1.0",
-    "typescript": "^5.6.2",
-    "typescript-eslint": "^8.8.0"
-  }
-}

package/lib/project-files-auth/preload.js

@@ -1,23 +0,0 @@
-/* eslint-disable */
-
-const dotenv = require('dotenv');
-const path = require('path');
-const moduleAlias = require('module-alias');
-
-
-// Check the env
-const NODE_ENV = (process.env.NODE_ENV || 'development');
-
-// Configure "dotenv"
-const result2 = dotenv.config({
-  path: path.join(__dirname, `./env/${NODE_ENV}.env`),
-});
-if (result2.error) {
-  throw result2.error;
-}
-
-// Configure module-alias
-if (NODE_ENV === 'production') {
-  moduleAlias.addAlias('@src', __dirname + '/dist');
-}
-

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

@@ -1,62 +0,0 @@
-import fs from 'fs-extra';
-import logger from 'jet-logger';
-import childProcess from 'child_process';
-
-
-/**
- * Start
- */
-(async () => {
-  try {
-    // Remove current build
-    await remove('./dist/');
-    await exec('npm run lint', './');
-    await exec('tsc --build tsconfig.prod.json', './');
-    // Copy
-    await copy('./src/public', './dist/public');
-    await copy('./src/views', './dist/views');
-  } catch (err) {
-    logger.err(err);
-    // eslint-disable-next-line n/no-process-exit
-    process.exit(1);
-  }
-})();
-
-/**
- * Remove file
- */
-function remove(loc: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return fs.remove(loc, err => {
-      return (!!err ? rej(err) : res());
-    });
-  });
-}
-
-/**
- * Copy file.
- */
-function copy(src: string, dest: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return fs.copy(src, dest, err => {
-      return (!!err ? rej(err) : res());
-    });
-  });
-}
-
-/**
- * Do command line command.
- */
-function exec(cmd: string, loc: string): Promise<void> {
-  return new Promise((res, rej) => {
-    return childProcess.exec(cmd, {cwd: loc}, (err, stdout, stderr) => {
-      if (!!stdout) {
-        logger.info(stdout);
-      }
-      if (!!stderr) {
-        logger.warn(stderr);
-      }
-      return (!!err ? rej(err) : res());
-    });
-  });
-}

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

@@ -1,46 +0,0 @@
-import find from 'find';
-import Jasmine from 'jasmine';
-import logger from 'jet-logger';
-import { argv } from 'process';
-
-
-// Init Jasmine
-const jasmine = new Jasmine();
-jasmine.exitOnCompletion = false;
-
-// Set location of test files
-jasmine.loadConfig({
-  random: true,
-  spec_dir: 'spec',
-  spec_files: [
-    './tests/**/*.spec.ts',
-  ],
-  stopSpecOnExpectationFailure: false,
-});
-
-// Run all or a single unit-test
-let execResp: Promise<jasmine.JasmineDoneInfo> | undefined;
-if (!!argv[2]) {
-  const testFile = argv[2];
-  find.file(testFile + '.spec.ts', './spec', (files: string[]) => {
-    if (files.length === 1) {
-      jasmine.execute([files[0]]);
-    } else {
-      logger.err('Test file not found!');
-    }
-  });
-} else {
-  execResp = jasmine.execute();
-}
-
-// Wait for tests to finish
-(async () => {
-  if (!!execResp) {
-    const info = await execResp;
-    if (info.overallStatus === 'passed') {
-      logger.info('All tests have passed :)');
-    } else {
-      logger.err('At least one test has failed :(');
-    }
-  }
-})();

package/lib/project-files-auth/spec/support/Paths.ts

@@ -1,10 +0,0 @@
-/**
- * Convert paths to full for testing.
- */
-
-import jetPaths from 'jet-paths';
-
-import Paths from '@src/common/Paths';
-
-
-export default jetPaths(Paths);

package/lib/project-files-auth/spec/support/apiCb.ts

@@ -1,76 +0,0 @@
-import { CallbackHandler } from 'supertest';
-import moment from 'moment';
-import logger from 'jet-logger';
-
-import { TApiCb, TRes } from 'spec/types/misc';
-
-
-/**
- * API callback function.
- */
-function apiCb(
-  cb: TApiCb,
-  dateParam = 'created',
-  printErr?: boolean,
-): CallbackHandler {
-  return (err: Error, res: TRes) => {
-    if (printErr) {
-      logger.err(err);
-    }
-    _strToDate(res.body, dateParam);
-    return cb(res);
-  };
-}
-
-/**
- * When date objects get sent through supertest they are converted to 
- * iso-strings. This will cause "toEqual()"" tests to fail, so we need to 
- * convert them back to Date objects.
- */
-function _strToDate(
-  param: unknown,
-  prop: string,
-): void {
-  return _iterate(param, prop);
-}
-
-/**
- * Interate object recursively and convert string-dates to "Date" objects.
- */
-function _iterate(param: unknown, prop: string): void {
-  if (!param || typeof param !== 'object') {
-    return;
-  }
-  const paramF = param as Record<string, unknown>;
-  // For Arrays
-  if (Array.isArray(paramF)) {
-    for (const item of paramF) {
-      _iterate(item, prop);
-    }
-    return;
-  }
-  // Check valid string or Date object. If undefined just skip
-  const val = paramF[prop];
-  if (
-    (typeof val !== 'undefined') && 
-    !((typeof val === 'string') || (val instanceof Date)) && 
-    !moment(val as string | Date).isValid()
-  ) {
-    throw new Error('Property must be a valid date-string or Date() object');
-  }
-  // Convert and iterate
-  if (typeof val !== 'undefined') {
-    paramF[prop] = new Date(val as string | Date);
-  }
-  for (const key in paramF) {
-    const oval = paramF[key];
-    if (typeof oval === 'object' && key !== prop) {
-      _iterate(oval, prop);
-    }
-  }
-}
-
-
-// **** Export default **** //
-
-export default apiCb;

package/lib/project-files-auth/spec/support/jasmine.json

@@ -1,11 +0,0 @@
-{
-  "spec_dir": "spec",
-  "spec_files": [
-    "**/*[sS]pec.ts"
-  ],
-  "helpers": [
-    "helpers/**/*.js"
-  ],
-  "stopSpecOnExpectationFailure": false,
-  "random": true
-}

package/lib/project-files-auth/spec/support/login.ts

@@ -1,42 +0,0 @@
-import { Test, Response } from 'supertest';
-import TestAgent from 'supertest/lib/agent';
-
-import User, { UserRoles } from '@src/models/User';
-import UserRepo from '@src/repos/UserRepo';
-import PwdUtil from '@src/util/PwdUtil';
-
-import Paths from './Paths';
-
-
-// Login Credentials
-const LoginCreds = {
-  email: 'jsmith@gmail.com',
-  password: 'Password@1',
-} as const;
-
-/**
- * Login a user.
- */
-function login(beforeAgent: TestAgent<Test>, done: (arg: string) => void) {
-  // Setup dummy data
-  const role = UserRoles.Admin,
-    pwdHash = PwdUtil.hashSync(LoginCreds.password),
-    loginUser = User.new('john smith', LoginCreds.email, new Date(), role, 
-      pwdHash);
-  // Add spy
-  spyOn(UserRepo, 'getOne').and.resolveTo(loginUser);
-  // Call Login API
-  beforeAgent
-    .post(Paths.Auth.Login)
-    .type('form')
-    .send(LoginCreds)
-    .end((_: Error, res: Response) => {
-      const cookie = res.headers['set-cookie'][0];
-      return done(cookie);
-    });
-}
-
-
-// **** Export default **** //
-
-export default login;