typescript-express-starter 9.2.0 → 10.0.0

package/lib/graphql/src/typedefs/users.type.ts

@@ -3,10 +3,10 @@ import { Field, ObjectType } from 'type-graphql';
 @ObjectType()
 export class User {
   @Field()
-  id: number;
+  id?: number;
 
   @Field()
-  email: string;
+  email?: string;
 
   @Field()
   password: string;

package/lib/graphql/src/utils/logger.ts

@@ -3,6 +3,7 @@ import { join } from 'path';
 import winston from 'winston';
 import winstonDaily from 'winston-daily-rotate-file';
 import { LOG_DIR } from '@config';
+import { HttpException } from '@exceptions/httpException';
 
 // logs dir
 const logDir: string = join(__dirname, LOG_DIR);
@@ -72,4 +73,5 @@ export const errorLogger = error => {
   }
 
   logger.error(message);
+  throw new HttpException(400, message);
 };

package/lib/graphql/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/graphql/tsconfig.json

@@ -23,7 +23,7 @@
     "paths": {
       "@/*": ["*"],
       "@config": ["config"],
-      "@databases": ["databases"],
+      "@database": ["database"],
       "@dtos/*": ["dtos/*"],
       "@entities/*": ["entities/*"],
       "@exceptions/*": ["exceptions/*"],
@@ -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/knex/.env.development.local

@@ -2,10 +2,10 @@
 PORT = 3000
 
 # DATABASE
-DB_HOST = localhost
-DB_PORT = 3306
 DB_USER = root
 DB_PASSWORD = password
+DB_HOST = localhost
+DB_PORT = 3306
 DB_DATABASE = dev
 
 # TOKEN

package/lib/knex/.env.production.local

@@ -2,11 +2,11 @@
 PORT = 3000
 
 # DATABASE
-DB_HOST = localhost
-DB_PORT = 3306
 DB_USER = root
 DB_PASSWORD = password
-DB_DATABASE = prod
+DB_HOST = localhost
+DB_PORT = 3306
+DB_DATABASE = dev
 
 # TOKEN
 SECRET_KEY = secretKey

package/lib/knex/.env.test.local

@@ -2,11 +2,11 @@
 PORT = 3000
 
 # DATABASE
-DB_HOST = localhost
-DB_PORT = 3306
 DB_USER = root
 DB_PASSWORD = password
-DB_DATABASE = test
+DB_HOST = localhost
+DB_PORT = 3306
+DB_DATABASE = dev
 
 # TOKEN
 SECRET_KEY = secretKey

package/lib/knex/.swcrc

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

package/lib/knex/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/knex/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/knex/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 - Dvelopment
 	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 MySQL
+	docker-compose up -d mysql

package/lib/knex/docker-compose.yml

@@ -1,43 +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_USER: root
+      DB_PASSWORD: password
+      DB_DATABASE: dev
     volumes:
       - ./:/app
       - /app/node_modules
-    restart: 'unless-stopped'
+    restart: "unless-stopped"
     networks:
       - backend
     links:
       - mysql
     depends_on:
       - mysql
+
   mysql:
-    image: mysql:5.7
     container_name: mysql
+    image: mysql:5.7
     environment:
-      MYSQL_ROOT_USER: root
-      MYSQL_ROOT_PASSWORD: password
-      MYSQL_DATABASE: test
+      DB_USER: root
+      DB_PASSWORD: password
+      DB_DATABASE: dev
     ports:
-      - '3306:3306'
+      - "3306:3306"
     networks:
       - backend
 

package/lib/knex/knexfile.ts

@@ -1,25 +1,23 @@
 import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from './src/config';
 
-const dbConfig = {
+export const dbConfig = {
   client: 'mysql',
   connection: {
     charset: 'utf8',
     timezone: 'UTC',
-    host: DB_HOST,
-    port: DB_PORT,
     user: DB_USER,
     password: DB_PASSWORD,
+    host: DB_HOST,
+    port: DB_PORT,
     database: DB_DATABASE,
   },
   migrations: {
-    directory: 'src/databases/migrations',
+    directory: 'src/database/migrations',
     tableName: 'migrations',
-    // stub: 'src/databases/stubs',
+    // stub: 'src/database/stubs',
   },
   seeds: {
-    directory: 'src/databases/seeds',
-    // stub: 'src/databases/stubs',
+    directory: 'src/database/seeds',
+    // stub: 'src/database/stubs',
   },
 };
-
-export default dbConfig;

package/lib/knex/package.json

@@ -37,8 +37,10 @@
     "morgan": "^1.10.0",
     "mysql": "^2.18.1",
     "objection": "^3.0.1",
+    "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/knex/src/app.ts

@@ -1,3 +1,4 @@
+import 'reflect-metadata';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
@@ -9,12 +10,12 @@ import { Model } from 'objection';
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
 import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
-import knex from '@databases';
+import { knex } from '@database';
 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;
@@ -45,7 +46,7 @@ class App {
   }
 
   private connectToDatabase() {
-    Model.knex(knex);
+    Model.knex(knex());
   }
 
   private initializeMiddlewares() {
@@ -82,8 +83,6 @@ class App {
   }
 
   private initializeErrorHandling() {
-    this.app.use(errorMiddleware);
+    this.app.use(ErrorMiddleware);
   }
 }
-
-export default App;

package/lib/knex/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_USER, DB_PASSWORD, 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_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_DATABASE } = process.env;

package/lib/knex/src/controllers/auth.controller.ts

@@ -1,16 +1,16 @@
 import { NextFunction, Request, Response } from 'express';
-import { CreateUserDto } from '@dtos/users.dto';
+import { Container } from 'typedi';
 import { RequestWithUser } from '@interfaces/auth.interface';
 import { User } from '@interfaces/users.interface';
-import AuthService from '@services/auth.service';
+import { AuthService } from '@services/auth.service';
 
-class AuthController {
-  public authService = new AuthService();
+export class AuthController {
+  public auth = Container.get(AuthService);
 
   public signUp = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     try {
-      const userData: CreateUserDto = req.body;
-      const signUpUserData: User = await this.authService.signup(userData);
+      const userData: User = req.body;
+      const signUpUserData: User = await this.auth.signup(userData);
 
       res.status(201).json({ data: signUpUserData, message: 'signup' });
     } catch (error) {
@@ -20,8 +20,8 @@ class AuthController {
 
   public logIn = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     try {
-      const userData: CreateUserDto = req.body;
-      const { cookie, findUser } = await this.authService.login(userData);
+      const userData: User = req.body;
+      const { cookie, findUser } = await this.auth.login(userData);
 
       res.setHeader('Set-Cookie', [cookie]);
       res.status(200).json({ data: findUser, message: 'login' });
@@ -33,7 +33,7 @@ class AuthController {
   public logOut = async (req: RequestWithUser, res: Response, next: NextFunction): Promise<void> => {
     try {
       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']);
       res.status(200).json({ data: logOutUserData, message: 'logout' });
@@ -42,5 +42,3 @@ class AuthController {
     }
   };
 }
-
-export default AuthController;

package/lib/knex/src/controllers/users.controller.ts

@@ -1,14 +1,14 @@
 import { NextFunction, Request, Response } from 'express';
-import { CreateUserDto } from '@dtos/users.dto';
+import { Container } from 'typedi'
 import { User } from '@interfaces/users.interface';
-import userService from '@services/users.service';
+import { UserService } from '@services/users.service';
 
-class UsersController {
-  public userService = new userService();
+export class UserController {
+  public user = Container.get(UserService);
 
   public getUsers = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     try {
-      const findAllUsersData: User[] = await this.userService.findAllUser();
+      const findAllUsersData: User[] = await this.user.findAllUser();
 
       res.status(200).json({ data: findAllUsersData, message: 'findAll' });
     } catch (error) {
@@ -19,7 +19,7 @@ class UsersController {
   public getUserById = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     try {
       const userId = Number(req.params.id);
-      const findOneUserData: User = await this.userService.findUserById(userId);
+      const findOneUserData: User = await this.user.findUserById(userId);
 
       res.status(200).json({ data: findOneUserData, message: 'findOne' });
     } catch (error) {
@@ -29,8 +29,8 @@ class UsersController {
 
   public createUser = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     try {
-      const userData: CreateUserDto = req.body;
-      const createUserData: User = await this.userService.createUser(userData);
+      const userData: User = req.body;
+      const createUserData: User = await this.user.createUser(userData);
 
       res.status(201).json({ data: createUserData, message: 'created' });
     } catch (error) {
@@ -42,7 +42,7 @@ class UsersController {
     try {
       const userId = Number(req.params.id);
       const userData: User = req.body;
-      const updateUserData: User = await this.userService.updateUser(userId, userData);
+      const updateUserData: User = await this.user.updateUser(userId, userData);
 
       res.status(200).json({ data: updateUserData, message: 'updated' });
     } catch (error) {
@@ -53,7 +53,7 @@ class UsersController {
   public deleteUser = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
     try {
       const userId = Number(req.params.id);
-      const deleteUserData: User = await this.userService.deleteUser(userId);
+      const deleteUserData: User = await this.user.deleteUser(userId);
 
       res.status(200).json({ data: deleteUserData, message: 'deleted' });
     } catch (error) {
@@ -61,5 +61,3 @@ class UsersController {
     }
   };
 }
-
-export default UsersController;

package/lib/knex/src/{databases → database}/index.ts

@@ -1,15 +1,15 @@
 import Knex from 'knex';
-import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from '@config';
+import { DB_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_DATABASE } from '@config';
 
 const dbConnection = {
   client: 'mysql',
   connection: {
     charset: 'utf8',
     timezone: 'UTC',
-    host: DB_HOST,
-    port: DB_PORT,
     user: DB_USER,
     password: DB_PASSWORD,
+    host: DB_HOST,
+    port: DB_PORT,
     database: DB_DATABASE,
   },
   pool: {
@@ -18,4 +18,4 @@ const dbConnection = {
   },
 };
 
-export default Knex(dbConnection);
+export const knex = () => Knex(dbConnection);

package/lib/knex/src/database/migrations/20210713110926_initial.ts

@@ -0,0 +1,17 @@
+import { Knex } from 'knex';
+
+const up = (knex: Knex): Promise<void> => {
+  return knex.schema.createTable('users', table => {
+    table.bigIncrements('id').unsigned().primary();
+    table.string('email', 45).notNullable();
+    table.string('password', 255).notNullable();
+    table.timestamp('createdAt').defaultTo(knex.fn.now());
+    table.timestamp('updatedAt').defaultTo(knex.fn.now());
+  });
+};
+
+const down = (knex: Knex): Promise<void> => {
+  return knex.schema.dropTable('users');
+};
+
+export default { up, down };

package/lib/knex/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/knex/src/interfaces/users.interface.ts

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

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

@@ -1,20 +1,29 @@
 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 { User } from '@interfaces/users.interface';
-import { Users } 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: User = await Users.query().findById(userId);
+      const verificationResponse = (await verify(Authorization, SECRET_KEY)) as DataStoredInToken;
+      const { id } = verificationResponse;
+      const findUser: User = await UserModel.query().findById(id);
 
       if (findUser) {
         req.user = findUser;
@@ -29,5 +38,3 @@ const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFun
     next(new HttpException(401, 'Wrong authentication token'));
   }
 };
-
-export default authMiddleware;

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

@@ -1,8 +1,8 @@
 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';
@@ -13,5 +13,3 @@ const errorMiddleware = (error: HttpException, req: Request, res: Response, next
     next(error);
   }
 };
-
-export default errorMiddleware;