express-generator-typescript 2.5.16 → 2.5.18

package/README-git

@@ -0,0 +1,95 @@
+<img alt='overnightjs' src='https://github.com/seanpmaxwell/express-generator-typescript/raw/master/express-typescript.png' border='0'>
+
+[Express](https://www.npmjs.com/package/express) with [TypeScript's](https://www.npmjs.com/package/typescript) application generator.
+
+<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/v/express-generator-typescript.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/l/express-generator-typescript.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/package/express-generator-typescript" target="_blank"><img src="https://img.shields.io/npm/dm/express-generator-typescript.svg" alt="NPM Downloads" /></a>
+
+
+## What is it?
+
+Creates a new express application similar to the _express-generator_ module. Except this new application is configured to use TypeScript instead of plain JavaScript. 
+
+This project complies with Typescript best practices listed <a href="https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md">here</a>.
+
+
+## Why express-generator-typescript?
+
+NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of type safety. TypeScript solves this issue and (along with its linter file) can even make your code more robust than some other static languages like Java.
+
+There are some other tools out there to generate express apps with TypeScript such as _express-generator-ts_, but these either haven't been updated in a while or install a lot of junk in your project (such as an ORM). 
+
+Due to the heavy use of single-page-applications, no view-engine is configured by default. Express is only setup with the minimal settings for calling APIs and serving an index.html file. All the tools you need to run for development (while restarting on changes), building, testing, and running for production are packaged with this library. 
+
+In addition, relative paths are also setup, so you don't have to go through the trouble of installing and configuring _tsconfig-paths_ and _module-alias_. Just make sure to update `paths` in _tsconfig.json_ and `_moduleAliases` in _preload.js_ if you want to add/edit the relative paths.
+
+
+## Sample-project
+
+When you run _express-generator-typescript_, it sets up a simple application with routes for adding, updating, deleting, and fetching user objects. This is just to demonstrate how routing is done with express. 
+
+### `--with-auth` option no longer available for version 2.5+
+
+For the command-line, you used to be able to pass the `--with-auth` option to generate an app which required a login before using the routes; however, maintaining two separate projects became quite cumbersome. If you want an example of how to do authentication in expressjs with json-web-tokens you can refer to this sample project <a href="https://github.com/seanpmaxwell/express-jsonwebtoken-demo">here</a>.
+
+
+## Installation
+
+```sh
+$ Just use 'npx'
+  Or
+$ npm install -g express-generator-typescript
+```
+
+
+## Quick Start
+
+The quickest way to get started is use npx and pass in the name of the project you want to create. If you don't specify a project name, the default _express-gen-ts_ will be used instead. If you want to use `yarn` instead of `npm`, pass the option `--use-yarn`.
+
+Create the app:<br/>
+With no options: `$ npx express-generator-typescript`<br/>
+With all options (order doesn't matter): `$ npx express-generator-typescript --use-yarn "project name"`
+
+
+Start your express-generator-typescript app in development mode at `http://localhost:3000/`:
+
+```bash
+$ cd "project name" && npm run dev
+```
+
+
+## Available commands for the server.
+
+- Run the server in development mode: `npm run dev` or `npm run dev:hot`.
+- Run all unit-tests: `npm run test` or `npm run test:hot`.
+- Run a single unit-test: `npm test -- --testFile="name of test file" (i.e. --testFile=Users)`.
+- Check for linting errors: `npm run lint`.
+- Build the project for production: `npm run build`.
+- Run the production build: `npm start`.
+- Check for typescript errors: `npm run type-check`.
+
+
+## Debugging
+
+During development, _express-generator-typescript_ uses `nodemon` to restart the server when changes are detected. If you want to enable debugging for node, you'll need to modify the nodemon configurations. This is located under `nodemonConfig:` in `package.json` for the server and `./spec/nodemon.json` for unit-testing. For the `exec` property, replace `ts-node` with `node --inspect -r ts-node/register`.
+
+
+## Note for VSCode users
+
+In order to use eslint as a typescript file with VSCode, you need to add a setting to your eslint options. At the root of your project, add a `.vscode/settings.json` file (if you don't have one already) and add the option `unstable_ts_config`:
+
+```typescript
+  "eslint.options": {
+    "flags": ["unstable_ts_config"]
+  }
+```
+<br/>
+
+
+Happy web deving :)
+
+
+## License
+
+[MIT](LICENSE)

package/README.md

@@ -12,84 +12,7 @@
 Creates a new express application similar to the _express-generator_ module. Except this new application is configured to use TypeScript instead of plain JavaScript. 
 
 This project complies with Typescript best practices listed <a href="https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md">here</a>.
-
-
-## Why express-generator-typescript?
-
-NodeJS is great for the rapid development of web-projects, but is often neglected because of the lack of type safety. TypeScript solves this issue and (along with its linter file) can even make your code more robust than some other static languages like Java.
-
-There are some other tools out there to generate express apps with TypeScript such as _express-generator-ts_, but these either haven't been updated in a while or install a lot of junk in your project (such as an ORM). 
-
-Due to the heavy use of single-page-applications, no view-engine is configured by default. Express is only setup with the minimal settings for calling APIs and serving an index.html file. All the tools you need to run for development (while restarting on changes), building, testing, and running for production are packaged with this library. 
-
-In addition, relative paths are also setup, so you don't have to go through the trouble of installing and configuring _tsconfig-paths_ and _module-alias_. Just make sure to update `paths` in _tsconfig.json_ and `_moduleAliases` in _preload.js_ if you want to add/edit the relative paths.
-
-
-## Sample-project
-
-When you run _express-generator-typescript_, it sets up a simple application with routes for adding, updating, deleting, and fetching user objects. This is just to demonstrate how routing is done with express. 
-
-### `--with-auth` option no longer available for version 2.5+
-
-For the command-line, you used to be able to pass the `--with-auth` option to generate an app which required a login before using the routes; however, maintaining two separate projects became quite cumbersome. If you want an example of how to do authentication in expressjs with json-web-tokens you can refer to this sample project <a href="https://github.com/seanpmaxwell/express-jsonwebtoken-demo">here</a>.
-
-
-## Installation
-
-```sh
-$ Just use 'npx'
-  Or
-$ npm install -g express-generator-typescript
-```
-
-
-## Quick Start
-
-The quickest way to get started is use npx and pass in the name of the project you want to create. If you don't specify a project name, the default _express-gen-ts_ will be used instead. If you want to use `yarn` instead of `npm`, pass the option `--use-yarn`.
-
-Create the app:<br/>
-With no options: `$ npx express-generator-typescript`<br/>
-With all options (order doesn't matter): `$ npx express-generator-typescript --use-yarn "project name"`
-
-
-Start your express-generator-typescript app in development mode at `http://localhost:3000/`:
-
-```bash
-$ cd "project name" && npm run dev
-```
-
-
-## Available commands for the server.
-
-- Run the server in development mode: `npm run dev` or `npm run dev:hot`.
-- Run all unit-tests: `npm run test` or `npm run test:hot`.
-- Run a single unit-test: `npm test -- --testFile="name of test file" (i.e. --testFile=Users)`.
-- Check for linting errors: `npm run lint`.
-- Build the project for production: `npm run build`.
-- Run the production build: `npm start`.
-- Check for typescript errors: `npm run type-check"`.
-
-
-## Debugging
-
-During development, _express-generator-typescript_ uses `nodemon` to restart the server when changes are detected. If you want to enable debugging for node, you'll need to modify the nodemon configurations. This is located under `nodemonConfig:` in `package.json` for the server and `./spec/nodemon.json` for unit-testing. For the `exec` property, replace `ts-node` with `node --inspect -r ts-node/register`.
-
-
-## Note for VSCode users
-
-In order to use eslint as a typescript file with VSCode, you need to add a setting to your eslint options. At the root of your project, add a `.vscode/settings.json` file (if you don't have one already) and add the option `unstable_ts_config`:
-
-```typescript
-  "eslint.options": {
-    "flags": ["unstable_ts_config"]
-  }
-```
 <br/>
 
 
-Happy web deving :)
-
-
-## License
-
-[MIT](LICENSE)
+Please refer to the official <a href="https://github.com/seanpmaxwell/express-generator-typescript">github repo</a> for the most up-to-date documentation.

package/lib/express-generator-typescript.js

@@ -15,7 +15,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-validators',
+  'jet-paths dayjs 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/README.md

@@ -2,6 +2,19 @@
 
 This project was created with [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript).
 
+**IMPORTANT** for demo purposes I had to disable `helmet` in production. In any real world app you should change these 3 lines of code in `src/server.ts`:
+```ts
+// eslint-disable-next-line n/no-process-env
+if (!process.env.DISABLE_HELMET) {
+  app.use(helmet());
+}
+```
+
+To just this:
+```ts
+app.use(helmet());
+```
+
 
 ## Available Scripts
 

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

@@ -5,6 +5,7 @@ NODE_ENV=production
 ## Server ##
 PORT=8081
 HOST=localhost
+DISABLE_HELMET=TRUE
 
 
 ## Setup jet-logger ##

package/lib/project-files/package.json

@@ -26,8 +26,7 @@
     "jet-env": "^1.1.4",
     "jet-logger": "^2.0.1",
     "jet-paths": "^1.1.0",
-    "jet-schema": "^1.4.2",
-    "jet-validators": "^1.1.0",
+    "jet-validators": "^1.3.3",
     "jsonfile": "^6.1.0",
     "module-alias": "^2.2.2",
     "morgan": "^1.10.0"

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

@@ -1,6 +1,7 @@
 import { Response } from 'supertest';
-import { TParseReqErr } from '@src/routes/common';
 import UserRepo from '@src/repos/UserRepo';
+import { IParseObjectError, parseJson } from 'jet-validators/utils';
+import { isString } from 'jet-validators';
 
 
 /******************************************************************************
@@ -17,9 +18,9 @@ interface IErrObj {
   [key: string]: unknown;
 }
 
-export interface IValidationErr {
+interface IValidationErr {
   message: string;
-  parameters: TParseReqErr[];
+  errors: IParseObjectError[];
 }
 
 
@@ -35,3 +36,13 @@ export async function cleanDatabase(): Promise<void> {
     UserRepo.deleteAllUsers(),
   ]);
 }
+
+/**
+ * JSON parse a validation error.
+ */
+export function parseValidationErr(arg: unknown): IValidationErr {
+  if (!isString(arg)) {
+    throw new Error('Not a string');
+  }
+  return parseJson<IValidationErr>(arg);
+}

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

@@ -1,6 +1,6 @@
 import supertest from 'supertest';
 import insertUrlParams from 'inserturlparams';
-import { parseJson, customDeepCompare } from 'jet-validators/utils';
+import { customDeepCompare } from 'jet-validators/utils';
 
 import app from '@src/server';
 
@@ -9,11 +9,10 @@ import User, { IUser } from '@src/models/User';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
-import { ValidationErr } from '@src/common/route-errors';
+import { ValidationError } from '@src/common/route-errors';
 
 import Paths from 'spec/support/Paths';
-import { cleanDatabase, IValidationErr, TRes } from 'spec/support';
-import { isObject } from 'jet-validators';
+import { cleanDatabase, parseValidationErr, TRes } from 'spec/support';
 
 
 /******************************************************************************
@@ -93,10 +92,9 @@ describe('UserRouter', () => {
         .send({ user: null })
         .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          const errorObj = parseJson<IValidationErr>(res.body.error),
-            parseErr = errorObj.parameters[0];
-          expect(errorObj.message).toBe(ValidationErr.MSG);
-          expect(isObject(parseErr) && parseErr.prop === 'user').toBeTruthy();
+          const errorObj = parseValidationErr(res.body.error);
+          expect(errorObj.message).toBe(ValidationError.MESSAGE);
+          expect(errorObj.errors[0].prop).toBe('user');
           done();
         });
     });
@@ -119,19 +117,21 @@ describe('UserRouter', () => {
         });
     });
 
-    // Param missing
+    // Id is the wrong data type
     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 => {
+      const user = User.new();
+      user.id = ('5' as unknown as number);
       agent
         .put(Paths.Users.Update)
-        .send({ user: null })
+        .send({ user })
         .end((_, res: TRes) => {
           expect(res.status).toBe(HttpStatusCodes.BAD_REQUEST);
-          const errorObj = parseJson<IValidationErr>(res.body.error),
-            parseErr = errorObj.parameters[0];
-          expect(errorObj.message).toBe(ValidationErr.MSG);
-          expect(isObject(parseErr) && parseErr.prop === 'user').toBeTruthy();
+          const errorObj = parseValidationErr(res.body.error);
+          expect(errorObj.message).toBe(ValidationError.MESSAGE);
+          expect(errorObj.errors[0].prop).toBe('user');
+          expect(errorObj.errors[0].children?.[0].prop).toBe('id');
           done();
         });
     });

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

@@ -1,8 +1,10 @@
+import { IParseObjectError } from 'jet-validators/utils';
+
 import HttpStatusCodes from '@src/common/HttpStatusCodes';
 
 
 /******************************************************************************
-                              Classes
+                                 Classes
 ******************************************************************************/
 
 /**
@@ -18,15 +20,17 @@ export class RouteError extends Error {
 }
 
 /**
- * Validation in route layer errors.
+ * Handle "parseObj" errors.
  */
-export class ValidationErr extends RouteError {
-  public static MSG = 'One or more parameters were missing or invalid.';
+export class ValidationError extends RouteError {
+
+  public static MESSAGE = 'The parseObj() function discovered one or ' + 
+    'more errors.';
 
-  public constructor(errObj: unknown) {
+  public constructor(errors: IParseObjectError[]) {
     const msg = JSON.stringify({
-      message: ValidationErr.MSG,
-      parameters: errObj,
+      message: ValidationError.MESSAGE,
+      errors,
     });
     super(HttpStatusCodes.BAD_REQUEST, msg);
   }

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

@@ -1,7 +1,19 @@
 import { isString } from 'jet-validators';
+import { parseObject, TParseOnError } from 'jet-validators/utils';
 
-import schema from '@src/util/schema';
-import { isRelationalKey } from '@src/util/validators';
+import { isRelationalKey, transIsDate } from '@src/util/validators';
+
+
+/******************************************************************************
+                                 Variables
+******************************************************************************/
+
+const DEFAULT_USER_VALS = (): IUser => ({
+  id: -1,
+  name: '',
+  created: new Date(),
+  email: '',
+});
 
 
 /******************************************************************************
@@ -17,14 +29,32 @@ export interface IUser {
 
 
 /******************************************************************************
-                                 Setup
+                                 Functions
 ******************************************************************************/
 
-const User = schema<IUser>({
+/**
+ * New user object.
+ */
+function newUser(user?: Partial<IUser>): IUser {
+  const retVal = { ...DEFAULT_USER_VALS(), ...user };
+  return parseUser(retVal);
+}
+
+/**
+ * Check is a user object.
+ */
+function testUser(arg: unknown, errCb?: TParseOnError): arg is IUser {
+  return !!parseUser(arg, errCb);
+}
+
+/**
+ * Validate a user object.
+ */
+const parseUser = parseObject<IUser>({
   id: isRelationalKey,
   name: isString,
-  created: Date,
   email: isString,
+  created: transIsDate,
 });
 
 
@@ -32,4 +62,7 @@ const User = schema<IUser>({
                                 Export default
 ******************************************************************************/
 
-export default User;
+export default {
+  new: newUser,
+  test: testUser,
+} as const;

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

@@ -1 +1 @@
-{"users":[{"id":833335167307,"name":"Bill","created":"2025-02-21T15:41:21.593Z","email":"sean.maxwell@gmail.com"},{"id":721615734671,"name":"John Smith","created":"2025-02-21T15:41:21.593Z","email":"john.smith@gmail.com"},{"id":531901228132,"name":"Gordan Freeman","created":"2025-02-21T15:41:21.593Z","email":"gordan.freeman@gmail.com"},{"id":811228870992,"name":"a","created":"2025-02-21T15:41:21.594Z","email":"a@a.com"}]}
+{"users":[{"id":937353914582,"name":"Bill","created":"2025-03-10T08:02:45.482Z","email":"sean.maxwell@gmail.com"},{"id":564064331076,"name":"John Smith","created":"2025-03-10T08:02:45.482Z","email":"john.smith@gmail.com"},{"id":491773368070,"name":"Gordan Freeman","created":"2025-03-10T08:02:45.482Z","email":"gordan.freeman@gmail.com"}]}

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

@@ -5,7 +5,7 @@ import HttpStatusCodes from '@src/common/HttpStatusCodes';
 import UserService from '@src/services/UserService';
 import User from '@src/models/User';
 
-import { parseReq, IReq, IRes } from './common';
+import { IReq, IRes, parseReq } from './common';
 
 
 /******************************************************************************

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

@@ -1,78 +1,28 @@
 import { Response, Request } from 'express';
-import { isObject, isString } from 'jet-validators';
 import { parseObject, TSchema } from 'jet-validators/utils';
 
-import { ValidationErr } from '@src/common/route-errors';
+import { ValidationError } from '@src/common/route-errors';
 
 
 /******************************************************************************
-                                Types
-******************************************************************************/
-
-type TRecord = Record<string, unknown>;
-export type IReq = Request<TRecord, void, TRecord, TRecord>;
-export type IRes = Response<unknown, TRecord>;
-
-export type TParseReqErr = {
-  prop: string,
-  value: unknown,
-  moreInfo?: string,
-} | string;
-
-
-/******************************************************************************
-                                Functions
+                              Functions
 ******************************************************************************/
 
 /**
- * Parse a Request object property and throw a Validation error if it fails.
+ * Throw a "ParseObjError" when "parseObject" fails. Also extract a nested 
+ * "ParseObjError" and add it to the nestedErrors array.
  */
 export function parseReq<U extends TSchema>(schema: U) {
-  return (arg: unknown) => {
-    // Don't alter original object (shallow copy is good enough)
-    if (isObject(arg)) {
-      arg = { ...arg };
-    }
-    // Setup error callback
-    const errArr: TParseReqErr[] = [],
-      errCb = setupErrorCb(errArr);
-    // Run Tests
-    const retVal = parseObject<U>(schema, errCb)(arg);
-    if (errArr.length > 0) {
-      throw new ValidationErr(errArr);
-    }
-    // Return
-    return retVal;
-  };
+  return parseObject(schema, errors => {
+    throw new ValidationError(errors);
+  });
 }
 
-/**
- * Setup the error callback function for when "parseReq" fires and error.
- */
-function setupErrorCb(errArr: TParseReqErr[]) {
-  return function (
-    prop = 'undefined',
-    value?: unknown,
-    caughtErr?: unknown,
-  ) {
-    // Initialize err
-    let err: TParseReqErr;
-    if (arguments.length === 1) {
-      err = prop;
-    } else {
-      err = { prop, value };
-    }
-    // Check if there's a "caught error"
-    if (isObject(err) && caughtErr !== undefined) {
-      let moreInfo;
-      if (!isString(caughtErr)) {
-        moreInfo = JSON.stringify(caughtErr);
-      } else {
-        moreInfo = caughtErr;
-      }
-      err.moreInfo = moreInfo;
-    }
-    // Add error to array
-    errArr.push(err);
-  };
-}
+
+/******************************************************************************
+                                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/server.ts

@@ -35,7 +35,10 @@ if (ENV.NodeEnv === NodeEnvs.Dev) {
 
 // Security
 if (ENV.NodeEnv === NodeEnvs.Production) {
-  app.use(helmet());
+  // eslint-disable-next-line n/no-process-env
+  if (!process.env.DISABLE_HELMET) {
+    app.use(helmet());
+  }
 }
 
 // Add APIs, must be after middleware

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

@@ -1,4 +1,8 @@
 
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
 /**
  * Get a random number between 1 and 1,000,000,000,000
  */

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

@@ -1,9 +1,22 @@
-import { isNumber } from 'jet-validators';
+import { isNumber, isDate } from 'jet-validators';
+import { transform } from 'jet-validators/utils';
 
 
+/******************************************************************************
+                                Functions
+******************************************************************************/
+
 /**
  * Database relational key.
  */
 export function isRelationalKey(arg: unknown): arg is number {
   return isNumber(arg) && arg >= -1;
 }
+
+/**
+ * Convert to date object then check is a validate date.
+ */
+export const transIsDate = transform(
+  arg => new Date(arg as string),
+  arg => isDate(arg),
+);

package/package.json

@@ -1,9 +1,11 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.5.16",
+  "version": "2.5.18",
   "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",
+    "pre-publish": "mv README.md README-git && mv README-npm README.md",
+    "post-publish": "mv README.md README-npm && mv README-git README.md",
     "start": "node bin/cli.js",
     "test": "echo \"Error: no test specified\" && exit 1"
   },

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

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