express-generator-typescript 3.0.3 → 3.1.0

package/lib/template/src/repos/UserRepo.ts

@@ -1,7 +1,4 @@
-import jetid from 'jet-id';
-
-import { getISOString } from '@src/common/utils/date-utils';
-import type { UserEntity } from '@src/entities/User';
+import { type UserEntity } from '@src/entities/User';
 
 import orm from './MockOrm';
 
@@ -15,9 +12,7 @@ import orm from './MockOrm';
 async function persists(id: string): Promise<boolean> {
   const db = await orm.openDb();
   for (const user of db.users) {
-    if (user.id === id) {
-      return true;
-    }
+    if (user.id === id) return true;
   }
   return false;
 }
@@ -27,13 +22,13 @@ async function persists(id: string): Promise<boolean> {
  */
 async function getAll(): Promise<UserEntity[]> {
   const db = await orm.openDb();
-  return db.users;
+  return db.users.sort((a, b) => a.id.localeCompare(b.id));
 }
 
 /**
  * Add one user.
  */
-async function add(user: UserEntity): Promise<void> {
+async function addOne(user: UserEntity): Promise<void> {
   const db = await orm.openDb();
   db.users.push(user);
   return orm.saveDb(db);
@@ -42,7 +37,7 @@ async function add(user: UserEntity): Promise<void> {
 /**
  * Update a user.
  */
-async function update(user: UserEntity): Promise<void> {
+async function updateOne(user: UserEntity): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === user.id) {
@@ -60,7 +55,7 @@ async function update(user: UserEntity): Promise<void> {
 /**
  * Delete one user.
  */
-async function delete_(id: string): Promise<void> {
+async function deleteOne(id: string): Promise<void> {
   const db = await orm.openDb();
   for (let i = 0; i < db.users.length; i++) {
     if (db.users[i].id === id) {
@@ -73,9 +68,9 @@ async function delete_(id: string): Promise<void> {
 // ============================ Unit-tests Only ============================ //
 
 /**
- * @testOnly
- *
  * Delete every user record.
+ *
+ * @testOnly
  */
 async function deleteAllUsers(): Promise<void> {
   const db = await orm.openDb();
@@ -84,34 +79,32 @@ async function deleteAllUsers(): Promise<void> {
 }
 
 /**
- * @testOnly
- *
  * Insert copies of `users` with fresh ids; the inputs are not modified.
+ *
+ * @testOnly
  */
 async function insertMultiple(
   users: UserEntity[] | readonly UserEntity[],
 ): Promise<UserEntity[]> {
   const db = await orm.openDb();
-  const inserted = users.map((user) => ({
-    ...user,
-    id: jetid(),
-    created: getISOString(),
-  }));
-  db.users = [...db.users, ...inserted];
+  db.users = [...db.users, ...users];
   await orm.saveDb(db);
-  return inserted;
+  return [...users];
 }
 
 // ========================================================================= //
 //                                  EXPORT                                   //
 // ========================================================================= //
 
+export const UserRepoTestOnly = {
+  deleteAllUsers,
+  insertMultiple,
+} as const;
+
 export default {
   persists,
   getAll,
-  add,
-  update,
-  delete: delete_,
-  deleteAllUsers,
-  insertMultiple,
+  addOne,
+  updateOne,
+  deleteOne,
 } as const;

package/lib/template/src/repos/common/database.json

@@ -1,19 +1,19 @@
 {
   "users": [
     {
-      "id": "2HF7W6BZV-23RYN-0GY0E-80X19N",
+      "id": "01a12230-a18b-721e-bf21-0ee836fa989d",
       "name": "Sean Maxwell",
       "email": "smaxwell@example.com",
       "created": "2024-03-22T05:14:36.252Z"
     },
     {
-      "id": "56N1CSRF5-SG3XG-M7CEY-TE5G45",
+      "id": "01a12230-a18c-7473-b1f0-845016f412d3",
       "name": "John Smith",
       "email": "john.smith@example.com",
       "created": "2024-03-22T05:20:55.079Z"
     },
     {
-      "id": "Q78BTED9D-HBPJQ-GFEYQ-3EVFJF",
+      "id": "01a12230-a18c-7473-b1f1-88ed3ea1d5ae",
       "name": "Gordan Freeman",
       "email": "nova@prospect.com",
       "created": "2024-03-22T05:42:18.895Z"

package/lib/template/src/{routes/apiRouter.ts → routers/api.router.ts}

@@ -2,7 +2,7 @@ import { Router } from 'express';
 
 import Paths from '@src/common/constants/Paths';
 
-import UserRoutes from './UserRoutes';
+import userRouter from './user.router';
 
 // ========================================================================= //
 //                                   EXEC                                    //
@@ -10,16 +10,8 @@ import UserRoutes from './UserRoutes';
 
 const apiRouter = Router();
 
-// ============================ Add `userRouter` =========================== //
-
-const userRouter = Router();
-
-userRouter.get(Paths.Users.Get._, UserRoutes.getAll);
-userRouter.post(Paths.Users.Add._, UserRoutes.add);
-userRouter.put(Paths.Users.Update._, UserRoutes.update);
-userRouter.delete(Paths.Users.Delete._, UserRoutes.delete);
-
-apiRouter.use(Paths.Users._, userRouter);
+// Add more routers as your app grows (e.g. `postsRouter`)
+apiRouter.use(Paths.Users.PATH, userRouter);
 
 // ========================================================================= //
 //                                  EXPORT                                   //

package/lib/template/src/{routes/UserRoutes.ts → routers/user.router.ts}

@@ -1,74 +1,65 @@
+import { Router } from 'express';
+import validate from 'express-zod-safe';
+
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import Paths from '@src/common/constants/Paths';
 import User from '@src/entities/User';
 import UserService from '@src/services/UserService';
 
-import type { Req, Res } from './common/express-types';
-import parseReq from './common/parseReq';
-
 // ========================================================================= //
-//                                   EXEC                                    //
+//                                 CONSTANTS                                 //
 // ========================================================================= //
 
-const reqValidators = {
-  add: parseReq({ user: User.isInput }),
-  update: parseReq({ user: User.isComplete }),
-  delete: parseReq({ id: User.isId }),
+// Shorthand for the path strings
+const P = {
+  GET: Paths.Users.Get.PATH,
+  ADD: Paths.Users.Add.PATH,
+  UPDATE: Paths.Users.Update.PATH,
+  DELETE: Paths.Users.Delete.PATH,
+} as const;
+
+// Middlware `validators`
+const V = {
+  add: validate({ body: { user: User.Schemas.Input } }),
+  update: validate({ body: { user: User.Schemas.Main } }),
+  delete: validate({ params: { id: User.Schemas.Id } }),
 } as const;
 
 // ========================================================================= //
-//                                 FUNCTIONS                                 //
+//                                   EXEC                                    //
 // ========================================================================= //
 
-/**
- * Get all users.
- *
- * @route GET /api/users/all
- */
-async function getAll(_: Req, res: Res) {
+const router = Router();
+
+// Get all users
+router.get(P.GET, async (_, res) => {
   const users = await UserService.getAll();
   res.status(HttpStatusCodes.OK).json({ users });
-}
+});
 
-/**
- * Add one user.
- *
- * @route POST /api/users/add
- */
-async function add(req: Req, res: Res) {
-  const { user } = reqValidators.add(req.body);
+// Add one user
+router.post(P.ADD, V.add, async (req, res) => {
+  const { user } = req.body;
   const created = await UserService.addOne(user);
   res.status(HttpStatusCodes.CREATED).json({ user: created });
-}
+});
 
-/**
- * Update one user.
- *
- * @route PUT /api/users/update
- */
-async function update(req: Req, res: Res) {
-  const { user } = reqValidators.update(req.body);
+// Update one user
+router.put(P.UPDATE, V.update, async (req, res) => {
+  const { user } = req.body;
   await UserService.updateOne(user);
   res.status(HttpStatusCodes.OK).end();
-}
+});
 
-/**
- * Delete one user.
- *
- * @route DELETE /api/users/delete?id=:id
- */
-async function delete_(req: Req, res: Res) {
-  const { id } = reqValidators.delete(req.query);
-  await UserService.delete(id);
+// Delete one user
+router.delete(P.DELETE, V.delete, async (req, res) => {
+  const { id } = req.params;
+  await UserService.deleteOne(id);
   res.status(HttpStatusCodes.OK).end();
-}
+});
 
 // ========================================================================= //
 //                                  EXPORT                                   //
 // ========================================================================= //
 
-export default {
-  getAll,
-  add,
-  update,
-  delete: delete_,
-} as const;
+export default router;

package/lib/template/src/server.ts

@@ -8,12 +8,12 @@ import logger from 'jet-logger';
 import morgan from 'morgan';
 import path from 'path';
 
+import { RouteError } from '@src/common/classes/route-errors';
 import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
 import Paths from '@src/common/constants/Paths';
-import { RouteError } from '@src/common/classes/route-errors';
-import BaseRouter from '@src/routes/apiRouter';
+import BaseRouter from '@src/routers/api.router';
 
-import { EnvVars, NodeEnvs } from './common/constants/env-inv';
+import { Env, NodeEnvs } from './common/constants/env.constants';
 
 // ========================================================================= //
 //                                   EXEC                                    //
@@ -28,17 +28,17 @@ app.use(express.json());
 app.use(express.urlencoded({ extended: true }));
 
 // Show routes called in console during development
-if (EnvVars.NodeEnv === NodeEnvs.DEV) {
+if (Env.NODE_ENV === NodeEnvs.DEVELOPMENT) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (EnvVars.NodeEnv === NodeEnvs.PRODUCTION) {
+if (Env.NODE_ENV === NodeEnvs.PRODUCTION) {
   app.use(helmet());
 }
 
 // Add APIs, must be after middleware
-app.use(Paths._, BaseRouter);
+app.use(Paths.PATH, BaseRouter);
 
 // Add error handler. `_next` must stay: Express only treats 4-arg middleware
 // as an error handler.
@@ -48,7 +48,20 @@ app.use((err: Error, _: Request, res: Response, _next: NextFunction) => {
       .status(err.status)
       .json({ error: err.message, errors: err.errors });
   }
-  if (EnvVars.NodeEnv !== NodeEnvs.TEST) {
+  // Body-parser errors are client errors; don't expose the rejected body.
+  if ('type' in err) {
+    if (err.type === 'entity.parse.failed') {
+      return res
+        .status(HttpStatusCodes.BAD_REQUEST)
+        .json({ error: 'Invalid JSON' });
+    }
+    if (err.type === 'entity.too.large') {
+      return res
+        .status(HttpStatusCodes.PAYLOAD_TOO_LARGE)
+        .json({ error: 'Request body too large' });
+    }
+  }
+  if (Env.NODE_ENV !== NodeEnvs.TEST) {
     logger.err(err, true);
   }
   return res
@@ -58,15 +71,13 @@ app.use((err: Error, _: Request, res: Response, _next: NextFunction) => {
 
 // =========================== Front-end Content =========================== //
 
-// Views directory (html)
+// Views/HTML directory (html)
 const viewsDir = path.join(import.meta.dirname, 'views');
-
-// Set static directory (js and css).
 const staticDir = path.join(import.meta.dirname, 'public');
 
 // Refresh the browser on changes. Imported lazily because livereload is a
 // dev dependency and isn't installed in production.
-if (EnvVars.NodeEnv === NodeEnvs.DEV) {
+if (Env.NODE_ENV === NodeEnvs.DEVELOPMENT) {
   const { setupLiveReload } = await import('@src/common/utils/dev-only');
   setupLiveReload(app, [staticDir, viewsDir]);
 }

package/lib/template/src/services/UserService.ts

@@ -1,5 +1,4 @@
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
-import { RouteError } from '@src/common/classes/route-errors';
+import { NotFoundError } from '@src/common/classes/route-errors';
 import User, { type UserEntity, type UserInput } from '@src/entities/User';
 import UserRepo from '@src/repos/UserRepo';
 
@@ -7,7 +6,7 @@ import UserRepo from '@src/repos/UserRepo';
 //                                 CONSTANTS                                 //
 // ========================================================================= //
 
-const Errors = {
+const UserServiceErrors = {
   USER_NOT_FOUND: 'User not found',
 } as const;
 
@@ -27,7 +26,7 @@ function getAll(): Promise<UserEntity[]> {
  */
 async function addOne(input: UserInput): Promise<UserEntity> {
   const user = User.create(input);
-  await UserRepo.add(user);
+  await UserRepo.addOne(user);
   return user;
 }
 
@@ -36,10 +35,8 @@ async function addOne(input: UserInput): Promise<UserEntity> {
  */
 async function updateOne(user: UserEntity): Promise<void> {
   const persists = await UserRepo.persists(user.id);
-  if (!persists) {
-    throw new RouteError(HttpStatusCodes.NOT_FOUND, Errors.USER_NOT_FOUND);
-  }
-  return UserRepo.update(user);
+  if (!persists) throw new NotFoundError(UserServiceErrors.USER_NOT_FOUND);
+  return UserRepo.updateOne(user);
 }
 
 /**
@@ -47,10 +44,8 @@ async function updateOne(user: UserEntity): Promise<void> {
  */
 async function deleteOne(id: string): Promise<void> {
   const persists = await UserRepo.persists(id);
-  if (!persists) {
-    throw new RouteError(HttpStatusCodes.NOT_FOUND, Errors.USER_NOT_FOUND);
-  }
-  return UserRepo.delete(id);
+  if (!persists) throw new NotFoundError(UserServiceErrors.USER_NOT_FOUND);
+  return UserRepo.deleteOne(id);
 }
 
 // ========================================================================= //
@@ -58,9 +53,9 @@ async function deleteOne(id: string): Promise<void> {
 // ========================================================================= //
 
 export default {
-  Errors,
+  Errors: UserServiceErrors,
   getAll,
   addOne,
   updateOne,
-  delete: deleteOne,
+  deleteOne,
 } as const;

package/lib/template/src/views/users.html

@@ -3,6 +3,7 @@
   <!-- Head -->
   <head>
     <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Users</title>
     <link rel="stylesheet" type="text/css" href="stylesheets/users.css" />
 
@@ -50,6 +51,13 @@
       <div id="all-users-anchor"></div>
     </div>
 
+    <!-- Error Display -->
+    <aside class="users-column errors-column" aria-labelledby="errors-heading">
+      <div id="errors-heading" class="column-header">Error Messages:</div>
+      <pre id="error-display" role="status" aria-live="polite">
+No errors to display.</pre>
+    </aside>
+
     <script src="/scripts/HttpClient.js"></script>
     <script src="/scripts/renderUsers.js"></script>
     <script src="/scripts/users.js"></script>

package/lib/template/tests/support/utils.ts

@@ -0,0 +1,23 @@
+import type { Response } from 'supertest';
+
+// ========================================================================= //
+//                                   TYPES                                   //
+// ========================================================================= //
+
+export type TypedRes<T> = Omit<Response, 'body'> & { body: T };
+export type TypedErrRes<T = 'string'> = TypedRes<{ error: T }>;
+
+interface ValidationError {
+  errors: { message: string }[];
+}
+
+// ========================================================================= //
+//                                  HELPERS                                  //
+// ========================================================================= //
+
+/**
+ * Get the error message from a superTest Response object.
+ */
+export function extractErrMsg(res: TypedRes<ValidationError[]>) {
+  return res.body[0].errors[0].message;
+}