npm - express-generator-typescript - Versions diffs - 2.7.8 → 2.7.9 - Mend

express-generator-typescript 2.7.8 → 2.7.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

package/lib/project-files/README.md +65 -0
package/lib/project-files/config/.env.development +15 -0
package/lib/project-files/config/.env.production +15 -0
package/lib/project-files/config/.env.test +14 -0
package/lib/project-files/config.ts +22 -0
package/lib/project-files/eslint.config.ts +100 -0
package/lib/project-files/gitignore +6 -0
package/lib/project-files/package.json +56 -0
package/lib/project-files/scripts/build.ts +28 -0
package/lib/project-files/scripts/common/utils.ts +93 -0
package/lib/project-files/src/common/constants/ENV.ts +19 -0
package/lib/project-files/src/common/constants/HTTP_STATUS_CODES.ts +81 -0
package/lib/project-files/src/common/constants/PATHS.ts +15 -0
package/lib/project-files/src/common/constants/index.ts +11 -0
package/lib/project-files/src/common/util/misc.ts +11 -0
package/lib/project-files/src/common/util/route-errors.ts +38 -0
package/lib/project-files/src/common/util/validators.ts +14 -0
package/lib/project-files/src/index.ts +27 -0
package/lib/project-files/src/models/User.ts +68 -0
package/lib/project-files/src/models/common/types.ts +5 -0
package/lib/project-files/src/public/stylesheets/users.css +48 -0
package/lib/project-files/src/repos/MockOrm.ts +63 -0
package/lib/project-files/src/repos/UserRepo.ts +134 -0
package/lib/project-files/src/repos/database.json +1 -0
package/lib/project-files/src/repos/database.test.json +1 -0
package/lib/project-files/src/routes/UserRoutes.ts +69 -0
package/lib/project-files/src/routes/common/types/index.ts +10 -0
package/lib/project-files/src/routes/common/util/index.ts +16 -0
package/lib/project-files/src/routes/index.ts +31 -0
package/lib/project-files/src/server.ts +86 -0
package/lib/project-files/src/services/UserService.ts +70 -0
package/lib/project-files/src/views/users.html +132 -0
package/lib/project-files/tests/aux/setup.ts +26 -0
package/lib/project-files/tests/common/types.ts +16 -0
package/lib/project-files/tests/common/utils.ts +55 -0
package/lib/project-files/tests/users.test.ts +133 -0
package/lib/project-files/tsconfig.json +35 -0
package/lib/project-files/tsconfig.prod.json +30 -0
package/lib/project-files/vitest.config.mts +18 -0
package/package.json +1 -1
package/README-git +0 -78
package/express-typescript.png +0 -0

package/lib/project-files/src/views/users.html ADDED Viewed

