typescript-express-starter 9.2.0 → 10.0.1

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

@@ -1,63 +1,52 @@
 import { compare, hash } from 'bcrypt';
 import { sign } from 'jsonwebtoken';
+import { Service } from 'typedi';
 import { SECRET_KEY } from '@config';
-import DB from '@databases';
+import { DB } from '@database';
 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 { isEmpty } from '@utils/util';
 
-class AuthService {
-  public users = DB.Users;
+const createToken = (user: User): TokenData => {
+  const dataStoredInToken: DataStoredInToken = { id: user.id };
+  const expiresIn: number = 60 * 60;
 
-  public async signup(userData: CreateUserDto): Promise<User> {
-    if (isEmpty(userData)) throw new HttpException(400, "userData is empty");
+  return { expiresIn, token: sign(dataStoredInToken, SECRET_KEY, { expiresIn }) };
+}
 
-    const findUser: User = await this.users.findOne({ where: { email: userData.email } });
+const createCookie = (tokenData: TokenData): string => {
+  return `Authorization=${tokenData.token}; HttpOnly; Max-Age=${tokenData.expiresIn};`;
+}
+@Service()
+export class AuthService {
+  public async signup(userData: CreateUserDto): Promise<User> {
+    const findUser: User = await DB.Users.findOne({ where: { email: userData.email } });
     if (findUser) throw new HttpException(409, `This email ${userData.email} already exists`);
 
     const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await this.users.create({ ...userData, password: hashedPassword });
+    const createUserData: User = await DB.Users.create({ ...userData, password: hashedPassword });
 
     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 this.users.findOne({ where: { email: userData.email } });
+    const findUser: User = await DB.Users.findOne({ where: { email: userData.email } });
     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 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 this.users.findOne({ where: { email: userData.email, password: userData.password } });
+    const findUser: User = await DB.Users.findOne({ where: { email: userData.email, password: userData.password } });
     if (!findUser) throw new HttpException(409, "User doesn't exist");
 
     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/sequelize/src/services/users.service.ts

@@ -1,61 +1,50 @@
 import { hash } from 'bcrypt';
-import DB from '@databases';
+import { Service } from 'typedi';
+import { DB } from '@database';
 import { CreateUserDto } from '@dtos/users.dto';
-import { HttpException } from '@exceptions/HttpException';
+import { HttpException } from '@/exceptions/httpException';
 import { User } from '@interfaces/users.interface';
-import { isEmpty } from '@utils/util';
-
-class UserService {
-  public users = DB.Users;
 
+@Service()
+export class UserService {
   public async findAllUser(): Promise<User[]> {
-    const allUser: User[] = await this.users.findAll();
+    const allUser: User[] = await DB.Users.findAll();
     return allUser;
   }
 
   public async findUserById(userId: number): Promise<User> {
-    if (isEmpty(userId)) throw new HttpException(400, "UserId is empty");
-
-    const findUser: User = await this.users.findByPk(userId);
+    const findUser: User = await DB.Users.findByPk(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 this.users.findOne({ where: { email: userData.email } });
+    const findUser: User = await DB.Users.findOne({ where: { email: userData.email } });
     if (findUser) throw new HttpException(409, `This email ${userData.email} already exists`);
 
     const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await this.users.create({ ...userData, password: hashedPassword });
+    const createUserData: User = await DB.Users.create({ ...userData, password: hashedPassword });
     return createUserData;
   }
 
   public async updateUser(userId: number, userData: CreateUserDto): Promise<User> {
-    if (isEmpty(userData)) throw new HttpException(400, "userData is empty");
-
-    const findUser: User = await this.users.findByPk(userId);
+    const findUser: User = await DB.Users.findByPk(userId);
     if (!findUser) throw new HttpException(409, "User doesn't exist");
 
     const hashedPassword = await hash(userData.password, 10);
-    await this.users.update({ ...userData, password: hashedPassword }, { where: { id: userId } });
+    await DB.Users.update({ ...userData, password: hashedPassword }, { where: { id: userId } });
 
-    const updateUser: User = await this.users.findByPk(userId);
+    const updateUser: User = await DB.Users.findByPk(userId);
     return updateUser;
   }
 
   public async deleteUser(userId: number): Promise<User> {
-    if (isEmpty(userId)) throw new HttpException(400, "User doesn't existId");
-
-    const findUser: User = await this.users.findByPk(userId);
+    const findUser: User = await DB.Users.findByPk(userId);
     if (!findUser) throw new HttpException(409, "User doesn't exist");
 
-    await this.users.destroy({ where: { id: userId } });
+    await DB.Users.destroy({ where: { id: userId } });
 
     return findUser;
   }
 }
-
-export default UserService;

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

@@ -1,9 +1,9 @@
 import bcrypt from 'bcrypt';
 import { Sequelize } from 'sequelize';
 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/sequelize/src/{tests → test}/users.test.ts

@@ -1,9 +1,9 @@
 import bcrypt from 'bcrypt';
 import { Sequelize } from 'sequelize';
 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/sequelize/src/utils/validateEnv.ts

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

package/lib/sequelize/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/starter.js

@@ -1,5 +1,5 @@
 /*****************************************************************
- * Create Typescript Express Starter
+ * Create TypeScript Express Starter
  * 2019.12.18 ~ 🎮
  * Made By AGUMON 🦖
  * https://github.com/ljlm0402/typescript-express-starter
@@ -29,8 +29,8 @@ const createProject = async (projectName) => {
 
   try {
     const template = await chooseTemplates();
-    const isUpdated = await dependenciesUpdates();
-    const isDeduped = await dependenciesDeduped();
+    // const isUpdated = await dependenciesUpdates();
+    // const isDeduped = await dependenciesDeduped();
 
     console.log("[ 1 / 3 ] 🔍  copying project...");
     console.log("[ 2 / 3 ] 🚚  fetching node_modules...");
@@ -47,8 +47,8 @@ const createProject = async (projectName) => {
     spinner.start();
 
     await installNodeModules(projectName, spinner);
-    isUpdated && (await updateNodeModules(projectName, spinner));
-    isDeduped && (await dedupeNodeModules(projectName, spinner));
+    // isUpdated && (await updateNodeModules(projectName, spinner));
+    // isDeduped && (await dedupeNodeModules(projectName, spinner));
     await postInstallScripts(projectName, template, spinner);
 
     await createGitignore(projectName, spinner);
@@ -83,7 +83,7 @@ const chooseTemplates = async () => {
     {
       type: "list",
       name: "chooseTemplates",
-      message: "Please select the template you want",
+      message: "Select a template",
       choices: [...directories, new inquirer.Separator()],
     },
   ]);
@@ -100,8 +100,7 @@ const dependenciesUpdates = async () => {
     {
       type: "confirm",
       name: "isUpdated",
-      message:
-        "Do you want to update all packages in the node_modules directory and dependency ?",
+      message: "Update the package dependencies to their latest versions ?",
     },
   ]);
 
@@ -111,7 +110,7 @@ const dependenciesUpdates = async () => {
         type: "confirm",
         name: "isUpdatedReconfirm",
         message:
-          "However, updating to the latest version may cause package dependency issues. Do you still want to update ?",
+          "The updated dependencies may contain breaking changes. Continue to update the dependencies anyway ?",
       },
     ]);
 
@@ -130,7 +129,7 @@ const dependenciesDeduped = async () => {
     {
       type: "confirm",
       name: "isDeduped",
-      message: "Do you want to Used to removed duplicate packages at npm ?",
+      message: "Deduplicate the package dependency tree (recommended) ?",
     },
   ]);
 
@@ -241,22 +240,14 @@ const initGit = async (destination) => {
 const succeedConsole = async (template, spinner) => {
   spinner.succeed(chalk`{green Complete setup project}`);
 
-  switch (template) {
-    case "prisma":
-      {
-        console.log(
-          "⛰ Prisma installed. Check your .env settings and then run `npm run prisma:migrate`"
-        );
-      }
-      break;
-    case "knex":
-      {
-        console.log(
-          "⛰ Knex installed. Check your .env settings and then run `npm run migrate`"
-        );
-      }
-      break;
-  }
+  const msg =
+    {
+      prisma:
+        "⛰ Prisma installed. Check your .env settings and then run `npm run prisma:migrate`",
+      knex: "⛰ Knex installed. Check your .env settings and then run `npm run migrate`",
+    }[template] || "";
+
+  msg && console.log(msg);
 };
 
 /**

package/lib/typegoose/.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/typegoose/.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/typegoose/.swcrc

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

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

@@ -31,8 +31,10 @@
     "jsonwebtoken": "^8.5.1",
     "mongoose": "^6.3.2",
     "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/typegoose/src/app.ts

@@ -1,3 +1,4 @@
+import 'reflect-metadata';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
@@ -5,13 +6,13 @@ import express from 'express';
 import helmet from 'helmet';
 import hpp from 'hpp';
 import morgan from 'morgan';
-import { connect, set } from 'mongoose';
+
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
 import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
-import { dbConnection } from '@databases';
+import { dbConnection } 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 {
@@ -44,12 +45,8 @@ class App {
     return this.app;
   }
 
-  private connectToDatabase() {
-    if (this.env !== 'production') {
-      set('debug', true);
-    }
-
-    connect(dbConnection);
+  private async connectToDatabase() {
+    await dbConnection();
   }
 
   private initializeMiddlewares() {
@@ -86,7 +83,7 @@ class App {
   }
 
   private initializeErrorHandling() {
-    this.app.use(errorMiddleware);
+    this.app.use(ErrorMiddleware);
   }
 }
 

package/lib/typegoose/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;

package/lib/typegoose/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) => {
     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) => {
     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) => {
     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;