typescript-express-starter 9.1.2 → 10.0.0

package/lib/prisma/tsconfig.json

@@ -34,5 +34,5 @@
     }
   },
   "include": ["src/**/*.ts", "src/**/*.json", ".env"],
-  "exclude": ["node_modules", "src/http", "src/logs", "src/tests"]
+  "exclude": ["node_modules", "src/http", "src/logs"]
 }

package/lib/routing-controllers/Dockerfile.dev

@@ -0,0 +1,19 @@
+# NodeJS Version 16
+FROM node:16.18-buster-slim
+
+# Copy Dir
+COPY . ./app
+
+# Work to Dir
+WORKDIR /app
+
+# Install Node Package
+RUN npm install --legacy-peer-deps
+
+# Set Env
+ENV NODE_ENV development
+
+EXPOSE 3000
+
+# Cmd script
+CMD ["npm", "run", "dev"]

package/lib/routing-controllers/Dockerfile.prod

@@ -0,0 +1,19 @@
+# NodeJS Version 16
+FROM node:16.18-buster-slim
+
+# Copy Dir
+COPY . ./app
+
+# Work to Dir
+WORKDIR /app
+
+# Install Node Package
+RUN npm install --legacy-peer-deps
+
+# Set Env
+ENV NODE_ENV production
+
+EXPOSE 3000
+
+# Cmd script
+CMD ["npm", "run", "start"]

package/lib/routing-controllers/Makefile

@@ -2,28 +2,41 @@
 # ex) production-stage: make build APP_NAME=<APP_NAME>
 # ex) development-stage: make build-dev APP_NAME=<APP_NAME>
 
+SHELL := /bin/bash
+
 APP_NAME = typescript-express
 APP_NAME := $(APP_NAME)
 
