typescript-express-starter 9.1.2 → 10.0.0

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,12 +129,12 @@ const dependenciesDeduped = async () => {
     {
       type: "confirm",
       name: "isDeduped",
-      message: "Used to removed duplicate packages at npm. Do you want to ?",
+      message: "Deduplicate the package dependency tree (recommended) ?",
     },
   ]);
 
   return isDeduped;
-}
+};
 
 /**
  * @method copyProjectFiles
@@ -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 - 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 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/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/typegoose/package.json

@@ -16,62 +16,64 @@
     "deploy:dev": "pm2 start ecosystem.config.js --only dev"
   },
   "dependencies": {
-    "@typegoose/typegoose": "^9.4.0",
+    "@typegoose/typegoose": "^9.10.1",
     "bcrypt": "^5.0.1",
     "class-transformer": "^0.5.1",
-    "class-validator": "^0.13.1",
+    "class-validator": "^0.13.2",
     "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",
     "mongoose": "^6.3.2",
     "morgan": "^1.10.0",
-    "swagger-jsdoc": "^6.0.0",
-    "swagger-ui-express": "^4.1.6",
-    "winston": "^3.3.3",
-    "winston-daily-rotate-file": "^4.5.5"
+    "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"
   },
   "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/mongoose": "^5.10.1",
     "@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-jsdoc": "^6.0.1",
     "@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/typegoose/src/app.ts

@@ -1,3 +1,4 @@
+import 'reflect-metadata';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
@@ -11,7 +12,7 @@ import swaggerUi from 'swagger-ui-express';
 import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
 import { dbConnection } from '@databases';
 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 {
@@ -86,7 +87,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;

package/lib/typegoose/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) => {
     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) => {
     try {
       const userId: string = 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) => {
     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) {
@@ -41,8 +41,8 @@ class UsersController {
   public updateUser = async (req: Request, res: Response, next: NextFunction) => {
     try {
       const userId: string = req.params.id;
-      const userData: CreateUserDto = req.body;
-      const updateUserData: User = await this.userService.updateUser(userId, userData);
+      const userData: User = req.body;
+      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) => {
     try {
       const userId: string = 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/typegoose/src/database/index.ts

@@ -0,0 +1,11 @@
+import { DB_HOST, DB_PORT, DB_DATABASE } from '@config';
+
+// export const dbConnection = `mongodb://${DB_HOST}:${DB_PORT}/${DB_DATABASE}`;
+
+export const dbConnection = {
+    url: `mongodb://${DB_HOST}:${DB_PORT}/${DB_DATABASE}`,
+    options: {
+      useNewUrlParser: true,
+      useUnifiedTopology: true
+    },
+  };

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

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

package/lib/typegoose/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 = await userModel.findById(userId);
+      const { _id } = (await verify(Authorization, SECRET_KEY)) as DataStoredInToken;
+      const findUser = await UserModel.findById(_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/typegoose/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;