express-generator-typescript 2.8.1 → 2.9.1

package/lib/template/README.md

@@ -0,0 +1,50 @@
+## About
+
+This project was created with [express-generator-typescript](https://github.com/seanpmaxwell/express-generator-typescript). It requires Node.js 22.12 or newer.
+
+<p align="center">· · ·</p>
+
+
+## Available Scripts
+
+### `npm run install:clean`
+
+Remove the existing `node_modules/` folder, `package-lock.json`, and reinstall all library modules.
+
+### `npm run dev` 
+
+Run the server in development with hot reloading and browser refresh (see `package.json` for all `npm run dev` variations)<br/>
+
+**IMPORTANT** development mode uses `swc` for performance reasons which DOES NOT check for typescript errors. Run `npm run typecheck` to check for type errors. NOTE: you should use your IDE to prevent most type errors.
+
+### `npm test`
+
+Run unit-tests with <a href="https://vitest.dev/guide/">vitest</a>.
+
+### `npm run lint`
+
+Check for linting errors.
+
+### `npm run format`
+
+Format `src/` and `tests/` with prettier.
+
+### `npm run build`
+
+Build the project for production.
+
+### `npm start`
+
+Run the production build (Must be built first).
+
+### `npm run typecheck`
+
+Check for typescript errors.
+
+<p align="center">· · ·</p>
+
+
+## Additional Notes
+
+- `config/.env.production` is listed in `.gitignore` so production secrets don't get committed. Keep it out of version control and provide its values through your deployment tooling.
+- The database is a JSON file (`src/repos/common/database.json`, or `dist/repos/common/database.json` in production) meant only for the demo. It's created automatically if missing and isn't safe for concurrent writes, so replace `src/repos/MockOrm.ts` with a real database before going to production.

package/lib/template/bs-config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  proxy: "http://localhost:3000/", // The address where your Express app runs
+  open: true, // Avoid reopening the browser on every nodemon restart
+  port: 3001, // The port BrowserSync will run on
+  files: ["src/**/*.*"], // Files to watch
+  ignore: ['**/node_modules/**', '**/repos/**/*.json'],
+  reloadDelay: 500, // Wait for nodemon to restart
+};

package/lib/{project-files → template}/config/.env.development

@@ -1,15 +1,13 @@
-## Environment ##
+# ---- Environment
 NODE_ENV=development
 
 
-## Server ##
+# ---- Server
 PORT=3000
-HOST=localhost
 
 
-## Setup jet-logger ##
+# ---- Setup jet-logger
 JET_LOGGER_MODE=console
 JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=true
+JET_LOGGER_SHOW_TIME=true
 JET_LOGGER_FORMAT=line
-

package/lib/{project-files → template}/config/.env.production

@@ -1,14 +1,13 @@
-## Environment ##
+# ---- Environment
 NODE_ENV=production
 
 
-## Server ##
+# ---- Server
 PORT=8081
-HOST=localhost
 
 
-## Setup jet-logger ##
+# ---- Setup jet-logger
 JET_LOGGER_MODE=file
 JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=true
+JET_LOGGER_SHOW_TIME=true
 JET_LOGGER_FORMAT=line

package/lib/{project-files → template}/config/.env.test

@@ -1,14 +1,13 @@
-## Environment ##
+# ---- Environment
 NODE_ENV=test
 
 
-## Server ##
+# ---- Server
 PORT=4000
-HOST=localhost
 
 
-## Setup jet-logger ##
+# ---- Setup `jet-logger`
 JET_LOGGER_MODE=console
 JET_LOGGER_FILEPATH=jet-logger.log
-JET_LOGGER_TIMESTAMP=true
+JET_LOGGER_SHOW_TIME=true
 JET_LOGGER_FORMAT=line

package/lib/{project-files → template}/eslint.config.ts

@@ -4,6 +4,10 @@ import n from 'eslint-plugin-n';
 import { defineConfig, globalIgnores } from 'eslint/config';
 import tseslint from 'typescript-eslint';
 