-.PHONY: build
-# Build the container image - Dvelopment
-build-dev:
-	docker build -t ${APP_NAME}\
-		--target development-build-stage\
-		-f Dockerfile .
+.PHONY: help start clean db test
+
+help:
+	@grep -E '^[1-9a-zA-Z_-]+:.*?## .*$$|(^#--)' $(MAKEFILE_LIST) \
+	| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m %-43s\033[0m %s\n", $$1, $$2}' \
+	| sed -e 's/\[32m #-- /[33m/'
+
+#-- Docker
+up: ## Up the container images
+	docker-compose up -d
+
+down: ## Down the container images
+	docker-compose down
 
-# Build the container image - Production
-build:
+build: ## Build the container image - Production
 	docker build -t ${APP_NAME}\
-		--target production-build-stage\
-		-f Dockerfile .
+		-f Dockerfile.prod .
 
-# Clean the container image
-clean:
-	docker rmi -f ${APP_NAME}
+build-dev: ## Build the container image - Dvelopment
+	docker build -t ${APP_NAME}\
+		-f Dockerfile.dev .
 
-# Run the container image
-run:
+run: ## Run the container image
 	docker run -d -it -p 3000:3000 ${APP_NAME}
 
-all: build
+pause: ## Pause the containers
+	docker container rm -f ${APP_NAME}
+
+clean: ## Clean the images
+	docker rmi -f ${APP_NAME}
+
+remove: ## Remove the volumes
+	docker volume rm -f ${APP_NAME}

package/lib/routing-controllers/docker-compose.yml

@@ -1,28 +1,28 @@
-version: '3.7'
+version: "3.9"
 
 services:
   proxy:
-    image: nginx:alpine
     container_name: proxy
+    image: nginx:alpine
     ports:
-      - '80:80'
+      - "80:80"
     volumes:
       - ./nginx.conf:/etc/nginx/nginx.conf
-    restart: 'unless-stopped'
+    restart: "unless-stopped"
     networks:
       - backend
+
   server:
+    container_name: server
     build:
       context: ./
-      target: development-build-stage
-      dockerfile: Dockerfile
-    container_name: server
+      dockerfile: Dockerfile.dev
     ports:
-      - '3000:3000'
+      - "3000:3000"
     volumes:
       - ./:/app
       - /app/node_modules
-    restart: 'unless-stopped'
+    restart: "unless-stopped"
     networks:
       - backend
 

package/lib/routing-controllers/jest.config.js

@@ -1,4 +1,4 @@
-const { pathsToModuleNameMapper } = require('ts-jest/utils');
+const { pathsToModuleNameMapper } = require('ts-jest');
 const { compilerOptions } = require('./tsconfig.json');
 
 module.exports = {

package/lib/routing-controllers/package.json

@@ -18,59 +18,60 @@
   "dependencies": {
     "bcrypt": "^5.0.1",
     "class-transformer": "^0.5.1",
-    "class-validator": "^0.13.1",
-    "class-validator-jsonschema": "^3.0.2",
+    "class-validator": "^0.13.2",
+    "class-validator-jsonschema": "^3.1.1",
     "compression": "^1.7.4",
-    "cookie-parser": "^1.4.5",
+    "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
-    "dotenv": "^10.0.0",
-    "envalid": "^7.1.0",
-    "express": "^4.17.1",
-    "helmet": "^4.6.0",
+    "dotenv": "^16.0.1",
+    "envalid": "^7.3.1",
+    "express": "^4.18.1",
+    "helmet": "^5.1.1",
     "hpp": "^0.2.3",
     "jsonwebtoken": "^8.5.1",
     "morgan": "^1.10.0",
     "reflect-metadata": "^0.1.13",
     "routing-controllers": "^0.9.0",
-    "routing-controllers-openapi": "^3.0.0",
-    "swagger-ui-express": "^4.1.6",
-    "winston": "^3.3.3",
-    "winston-daily-rotate-file": "^4.5.5"
+    "routing-controllers-openapi": "^3.1.0",
+    "swagger-ui-express": "^4.5.0",
+    "typedi": "^0.10.0",
+    "winston": "^3.8.1",
+    "winston-daily-rotate-file": "^4.7.1"
   },
   "devDependencies": {
-    "@swc/cli": "^0.1.51",
-    "@swc/core": "^1.2.108",
+    "@swc/cli": "^0.1.57",
+    "@swc/core": "^1.2.220",
     "@types/bcrypt": "^5.0.0",
-    "@types/compression": "^1.7.1",
-    "@types/cookie-parser": "^1.4.2",
-    "@types/cors": "^2.8.11",
+    "@types/compression": "^1.7.2",
+    "@types/cookie-parser": "^1.4.3",
+    "@types/cors": "^2.8.12",
     "@types/express": "^4.17.13",
-    "@types/hpp": "^0.2.1",
-    "@types/jest": "27.4.x",
-    "@types/jsonwebtoken": "^8.5.4",
+    "@types/hpp": "^0.2.2",
+    "@types/jest": "^28.1.6",
+    "@types/jsonwebtoken": "^8.5.8",
     "@types/morgan": "^1.9.3",
-    "@types/node": "^16.0.1",
-    "@types/supertest": "^2.0.11",
+    "@types/node": "^17.0.45",
+    "@types/supertest": "^2.0.12",
     "@types/swagger-ui-express": "^4.1.3",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
+    "@typescript-eslint/eslint-plugin": "^5.29.0",
+    "@typescript-eslint/parser": "^5.29.0",
     "cross-env": "^7.0.3",
-    "eslint": "^7.30.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "husky": "^7.0.1",
-    "jest": "27.4.x",
-    "lint-staged": "^11.0.0",
+    "eslint": "^8.20.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
+    "jest": "^28.1.1",
+    "lint-staged": "^13.0.3",
     "node-config": "^0.0.2",
-    "node-gyp": "^8.1.0",
-    "nodemon": "^2.0.9",
-    "pm2": "^5.1.0",
-    "prettier": "^2.3.2",
-    "supertest": "^6.2.2",
-    "ts-jest": "^27.1.4",
-    "ts-node": "^10.4.0",
-    "tsc-alias": "^1.4.1",
-    "tsconfig-paths": "^3.10.1",
-    "typescript": "^4.5.2"
+    "node-gyp": "^9.1.0",
+    "nodemon": "^2.0.19",
+    "pm2": "^5.2.0",
+    "prettier": "^2.7.1",
+    "supertest": "^6.2.4",
+    "ts-jest": "^28.0.7",
+    "ts-node": "^10.9.1",
+    "tsc-alias": "^1.7.0",
+    "tsconfig-paths": "^4.0.0",
+    "typescript": "^4.7.4"
   }
-}
+}

package/lib/routing-controllers/src/app.ts

@@ -1,5 +1,5 @@
 import 'reflect-metadata';
