express-generator-typescript 2.7.7 → 2.7.9

package/README.md

@@ -10,7 +10,7 @@
 
 # express-generator-typescript
 
-Production-ready Express application scaffolding with TypeScript baked in. Generate a modern API starter in seconds that follows the [TypeScript best practices](https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md) used to build this tool.
+Command line tool which generates production-ready express templates with TypeScript baked in. Spin up a web server in seconds that follows the [TypeScript best practices](https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md).
 
 
 ## Documenation

package/lib/express-generator-typescript.js

@@ -14,7 +14,7 @@ const PROJECT_FOLDER_PATH = './project-files';
 
 // Project-folder dependencies
 const DEPENDENCIES = 'express dotenv morgan cookie-parser jet-logger ' +
-  'module-alias helmet jsonfile inserturlparams jet-paths dayjs jet-env ' + 
+  'module-alias helmet jsonfile jet-paths dayjs jet-env ' + 
   'jet-validators',
   DEV_DEPENDENCIES = 'ts-node typescript nodemon find supertest vitest ' +
     '@types/node @types/find @types/morgan @types/cookie-parser ' +

package/lib/project-files/package.json

@@ -20,7 +20,6 @@
     "dotenv": "^16.5.0",
     "express": "^5.1.0",
     "helmet": "^8.1.0",
-    "inserturlparams": "^2.0.5",
     "jet-env": "^1.1.4",
     "jet-logger": "^2.1.1",
     "jet-paths": "^2.0.1",

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

