typescript-express-starter 8.1.7 → 9.1.1

package/lib/mikro-orm/src/middlewares/validation.middleware.ts

@@ -0,0 +1,25 @@
+import { plainToClass } from 'class-transformer';
+import { validate, ValidationError } from 'class-validator';
+import { RequestHandler } 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) {
+        const message = errors.map((error: ValidationError) => Object.values(error.constraints)).join(', ');
+        next(new HttpException(400, message));
+      } else {
+        next();
+      }
+    });
+  };
+};
+
+export default validationMiddleware;

package/lib/mikro-orm/src/routes/auth.route.ts

@@ -0,0 +1,24 @@
+import { Router } from 'express';
+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';
+
+class AuthRoute implements Routes {
+  public path = '/';
+  public router = Router();
+  public authController = 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);
+  }
+}
+
+export default AuthRoute;

package/lib/mikro-orm/src/routes/index.route.ts

@@ -0,0 +1,19 @@
+import { Router } from 'express';
+import IndexController from '@controllers/index.controller';
+import { Routes } from '@interfaces/routes.interface';
+
+class IndexRoute implements Routes {
+  public path = '/';
+  public router = Router();
+  public indexController = new IndexController();
+
+  constructor() {
+    this.initializeRoutes();
+  }
+
+  private initializeRoutes() {
+    this.router.get(`${this.path}`, this.indexController.index);
+  }
+}
+
+export default IndexRoute;

package/lib/mikro-orm/src/routes/users.route.ts

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

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

@@ -0,0 +1,11 @@
+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';
+
+validateEnv();
+
+const app = new App([new IndexRoute(), new UsersRoute(), new AuthRoute()]);
+
+app.listen();

package/lib/mikro-orm/src/services/auth.service.ts

@@ -0,0 +1,63 @@
+import { hash, compare } from 'bcrypt';
+import { sign } from 'jsonwebtoken';
+import { SECRET_KEY } from '@config';
+import { DI } from '@databases';
+import { CreateUserDto } from '@dtos/users.dto';
+import { HttpException } from '@exceptions/HttpException';
+import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
+import { User } from '@interfaces/users.interface';
+import { isEmpty } from '@utils/util';
+
+class AuthService {
+  public async signup(userData: CreateUserDto): Promise<User> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await DI.userRepository.findOne({ email: userData.email });
+    if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
+
+    const hashedPassword = await hash(userData.password, 10);
+    const createUserData: User = DI.userRepository.create({ ...userData, password: hashedPassword });
+
+    await DI.em.persistAndFlush(createUserData);
+
+    return createUserData;
+  }
+
+  public async login(userData: CreateUserDto): Promise<{ cookie: string; findUser: User }> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await DI.userRepository.findOne({ email: userData.email });
+    if (!findUser) throw new HttpException(409, `You're email ${userData.email} not found`);
+
+    const isPasswordMatching: boolean = await compare(userData.password, findUser.password);
+    if (!isPasswordMatching) throw new HttpException(409, "You're password not matching");
+
+    const tokenData = this.createToken(findUser);
+    const cookie = this.createCookie(tokenData);
+
+    return { cookie, findUser };
+  }
+
+  public async logout(userData: User): Promise<User> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await DI.userRepository.findOne({ email: userData.email, password: userData.password });
+    if (!findUser) throw new HttpException(409, `You're email ${userData.email} not found`);
+
+    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/mikro-orm/src/services/users.service.ts

@@ -0,0 +1,68 @@
+import { hash } from 'bcrypt';
+import { wrap } from '@mikro-orm/core';
+import { DI } from '@databases';
+import { CreateUserDto } from '@dtos/users.dto';
+import { HttpException } from '@exceptions/HttpException';
+import { User } from '@interfaces/users.interface';
+import { isEmpty } from '@utils/util';
+
+class UserService {
+  public async findAllUser(): Promise<User[]> {
+    const users: User[] = await DI.userRepository.findAll();
+    return users;
+  }
+
+  public async findUserById(userId: string): Promise<User> {
+    if (isEmpty(userId)) throw new HttpException(400, "You're not userId");
+
+    const findUser: User = await DI.userRepository.findOne(userId);
+    if (!findUser) throw new HttpException(409, "You're not user");
+
+    return findUser;
+  }
+
+  public async createUser(userData: CreateUserDto): Promise<User> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await DI.userRepository.findOne({ email: userData.email });
+    if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
+
+    const hashedPassword = await hash(userData.password, 10);
+    const createUserData: User = DI.userRepository.create({ ...userData, password: hashedPassword });
+
+    await DI.em.persistAndFlush(createUserData);
+
+    return createUserData;
+  }
+
+  public async updateUser(userId: string, userData: CreateUserDto): Promise<User> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    if (userData.email) {
+      const findUser: User = await DI.userRepository.findOne({ email: userData.email });
+      if (findUser && findUser.id !== userId) throw new HttpException(409, `You're email ${userData.email} already exists`);
+    }
+
+    if (userData.password) {
+      const hashedPassword = await hash(userData.password, 10);
+      userData = { ...userData, password: hashedPassword };
+    }
+
+    const updateUserById: User = await DI.userRepository.findOne(userId);
+    wrap(updateUserById).assign(userData);
+    if (!updateUserById) throw new HttpException(409, "You're not user");
+
+    return updateUserById;
+  }
+
+  public async deleteUser(userId: string): Promise<User> {
+    const findUser = await DI.userRepository.findOne(userId);
+
+    if (!findUser) throw new HttpException(409, "You're not user");
+    await DI.userRepository.removeAndFlush(findUser);
+
+    return findUser;
+  }
+}
+
+export default UserService;