-import { defaultMetadataStorage } from 'class-transformer';
+import { defaultMetadataStorage } from 'class-transformer/cjs/storage';
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
@@ -11,10 +11,10 @@ import { useExpressServer, getMetadataArgsStorage } from 'routing-controllers';
 import { routingControllersToSpec } from 'routing-controllers-openapi';
 import swaggerUi from 'swagger-ui-express';
 import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
-import errorMiddleware from '@middlewares/error.middleware';
+import { ErrorMiddleware } from '@middlewares/error.middleware';
 import { logger, stream } from '@utils/logger';
 
-class App {
+export class App {
   public app: express.Application;
   public env: string;
   public port: string | number;
@@ -96,8 +96,6 @@ class App {
   }
 
   private initializeErrorHandling() {
-    this.app.use(errorMiddleware);
+    this.app.use(ErrorMiddleware);
   }
 }
-
-export default App;

package/lib/routing-controllers/src/controllers/auth.controller.ts

@@ -1,38 +1,39 @@
 import { Response } from 'express';
 import { Controller, Req, Body, Post, UseBefore, HttpCode, Res } from 'routing-controllers';
+import { Container } from 'typedi';
 import { CreateUserDto } from '@dtos/users.dto';
 import { RequestWithUser } from '@interfaces/auth.interface';
 import { User } from '@interfaces/users.interface';
-import authMiddleware from '@middlewares/auth.middleware';
-import { validationMiddleware } from '@middlewares/validation.middleware';
-import AuthService from '@services/auth.service';
+import { AuthMiddleware } from '@middlewares/auth.middleware';
+import { ValidationMiddleware } from '@middlewares/validation.middleware';
+import { AuthService } from '@services/auth.service';
 
 @Controller()
 export class AuthController {
-  public authService = new AuthService();
+  public auth = Container.get(AuthService);
 
   @Post('/signup')
-  @UseBefore(validationMiddleware(CreateUserDto, 'body'))
+  @UseBefore(ValidationMiddleware(CreateUserDto, 'body'))
   @HttpCode(201)
-  async signUp(@Body() userData: CreateUserDto) {
-    const signUpUserData: User = await this.authService.signup(userData);
+  async signUp(@Body() userData: User) {
+    const signUpUserData: User = await this.auth.signup(userData);
     return { data: signUpUserData, message: 'signup' };
   }
 
   @Post('/login')
-  @UseBefore(validationMiddleware(CreateUserDto, 'body'))
-  async logIn(@Res() res: Response, @Body() userData: CreateUserDto) {
-    const { cookie, findUser } = await this.authService.login(userData);
+  @UseBefore(ValidationMiddleware(CreateUserDto, 'body'))
+  async logIn(@Res() res: Response, @Body() userData: User) {
+    const { cookie, findUser } = await this.auth.login(userData);
 
     res.setHeader('Set-Cookie', [cookie]);
     return { data: findUser, message: 'login' };
   }
 
   @Post('/logout')
-  @UseBefore(authMiddleware)
+  @UseBefore(AuthMiddleware)
   async logOut(@Req() req: RequestWithUser, @Res() res: Response) {
     const userData: User = req.user;
-    const logOutUserData: User = await this.authService.logout(userData);
+    const logOutUserData: User = await this.auth.logout(userData);
 
     res.setHeader('Set-Cookie', ['Authorization=; Max-age=0']);
     return { data: logOutUserData, message: 'logout' };

package/lib/routing-controllers/src/controllers/users.controller.ts

@@ -1,49 +1,51 @@
 import { Controller, Param, Body, Get, Post, Put, Delete, HttpCode, UseBefore } from 'routing-controllers';
 import { OpenAPI } from 'routing-controllers-openapi';
+import { Container } from 'typedi';
 import { CreateUserDto } from '@dtos/users.dto';
 import { User } from '@interfaces/users.interface';
-import userService from '@services/users.service';
-import { validationMiddleware } from '@middlewares/validation.middleware';
+import { ValidationMiddleware } from '@middlewares/validation.middleware';
+import { UserService } from '@services/users.service';
 
 @Controller()
-export class UsersController {
-  public userService = new userService();
+export class UserController {
+  public path = '/users'
+  public user = Container.get(UserService);
 
   @Get('/users')
   @OpenAPI({ summary: 'Return a list of users' })
   async getUsers() {
-    const findAllUsersData: User[] = await this.userService.findAllUser();
+    const findAllUsersData: User[] = await this.user.findAllUser();
     return { data: findAllUsersData, message: 'findAll' };
   }
 
   @Get('/users/:id')
   @OpenAPI({ summary: 'Return find a user' })
   async getUserById(@Param('id') userId: number) {
-    const findOneUserData: User = await this.userService.findUserById(userId);
+    const findOneUserData: User = await this.user.findUserById(userId);
     return { data: findOneUserData, message: 'findOne' };
   }
 
   @Post('/users')
   @HttpCode(201)
-  @UseBefore(validationMiddleware(CreateUserDto, 'body'))
+  @UseBefore(ValidationMiddleware(CreateUserDto, 'body'))
   @OpenAPI({ summary: 'Create a new user' })
-  async createUser(@Body() userData: CreateUserDto) {
-    const createUserData: User = await this.userService.createUser(userData);
+  async createUser(@Body() userData: User) {
+    const createUserData: User = await this.user.createUser(userData);
     return { data: createUserData, message: 'created' };
   }
 
   @Put('/users/:id')
-  @UseBefore(validationMiddleware(CreateUserDto, 'body', true))
+  @UseBefore(ValidationMiddleware(CreateUserDto, 'body', true))
   @OpenAPI({ summary: 'Update a user' })
-  async updateUser(@Param('id') userId: number, @Body() userData: CreateUserDto) {
-    const updateUserData: User[] = await this.userService.updateUser(userId, userData);
+  async updateUser(@Param('id') userId: number, @Body() userData: User) {
+    const updateUserData: User[] = await this.user.updateUser(userId, userData);
     return { data: updateUserData, message: 'updated' };
   }
 
   @Delete('/users/:id')
   @OpenAPI({ summary: 'Delete a user' })
   async deleteUser(@Param('id') userId: number) {
-    const deleteUserData: User[] = await this.userService.deleteUser(userId);
+    const deleteUserData: User[] = await this.user.deleteUser(userId);
     return { data: deleteUserData, message: 'deleted' };
   }
 }

package/lib/routing-controllers/src/dtos/users.dto.ts

@@ -1,9 +1,20 @@
-import { IsEmail, IsString } from 'class-validator';
+import { IsEmail, IsString, IsNotEmpty, MinLength, MaxLength } from 'class-validator';
 
 export class CreateUserDto {
   @IsEmail()
   public email: string;
 
   @IsString()
+  @IsNotEmpty()
+  @MinLength(9)
+  @MaxLength(32)
+  public password: string;
+}
+
+export class UpdateUserDto {
+  @IsString()
+  @IsNotEmpty()
+  @MinLength(9)
+  @MaxLength(32)
   public password: string;
 }

package/lib/routing-controllers/src/interfaces/users.interface.ts

@@ -1,5 +1,5 @@
 export interface User {
-  id: number;
+  id?: number;
   email: string;
   password: string;
 }

package/lib/routing-controllers/src/middlewares/auth.middleware.ts

@@ -1,19 +1,27 @@
 import { NextFunction, Response } from 'express';
 import { verify } from 'jsonwebtoken';
 import { SECRET_KEY } from '@config';
-import { HttpException } from '@exceptions/HttpException';
+import { HttpException } from '@exceptions/httpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
-import userModel from '@models/users.model';
+import { UserModel } from '@models/users.model';
 
-const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFunction) => {
+const getAuthorization = (req) => {
+  const coockie = req.cookies['Authorization'];
+  if (coockie) return coockie;
+
+  const header = req.header('Authorization');
+  if (header) return header.split('Bearer ')[1];
+
+  return null;
+}
+
+export const AuthMiddleware = async (req: RequestWithUser, res: Response, next: NextFunction) => {
   try {
-    const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
+    const Authorization = getAuthorization(req);
 
     if (Authorization) {
-      const secretKey: string = SECRET_KEY;
-      const verificationResponse = (await verify(Authorization, secretKey)) as DataStoredInToken;
-      const userId = verificationResponse.id;
-      const findUser = userModel.find(user => user.id === userId);
+      const { id } = (await verify(Authorization, SECRET_KEY)) as DataStoredInToken;
+      const findUser = UserModel.find(user => user.id === id);
 
       if (findUser) {
         req.user = findUser;
@@ -28,5 +36,3 @@ const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFun
     next(new HttpException(401, 'Wrong authentication token'));
   }
 };
-
-export default authMiddleware;

package/lib/routing-controllers/src/middlewares/error.middleware.ts

@@ -1,18 +1,15 @@
 import { NextFunction, Request, Response } from 'express';
-import { HttpException } from '@exceptions/HttpException';
+import { HttpException } from '@exceptions/httpException';
 import { logger } from '@utils/logger';
 
-const errorMiddleware = (error: HttpException, req: Request, res: Response, next: NextFunction) => {
+export const ErrorMiddleware = (error: HttpException, req: Request, res: Response, next: NextFunction) => {
   try {
     const status: number = error.status || 500;
     const message: string = error.message || 'Something went wrong';
 
-    console.error(`[${req.method}] ${req.path} >> StatusCode:: ${status}, Message:: ${message}`);
     logger.error(`[${req.method}] ${req.path} >> StatusCode:: ${status}, Message:: ${message}`);
     res.status(status).json({ message });
   } catch (error) {
     next(error);
   }
 };
-
-export default errorMiddleware;

package/lib/routing-controllers/src/middlewares/validation.middleware.ts

@@ -1,31 +1,27 @@
-import { plainToClass } from 'class-transformer';
-import { validate, ValidationError } from 'class-validator';
-import { RequestHandler } from 'express';
-import { HttpException } from '@exceptions/HttpException';
+import { plainToInstance } from 'class-transformer';
+import { validateOrReject, ValidationError } from 'class-validator';
+import { NextFunction, Request, Response } from 'express';
+import { HttpException } from '@exceptions/httpException';
 
-const getAllNestedErrors = (error: ValidationError) => {
-  if(error.constraints){
-    return Object.values(error.constraints)
-  }
-  return error.children.map(getAllNestedErrors).join(',')
-}
-
-export const validationMiddleware = (
-  type: any,
-  value: string | 'body' | 'query' | 'params' = 'body',
-  skipMissingProperties = false,
-  whitelist = true,
-  forbidNonWhitelisted = true,
-): RequestHandler => {
-  return (req, res, next) => {
-    const obj = plainToClass(type, req[value]);
-    validate(obj, { skipMissingProperties, whitelist, forbidNonWhitelisted }).then((errors: ValidationError[]) => {
-      if (errors.length > 0) {
-        const message = errors.map(getAllNestedErrors).join(', ');
-        next(new HttpException(400, message));
-      } else {
+/**
+ * @name ValidationMiddleware
+ * @description Allows use of decorator and non-decorator based validation
+ * @param type dto
+ * @param skipMissingProperties When skipping missing properties
+ * @param whitelist Even if your object is an instance of a validation class it can contain additional properties that are not defined
+ * @param forbidNonWhitelisted If you would rather to have an error thrown when any non-whitelisted properties are present
+ */
+export const ValidationMiddleware = (type: any, skipMissingProperties = false, whitelist = false, forbidNonWhitelisted = false) => {
+  return (req: Request, res: Response, next: NextFunction) => {
+    const dto = plainToInstance(type, req.body);
+    validateOrReject(dto, { skipMissingProperties, whitelist, forbidNonWhitelisted })
+      .then(() => {
+        req.body = dto;
         next();
-      }
-    });
+      })
+      .catch((errors: ValidationError[]) => {
+        const message = errors.map((error: ValidationError) => Object.values(error.constraints)).join(', ');
+        next(new HttpException(400, message));
+      });
   };
 };

package/lib/routing-controllers/src/models/users.model.ts

@@ -1,11 +1,9 @@
 import { User } from '@interfaces/users.interface';
 
 // password: password
-const userModel: User[] = [
+export const UserModel: User[] = [
   { id: 1, email: 'example1@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
   { id: 2, email: 'example2@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
   { id: 3, email: 'example3@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
   { id: 4, email: 'example4@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
 ];
-
-export default userModel;

package/lib/routing-controllers/src/server.ts

@@ -1,10 +1,9 @@
-import App from '@/app';
+import { App } from '@/app';
 import { AuthController } from '@controllers/auth.controller';
-import { IndexController } from '@controllers/index.controller';
-import { UsersController } from '@controllers/users.controller';
-import validateEnv from '@utils/validateEnv';
+import { UserController } from '@controllers/users.controller';
+import { ValidateEnv } from '@utils/validateEnv';
 
-validateEnv();
+ValidateEnv();
 
-const app = new App([AuthController, IndexController, UsersController]);
+const app = new App([AuthController, UserController]);
 app.listen();