+// ========================================================================= //
+//                                  EXPORT                                   //
+// ========================================================================= //
+
 export default defineConfig([
   // global ignores
   globalIgnores(['**/dist/**', '**/public/**/lib/**']),

package/lib/template/gitignore

@@ -0,0 +1,10 @@
+**/node_modules
+dist/
+**/**/*.log
+tsconfig.tsbuildinfo
+
+# Rewritten on every test run
+src/repos/common/database.test.json
+
+# Keep production secrets out of git; share values through your deploy tooling
+config/.env.production

package/lib/{project-files → template}/package.json

@@ -1,11 +1,10 @@
 {
   "name": "express-typescript-example",
-  "version": "0.0.0",
+  "version": "0.1.0",
   "scripts": {
-    "build": "shx rm -rf dist && npm run lint && tsc --project tsconfig.prod.json && npm run build:copy-static && npm run build:make-db",
+    "build": "shx rm -rf dist && npm run lint && tsc --project tsconfig.prod.json && npm run build:copy-static",
     "build:copy-static": "shx mkdir -p dist/public dist/views && shx cp -r src/public/* dist/public && shx cp -r src/views/* dist/views",
-    "build:make-db": "shx mkdir -p dist/repos/common && shx touch dist/repos/common/database.json && echo \"{}\" > dist/repos/common/database.json",
-    "clean-install": "rm -rf ./node_modules && rm -r package-lock.json && npm i",
+    "install:clean": "shx rm -rf ./node_modules package-lock.json && npm i",
     "dev:basic": "cross-env DOTENV_CONFIG_PATH=./config/.env.development ts-node ./src/main",
     "dev:watch": "nodemon --exec \"npm run dev:basic\" --watch ./src --ext .ts",
     "dev": "concurrently \"npm run dev:watch\" \"npm run sync\"",
@@ -14,59 +13,55 @@
     "start": "cross-env DOTENV_CONFIG_PATH=./config/.env.production node -r dotenv/config -r module-alias/register ./dist/main.js",
     "sync": "delay 1s && browser-sync start --config bs-config.js",
     "test": "cross-env NODE_ENV=test vitest",
-    "type-check": "tsc -b --noEmit"
+    "typecheck": "tsc -b --noEmit"
   },
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=22.12.0"
   },
   "_moduleAliases": {
     "@src": "dist"
   },
   "dependencies": {
-    "cookie-parser": "^1.4.7",
     "cross-env": "^10.1.0",
-    "dayjs": "^1.11.19",
-    "dotenv": "^17.2.3",
+    "dotenv": "^18.0.4",
     "express": "^5.2.1",
-    "helmet": "^8.1.0",
+    "helmet": "^8.3.0",
     "jet-env": "^1.1.6",
-    "jet-logger": "^2.2.3",
-    "jet-paths": "^3.1.1",
+    "jet-id": "^1.3.1",
+    "jet-logger": "3.0.0",
+    "jet-paths": "^4.0.2",
     "jet-validators": "^2.3.1",
-    "jsonfile": "^6.2.0",
-    "module-alias": "^2.2.3",
-    "morgan": "^1.10.1",
-    "tspo": "^1.0.7"
+    "jsonfile": "^6.2.1",
+    "module-alias": "^2.3.4",
+    "morgan": "^1.12.1"
   },
   "devDependencies": {
-    "@eslint/js": "^9.39.2",
-    "@swc/core": "^1.15.8",
+    "@eslint/js": "^10.0.1",
+    "@swc/core": "^1.16.2",
     "@trivago/prettier-plugin-sort-imports": "^6.0.2",
-    "@types/cookie-parser": "^1.4.10",
-    "@types/find": "^0.2.4",
-    "@types/fs-extra": "^11.0.4",
+    "@types/express": "^5.0.6",
     "@types/jsonfile": "^6.1.4",
-    "@types/module-alias": "^2.0.4",
     "@types/morgan": "^1.9.10",
-    "@types/node": "^25.0.9",
-    "@types/supertest": "^6.0.3",
+    "@types/node": "^26.6.2",
+    "@types/supertest": "^7.2.1",
     "browser-sync": "^3.0.4",
-    "concurrently": "^9.2.1",
+    "concurrently": "^10.0.5",
     "delay-cli": "^3.0.0",
-    "eslint": "^9.39.2",
+    "eslint": "^10.11.0",
     "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-n": "^17.23.2",
-    "find": "^0.3.0",
-    "fs-extra": "^11.3.3",
-    "jiti": "^2.6.1",
-    "nodemon": "^3.1.11",
-    "prettier": "^3.8.0",
+    "eslint-plugin-n": "^18.3.0",
+    "jiti": "^2.7.0",
+    "nodemon": "^3.1.14",
+    "prettier": "^3.9.9",
     "shx": "^0.4.0",
-    "supertest": "^7.2.2",
+    "supertest": "^7.3.0",
     "ts-node": "^10.9.2",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.9.3",
-    "typescript-eslint": "^8.53.0",
-    "vitest": "^4.0.17"
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.70.1",
+    "vitest": "^5.0.2"
+  },
+  "allowScripts": {
+    "@swc/core@1.16.2": true
   }
 }

package/lib/{project-files → template}/src/common/constants/HttpStatusCodes.ts

@@ -1,9 +1,8 @@
+import { ValueOf } from '../types/utility-types';
 
-/******************************************************************************
-                                Constants
-******************************************************************************/
-
-import { ValueOf } from "../types/structure-utils";
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
 
 /**
  * Hypertext Transfer Protocol (HTTP) response status codes.
@@ -386,9 +385,14 @@ const HttpStatusCodes = {
   NETWORK_AUTHENTICATION_REQUIRED: 511,
 } as const;
 
-/******************************************************************************
-                            Export default
-******************************************************************************/
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
 
 type HttpStatusCodes = ValueOf<typeof HttpStatusCodes>;
+
+// ========================================================================= //
+//                                  EXPORT                                   //
+// ========================================================================= //
+
 export default HttpStatusCodes;

package/lib/template/src/common/constants/Paths.ts

@@ -0,0 +1,22 @@
+import jetPaths from 'jet-paths';
+
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
+
+const Paths = jetPaths({
+  _: '/api',
+  Users: {
+    _: '/users',
+    Get: '/all',
+    Add: '/add',
+    Update: '/update',
+    Delete: '/delete',
+  },
+} as const);
+
+// ========================================================================= //
+//                                  EXPORT                                   //
+// ========================================================================= //
+
+export default Paths;

package/lib/template/src/common/constants/env-inv.ts

@@ -0,0 +1,31 @@
+import jetEnv, { num } from 'jet-env';
+import { ValueOf } from '../types/utility-types';
+
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
+
+// NOTE: These need to match the names of your ".env" files
+export const NodeEnvs = {
+  DEV: 'development',
+  TEST: 'test',
+  PRODUCTION: 'production',
+} as const;
+export type NodeEnvs = ValueOf<typeof NodeEnvs>;
+
+// ========================================================================= //
+//                                   EXEC                                    //
+// ========================================================================= //
+
+// Setup the is `NodeEnvs` validator
+const isNodeEnv = (() => {
+  const vals = Object.values(NodeEnvs);
+  const valsFin = vals.map((item) => item.toLowerCase());
+  const set = new Set(valsFin);
+  return (val: unknown): val is NodeEnvs => set.has(val as NodeEnvs);
+})();
+
+export const EnvVars = jetEnv({
+  NodeEnv: isNodeEnv,
+  Port: num,
+});

package/lib/template/src/common/types/utility-types.ts

@@ -0,0 +1,5 @@
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export type ValueOf<T> = T[keyof T];

package/lib/template/src/common/utils/date-utils.ts

@@ -0,0 +1,29 @@
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export type ISOString =
+  `${number}-${number}-${number}T${number}:${number}:${number}${string}`;
+
+// ========================================================================= //
+//                                 FUNCTIONS                                 //
+// ========================================================================= //
+
+/**
+ * Return the current-date (or a provided date) as an ISOString.
+ */
+export function getISOString(date = new Date()): ISOString {
+  return date.toISOString() as ISOString;
+}
+
+/**
+ * Validate an ISOString.
+ */
+export function isISOString(value: unknown): value is ISOString {
+  try {
+    const date = new Date(value as string);
+    return !isNaN(date.getTime()) && date.toISOString() === value;
+  } catch {
+    return false;
+  }
+}

package/lib/template/src/common/utils/route-errors.ts

@@ -0,0 +1,37 @@
+import { ParseError } from 'jet-validators/utils';
+
+import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+
+// ========================================================================= //
+//                                  CLASSES                                  //
+// ========================================================================= //
+
+/**
+ * Error with status code and message. `errors` (optional) is sent to the
+ * client alongside the message.
+ */
+export class RouteError extends Error {
+  public status: HttpStatusCodes;
+  public errors?: unknown[];
+
+  public constructor(
+    status: HttpStatusCodes,
+    message: string,
+    errors?: unknown[],
+  ) {
+    super(message);
+    this.status = status;
+    this.errors = errors;
+  }
+}
+
+/**
+ * Request data failed schema validation.
+ */
+export class ValidationError extends RouteError {
+  public static MESSAGE = 'Request validation failed.';
+
+  public constructor(errors: ParseError[]) {
+    super(HttpStatusCodes.BAD_REQUEST, ValidationError.MESSAGE, errors);
+  }
+}

package/lib/template/src/main.ts

@@ -0,0 +1,24 @@
+import logger from 'jet-logger';
+
+import { EnvVars } from './common/constants/env-inv';
+import server from './server';
+
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
+
+const SERVER_START_MESSAGE =
+  'Express server started on port: ' + EnvVars.Port.toString();
+
+// ========================================================================= //
+//                                   EXEC                                    //
+// ========================================================================= //
+
+// Start the server
+server.listen(EnvVars.Port, (err) => {
+  if (!!err) {
+    logger.err(err.message);
+  } else {
+    logger.info(SERVER_START_MESSAGE);
+  }
+});

package/lib/template/src/models/User.model.ts

@@ -0,0 +1,95 @@
+import jetid from 'jet-id';
+import { isNonEmptyString, isString } from 'jet-validators';
+import { parseObject, Schema, testObject } from 'jet-validators/utils';
+
+import { getISOString, isISOString } from '@src/common/utils/date-utils';
+
+import { Entity } from './common/types';
+
+// ========================================================================= //
+//                                 CONSTANTS                                 //
+// ========================================================================= //
+
+const GetDefaults = (): IUser => ({
+  id: jetid(),
+  name: '',
+  email: '',
+  created: getISOString(),
+});
+
+const schema: Schema<IUser> = {
+  id: isUserId,
+  name: isString,
+  email: isString,
+  created: isISOString,
+};
+
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+/**
+ * @entity users
+ */
+export interface IUser extends Entity {
+  name: string;
+  email: string;
+}
+
+/**
+ * Fields a client supplies when creating a user; the server sets the rest.
+ */
+export type IUserInput = Pick<IUser, 'name' | 'email'>;
+
+// ========================================================================= //
+//                                 FUNCTIONS                                 //
+// ========================================================================= //
+
+/**
+ * Validate the `User` schema.
+ */
+const parseUser = parseObject<IUser>(schema);
+
+/**
+ * For the APIs make sure the right fields are complete
+ */
+const isCompleteUser = testObject<IUser>({
+  ...schema,
+  name: isNonEmptyString,
+  email: isNonEmptyString,
+});
+
+/**
+ * Validate the fields a client sends to create a user.
+ */
+const isUserInput = testObject<IUserInput>({
+  name: isNonEmptyString,
+  email: isNonEmptyString,
+});
+
+/**
+ * Test if an id is a valid user id.
+ */
+function isUserId(val: unknown): val is string {
+  return jetid.test(val);
+}
+
+/**
+ * New user object.
+ */
+function new_(user?: Partial<IUser>): IUser {
+  return parseUser({ ...GetDefaults(), ...user }, (errors) => {
+    throw new Error('Setup new user failed ' + JSON.stringify(errors, null, 2));
+  });
+}
+
+// ========================================================================= //
+//                                  EXPORT                                   //
+// ========================================================================= //
+
+export default {
+  new: new_,
+  isId: isUserId,
+  isComplete: isCompleteUser,
+  isInput: isUserInput,
+} as const;

package/lib/template/src/models/common/types.ts

@@ -0,0 +1,10 @@
+import { ISOString } from "@src/common/utils/date-utils";
+
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export interface Entity {
+  id: string; // @PK
+  created: ISOString; // @audit
+}

package/lib/template/src/public/scripts/http.js

@@ -0,0 +1,25 @@
+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')),
+  };
+})();