typescript-express-starter 9.2.0 → 10.0.1

package/lib/knex/src/middlewares/validation.middleware.ts

@@ -1,25 +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 validationMiddleware = (
-  type: any,
-  value: string | 'body' | 'query' | 'params' = 'body',
-  skipMissingProperties = false,
-  whitelist = true,
-  forbidNonWhitelisted = true,
-): RequestHandler => {
-  return (req, res, next) => {
-    validate(plainToClass(type, req[value]), { skipMissingProperties, whitelist, forbidNonWhitelisted }).then((errors: ValidationError[]) => {
-      if (errors.length > 0) {
+/**
+ * @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));
-      } else {
-        next();
-      }
-    });
+      });
   };
 };
-
-export default validationMiddleware;

package/lib/knex/src/models/users.model.ts

@@ -1,7 +1,7 @@
 import { Model, ModelObject } from 'objection';
 import { User } from '@interfaces/users.interface';
 
-export class Users extends Model implements User {
+export class UserModel extends Model implements User {
   id!: number;
   email!: string;
   password!: string;
@@ -10,4 +10,4 @@ export class Users extends Model implements User {
   static idColumn = 'id'; // id column name
 }
 
-export type UsersShape = ModelObject<Users>;
+export type UserShape = ModelObject<UserModel>;

package/lib/knex/src/routes/auth.route.ts

@@ -1,24 +1,22 @@
 import { Router } from 'express';
-import AuthController from '@controllers/auth.controller';
+import { AuthController } from '@/controllers/auth.controller';
 import { CreateUserDto } from '@dtos/users.dto';
 import { Routes } from '@interfaces/routes.interface';
-import authMiddleware from '@middlewares/auth.middleware';
-import validationMiddleware from '@middlewares/validation.middleware';
+import { AuthMiddleware } from '@middlewares/auth.middleware';
+import { ValidationMiddleware } from '@middlewares/validation.middleware';
 
-class AuthRoute implements Routes {
+export class AuthRoute implements Routes {
   public path = '/';
   public router = Router();
-  public authController = new AuthController();
+  public auth = new AuthController();
 
   constructor() {
     this.initializeRoutes();
   }
 
   private initializeRoutes() {
-    this.router.post(`${this.path}signup`, validationMiddleware(CreateUserDto, 'body'), this.authController.signUp);
-    this.router.post(`${this.path}login`, validationMiddleware(CreateUserDto, 'body'), this.authController.logIn);
-    this.router.post(`${this.path}logout`, authMiddleware, this.authController.logOut);
+    this.router.post(`${this.path}signup`, ValidationMiddleware(CreateUserDto), this.auth.signUp);
+    this.router.post(`${this.path}login`, ValidationMiddleware(CreateUserDto), this.auth.logIn);
+    this.router.post(`${this.path}logout`, AuthMiddleware, this.auth.logOut);
   }
 }
-
-export default AuthRoute;

package/lib/knex/src/routes/users.route.ts

@@ -1,25 +1,23 @@
 import { Router } from 'express';
-import UsersController from '@controllers/users.controller';
-import { CreateUserDto } from '@dtos/users.dto';
+import { UserController } from '@/controllers/users.controller';
+import { CreateUserDto, UpdateUserDto } from '@dtos/users.dto';
 import { Routes } from '@interfaces/routes.interface';
-import validationMiddleware from '@middlewares/validation.middleware';
+import { ValidationMiddleware } from '@middlewares/validation.middleware';
 
-class UsersRoute implements Routes {
+export class UserRoute implements Routes {
   public path = '/users';
   public router = Router();
-  public usersController = new UsersController();
+  public user = new UserController();
 
   constructor() {
     this.initializeRoutes();
   }
 
   private initializeRoutes() {
-    this.router.get(`${this.path}`, this.usersController.getUsers);
-    this.router.get(`${this.path}/:id(\\d+)`, this.usersController.getUserById);
-    this.router.post(`${this.path}`, validationMiddleware(CreateUserDto, 'body'), this.usersController.createUser);
-    this.router.put(`${this.path}/:id(\\d+)`, validationMiddleware(CreateUserDto, 'body', true), this.usersController.updateUser);
-    this.router.delete(`${this.path}/:id(\\d+)`, this.usersController.deleteUser);
+    this.router.get(`${this.path}`, this.user.getUsers);
+    this.router.get(`${this.path}/:id(\\d+)`, this.user.getUserById);
+    this.router.post(`${this.path}`, ValidationMiddleware(CreateUserDto), this.user.createUser);
+    this.router.put(`${this.path}/:id(\\d+)`, ValidationMiddleware(UpdateUserDto), this.user.updateUser);
+    this.router.delete(`${this.path}/:id(\\d+)`, this.user.deleteUser);
   }
 }
-
-export default UsersRoute;

package/lib/knex/src/server.ts

@@ -1,11 +1,10 @@
-import App from '@/app';
-import AuthRoute from '@routes/auth.route';
-import IndexRoute from '@routes/index.route';
-import UsersRoute from '@routes/users.route';
-import validateEnv from '@utils/validateEnv';
+import { App } from '@/app';
+import { AuthRoute } from '@routes/auth.route';
+import { UserRoute } from '@routes/users.route';
+import { ValidateEnv } from '@utils/validateEnv';
 
-validateEnv();
+ValidateEnv();
 
-const app = new App([new IndexRoute(), new UsersRoute(), new AuthRoute()]);
+const app = new App([new UserRoute(), new AuthRoute()]);
 
 app.listen();

package/lib/knex/src/services/auth.service.ts

@@ -1,47 +1,52 @@
 import { hash, compare } from 'bcrypt';
 import { sign } from 'jsonwebtoken';
+import { Service } from 'typedi';
 import { SECRET_KEY } from '@config';
-import { CreateUserDto } from '@dtos/users.dto';
-import { HttpException } from '@exceptions/HttpException';
+import { HttpException } from '@exceptions/httpException';
 import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
 import { User } from '@interfaces/users.interface';
-import { Users } from '@models/users.model';
-import { isEmpty } from '@utils/util';
+import { UserModel } from '@models/users.model';
 
-class AuthService {
-  public async signup(userData: CreateUserDto): Promise<User> {
-    if (isEmpty(userData)) throw new HttpException(400, "userData is empty");
+const createToken = (user: User): TokenData => {
+  const dataStoredInToken: DataStoredInToken = { id: user.id };
+  const expiresIn: number = 60 * 60;
 
-    const findUser: Users = await Users.query().select().from('users').where('email', '=', userData.email).first();
+  return { expiresIn, token: sign(dataStoredInToken, SECRET_KEY, { expiresIn }) };
+};
+
+const createCookie = (tokenData: TokenData): string => {
+  return `Authorization=${tokenData.token}; HttpOnly; Max-Age=${tokenData.expiresIn};`;
+};
+
+@Service()
+export class AuthService {
+  public async signup(userData: User): Promise<User> {
+    const findUser: User = await UserModel.query().select().from('users').where('email', '=', userData.email).first();
     if (findUser) throw new HttpException(409, `This email ${userData.email} already exists`);
 
     const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await Users.query()
+    const createUserData: User = await UserModel.query()
       .insert({ ...userData, password: hashedPassword })
       .into('users');
 
     return createUserData;
   }
 
-  public async login(userData: CreateUserDto): Promise<{ cookie: string; findUser: User }> {
-    if (isEmpty(userData)) throw new HttpException(400, "userData is empty");
-
-    const findUser: User = await Users.query().select().from('users').where('email', '=', userData.email).first();
+  public async login(userData: User): Promise<{ cookie: string; findUser: User }> {
+    const findUser: User = await UserModel.query().select().from('users').where('email', '=', userData.email).first();
     if (!findUser) throw new HttpException(409, `This email ${userData.email} was not found`);
 
     const isPasswordMatching: boolean = await compare(userData.password, findUser.password);
-    if (!isPasswordMatching) throw new HttpException(409, "Password is not matching");
+    if (!isPasswordMatching) throw new HttpException(409, 'Password is not matching');
 
-    const tokenData = this.createToken(findUser);
-    const cookie = this.createCookie(tokenData);
+    const tokenData = createToken(findUser);
+    const cookie = createCookie(tokenData);
 
     return { cookie, findUser };
   }
 
   public async logout(userData: User): Promise<User> {
-    if (isEmpty(userData)) throw new HttpException(400, "userData is empty");
-
-    const findUser: User = await Users.query()
+    const findUser: User = await UserModel.query()
       .select()
       .from('users')
       .where('email', '=', userData.email)
@@ -52,18 +57,4 @@ class AuthService {
 
     return findUser;
   }
-
-  public createToken(user: User): TokenData {
-    const dataStoredInToken: DataStoredInToken = { id: user.id };
-    const secretKey: string = SECRET_KEY;
-    const expiresIn: number = 60 * 60;
-
-    return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };
-  }
-
-  public createCookie(tokenData: TokenData): string {
-    return `Authorization=${tokenData.token}; HttpOnly; Max-Age=${tokenData.expiresIn};`;
-  }
 }
-
-export default AuthService;

package/lib/knex/src/services/users.service.ts

@@ -1,31 +1,30 @@
 import { hash } from 'bcrypt';
+import { Service } from 'typedi';
 import { CreateUserDto } from '@dtos/users.dto';
-import { HttpException } from '@exceptions/HttpException';
+import { HttpException } from '@exceptions/httpException';
 import { User } from '@interfaces/users.interface';
-import { Users } from '@models/users.model';
-import { isEmpty } from '@utils/util';
+import { UserModel } from '@models/users.model';
 
-class UserService {
+@Service()
+export class UserService {
   public async findAllUser(): Promise<User[]> {
-    const users: User[] = await Users.query().select().from('users');
+    const users: User[] = await UserModel.query().select().from('users');
     return users;
   }
 
   public async findUserById(userId: number): Promise<User> {
-    const findUser: User = await Users.query().findById(userId);
+    const findUser: User = await UserModel.query().findById(userId);
     if (!findUser) throw new HttpException(409, "User doesn't exist");
 
     return findUser;
   }
 
   public async createUser(userData: CreateUserDto): Promise<User> {
-    if (isEmpty(userData)) throw new HttpException(400, "userData is empty");
-
-    const findUser: User = await Users.query().select().from('users').where('email', '=', userData.email).first();
+    const findUser: User = await UserModel.query().select().from('users').where('email', '=', userData.email).first();
     if (findUser) throw new HttpException(409, `This email ${userData.email} already exists`);
 
     const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await Users.query()
+    const createUserData: User = await UserModel.query()
       .insert({ ...userData, password: hashedPassword })
       .into('users');
 
@@ -33,28 +32,24 @@ class UserService {
   }
 
   public async updateUser(userId: number, userData: User): Promise<User> {
-    if (isEmpty(userData)) throw new HttpException(400, "userData is empty");
-
-    const findUser: User[] = await Users.query().select().from('users').where('id', '=', userId);
+    const findUser: User[] = await UserModel.query().select().from('users').where('id', '=', userId);
     if (!findUser) throw new HttpException(409, "User doesn't exist");
 
     const hashedPassword = await hash(userData.password, 10);
-    await Users.query()
+    await UserModel.query()
       .update({ ...userData, password: hashedPassword })
       .where('id', '=', userId)
       .into('users');
 
-    const updateUserData: User = await Users.query().select().from('users').where('id', '=', userId).first();
+    const updateUserData: User = await UserModel.query().select().from('users').where('id', '=', userId).first();
     return updateUserData;
   }
 
   public async deleteUser(userId: number): Promise<User> {
-    const findUser: User = await Users.query().select().from('users').where('id', '=', userId).first();
+    const findUser: User = await UserModel.query().select().from('users').where('id', '=', userId).first();
     if (!findUser) throw new HttpException(409, "User doesn't exist");
 
-    await Users.query().delete().where('id', '=', userId).into('users');
+    await UserModel.query().delete().where('id', '=', userId).into('users');
     return findUser;
   }
 }
-
-export default UserService;

package/lib/knex/src/{tests → test}/auth.test.ts

@@ -1,7 +1,7 @@
 import request from 'supertest';
-import App from '@/app';
+import { App } from '@/app';
 import { CreateUserDto } from '@dtos/users.dto';
-import AuthRoute from '@routes/auth.route';
+import { AuthRoute } from '@routes/auth.route';
 
 afterAll(async () => {
   await new Promise<void>(resolve => setTimeout(() => resolve(), 500));

package/lib/knex/src/{tests → test}/users.test.ts

@@ -1,7 +1,7 @@
 import request from 'supertest';
-import App from '@/app';
+import { App } from '@/app';
 import { CreateUserDto } from '@dtos/users.dto';
-import UserRoute from '@routes/users.route';
+import { UserRoute } from '@routes/users.route';
 
 afterAll(async () => {
   await new Promise<void>(resolve => setTimeout(() => resolve(), 500));

package/lib/knex/src/utils/validateEnv.ts

@@ -1,10 +1,8 @@
 import { cleanEnv, port, str } from 'envalid';
 
-const validateEnv = () => {
+export const ValidateEnv = () => {
   cleanEnv(process.env, {
     NODE_ENV: str(),
     PORT: port(),
   });
 };
-
-export default validateEnv;

package/lib/knex/tsconfig.json

@@ -24,7 +24,7 @@
       "@/*": ["*"],
       "@config": ["config"],
       "@controllers/*": ["controllers/*"],
-      "@databases": ["databases"],
+      "@database": ["database"],
       "@dtos/*": ["dtos/*"],
       "@exceptions/*": ["exceptions/*"],
       "@interfaces/*": ["interfaces/*"],
@@ -36,5 +36,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/mikro-orm/.env.production.local

@@ -4,7 +4,7 @@ PORT = 3000
 # DATABASE
 DB_HOST = localhost
 DB_PORT = 27017
-DB_DATABASE = prod
+DB_DATABASE = dev
 
 # TOKEN
 SECRET_KEY = secretKey

package/lib/mikro-orm/.env.test.local

@@ -4,7 +4,7 @@ PORT = 3000
 # DATABASE
 DB_HOST = localhost
 DB_PORT = 27017
-DB_DATABASE = test
+DB_DATABASE = dev
 
 # TOKEN
 SECRET_KEY = secretKey

package/lib/mikro-orm/.swcrc

@@ -23,7 +23,7 @@
       "@/*": ["*"],
       "@config": ["config"],
       "@controllers/*": ["controllers/*"],
-      "@databases": ["databases"],
+      "@database": ["database"],
       "@dtos/*": ["dtos/*"],
       "@entities/*": ["entities/*"],
       "@exceptions/*": ["exceptions/*"],

package/lib/mikro-orm/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/mikro-orm/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/mikro-orm/Makefile

@@ -2,28 +2,45 @@
 # 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:
+.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: ## Build the container image - Production
 	docker build -t ${APP_NAME}\
-		--target development-build-stage\
-		-f Dockerfile .
+		-f Dockerfile.prod .
 
-# Build the container image - Production
-build:
+build-dev: ## Build the container image - Development
 	docker build -t ${APP_NAME}\
-		--target production-build-stage\
-		-f Dockerfile .
+		-f Dockerfile.dev .
 
-# Clean the container image
-clean:
+run: ## Run the container image
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+pause: ## Pause the containers
+	docker container rm -f ${APP_NAME}
+
+clean: ## Clean the images
 	docker rmi -f ${APP_NAME}
 
-# Run the container image
-run:
-	docker run -d -it -p 3000:3000 ${APP_NAME}
+remove: ## Remove the volumes
+	docker volume rm -f ${APP_NAME}
 
-all: build
+#-- Database
+db: ## Start the local database MongoDB
+	docker-compose up -d mongo

package/lib/mikro-orm/docker-compose.yml

@@ -1,39 +1,48 @@
-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"
+    environment:
+      DB_HOST: localhost
+      DB_PORT: 27017
+      DB_DATABASE: dev
     volumes:
       - ./:/app
       - /app/node_modules
-    restart: 'unless-stopped'
+    restart: "unless-stopped"
     networks:
       - backend
     links:
       - mongo
     depends_on:
       - mongo
+
   mongo:
-    image: mvertes/alpine-mongo
     container_name: mongo
+    image: mongo
     ports:
-      - '27017:27017'
+      - "27017:27017"
+    environment:
+      DB_HOST: localhost
+      DB_PORT: 27017
+      DB_DATABASE: dev
     networks:
       - backend
 

package/lib/mikro-orm/package.json

@@ -31,8 +31,10 @@
     "hpp": "^0.2.3",
     "jsonwebtoken": "^8.5.1",
     "morgan": "^1.10.0",
+    "reflect-metadata": "^0.1.13",
     "swagger-jsdoc": "^6.2.1",
     "swagger-ui-express": "^4.5.0",
+    "typedi": "^0.10.0",
     "winston": "^3.8.1",
     "winston-daily-rotate-file": "^4.7.1"
   },

package/lib/mikro-orm/src/app.ts

@@ -1,3 +1,5 @@
+import 'reflect-metadata';
+import { MikroORM, RequestContext } from '@mikro-orm/core';
 import express from 'express';
 import cookieParser from 'cookie-parser';
 import compression from 'compression';
@@ -7,27 +9,25 @@ import hpp from 'hpp';
 import morgan from 'morgan';
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
-import { logger, stream } from '@utils/logger';
-import { MikroORM, RequestContext } from '@mikro-orm/core';
 import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
-import { DI, dbOptions } from '@databases';
+import { DI, dbOptions } from '@database';
 import { UserEntity } from '@entities/users.entity';
 import { Routes } from '@interfaces/routes.interface';
-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;
-  public host: string;
 
   constructor(routes: Routes[]) {
     this.app = express();
     this.env = NODE_ENV || 'development';
     this.port = PORT || 3000;
 
-    this.initializeMiddlewares();
     this.connectToDatabase();
+    this.initializeMiddlewares();
     this.initializeRoutes(routes);
     this.initializeSwagger();
     this.initializeErrorHandling();
@@ -49,12 +49,13 @@ class App {
   private async connectToDatabase() {
     try {
       DI.orm = await MikroORM.init(dbOptions);
-      DI.em = DI.orm.em.fork();
-      DI.userRepository = DI.orm.em.fork().getRepository(UserEntity);
+      DI.em = DI.orm.em;
+      DI.userRepository = DI.orm.em.getRepository(UserEntity);
     } catch (error) {
       logger.error(error);
+    } finally {
+      this.app.use((_1, _2, next) => RequestContext.create(DI.orm.em, next));
     }
-    this.app.use((_1, _2, next) => RequestContext.create(DI.orm.em, next));
   }
 
   private initializeMiddlewares() {
@@ -91,8 +92,6 @@ class App {
   }
 
   private initializeErrorHandling() {
-    this.app.use(errorMiddleware);
+    this.app.use(ErrorMiddleware);
   }
 }
-
-export default App;

package/lib/mikro-orm/src/config/index.ts

@@ -2,4 +2,5 @@ import { config } from 'dotenv';
 config({ path: `.env.${process.env.NODE_ENV || 'development'}.local` });
 
 export const CREDENTIALS = process.env.CREDENTIALS === 'true';
-export const { NODE_ENV, PORT, DB_HOST, DB_PORT, DB_DATABASE, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;
+export const { NODE_ENV, PORT, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;
+export const { DB_HOST, DB_PORT, DB_DATABASE } = process.env;