@@ -0,0 +1,132 @@
+<!DOCTYPE html>
+<html lang="en">
+  <!-- Head -->
+  <head>
+    <meta charset="UTF-8">
+    <title>Users</title>
+    <link rel="stylesheet" type="text/css" href="/stylesheets/users.css" />
+    <!-- Handlebars -->
+    <script src="http://cdnjs.cloudflare.com/ajax/libs/handlebars.js/4.7.8/handlebars.min.js"></script>
+    <!-- Bootstrap -->
+    <link
+      href="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css"
+      rel="stylesheet"
+      integrity="sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH"
+      crossorigin="anonymous"
+    />
+    <script
+      src="https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js"
+      integrity="sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz"
+      crossorigin="anonymous"
+    ></script>
+  </head>
+  <!-- Body -->
+  <body>
+    <!-- Add Users -->
+    <div class="users-column add-user-col">
+      <div class="column-header">
+        Add User:
+      </div>
+      <div>
+        <input
+          id="name-input"
+          type="text"
+          class="form-control"
+          placeholder="Name"
+        />
+      </div>
+      <div>
+        <input
+          id="email-input"
+          type="email"
+          class="form-control"
+          placeholder="Email"
+        />
+      </div>
+      <div>
+        <button
+          id="add-user-btn"
+          class="btn btn-success"
+        >
+          Add
+        </button>
+      </div>
+    </div>
+    <!-- Display Users -->
+    <div class="users-column">
+      <div class="column-header">
+        Users:
+      </div>
+      <div id="all-users-anchor"></div>
+      <script
+        id="all-users-template"
+        type="text/x-handlebars-template"
+      >
+        {{#each users}}
+          <div class="user-display-ele">
+            <div class="normal-view">
+              <div><b>Name:</b> {{name}}</div>
+              <div><b>Email:</b> {{email}}</div>
+              <div><b>Created:</b> {{createdFormatted}}</div>
+              <button
+                type="button"
+                class="btn btn-primary edit-user-btn"
+                data-user-id="{{id}}"
+              >
+                Edit
+              </button>
+              <button
+                class="btn btn-danger delete-user-btn"
+                data-user-id="{{id}}"
+              >
+                Delete
+              </button>
+            </div>
+            <div class="edit-view">
+              <div>
+                Name:&nbsp;
+                <input
+                  type="text"
+                  class="form-control name-edit-input"
+                  value="{{name}}"
+                />
+              </div>
+              <div class="email-edit">
+                Email:&nbsp;
+                <input
+                  type="email"
+                  class="form-control email-edit-input"
+                  value="{{email}}"
+                />
+              </div>
+              <button
+                class="btn btn-primary submit-edit-btn"
+                data-user-id="{{id}}"
+                data-user-created="{{created}}"
+              >
+                Submit
+              </button>
+              <button
+                class="btn btn-secondary cancel-edit-btn"
+                data-user-id="{{id}}"
+              >
+                Cancel
+              </button>
+            </div>
+          </div>
+        {{/each}}
+      </script>
+    </div>
+  </body>
+  <script src="scripts/http.js"></script>
+  <script src="scripts/users.js"></script>
+</html>

package/lib/project-files/tests/aux/setup.ts ADDED Viewed

@@ -0,0 +1,26 @@
+import { beforeAll } from 'vitest';
+import supertest, { Test } from 'supertest';
+import TestAgent from 'supertest/lib/agent';
+import app from '@src/server';
+import MockOrm from '@src/repos/MockOrm';
+/******************************************************************************
+                                    Run
+******************************************************************************/
+let agent: TestAgent<Test>;
+beforeAll(async () => {
+  agent = supertest.agent(app);
+  await MockOrm.cleanDb();
+});
+/******************************************************************************
+                                    Export
+******************************************************************************/
+export { agent };

package/lib/project-files/tests/common/types.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { Response } from 'supertest';
+/******************************************************************************
+                                Types
+******************************************************************************/
+// Use generics to add properties to 'body'
+export type TRes<T = object> = Omit<Response, 'body'> & {
+  body: T & { error?: string | IErrorObject },
+};
+interface IErrorObject {
+  message: string;
+  [key: string]: unknown;
+}

package/lib/project-files/tests/common/utils.ts ADDED Viewed

@@ -0,0 +1,55 @@
+import { IParseObjectError, parseJson } from 'jet-validators/utils';
+import { isString } from 'jet-validators';
+import { IUser } from '@src/models/User';
+/******************************************************************************
+                                Types
+******************************************************************************/
+type TUserArray = IUser[] | readonly IUser[];
+interface IValidationError {
+  message: string;
+  errors: IParseObjectError[];
+}
+/******************************************************************************
+                                Functions
+******************************************************************************/
+/**
+ * JSON parse a validation error.
+ */
+export function parseValidationError(arg: unknown): IValidationError {
+  if (!isString(arg)) {
+    throw new Error('Not a string');
+  }
+  return parseJson<IValidationError>(arg);
+}
+/**
+ * Compare to user arrays. Order does not matter and this assumes the email
+ * field is unique
+ */
+export function compareUserArrays(a: TUserArray, b: TUserArray): boolean {
+  if (a.length !== b.length) return false;
+  const aSorted = sortByEmail(a);
+  const bSorted = sortByEmail(b);
+  for (let i = 0; i < aSorted.length; i++) {
+    const a = aSorted[i],
+      b = bSorted[i];
+    if (a.email !== b.email || a.name !== b.name) {
+      return false;
+    }
+  }
+  return true;
+}
+/**
+ * Sort user array by email.
+ */
+function sortByEmail(arr: TUserArray): IUser[] {
+  return [...arr].sort((x, y) => {
+    return x.email.localeCompare(y.email);
+  });
+}

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

@@ -0,0 +1,133 @@
+import UserRepo from '@src/repos/UserRepo';
+import User, { IUser } from '@src/models/User';
+import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
+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/utils';
+import { agent } from './aux/setup';
+import { TRes } from './common/types';
+/******************************************************************************
+                               Constants
+******************************************************************************/
+// Dummy users for GET req
+const DB_USERS = [
+  User.new({ name: 'Sean Maxwell', email: 'sean.maxwell@gmail.com' }),
+  User.new({ name: 'John Smith', email: 'john.smith@gmail.com' }),
+  User.new({ name: 'Gordan Freeman', email: 'gordan.freeman@gmail.com' }),
+] as const;
+/******************************************************************************
+                                 Tests
+  IMPORTANT: Following TypeScript best practices, we test all scenarios that
+  can be triggered by a user under normal circumstances. Not all theoretically
+  scenarios (i.e. a failed database connection).
+******************************************************************************/
+describe('UserRouter', () => {
+  let dbUsers: IUser[] = [];
+  // Run before all tests
+  beforeEach(async () => {
+    await UserRepo.deleteAllUsers();
+    dbUsers = await UserRepo.insertMult(DB_USERS);
+  });
+  // Get all users
+  describe(`"GET:${Paths.Users.Get}"`, () => {
+    // Success
+    it('should return a JSON object with all the users and a status code ' +
+    `of "${HTTP_STATUS_CODES.Ok}" if the request was successful.`, async () => {
+      const res: TRes<{ users: IUser[]}> = await agent.get(Paths.Users.Get);
+      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
+      expect(compareUserArrays(res.body.users, DB_USERS)).toBeTruthy();
+    });
+  });
+  // Test add user
+  describe(`"POST:${Paths.Users.Add}"`, () => {
+    // Test add user success
+    it(`should return a status code of "${HTTP_STATUS_CODES.Created}" if ` +
+    'the request was successful.', async () => {
+      const user = User.new({ name: 'a', email: 'a@a.com' }),
+        res = await agent.post(Paths.Users.Add).send({ user });
+      expect(res.status).toBe(HTTP_STATUS_CODES.Created);
+    });
+    // Missing param
+    it('should return a JSON object with an error message of and a status ' +
+      `code of "${HTTP_STATUS_CODES.BadRequest}" if the user param was ` +
+      'missing.', async () => {
+      const res: TRes = await agent.post(Paths.Users.Add).send({ user: null });
+      expect(res.status).toBe(HTTP_STATUS_CODES.BadRequest);
+      const errorObj = parseValidationError(res.body.error);
+      expect(errorObj.message).toBe(ValidationError.MESSAGE);
+      expect(errorObj.errors[0].prop).toBe('user');
+    });
+  });
+  // Update users
+  describe(`"PUT:${Paths.Users.Update}"`, () => {
+    // Success
+    it(`should return a status code of "${HTTP_STATUS_CODES.Ok}" if the ` +
+    'request was successful.', async () => {
+      const user = DB_USERS[0];
+      user.name = 'Bill';
+      const res = await agent.put(Paths.Users.Update).send({ user });
+      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
+    });
+    // Id is the wrong data type
+    it('should return a JSON object with an error message and a status code ' +
+    `of "${HTTP_STATUS_CODES.BadRequest}" if the user param was missing`,
+    async () => {
+      const user = User.new();
+      user.id = ('5' as unknown as number);
+      const res: TRes = await agent.put(Paths.Users.Update).send({ user });
+      expect(res.status).toBe(HTTP_STATUS_CODES.BadRequest);
+      const errorObj = parseValidationError(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');
+    });
+    // User not found
+    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 user = User.new({ id: 4, name: 'a', email: 'a@a.com' }),
+        res: TRes = await agent.put(Paths.Users.Update).send({ user });
+      expect(res.status).toBe(HTTP_STATUS_CODES.NotFound);
+      expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
+    });
+  });
+  // Delete User
+  describe(`"DELETE:${Paths.Users.Delete()}"`, () => {
+    // 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(Paths.Users.Delete(id));
+      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
+    });
+    // User not found
+    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(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/tsconfig.json ADDED Viewed

@@ -0,0 +1,35 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "lib": ["ES2020"],
+    "strict": true,
+    "baseUrl": "./",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@src/*": ["src/*"]
+    },
+    "useUnknownInCatchVariables": false,
+    "types": ["vitest/globals"],
+  },
+  "ts-node": {
+    "swc": true,
+    "require": [
+      "tsconfig-paths/register",
+      "./config.ts"
+    ],
+  },
+  "include": [
+    "src/**/*.ts",
+    "tests/**/*.ts",
+    "config.ts",
+    "scripts",
+    "eslint.config.ts",
+    "vitest.config.mts"
+  ],
+  "exclude": [
+    "src/public/*"
+  ]
+}

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

@@ -0,0 +1,30 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "module": "CommonJS",
+    "lib": ["ES2020"],
+    "strict": true,
+    "baseUrl": "./",
+    "outDir": "temp",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@src/*": ["src/*"]
+    },
+    "useUnknownInCatchVariables": false,
+    "sourceMap": false,
+    "removeComments": true
+  },
+  "include": [
+    "src/**/*.ts",
+    "config.ts"
+  ],
+  "exclude": [
+    "tests",
+    "src/public/",
+    "scripts",
+    "eslint.config.ts",
+    "vitest.config.js"
+  ]
+}

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

@@ -0,0 +1,18 @@
+import { defineConfig } from 'vitest/config';
+import path from 'path';
+const config = defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    setupFiles: ['config.ts', './tests/aux/setup.ts'],
+    isolate: true,
+  },
+  resolve: {
+    alias: {
+      '@src': path.resolve(__dirname, './src'),
+    },
+  },
+});
+export default config;

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.7.8",
+  "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 DELETED Viewed

@@ -1,78 +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
-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).
-## 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. 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.                             |
-> 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/express-typescript.png DELETED Viewed

Binary file