typescript-express-starter 6.2.1 → 6.3.0

package/lib/routing-controllers/src/app.ts

@@ -1,5 +1,6 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';
-
+import 'reflect-metadata';
+import '@/index';
+import { defaultMetadataStorage } from 'class-transformer';
 import { validationMetadatasToSchemas } from 'class-validator-jsonschema';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
@@ -65,8 +66,6 @@ class App {
   }
 
   private initializeSwagger(controllers: Function[]) {
-    const { defaultMetadataStorage } = require('class-transformer/cjs/storage');
-
     const schemas = validationMetadatasToSchemas({
       classTransformerMetadataStorage: defaultMetadataStorage,
       refPointerPrefix: '#/components/schemas/',

package/lib/routing-controllers/src/http/auth.http

@@ -1,35 +1,32 @@
-# auth API
-
-###
 # baseURL
 @baseURL = http://localhost:3000
 
 ###
-# signup
-POST {{baseURL}}/signup
+# User Signup
+POST {{ baseURL }}/signup
 Content-Type: application/json
 
 {
-    "email": "example@gmail.com",
-	"password": "qwer1234"
+    "email": "example@email.com",
+	"password": "password"
 }
 
 ###
-# Login
-POST {{baseURL}}/login
+# User Login
+POST {{ baseURL }}/login
 Content-Type: application/json
 
 {
-    "email": "lim@gmail.com",
-	"password": "q1w2e3r4"
+    "email": "example@email.com",
+	"password": "password"
 }
 
 ###
-# Logout
-POST {{baseURL}}/logout
+# User Logout
+POST {{ baseURL }}/logout
 Content-Type: application/json
 
 {
-    "email": "lim@gmail.com",
-	"password": "q1w2e3r4"
+    "email": "example@email.com",
+	"password": "password"
 }

package/lib/routing-controllers/src/http/users.http

@@ -1,38 +1,34 @@
-# users API
-
-###
 # baseURL
 @baseURL = http://localhost:3000
 
 ###
 # Find All Users
-GET {{baseURL}}/users
+GET {{ baseURL }}/users
 
 ###
 # Find User By Id
-GET {{baseURL}}/users/1
-
+GET {{ baseURL }}/users/1
 
 ###
-# Add User
-POST {{baseURL}}/users
+# Create User
+POST {{ baseURL }}/users
 Content-Type: application/json
 
 {
-    "email": "example@gmail.com",
-	"password": "qwer1234"
+    "email": "example@email.com",
+	"password": "password"
 }
 
 ###
-# Edit User By Id
-PUT {{baseURL}}/users/1
+# Modify User By Id
+PUT {{ baseURL }}/users/1
 Content-Type: application/json
 
 {
-    "email": "example@gmail.com",
-	"password": "qwer1234"
+    "email": "example@email.com",
+	"password": "password"
 }
 
 ###
-# Del User By Id
-DELETE {{baseURL}}/users/1
+# Delete User By Id
+DELETE {{ baseURL }}/users/1

package/lib/routing-controllers/src/index.ts

@@ -0,0 +1 @@
+process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';

package/lib/routing-controllers/src/middlewares/auth.middleware.ts

@@ -1,17 +1,17 @@
 import config from 'config';
 import { NextFunction, Response } from 'express';
-import jwt from 'jsonwebtoken';
+import { verify } from 'jsonwebtoken';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
 import userModel from '@models/users.model';
 
 const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFunction) => {
   try {
-    const Authorization = req.cookies['Authorization'] || req.header('Authorization').split('Bearer ')[1] || null;
+    const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
 
     if (Authorization) {
       const secretKey: string = config.get('secretKey');
-      const verificationResponse = (await jwt.verify(Authorization, secretKey)) as DataStoredInToken;
+      const verificationResponse = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const userId = verificationResponse.id;
       const findUser = userModel.find(user => user.id === userId);
 

package/lib/routing-controllers/src/middlewares/validation.middleware.ts

@@ -3,6 +3,13 @@ import { validate, ValidationError } from 'class-validator';
 import { RequestHandler } from 'express';
 import { HttpException } from '@exceptions/HttpException';
 
+const getAllNestedErrors = (error: ValidationError) => {
+  if(error.constraints){
+    return Object.values(error.constraints)
+  }
+  return error.children.map(getAllNestedErrors).join(',')
+}
+
 export const validationMiddleware = (
   type: any,
   value: string | 'body' | 'query' | 'params' = 'body',
@@ -11,9 +18,10 @@ export const validationMiddleware = (
   forbidNonWhitelisted = true,
 ): RequestHandler => {
   return (req, res, next) => {
-    validate(plainToClass(type, req[value]), { skipMissingProperties, whitelist, forbidNonWhitelisted }).then((errors: ValidationError[]) => {
+    const obj = plainToClass(type, req[value]);
+    validate(obj, { skipMissingProperties, whitelist, forbidNonWhitelisted }).then((errors: ValidationError[]) => {
       if (errors.length > 0) {
-        const message = errors.map((error: ValidationError) => Object.values(error.constraints)).join(', ');
+        const message = errors.map(getAllNestedErrors).join(', ');
         next(new HttpException(400, message));
       } else {
         next();

package/lib/routing-controllers/src/models/users.model.ts

@@ -1,11 +1,11 @@
 import { User } from '@interfaces/users.interface';
 
-// password: q1w2e3r4
+// password: password
 const userModel: User[] = [
-  { id: 1, email: 'lim@gmail.com', password: '$2b$10$hmrwtGwC.QlfWt6YWaT3S.FP9CarS3.V9n3Qr.d9y2ovcan0oxs56' },
-  { id: 2, email: 'kim@gmail.com', password: '$2b$10$hmrwtGwC.QlfWt6YWaT3S.FP9CarS3.V9n3Qr.d9y2ovcan0oxs56' },
-  { id: 3, email: 'park@gmail.com', password: '$2b$10$hmrwtGwC.QlfWt6YWaT3S.FP9CarS3.V9n3Qr.d9y2ovcan0oxs56' },
-  { id: 4, email: 'choi@gmail.com', password: '$2b$10$hmrwtGwC.QlfWt6YWaT3S.FP9CarS3.V9n3Qr.d9y2ovcan0oxs56' },
+  { id: 1, email: 'example1@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
+  { id: 2, email: 'example2@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
+  { id: 3, email: 'example3@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
+  { id: 4, email: 'example4@email.com', password: '$2b$10$TBEfaCe1oo.2jfkBDWcj/usBj4oECsW2wOoDXpCa2IH9xqCpEK/hC' },
 ];
 
 export default userModel;

package/lib/routing-controllers/src/server.ts

@@ -1,7 +1,5 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';
-
 import 'dotenv/config';
-import 'reflect-metadata';
+import '@/index';
 import App from '@/app';
 import { AuthController } from '@controllers/auth.controller';
 import { IndexController } from '@controllers/index.controller';

package/lib/routing-controllers/src/services/auth.service.ts

@@ -1,6 +1,6 @@
-import bcrypt from 'bcrypt';
+import { compare, hash } from 'bcrypt';
 import config from 'config';
-import jwt from 'jsonwebtoken';
+import { sign } from 'jsonwebtoken';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
@@ -17,7 +17,7 @@ class AuthService {
     const findUser: User = this.users.find(user => user.email === userData.email);
     if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
 
-    const hashedPassword = await bcrypt.hash(userData.password, 10);
+    const hashedPassword = await hash(userData.password, 10);
     const createUserData: User = { id: this.users.length + 1, ...userData, password: hashedPassword };
 
     return createUserData;
@@ -29,7 +29,7 @@ class AuthService {
     const findUser: User = this.users.find(user => user.email === userData.email);
     if (!findUser) throw new HttpException(409, `You're email ${userData.email} not found`);
 
-    const isPasswordMatching: boolean = await bcrypt.compare(userData.password, findUser.password);
+    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);
@@ -52,7 +52,7 @@ class AuthService {
     const secretKey: string = config.get('secretKey');
     const expiresIn: number = 60 * 60;
 
-    return { expiresIn, token: jwt.sign(dataStoredInToken, secretKey, { expiresIn }) };
+    return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };
   }
 
   public createCookie(tokenData: TokenData): string {

package/lib/routing-controllers/src/services/users.service.ts

@@ -1,4 +1,4 @@
-import bcrypt from 'bcrypt';
+import { hash } from 'bcrypt';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
 import { User } from '@interfaces/users.interface';
@@ -26,7 +26,7 @@ class UserService {
     const findUser: User = this.users.find(user => user.email === userData.email);
     if (findUser) throw new HttpException(409, `Your email ${userData.email} already exists`);
 
-    const hashedPassword = await bcrypt.hash(userData.password, 10);
+    const hashedPassword = await hash(userData.password, 10);
     const createUserData: User = { id: this.users.length + 1, ...userData, password: hashedPassword };
     this.users = [...this.users, createUserData];
 
@@ -39,7 +39,7 @@ class UserService {
     const findUser: User = this.users.find(user => user.id === userId);
     if (!findUser) throw new HttpException(409, "You're not user");
 
-    const hashedPassword = await bcrypt.hash(userData.password, 10);
+    const hashedPassword = await hash(userData.password, 10);
     const updateUserData: User[] = this.users.map((user: User) => {
       if (user.id === findUser.id) user = { id: userId, ...userData, password: hashedPassword };
       return user;

package/lib/routing-controllers/src/utils/logger.ts

@@ -1,14 +1,14 @@
 import config from 'config';
-import fs from 'fs';
-import path from 'path';
+import { existsSync, mkdirSync } from 'fs';
+import { join } from 'path';
 import winston from 'winston';
 import winstonDaily from 'winston-daily-rotate-file';
 
 // logs dir
-const logDir: string = path.join(__dirname, config.get('log.dir'));
+const logDir: string = join(__dirname, config.get('log.dir'));
 
-if (!fs.existsSync(logDir)) {
-  fs.mkdirSync(logDir);
+if (!existsSync(logDir)) {
+  mkdirSync(logDir);
 }
 
 // Define log format

package/lib/routing-controllers/tsconfig.json

@@ -13,7 +13,7 @@
     "pretty": true,
     "sourceMap": true,
     "declaration": true,
-    "outDir": "./dist",
+    "outDir": "dist",
     "allowJs": true,
     "noEmit": false,
     "esModuleInterop": true,
@@ -33,5 +33,5 @@
     }
   },
   "include": ["src/**/*.ts", "src/**/*.json", ".env"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules", "src/http", "src/logs", "src/tests"]
 }

package/lib/sequelize/.swcrc

@@ -0,0 +1,39 @@
+{
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "tsx": false,
+      "dynamicImport": true,
+      "decorators": true
+    },
+    "transform": {
+      "legacyDecorator": true,
+      "decoratorMetadata": true
+    },
+    "target": "es2017",
+    "externalHelpers": false,
+    "keepClassNames": true,
+    "loose": false,
+    "minify": {
+      "compress": false,
+      "mangle": false
+    },
+    "baseUrl": "src",
+    "paths": {
+      "@/*": ["*"],
+      "@controllers/*": ["controllers/*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@models/*": ["models/*"],
+      "@routes/*": ["routes/*"],
+      "@services/*": ["services/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "module": {
+    "type": "commonjs"
+  }
+}

package/lib/sequelize/docker-compose.yml

@@ -19,11 +19,6 @@ services:
     container_name: server
     ports:
       - '3000:3000'
-    environment:
-      MYSQL_USER: root
-      MYSQL_PASSWORD: password
-      MYSQL_HOST: mysql
-      MYSQL_DATABASE: sequelize
     volumes:
       - ./:/app
       - /app/node_modules
@@ -40,7 +35,7 @@ services:
     environment:
       MYSQL_ROOT_USER: root
       MYSQL_ROOT_PASSWORD: password
-      MYSQL_DATABASE: sequelize
+      MYSQL_DATABASE: test
     ports:
       - '3306:3306'
     networks:

package/lib/sequelize/nodemon.json

@@ -5,8 +5,8 @@
     ],
     "ext": "js,ts,json",
     "ignore": [
-        "src/**/*.spec.ts",
-        "src/**/*.test.ts"
+        "src/logs/*",
+        "src/**/*.{spec,test}.ts"
     ],
     "exec": "ts-node -r tsconfig-paths/register --transpile-only src/server.ts"
 }

package/lib/sequelize/package.json

@@ -7,7 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && npx tsc-alias",
+    "build": "swc src -d dist --source-maps --copy-files",
+    "build:tsc": "tsc && tsc-alias",
     "test": "jest --forceExit --detectOpenHandles",
     "lint": "eslint --ignore-path .gitignore --ext .ts src/",
     "lint:fix": "npm run lint -- --fix",
@@ -22,27 +23,23 @@
     "config": "^3.3.6",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
-    "cross-env": "^7.0.3",
     "dotenv": "^10.0.0",
     "envalid": "^7.1.0",
     "express": "^4.17.1",
     "helmet": "^4.6.0",
     "hpp": "^0.2.3",
-    "jest": "^27.0.6",
     "jsonwebtoken": "^8.5.1",
     "morgan": "^1.10.0",
     "mysql2": "^2.2.5",
-    "pm2": "^5.1.0",
     "sequelize": "^6.6.5",
     "swagger-jsdoc": "^6.0.0",
     "swagger-ui-express": "^4.1.6",
-    "ts-jest": "^27.0.3",
-    "ts-node": "^10.0.0",
-    "typescript": "^4.3.5",
     "winston": "^3.3.3",
     "winston-daily-rotate-file": "^4.5.5"
   },
   "devDependencies": {
+    "@swc/cli": "^0.1.51",
+    "@swc/core": "^1.2.108",
     "@types/bcrypt": "^5.0.0",
     "@types/compression": "^1.7.1",
     "@types/config": "^0.0.39",
@@ -63,17 +60,24 @@
     "@types/winston": "^2.4.4",
     "@typescript-eslint/eslint-plugin": "^4.28.2",
     "@typescript-eslint/parser": "^4.28.2",
+    "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.0.6",
     "lint-staged": "^11.0.0",
     "node-config": "^0.0.2",
     "node-gyp": "^8.1.0",
     "nodemon": "^2.0.9",
+    "pm2": "^5.1.0",
     "prettier": "^2.3.2",
     "sequelize-cli": "^6.2.0",
     "supertest": "^6.1.3",
-    "tsconfig-paths": "^3.10.1"
+    "ts-jest": "^27.0.7",
+    "ts-node": "^10.4.0",
+    "tsc-alias": "^1.4.1",
+    "tsconfig-paths": "^3.10.1",
+    "typescript": "^4.5.2"
   }
 }

package/lib/sequelize/src/app.ts

@@ -1,5 +1,4 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';
-
+import '@/index';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';

package/lib/sequelize/src/configs/development.json

@@ -1,10 +1,10 @@
 {
     "env": "development",
     "dbConfig": {
-        "host": "mysql",
+        "host": "localhost",
         "user": "root",
         "password": "password",
-        "database": "sequelize",
+        "database": "test",
         "pool": {
             "min": 0,
             "max": 5

package/lib/sequelize/src/configs/production.json

@@ -4,7 +4,7 @@
         "host": "localhost",
         "user": "root",
         "password": "password",
-        "database": "sequelize",
+        "database": "test",
         "pool": {
             "min": 0,
             "max": 5

package/lib/sequelize/src/configs/test.json

@@ -4,7 +4,7 @@
         "host": "localhost",
         "user": "root",
         "password": "password",
-        "database": "sequelize",
+        "database": "test",
         "pool": {
             "min": 0,
             "max": 5

package/lib/sequelize/src/http/auth.http

@@ -0,0 +1,32 @@
+# baseURL
+@baseURL = http://localhost:3000
+
+###
+# User Signup
+POST {{ baseURL }}/signup
+Content-Type: application/json
+
+{
+    "email": "example@email.com",
+	"password": "password"
+}
+
+###
+# User Login
+POST {{ baseURL }}/login
+Content-Type: application/json
+
+{
+    "email": "example@email.com",
+	"password": "password"
+}
+
+###
+# User Logout
+POST {{ baseURL }}/logout
+Content-Type: application/json
+
+{
+    "email": "example@email.com",
+	"password": "password"
+}

package/lib/sequelize/src/http/users.http

@@ -0,0 +1,34 @@
+# baseURL
+@baseURL = http://localhost:3000
+
+###
+# Find All Users
+GET {{ baseURL }}/users
+
+###
+# Find User By Id
+GET {{ baseURL }}/users/1
+
+###
+# Create User
+POST {{ baseURL }}/users
+Content-Type: application/json
+
+{
+    "email": "example@email.com",
+	"password": "password"
+}
+
+###
+# Modify User By Id
+PUT {{ baseURL }}/users/1
+Content-Type: application/json
+
+{
+    "email": "example@email.com",
+	"password": "password"
+}
+
+###
+# Delete User By Id
+DELETE {{ baseURL }}/users/1

package/lib/sequelize/src/index.ts

@@ -0,0 +1 @@
+process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';

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

@@ -1,17 +1,17 @@
-import { NextFunction, Response } from 'express';
 import config from 'config';
-import jwt from 'jsonwebtoken';
+import { NextFunction, Response } from 'express';
+import { verify } from 'jsonwebtoken';
 import DB from '@databases';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
 
 const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFunction) => {
   try {
-    const Authorization = req.cookies['Authorization'] || req.header('Authorization').split('Bearer ')[1] || null;
+    const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
 
     if (Authorization) {
       const secretKey: string = config.get('secretKey');
-      const verificationResponse = jwt.verify(Authorization, secretKey) as DataStoredInToken;
+      const verificationResponse = verify(Authorization, secretKey) as DataStoredInToken;
       const userId = verificationResponse.id;
       const findUser = await DB.Users.findByPk(userId);
 

package/lib/sequelize/src/server.ts

@@ -1,6 +1,5 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';
-
 import 'dotenv/config';
+import '@/index';
 import App from '@/app';
 import AuthRoute from '@routes/auth.route';
 import IndexRoute from '@routes/index.route';

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

@@ -1,6 +1,6 @@
-import bcrypt from 'bcrypt';
+import { compare, hash } from 'bcrypt';
 import config from 'config';
-import jwt from 'jsonwebtoken';
+import { sign } from 'jsonwebtoken';
 import DB from '@databases';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
@@ -17,7 +17,7 @@ class AuthService {
     const findUser: User = await this.users.findOne({ where: { email: userData.email } });
     if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
 
-    const hashedPassword = await bcrypt.hash(userData.password, 10);
+    const hashedPassword = await hash(userData.password, 10);
     const createUserData: User = await this.users.create({ ...userData, password: hashedPassword });
 
     return createUserData;
@@ -29,7 +29,7 @@ class AuthService {
     const findUser: User = await this.users.findOne({ where: { email: userData.email } });
     if (!findUser) throw new HttpException(409, `You're email ${userData.email} not found`);
 
-    const isPasswordMatching: boolean = await bcrypt.compare(userData.password, findUser.password);
+    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);
@@ -52,7 +52,7 @@ class AuthService {
     const secretKey: string = config.get('secretKey');
     const expiresIn: number = 60 * 60;
 
-    return { expiresIn, token: jwt.sign(dataStoredInToken, secretKey, { expiresIn }) };
+    return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };
   }
 
   public createCookie(tokenData: TokenData): string {

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

@@ -1,4 +1,4 @@
-import bcrypt from 'bcrypt';
+import { hash } from 'bcrypt';
 import DB from '@databases';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
@@ -28,7 +28,7 @@ class UserService {
     const findUser: User = await this.users.findOne({ where: { email: userData.email } });
     if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
 
-    const hashedPassword = await bcrypt.hash(userData.password, 10);
+    const hashedPassword = await hash(userData.password, 10);
     const createUserData: User = await this.users.create({ ...userData, password: hashedPassword });
     return createUserData;
   }
@@ -39,7 +39,7 @@ class UserService {
     const findUser: User = await this.users.findByPk(userId);
     if (!findUser) throw new HttpException(409, "You're not user");
 
-    const hashedPassword = await bcrypt.hash(userData.password, 10);
+    const hashedPassword = await hash(userData.password, 10);
     await this.users.update({ ...userData, password: hashedPassword }, { where: { id: userId } });
 
     const updateUser: User = await this.users.findByPk(userId);