express-generator-typescript 2.5.5 → 2.5.7

package/lib/express-generator-typescript.js

@@ -13,7 +13,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-paths dayjs jet-schema jet-env ',
+  'jet-paths dayjs jet-schema jet-env jet-validators',
   DEV_DEPENDENCIES = 'ts-node typescript nodemon find jasmine supertest ' +
     '@types/node @types/express @types/jasmine @types/find @types/morgan  ' +
     '@types/cookie-parser @types/supertest fs-extra tsconfig-paths jiti @swc/core ' +

package/lib/project-files/eslint.config.ts

@@ -4,7 +4,6 @@ import stylisticJs from '@stylistic/eslint-plugin-js';
 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'],

package/lib/project-files/package.json

@@ -18,21 +18,22 @@
   "dependencies": {
     "cookie-parser": "^1.4.6",
     "dayjs": "^1.11.13",
-    "dotenv": "^16.0.2",
+    "dotenv": "^16.4.5",
     "express": "^4.18.1",
     "express-async-errors": "^3.1.1",
     "helmet": "^6.0.0",
-    "inserturlparams": "^1.0.1",
+    "inserturlparams": "^2.0.5",
     "jet-env": "^1.1.4",
-    "jet-logger": "^1.3.1",
-    "jet-paths": "^1.0.5",
+    "jet-logger": "^2.0.1",
+    "jet-paths": "^1.1.0",
     "jet-schema": "^1.4.2",
+    "jet-validators": "^1.0.6",
     "jsonfile": "^6.1.0",
     "module-alias": "^2.2.2",
     "morgan": "^1.10.0"
   },
   "devDependencies": {
-    "@eslint/js": "^9.11.1",
+    "@eslint/js": "^9.16.0",
     "@stylistic/eslint-plugin-js": "^2.11.0",
     "@stylistic/eslint-plugin-ts": "^2.8.0",
     "@swc/core": "^1.9.3",
@@ -48,7 +49,7 @@
     "@types/node": "^18.7.14",
     "@types/supertest": "^6.0.2",
     "eslint": "^9.11.1",
-    "eslint-plugin-n": "^17.10.3",
+    "eslint-plugin-n": "^17.14.0",
     "find": "^0.3.0",
     "fs-extra": "^10.1.0",
     "jasmine": "^4.3.0",

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

@@ -0,0 +1,18 @@
+import { isValidDate } from 'jet-validators';
+import { traverseObject } from 'jet-validators/utils';
+
+
+/**
+ * Send a date object over an API will convert it to a string, so for jasmine
+ * tests to pass we need to convert them back to date objects.
+ */
+export function convertValidDates(toConvert: string | string[]) {
+  if (!Array.isArray(toConvert)) {
+    toConvert = [toConvert];
+  }
+  return traverseObject((prop, value, parentObj) => {
+    if (toConvert.includes(prop) && isValidDate(value)) {
+      parentObj[prop] = new Date(value);
+    }
+  });
+}

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

@@ -1,22 +1,25 @@
 import supertest, { Test } from 'supertest';
 import TestAgent from 'supertest/lib/agent';
 import insertUrlParams from 'inserturlparams';
+import { safeJsonParse } from 'jet-validators/utils';
+import logger from 'jet-logger';
 
 import app from '@src/server';
 
 import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
 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 { convertValidDates } from 'spec/support';
+import { TApiCb, TRes } from 'spec/types/misc';
 
 
+// **** Setup **** //
+
 // Dummy users for GET req
 const getDummyUsers = () => [
   User.new({ name: 'Sean Maxwell', email: 'sean.maxwell@gmail.com' }),
@@ -24,8 +27,25 @@ const getDummyUsers = () => [
   User.new({ name: 'Gordan Freeman', email: 'gordan.freeman@gmail.com' }),
 ];
 
+// Convert "created" prop back to Date object
+const createdKeyToDate = convertValidDates('created');
+
+// Setup wrap-callback function
+const wrapCb = (cb: TApiCb) => (err: Error, res: TRes) => {
+  if (!!err) {
+    logger.err(err);
+  }
+  if (!!res.body.user) {
+    createdKeyToDate(res.body.user);
+  } else if (!!res.body.users) {
+    res.body.users?.map(user => createdKeyToDate(user));
+  }
+  return cb(res);
+};
+
+
+// **** Run Tests **** //
 
-// Tests
 describe('UserRouter', () => {
 
   let agent: TestAgent<Test>;
@@ -43,7 +63,7 @@ describe('UserRouter', () => {
     const api = (cb: TApiCb) => 
       agent
         .get(Paths.Users.Get)
-        .end(apiCb(cb));
+        .end(wrapCb(cb));
 
     // Success
     it('should return a JSON object with all the users and a status code ' + 
@@ -70,7 +90,7 @@ describe('UserRouter', () => {
       agent
         .post(Paths.Users.Add)
         .send({ user })
-        .end(apiCb(cb));
+        .end(wrapCb(cb));
 
     // Test add user success
     it(`should return a status code of "${HttpStatusCodes.CREATED}" if the ` + 
@@ -109,7 +129,7 @@ describe('UserRouter', () => {
       agent
         .put(Paths.Users.Update)
         .send({ user })
-        .end(apiCb(cb));
+        .end(wrapCb(cb));
 
     // Success
     it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
@@ -154,7 +174,7 @@ describe('UserRouter', () => {
     const callApi = (id: number, cb: TApiCb) => 
       agent
         .delete(insertUrlParams(Paths.Users.Delete, { id }))
-        .end(apiCb(cb));
+        .end(wrapCb(cb));
 
     // Success
     it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 

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

@@ -1,6 +1,6 @@
 import jetEnv, { num } from 'jet-env';
+import { isEnumVal } from 'jet-validators';
 
-import { isEnumVal } from '@src/util/validators';
 import { NodeEnvs } from './constants';
 
 

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

@@ -1,5 +1,7 @@
+import { isString } from 'jet-validators';
+
 import schema from '@src/util/schema';
-import { isNum, isStr } from '@src/util/validators';
+import { isRelationalKey } from '@src/util/validators';
 
 
 export interface IUser {
@@ -10,10 +12,10 @@ export interface IUser {
 }
 
 const User = schema<IUser>({
-  id: isNum,
-  name: isStr,
+  id: isRelationalKey,
+  name: isString,
   created: Date,
-  email: isStr,
+  email: isString,
 });
 
 

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

@@ -1,7 +1,10 @@
+import { isNumber } from 'jet-validators';
+import { transform } from 'jet-validators/utils';
+
 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 { parseReq, IReq, IRes } from './common';
 
@@ -11,7 +14,7 @@ import { parseReq, IReq, IRes } from './common';
 const Validators = {
   add: parseReq({ user: User.test }),
   update: parseReq({ user: User.test }),
-  delete: parseReq({ id: transform(Number, isNum) }),
+  delete: parseReq({ id: transform(Number, isNumber) }),
 } as const;
 
 

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

@@ -1,14 +1,14 @@
 import { Response, Request } from 'express';
+import { parseObject, TSchema } from 'jet-validators/utils';
 
-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>;
+type TRecord = Record<string, unknown>;
+export type IReq = Request<TRecord, void, TRecord, TRecord>;
+export type IRes = Response<unknown, TRecord>;
 
 
 // **** Functions **** //
@@ -17,7 +17,7 @@ export type IRes = Response<unknown, TObj>;
  * Parse a Request object property and throw a Validation error if it fails.
  */
 export function parseReq<U extends TSchema>(schema: U) {
-  return parseObj<U>(schema, _parseReqOnError);
+  return parseObject<U>(schema, _parseReqOnError);
 }
 
 /**

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

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

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

@@ -1,326 +1,9 @@
-/**
- * NOTE: These functions were copied from here: 
- * https://github.com/seanpmaxwell/ts-validators/blob/master/src/validators.ts
- */
-
-/* eslint-disable max-len */
-
-
-// **** Types **** //
-
-type TBasicObj = Record<string, unknown>;
-type TEnum = Record<string, string | number>;
-
-// Add modifiers
-type AddNull<T, N> = (N extends true ? T | null : T);
-type AddNullables<T, O, N> = (O extends true ? AddNull<T, N> | undefined  : AddNull<T, N>);
-type AddMods<T, O, N, A> = A extends true ? AddNullables<T[], O, N> : AddNullables<T, O, N>;
-export type TValidateWithTransform<T> = (arg: unknown, cb?: (arg: T) => void) => arg is T;
-
-
-// **** Functions **** //
-
-// Nullables
-export const isUndef = ((arg: unknown): arg is undefined => arg === undefined);
-export const isNull = ((arg: unknown): arg is null => arg === null);
-
-// Base types
-export const isStr = _checkType<string>('string');
-export const isNum = _checkType<number>('number');
-export const isBool = _checkType<boolean>('boolean');
-export const isObj = _checkType<object>('object');
-
-// Misc
-export const parseObj = <U extends TSchema>(arg: U, onError?: TParseOnError<false>) => 
-  _parseObj<U, false, false, false>(arg, false, false, false, onError);
-export const isEnumVal = <T>(arg: T) => _isEnumVal<T, false, false>(arg, false, false);
-
-// Util
-export const transform = _transform;
-export const safeJsonParse = _safeJsonParse;
-
-
-// **** Helpers **** //
-
-/**
- * Check if unknown is a valid enum object.
- * NOTE: this does not work for mixed enums see: "eslint@typescript-eslint/no-mixed-enums"
- */
-function _isEnum(arg: unknown): arg is TEnum {
-  // Check is non-array object
-  if (!(isObj(arg) && !Array.isArray(arg))) {
-    return false;
-  }
-  // Check if string or number enum
-  const param = (arg as TBasicObj),
-    keys = Object.keys(param),
-    middle = Math.floor(keys.length / 2);
-  // ** String Enum ** //
-  if (!isNum(param[keys[middle]])) {
-    return _checkObjEntries(arg, (key, val) => {
-      return isStr(key) && isStr(val);
-    });
-  }
-  // ** Number Enum ** //
-  // Enum key length will always be even
-  if (keys.length % 2 !== 0) {
-    return false;
-  }
-  // Check key/values
-  for (let i = 0; i < middle; i++) {
-    const thisKey = keys[i],
-      thisVal = param[thisKey],
-      thatKey = keys[i + middle],
-      thatVal = param[thatKey];
-    if (!(thisVal === thatKey && thisKey === String(thatVal))) {
-      return false;
-    }
-  }
-  // Return
-  return true;
-}
-
-/**
- * Check is value satisfies enum.
- */
-function _isEnumVal<T, 
-  O extends boolean,
-  N extends boolean
->(
-  enumArg: T,
-  optional: O,
-  nullable: N,
-): ((arg: unknown) => arg is AddNullables<T[keyof T], O, N>) {
-  // Check is enum
-  if (!_isEnum(enumArg)) {
-    throw Error('Item to check from must be an enum.');
-  }
-  // Get keys
-  let resp = Object.keys(enumArg).reduce((arr: unknown[], key) => {
-    if (!arr.includes(key)) {
-      arr.push(enumArg[key]);
-    }
-    return arr;
-  }, []);
-  // Check if string or number enum
-  if (isNum(enumArg[resp[0] as string])) {
-    resp = resp.map(item => enumArg[item as string]);
-  }
-  // Return validator function
-  return (arg: unknown): arg is AddNullables<T[keyof T], O, N> => {
-    if (isUndef(arg)) {
-      return !!optional;
-    }
-    if (isNull(arg)) {
-      return !!nullable;
-    }
-    return resp.some(val => arg === val);
-  };
-}
-
-/**
- * Do a validator callback function for each object key/value pair.
- */
-function _checkObjEntries(
-  val: unknown,
-  cb: (key: string, val: unknown) => boolean,
-): val is NonNullable<object> {
-  if (isObj(val)) {
-    for (const entry of Object.entries(val)) {
-      if (!cb(entry[0], entry[1])) {
-        return false;
-      }
-    }
-  }
-  return true;
-}
+import { isNumber } from 'jet-validators';
 
-/**
- * Wrapper to check basic type.
- */
-function _checkType<T>(type: string) {
-  return (arg: unknown): arg is T => {
-    return typeof arg === type && (type === 'object' ? (arg !== null) : true);
-  };
-}
-
-/**
- * Transform a value before checking it.
- */
-function _transform<T>(
-  transFn: (arg: unknown) => T,
-  vldt: ((arg: unknown) => arg is T),
-): TValidateWithTransform<T> {
-  return (arg: unknown, cb?: (arg: T) => void): arg is T => {
-    if (arg !== undefined) {
-      arg = transFn(arg);
-    }
-    cb?.(arg as T);
-    return vldt(arg);
-  };
-}
-
-/**
- * Safe JSON parse
- */
-function _safeJsonParse<T>(arg: unknown): T {
-  if (isStr(arg)) {
-    return JSON.parse(arg) as T;
-  } else {
-    throw Error('JSON parse argument must be a string');
-  }
-}
-
-
-// **** Parse Object **** //
-
-export interface TSchema {
-  [key: string]: TValidateWithTransform<unknown> | TSchema;
-}
-
-type TInferParseRes<U, O, N, A, Schema = TInferParseResHelper<U>> = (
-  AddMods<Schema, O, N, A>
-);
-
-type TInferParseResHelper<U> = {
-  [K in keyof U]: (
-    U[K] extends TValidateWithTransform<infer X> 
-    ? X 
-    : U[K] extends TSchema
-    ? TInferParseResHelper<U[K]>
-    : never
-  );
-};
-
-type TParseOnError<A> = (
-  A extends true 
-  ? ((property?: string, value?: unknown, index?: number, caughtErr?: unknown) => void) 
-  : ((property?: string, value?: unknown, caughtErr?: unknown) => void)
-);
-
-/**
- * validates an object schema, calls an error function is supplied one, returns 
- * "undefined" if the parse fails, and works recursively too.
- */
-function _parseObj<
-  U extends TSchema,
-  O extends boolean,
-  N extends boolean,
-  A extends boolean,
->(
-  schema: U,
-  optional: O,
-  nullable: N,
-  isArr: A,
-  onError?: TParseOnError<A>,
-) {
-  return (arg: unknown) => _parseObjCore(
-    !!optional,
-    !!nullable,
-    !!isArr,
-    schema,
-    arg,
-    onError,
-  ) as TInferParseRes<U, O, N, A>;
-}
-
-/**
- * Validate the schema. 
- */
-function _parseObjCore<A>(
-  optional: boolean,
-  nullable: boolean,
-  isArr: A,
-  schema: TSchema,
-  arg: unknown,
-  onError?: TParseOnError<A>,
-) {
-  // Check "undefined"
-  if (arg === undefined) {
-    if (!optional) {
-      onError?.('object value was undefined but not optional', arg);
-      return undefined;
-    }
-  }
-  // Check "null"
-  if (arg === null) {
-    if (!nullable) {
-      onError?.('object value was null but not nullable', arg);
-      return undefined;
-    }
-    return null;
-  }
-  // Check "array"
-  if (isArr) {
-    if (!Array.isArray(arg)) {
-      onError?.('object not an array', arg);
-      return null;
-    }
-    // Iterate array
-    const resp = [];
-    for (let i = 0; i < arg.length; i++) {
-      const item: unknown = arg[i];
-      const parsedItem = _parseObjCoreHelper(schema, item, (prop, val, caughtErr) => {
-        onError?.(prop, val, i, caughtErr);
-      });
-      if (parsedItem === undefined) {
-        return undefined;
-      } else {
-        resp.push(parsedItem);
-      }
-    }
-    return resp;
-  // Default
-  } else {
-    return _parseObjCoreHelper(schema, arg, onError as TParseOnError<false>);
-  }
-}
 
 /**
- * Iterate an object, apply a validator function to to each property in an 
- * object using the schema.
+ * Database relational key.
  */
-function _parseObjCoreHelper(
-  schema: TSchema,
-  arg: unknown,
-  onError?: TParseOnError<false>,
-): unknown {
-  if (!isObj(arg)) {
-    return;
-  }
-  const retVal = (arg as TBasicObj);
-  for (const key in schema) {
-    const schemaProp = schema[key],
-      val = retVal[key];
-    // Nested object
-    if (typeof schemaProp === 'object') {
-      const childVal = _parseObjCoreHelper(schemaProp, val, onError);
-      if (childVal === undefined) {
-        return undefined;
-      }
-    // Run validator
-    } else if (typeof schemaProp === 'function') {
-      try {
-        if (!schemaProp(val, (tval: unknown) => {
-          retVal[key] = tval;
-        })) {
-          return onError?.(key, val);
-        }
-      } catch (err) {
-        if (err instanceof Error) {
-          return onError?.(key, val, err.message);
-        } else {
-          return onError?.(key, val, err);
-        }
-      }
-    }
-  }
-  // Purse keys not in schema
-  for (const key in retVal) {
-    if (!(key in schema)) {
-      Reflect.deleteProperty(arg, key);
-    }
-  }
-  // Return
-  return retVal;
+export function isRelationalKey(arg: unknown): arg is number {
+  return isNumber(arg) && arg >= -1;
 }

package/lib/project-files/tsconfig.json

@@ -1,12 +1,11 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "module": "commonjs",
+    "module": "NodeNext",
     "lib": [
       "ES2020"
-    ],                    
+    ],                        
     "strict": true,
-    "moduleResolution": "node",
     "baseUrl": "./",
     "esModuleInterop": true,                 
     "skipLibCheck": true,                     

package/lib/project-files/tsconfig.prod.json

@@ -1,12 +1,11 @@
 {
   "compilerOptions": {
     "target": "ES2020",
-    "module": "commonjs",
+    "module": "NodeNext",
     "lib": [
       "ES2020"
-    ],                  
+    ],                        
     "strict": true,
-    "moduleResolution": "node",
     "baseUrl": "./",
     "outDir": "temp",
     "esModuleInterop": true,                 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.5.5",
+  "version": "2.5.7",
   "description": "Generate new Express applications similar to express-generate which but sets it up to use TypeScript instead",
   "scripts": {
     "express-generator-typescript": "node bin/cli.js",

package/lib/project-files/config.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
-const dotenv_1 = __importDefault(require("dotenv"));
-const module_alias_1 = __importDefault(require("module-alias"));
-const NODE_ENV = (process.env.NODE_ENV ?? 'development');
-const result2 = dotenv_1.default.config({
-    path: path_1.default.join(__dirname, `./config/.env.${NODE_ENV}`),
-});
-if (result2.error) {
-    throw result2.error;
-}
-if (__filename.endsWith('js')) {
-    module_alias_1.default.addAlias('@src', __dirname + '/dist');
-}

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

@@ -1,88 +0,0 @@
-import { CallbackHandler } from 'supertest';
-import dayjs, { Dayjs } from 'dayjs';
-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 (val !== undefined && !_isValidDate(val)) {
-    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);
-    }
-  }
-}
-
-/**
- * Is date a valid date.
- */
-function _isValidDate(date: unknown): boolean {
-  if (
-    typeof date === 'string' || 
-    (date instanceof Date) || 
-    (date instanceof Dayjs) || 
-    typeof date === 'number'
-  ) {
-    return dayjs(date).isValid();
-  } else {
-    return false;
-  }
-}
-
-
-// **** Export default **** //
-
-export default apiCb;