@@ -1,21 +1,14 @@
-import { isNumber, isDate } from 'jet-validators';
+import { 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(
+export const transformIsDate = transform(
   arg => new Date(arg as string),
   arg => isDate(arg),
 );

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

@@ -1,7 +1,7 @@
-import { isString } from 'jet-validators';
+import { isString, isUnsignedInteger } from 'jet-validators';
 import { parseObject, TParseOnError } from 'jet-validators/utils';
 
-import { isRelationalKey, transIsDate } from '@src/common/util/validators';
+import { transformIsDate } from '@src/common/util/validators';
 import { IModel } from './common/types';
 
 /******************************************************************************
@@ -9,7 +9,7 @@ import { IModel } from './common/types';
 ******************************************************************************/
 
 const DEFAULT_USER_VALS: IUser = {
-  id: -1,
+  id: 0,
   name: '',
   created: new Date(),
   email: '',
@@ -30,10 +30,10 @@ export interface IUser extends IModel {
 
 // Initialize the "parseUser" function
 const parseUser = parseObject<IUser>({
-  id: isRelationalKey,
+  id: isUnsignedInteger,
   name: isString,
   email: isString,
-  created: transIsDate,
+  created: transformIsDate,
 });
 
 /******************************************************************************
@@ -46,8 +46,7 @@ const parseUser = parseObject<IUser>({
 function __new__(user?: Partial<IUser>): IUser {
   const defaults = { ...DEFAULT_USER_VALS };
   defaults.created = new Date();
-  const retVal = { ...defaults, ...user };
-  return parseUser(retVal, errors => {
+  return parseUser({ ...defaults, ...user }, errors => {
     throw new Error('Setup new user failed ' + JSON.stringify(errors, null, 2));
   });
 }

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

@@ -1 +1 @@
-{"users":[{"id":967269206317,"name":"Bill","created":"2025-12-17T09:55:17.960Z","email":"sean.maxwell@gmail.com"},{"id":3025435078,"name":"John Smith","created":"2025-12-17T09:55:17.960Z","email":"john.smith@gmail.com"},{"id":786429791732,"name":"Gordan Freeman","created":"2025-12-17T09:55:17.960Z","email":"gordan.freeman@gmail.com"}]}
+{"users":[{"id":345992854447,"name":"Bill","created":"2025-12-18T02:17:25.124Z","email":"sean.maxwell@gmail.com"},{"id":321485906005,"name":"John Smith","created":"2025-12-18T02:17:25.124Z","email":"john.smith@gmail.com"},{"id":70616376029,"name":"Gordan Freeman","created":"2025-12-18T02:17:25.124Z","email":"gordan.freeman@gmail.com"}]}

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

@@ -1,5 +1,3 @@
-import insertUrlParams from 'inserturlparams';
-
 import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
@@ -8,8 +6,8 @@ import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
 import { ValidationError } from '@src/common/util/route-errors';
 import { JET_PATHS as Paths }  from '@src/common/constants/PATHS';
 
-import { compareUserArrays, parseValidationError } from './common/util';
-import { agent } from './support/setup';
+import { compareUserArrays, parseValidationError } from './common/utils';
+import { agent } from './aux/setup';
 import { TRes } from './common/types';
 
 /******************************************************************************
@@ -115,14 +113,11 @@ describe('UserRouter', () => {
   // Delete User
   describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
 
-    const getPath = (id: number) => insertUrlParams(Paths.Users.Delete({ id}), 
-      { id });
-
     // Success
     it(`should return a status code of "${HTTP_STATUS_CODES.Ok}" if the ` + 
     'request was successful.', async () => {
       const id = dbUsers[0].id,
-        res = await agent.delete(getPath(id));
+        res = await agent.delete(Paths.Users.Delete(id));
       expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
     });
 
@@ -130,7 +125,7 @@ describe('UserRouter', () => {
     it('should return a JSON object with the error message of ' + 
     `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
     `"${HTTP_STATUS_CODES.NotFound}" if the id was not found.`, async () => {
-      const res: TRes = await agent.delete(getPath(-1));
+      const res: TRes = await agent.delete(Paths.Users.Delete(-1));
       expect(res.status).toBe(HTTP_STATUS_CODES.NotFound);
       expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
     });

package/lib/project-files/vitest.config.mts

@@ -5,7 +5,7 @@ const config = defineConfig({
   test: {
     globals: true,
     environment: 'node',
-    setupFiles: ['config.ts', './tests/support/setup.ts'],
+    setupFiles: ['config.ts', './tests/aux/setup.ts'],
     isolate: true,
   },
   resolve: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.7.7",
+  "version": "2.7.9",
   "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/README-git

@@ -1,79 +0,0 @@
-<p align="center">
-  <img alt="express-generator-typescript" src="https://github.com/seanpmaxwell/express-generator-typescript/raw/master/express-typescript.png" width="420">
-</p>
-
-<p align="center">
-  <a href="https://www.npmjs.com/package/express-generator-typescript"><img src="https://img.shields.io/npm/v/express-generator-typescript.svg?style=for-the-badge&logo=npm" alt="NPM Version"></a>
-  <a href="https://www.npmjs.com/package/express-generator-typescript"><img src="https://img.shields.io/npm/dm/express-generator-typescript.svg?style=for-the-badge" alt="NPM Downloads"></a>
-  <a href="https://www.npmjs.com/package/express-generator-typescript"><img src="https://img.shields.io/npm/l/express-generator-typescript.svg?style=for-the-badge" alt="License"></a>
-</p>
-
-# express-generator-typescript
-
-Production-ready Express application scaffolding with TypeScript baked in. Generate a modern API starter in seconds that follows the [TypeScript best practices](https://github.com/seanpmaxwell/Typescript-Best-Practices/blob/main/README.md) used to build this tool.
-
-## Overview
-
-`express-generator-typescript` creates a new Express application similar to the classic `express-generator` package, but the generated project is fully wired for TypeScript from day one. You get strict typing, linting, hot reloading, production builds, testing utilities, and sane defaults that focus on APIs (no view engine or opinionated ORM). Path aliases are preconfigured through `tsconfig-paths` and `_moduleAliases`, so referencing modules stays clean even as the app grows.
-
-## Features
-
-- **TypeScript-first** – strict compiler settings, linting, and sensible tsconfig defaults ready to go.
-- **API-centric** – no view engine or extra dependencies; ideal for SPAs, mobile backends, or services.
-- **Productivity tooling** – includes nodemon, ts-node, hot reload scripts, Jest, ESLint, and production builds.
-- **Path aliases** – aliases configured in `tsconfig.json` and `preload.js` so you can import modules cleanly.
-- **Keeps dependencies lean** – no bundled ORM or UI layers; only the essentials for Express + TS development.
-
-## Installation
-
-```bash
-npx express-generator-typescript
-# or install globally
-npm install -g express-generator-typescript
-```
-
-## Quick Start
-
-```bash
-# generate a project (defaults to express-gen-ts)
-npx express-generator-typescript my-api
-
-cd my-api
-
-# start developing at http://localhost:3000
-npm run dev
-```
-
-Use `--use-yarn` if you prefer Yarn over npm. If you omit the project name, the generator creates `express-gen-ts`.
-
-## CLI Options
-
-| Option            | Description                                                                 |
-| ----------------- | --------------------------------------------------------------------------- |
-| `project name`    | Folder to create. Defaults to `express-gen-ts` if omitted.                  |
-| `--use-yarn`      | Installs dependencies with Yarn instead of npm.                             |
-| `--version`       | Prints the generator version.                                               |
-
-> The historical `--with-auth` switch was removed in v2.5+. For an auth-ready example see the [express-jsonwebtoken-demo](https://github.com/seanpmaxwell/express-jsonwebtoken-demo) project.
-
-## Sample Project
-
-The generated code includes CRUD routes for illustrative `User` resources to demonstrate controllers, services, and routing patterns in Express + TypeScript. Replace these samples with your own modules after scaffolding.
-
-## Available Scripts
-
-- `npm run dev` / `npm run dev:hot` – Run the server with live reload.
-- `npm run test` / `npm run test:hot` – Execute all Jest tests, optionally with watch mode.
-- `npm run test -- users.test.ts` – Target a single test file.
-- `npm run lint` – Run ESLint checks.
-- `npm run build` – Compile the project for production.
-- `npm start` – Serve the built project.
-- `npm run type-check` – Run the TypeScript compiler without emitting files.
-
-## Debugging
-
-Development uses `nodemon` so the server restarts when files change. To enable the Node.js inspector, edit `nodemonConfig` in `package.json` (and `spec/nodemon.json` for tests) and change the `exec` value from `ts-node` to `node --inspect -r ts-node/register`.
-
-## License
-
-[MIT](LICENSE)

package/lib/project-files/src/public/scripts/http.js

@@ -1,26 +0,0 @@
-var Http = (() => {
-
-  // Setup request for json
-  var getOptions = (verb, data) => {
-    var options = {
-      dataType: 'json',
-      method: verb,
-      headers: {
-        'Accept': 'application/json',
-        'Content-Type': 'application/json',
-      },
-    };
-    if (!!data) {
-      options.body = JSON.stringify(data);
-    }
-    return options;
-  };
-
-  // Set Http methods
-  return {
-    get: (path) => fetch(path, getOptions('GET')),
-    post: (path, data) => fetch(path, getOptions('POST', data)),
-    put: (path, data) => fetch(path, getOptions('PUT', data)),
-    delete: (path) => fetch(path, getOptions('DELETE')),
-  };
-})();

package/lib/project-files/src/public/scripts/users.js

@@ -1,141 +0,0 @@
-// @ts-nocheck
-
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-const DateFormatter = new Intl.DateTimeFormat('en-US', {
-  year: 'numeric',
-  month: '2-digit',
-  day: '2-digit',
-});
-
-const formatDate = (date) => DateFormatter.format(new Date(date));
-
-
-/******************************************************************************
-                                  Run
-******************************************************************************/
-
-// Start
-displayUsers();
-
-
-/******************************************************************************
-                              Functions
-******************************************************************************/
-
-/**
- * Call api
- */
-function displayUsers() {
-  Http
-    .get('/api/users/all')
-    .then(resp => resp.json())
-    .then(resp => {
-      var allUsersTemplate = document.getElementById('all-users-template'),
-        allUsersTemplateHtml = allUsersTemplate.innerHTML,
-        template = Handlebars.compile(allUsersTemplateHtml);
-      var allUsersAnchor = document.getElementById('all-users-anchor');
-      allUsersAnchor.innerHTML = template({
-        users: resp.users.map(user => ({
-          ...user,
-          createdFormatted: formatDate(user.created),
-        })),
-      });
-    });
-}
-
-// Setup event listener for button click
-document.addEventListener('click', event => {
-  event.preventDefault();
-  var ele = event.target;
-  if (ele.matches('#add-user-btn')) {
-    addUser();
-  } else if (ele.matches('.edit-user-btn')) {
-    showEditView(ele.parentNode.parentNode);
-  } else if (ele.matches('.cancel-edit-btn')) {
-    cancelEdit(ele.parentNode.parentNode);
-  } else if (ele.matches('.submit-edit-btn')) {
-    submitEdit(ele);
-  } else if (ele.matches('.delete-user-btn')) {
-    deleteUser(ele);
-  }
-}, false);
-
-/**
- * Add a new user.
- */
-function addUser() {
-  var nameInput = document.getElementById('name-input');
-  var emailInput = document.getElementById('email-input');
-  var data = {
-    user: {
-      id: -1,
-      name: nameInput.value,
-      email: emailInput.value,
-      created: new Date(),
-    },
-  };
-  // Call api
-  Http
-    .post('/api/users/add', data)
-    .then(() => {
-      nameInput.value = '';
-      emailInput.value = '';
-      displayUsers();
-    });
-}
-
-/**
- * Show edit view.
- */
-function showEditView(userEle) {
-  var normalView = userEle.getElementsByClassName('normal-view')[0];
-  var editView = userEle.getElementsByClassName('edit-view')[0];
-  normalView.style.display = 'none';
-  editView.style.display = 'block';
-}
-
-/**
- * Cancel edit.
- */
-function cancelEdit(userEle) {
-  var normalView = userEle.getElementsByClassName('normal-view')[0];
-  var editView = userEle.getElementsByClassName('edit-view')[0];
-  normalView.style.display = 'block';
-  editView.style.display = 'none';
-}
-
-/**
- * Submit edit.
- */
-function submitEdit(ele) {
-  var userEle = ele.parentNode.parentNode;
-  var nameInput = userEle.getElementsByClassName('name-edit-input')[0];
-  var emailInput = userEle.getElementsByClassName('email-edit-input')[0];
-  var id = ele.getAttribute('data-user-id');
-  var created = ele.getAttribute('data-user-created');
-    console.log(ele, created)
-  var data = {
-    user: {
-      id: Number(id),
-      name: nameInput.value,
-      email: emailInput.value,
-      created: new Date(created),
-    },
-  };
-	Http
-    .put('/api/users/update', data)
-    .then(() => displayUsers());
-}
-
-/**
- * Delete a user
- */
-function deleteUser(ele) {
-  var id = ele.getAttribute('data-user-id');
-	Http
-    .delete('/api/users/delete/' + id)
-    .then(() => displayUsers());
-}