package/lib/mikro-orm/src/tests/auth.test.ts

@@ -0,0 +1,66 @@
+import request from 'supertest';
+import App from '../app';
+import { DI } from '../databases';
+import { CreateUserDto } from '../dtos/users.dto';
+import AuthRoute from '../routes/auth.route';
+
+const authRoute = new AuthRoute();
+
+const app = new App([authRoute]);
+
+let cookies: string;
+
+/**
+ ** MikroORM Seeding
+ ** https://mikro-orm.io/docs/seeding#use-in-tests
+ */
+
+beforeAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+
+  await DI.orm.getSchemaGenerator().refreshDatabase();
+});
+
+afterAll(async () => {
+  await DI.orm.close();
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('Testing Auth', () => {
+  describe('[POST] /signup', () => {
+    it('response should have the Create userData', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4!',
+      };
+      return request(app.getServer()).post(`${authRoute.path}signup`).send(userData);
+    });
+  });
+  describe('[POST] /login', () => {
+    it('response should have the Set-Cookie header with the Authorization token', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4!',
+      };
+      const res = await request(app.getServer())
+        .post(`${authRoute.path}login`)
+        .send(userData)
+        .expect('Set-Cookie', /^Authorization=.+/);
+
+      cookies = res.headers['set-cookie'];
+    });
+  });
+  describe('[POST] /logout', () => {
+    it('logout Set-Cookie Authorization=; Max-age=0', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4!',
+      };
+      return request(app.getServer())
+        .post(`${authRoute.path}logout`)
+        .send(userData)
+        .set('Cookie', cookies)
+        .expect('Set-Cookie', /^Authorization=\; Max-age=0/);
+    });
+  });
+});

package/lib/mikro-orm/src/tests/index.test.ts

@@ -0,0 +1,18 @@
+import request from 'supertest';
+import App from '../app';
+import IndexRoute from '../routes/index.route';
+
+afterAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('Testing Index', () => {
+  describe('[GET] /', () => {
+    it('response statusCode 200', () => {
+      const indexRoute = new IndexRoute();
+      const app = new App([indexRoute]);
+
+      return request(app.getServer()).get(`${indexRoute.path}`).expect(200);
+    });
+  });
+});

package/lib/mikro-orm/src/tests/users.test.ts

