express-generator-typescript 2.7.3 → 2.7.5

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

@@ -1,7 +1,7 @@
 import { isNumber } from 'jet-validators';
 import { transform } from 'jet-validators/utils';
 
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
 import UserService from '@src/services/UserService';
 import User from '@src/models/User';
 
@@ -29,7 +29,7 @@ const Validators = {
  */
 async function getAll(_: IReq, res: IRes) {
   const users = await UserService.getAll();
-  res.status(HttpStatusCodes.OK).json({ users });
+  res.status(HTTP_STATUS_CODES.Ok).json({ users });
 }
 
 /**
@@ -38,7 +38,7 @@ async function getAll(_: IReq, res: IRes) {
 async function add(req: IReq, res: IRes) {
   const { user } = Validators.add(req.body);
   await UserService.addOne(user);
-  res.status(HttpStatusCodes.CREATED).end();
+  res.status(HTTP_STATUS_CODES.Created).end();
 }
 
 /**
@@ -47,7 +47,7 @@ async function add(req: IReq, res: IRes) {
 async function update(req: IReq, res: IRes) {
   const { user } = Validators.update(req.body);
   await UserService.updateOne(user);
-  res.status(HttpStatusCodes.OK).end();
+  res.status(HTTP_STATUS_CODES.Ok).end();
 }
 
 /**
@@ -56,7 +56,7 @@ async function update(req: IReq, res: IRes) {
 async function delete_(req: IReq, res: IRes) {
   const { id } = Validators.delete(req.params);
   await UserService.delete(id);
-  res.status(HttpStatusCodes.OK).end();
+  res.status(HTTP_STATUS_CODES.Ok).end();
 }
 
 

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

@@ -1,6 +1,6 @@
 import { Router } from 'express';
 
-import Paths from '@src/common/constants/Paths';
+import PATHS from '@src/common/constants/PATHS';
 import UserRoutes from './UserRoutes';
 
 
@@ -17,13 +17,13 @@ const apiRouter = Router();
 const userRouter = Router();
 
 // Get all users
-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);
+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);
 
 // Add UserRouter
-apiRouter.use(Paths.Users.Base, userRouter);
+apiRouter.use(PATHS.Users.Base, userRouter);
 
 
 /******************************************************************************

package/lib/project-files/src/server.ts

@@ -6,11 +6,13 @@ import logger from 'jet-logger';
 
 import BaseRouter from '@src/routes';
 
-import Paths from '@src/common/constants/Paths';
+import Paths from '@src/common/constants/PATHS';
 import ENV from '@src/common/constants/ENV';
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES, {
+  HttpStatusCodes,
+} from '@src/common/constants/HTTP_STATUS_CODES';
 import { RouteError } from '@src/common/util/route-errors';
-import { NodeEnvs } from '@src/common/constants';
+import { NODE_ENVS } from '@src/common/constants';
 
 
 /******************************************************************************
@@ -27,12 +29,12 @@ app.use(express.json());
 app.use(express.urlencoded({extended: true}));
 
 // Show routes called in console during development
-if (ENV.NodeEnv === NodeEnvs.Dev) {
+if (ENV.NodeEnv === NODE_ENVS.Dev) {
   app.use(morgan('dev'));
 }
 
 // Security
-if (ENV.NodeEnv === NodeEnvs.Production) {
+if (ENV.NodeEnv === NODE_ENVS.Production) {
   // eslint-disable-next-line n/no-process-env
   if (!process.env.DISABLE_HELMET) {
     app.use(helmet());
@@ -44,10 +46,10 @@ app.use(Paths.Base, BaseRouter);
 
 // Add error handler
 app.use((err: Error, _: Request, res: Response, next: NextFunction) => {
-  if (ENV.NodeEnv !== NodeEnvs.Test.valueOf()) {
+  if (ENV.NodeEnv !== NODE_ENVS.Test.valueOf()) {
     logger.err(err, true);
   }
-  let status = HttpStatusCodes.BAD_REQUEST;
+  let status: HttpStatusCodes = HTTP_STATUS_CODES.BadRequest;
   if (err instanceof RouteError) {
     status = err.status;
     res.status(status).json({ error: err.message });

package/lib/project-files/src/services/UserService.ts

@@ -1,5 +1,5 @@
 import { RouteError } from '@src/common/util/route-errors';
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
 
 import UserRepo from '@src/repos/UserRepo';
 import { IUser } from '@src/models/User';
@@ -37,7 +37,7 @@ async function updateOne(user: IUser): Promise<void> {
   const persists = await UserRepo.persists(user.id);
   if (!persists) {
     throw new RouteError(
-      HttpStatusCodes.NOT_FOUND,
+      HTTP_STATUS_CODES.NotFound,
       USER_NOT_FOUND_ERR,
     );
   }
@@ -52,7 +52,7 @@ async function _delete(id: number): Promise<void> {
   const persists = await UserRepo.persists(id);
   if (!persists) {
     throw new RouteError(
-      HttpStatusCodes.NOT_FOUND,
+      HTTP_STATUS_CODES.NotFound,
       USER_NOT_FOUND_ERR,
     );
   }

package/lib/project-files/tests/common/Paths.ts

@@ -1,5 +1,5 @@
 import jetPaths from 'jet-paths';
-import Paths from '@src/common/constants/Paths';
+import Paths from '@src/common/constants/PATHS';
 
 
 export default jetPaths(Paths);

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

@@ -5,7 +5,7 @@ import UserRepo from '@src/repos/UserRepo';
 import User, { IUser } from '@src/models/User';
 import { USER_NOT_FOUND_ERR } from '@src/services/UserService';
 
-import HttpStatusCodes from '@src/common/constants/HttpStatusCodes';
+import HTTP_STATUS_CODES from '@src/common/constants/HTTP_STATUS_CODES';
 import { ValidationError } from '@src/common/util/route-errors';
 
 import Paths from './common/Paths';
@@ -53,9 +53,9 @@ describe('UserRouter', () => {
 
     // Success
     it('should return a JSON object with all the users and a status code ' + 
-    `of "${HttpStatusCodes.OK}" if the request was successful.`, async () => {
+    `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(HttpStatusCodes.OK);
+      expect(res.status).toBe(HTTP_STATUS_CODES.Ok);
       expect(compareUserArrays(res.body.users, DB_USERS)).toBeTruthy();
     });
   });
@@ -64,19 +64,19 @@ describe('UserRouter', () => {
   describe(`"POST:${Paths.Users.Add}"`, () => {
 
     // Test add user success
-    it(`should return a status code of "${HttpStatusCodes.CREATED}" if the ` + 
-    'request was successful.', async () => {
+    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(HttpStatusCodes.CREATED);
+      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 "${HttpStatusCodes.BAD_REQUEST}" if the user param was ` + 
+      `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(HttpStatusCodes.BAD_REQUEST);
+      expect(res.status).toBe(HTTP_STATUS_CODES.BadRequest);
       const errorObj = parseValidationErr(res.body.error);
       expect(errorObj.message).toBe(ValidationError.MESSAGE);
       expect(errorObj.errors[0].prop).toBe('user');
@@ -87,22 +87,22 @@ describe('UserRouter', () => {
   describe(`"PUT:${Paths.Users.Update}"`, () => {
 
     // Success
-    it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
+    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(HttpStatusCodes.OK);
+      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 "${HttpStatusCodes.BAD_REQUEST}" if the user param was missing`, 
+    `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(HttpStatusCodes.BAD_REQUEST);
+      expect(res.status).toBe(HTTP_STATUS_CODES.BadRequest);
       const errorObj = parseValidationErr(res.body.error);
       expect(errorObj.message).toBe(ValidationError.MESSAGE);
       expect(errorObj.errors[0].prop).toBe('user');
@@ -112,10 +112,10 @@ describe('UserRouter', () => {
     // User not found
     it('should return a JSON object with the error message of ' + 
     `"${USER_NOT_FOUND_ERR}" and a status code of ` + 
-    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, async () => {
+    `"${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(HttpStatusCodes.NOT_FOUND);
+      expect(res.status).toBe(HTTP_STATUS_CODES.NotFound);
       expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
     });
   });
@@ -127,19 +127,19 @@ describe('UserRouter', () => {
       { id });
 
     // Success
-    it(`should return a status code of "${HttpStatusCodes.OK}" if the ` + 
+    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));
-      expect(res.status).toBe(HttpStatusCodes.OK);
+      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 ` + 
-    `"${HttpStatusCodes.NOT_FOUND}" if the id was not found.`, async () => {
+    `"${HTTP_STATUS_CODES.NotFound}" if the id was not found.`, async () => {
       const res: TRes = await agent.delete(getPath(-1));
-      expect(res.status).toBe(HttpStatusCodes.NOT_FOUND);
+      expect(res.status).toBe(HTTP_STATUS_CODES.NotFound);
       expect(res.body.error).toBe(USER_NOT_FOUND_ERR);
     });
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-generator-typescript",
-  "version": "2.7.3",
+  "version": "2.7.5",
   "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-npm

@@ -1,20 +0,0 @@
-<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>.
-<br/>
-
-
-## Documenation
-
-Please refer to the official <a href="https://github.com/seanpmaxwell/express-generator-typescript">github repo</a> for the most up-to-date documentation.