@@ -0,0 +1,70 @@
+import request from 'supertest';
+import App from '../app';
+import { DI } from '../databases';
+import { CreateUserDto } from '../dtos/users.dto';
+import UsersRoute from '../routes/users.route';
+
+const usersRoute = new UsersRoute();
+
+const app = new App([usersRoute]);
+
+let userId: string;
+
+/**
+ ** MikroORM Seeding
+ ** https://mikro-orm.io/docs/seeding#use-in-tests
+ */
+
+beforeAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+
+  await DI.orm.getSchemaGenerator().refreshDatabase();
+});
+
+afterAll(async () => {
+  await DI.orm.close();
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('Testing Users', () => {
+  describe('[GET] /users', () => {
+    it('response fineAll Users', async () => {
+      return request(app.getServer()).get(`${usersRoute.path}`).expect(200);
+    });
+  });
+
+  describe('[POST] /users', () => {
+    it('response Create User', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+
+      const { body } = await request(app.getServer()).post(`${usersRoute.path}`).send(userData).expect(201);
+      userId = body.data.id;
+    });
+  });
+
+  describe('[GET] /users/:id', () => {
+    it('response findOne User', async () => {
+      return await request(app.getServer()).get(`${usersRoute.path}/${userId}`).expect(200);
+    });
+  });
+
+  describe('[PUT] /users/:id', () => {
+    it('response Update User', async () => {
+      const userData: CreateUserDto = {
+        email: 'test1@email.com',
+        password: 'q1w2e3r4',
+      };
+
+      return await request(app.getServer()).put(`${usersRoute.path}/${userId}`).send(userData).expect(200);
+    });
+  });
+
+  describe('[DELETE] /users/:id', () => {
+    it('response Delete User', async () => {
+      return request(app.getServer()).delete(`${usersRoute.path}/${userId}`).expect(200);
+    });
+  });
+});

package/lib/mikro-orm/src/utils/logger.ts

@@ -0,0 +1,65 @@
+import { existsSync, mkdirSync } from 'fs';
+import { join } from 'path';
+import winston from 'winston';
+import winstonDaily from 'winston-daily-rotate-file';
+import { LOG_DIR } from '@config';
+
+// logs dir
+const logDir: string = join(__dirname, LOG_DIR);
+
+if (!existsSync(logDir)) {
+  mkdirSync(logDir);
+}
+
+// Define log format
+const logFormat = winston.format.printf(({ timestamp, level, message }) => `${timestamp} ${level}: ${message}`);
+
+/*
+ * Log Level
+ * error: 0, warn: 1, info: 2, http: 3, verbose: 4, debug: 5, silly: 6
+ */
+const logger = winston.createLogger({
+  format: winston.format.combine(
+    winston.format.timestamp({
+      format: 'YYYY-MM-DD HH:mm:ss',
+    }),
+    logFormat,
+  ),
+  transports: [
+    // debug log setting
+    new winstonDaily({
+      level: 'debug',
+      datePattern: 'YYYY-MM-DD',
+      dirname: logDir + '/debug', // log file /logs/debug/*.log in save
+      filename: `%DATE%.log`,
+      maxFiles: 30, // 30 Days saved
+      json: false,
+      zippedArchive: true,
+    }),
+    // error log setting
+    new winstonDaily({
+      level: 'error',
+      datePattern: 'YYYY-MM-DD',
+      dirname: logDir + '/error', // log file /logs/error/*.log in save
+      filename: `%DATE%.log`,
+      maxFiles: 30, // 30 Days saved
+      handleExceptions: true,
+      json: false,
+      zippedArchive: true,
+    }),
+  ],
+});
+
+logger.add(
+  new winston.transports.Console({
+    format: winston.format.combine(winston.format.splat(), winston.format.colorize()),
+  }),
+);
+
+const stream = {
+  write: (message: string) => {
+    logger.info(message.substring(0, message.lastIndexOf('\n')));
+  },
+};
+
+export { logger, stream };

package/lib/mikro-orm/src/utils/util.ts

@@ -0,0 +1,19 @@
+/**
+ * @method isEmpty
+ * @param {String | Number | Object} value
+ * @returns {Boolean} true & false
+ * @description this value is Empty Check
+ */
+ export const isEmpty = (value: string | number | object): boolean => {
+  if (value === null) {
+    return true;
+  } else if (typeof value !== 'number' && value === '') {
+    return true;
+  } else if (typeof value === 'undefined' || value === undefined) {
+    return true;
+  } else if (value !== null && typeof value === 'object' && !Object.keys(value).length) {
+    return true;
+  } else {
+    return false;
+  }
+};

package/lib/mikro-orm/src/utils/validateEnv.ts

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

package/lib/mikro-orm/swagger.yaml

@@ -0,0 +1,122 @@
+tags:
+- name: users
+  description: users API
+
+paths:
+# [GET] users
+  /users:
+    get:
+      tags:
+      - users
+      summary: Find All Users
+      responses:
+        200:
+          description: 'OK'
+        500:
+          description: 'Server Error'
+
+# [POST] users
+    post:
+      tags:
+      - users
+      summary: Add User
+      parameters:
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        201:
+          description: 'Created'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [GET] users/id
+  /users/{id}:
+    get:
+      tags:
+      - users
+      summary: Find User By Id
+      parameters:
+      - name: id
+        in: path
+        description: User Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [PUT] users/id
+    put:
+      tags:
+      - users
+      summary: Update User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        200:
+          description: 'OK'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [DELETE] users/id
+    delete:
+      tags:
+      - users
+      summary: Delete User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# definitions
+definitions:
+  users:
+    type: object
+    required:
+        - email
+        - password
+    properties:
+      id:
+        description: user Id
+      email:
+        type: string
+        description: user Email
+      password:
+        type: string
+        description: user Password
+
+schemes:
+ - https
+ - http

package/lib/mikro-orm/tsconfig.json

@@ -0,0 +1,41 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "target": "es2017",
+    "lib": ["es2017", "esnext.asynciterable"],
+    "typeRoots": ["node_modules/@types"],
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "pretty": true,
+    "sourceMap": true,
+    "declaration": true,
+    "outDir": "dist",
+    "allowJs": true,
+    "noEmit": false,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "importHelpers": true,
+    "baseUrl": "src",
+    "paths": {
+      "@/*": ["*"],
+      "@config": ["config"],
+      "@controllers/*": ["controllers/*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@entities/*": ["entities/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@models/*": ["models/*"],
+      "@routes/*": ["routes/*"],
+      "@services/*": ["services/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.json", ".env"],
+  "exclude": ["node_modules", "src/http", "src/logs", "src/tests"]
+}

package/lib/mongoose/.env.development.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/mongoose/.env.production.local

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