typescript-express-starter 6.0.0 → 6.3.0

package/lib/default/.swcrc

@@ -0,0 +1,41 @@
+{
+  "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/*"],
+      "@dtos/*": ["dtos/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@models/*": ["models/*"],
+      "@routes/*": ["routes/*"],
+      "@services/*": ["services/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "module": {
+    "type": "commonjs"
+  }
+}
+
+
+

package/lib/default/Dockerfile

@@ -9,7 +9,7 @@ RUN npm install
 
 EXPOSE 3000
 
-# Dvelopment build stage
+# Development build stage
 FROM common-build-stage as development-build-stage
 
 ENV NODE_ENV development

package/lib/default/ecosystem.config.js

@@ -1,41 +1,57 @@
-module.exports = {
+/**
+ * @description pm2 configuration file.
+ * @example
+ *  production mode :: pm2 start ecosystem.config.js --only prod
+ *  development mode :: pm2 start ecosystem.config.js --only dev
+ */
+ module.exports = {
   apps: [
     {
-      name: 'myapp',
-      // package.json에 정의된 npm run start를 실행하게 해서 PM2로 관리하게 한다.
-      script: 'npm',
-      args: 'run dev',
-      instances: 2,
-      autorestart: true,
-      watch: false,
-      max_memory_restart: '1G',
-      // production mode
-      // pm2 start ecosystem.config.js
-      env: {
-        HOST: '0.0.0.0',
+      name: 'prod', // pm2 start App name
+      script: 'dist/server.js',
+      exec_mode: 'cluster', // 'cluster' or 'fork'
+      instance_var: 'INSTANCE_ID', // instance variable
+      instances: 2, // pm2 instance count
+      autorestart: true, // auto restart if process crash
+      watch: false, // files change automatic restart
+      ignore_watch: ['node_modules', 'logs'], // ignore files change
+      max_memory_restart: '1G', // restart if process use more than 1G memory
+      merge_logs: true, // if true, stdout and stderr will be merged and sent to pm2 log
+      output: './logs/access.log', // pm2 log file
+      error: './logs/error.log', // pm2 error log file
+      env: { // environment variable
         PORT: 3000,
         NODE_ENV: 'production',
       },
-      // development mode
-      // pm2 start ecosystem.config.js --env development
-      env_development: {
-        HOST: '0.0.0.0',
+    },
+    {
+      name: 'dev', // pm2 start App name
+      script: 'ts-node', // ts-node
+      args: '-r tsconfig-paths/register --transpile-only src/server.ts', // ts-node args
+      exec_mode: 'cluster', // 'cluster' or 'fork'
+      instance_var: 'INSTANCE_ID', // instance variable
+      instances: 2, // pm2 instance count
+      autorestart: true, // auto restart if process crash
+      watch: false, // files change automatic restart
+      ignore_watch: ['node_modules', 'logs'], // ignore files change
+      max_memory_restart: '1G', // restart if process use more than 1G memory
+      merge_logs: true, // if true, stdout and stderr will be merged and sent to pm2 log
+      output: './logs/access.log', // pm2 log file
+      error: './logs/error.log', // pm2 error log file
+      env: { // environment variable
         PORT: 3000,
         NODE_ENV: 'development',
       },
-      output: './logs/console.log',
-      error: './logs/consoleError.log',
     },
   ],
   deploy: {
     production: {
-      // sample
-      user: 'node',
-      host: '123.12.123.1',
+      user: 'user',
+      host: '0.0.0.0',
       ref: 'origin/master',
       repo: 'git@github.com:repo.git',
-      path: '/var/www/production',
-      'post-deploy': 'npm install && pm2 reload ecosystem.config.js --env production',
+      path: 'dist/server.js',
+      'post-deploy': 'npm install && npm run build && pm2 reload ecosystem.config.js --only prod',
     },
   },
 };

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

@@ -7,10 +7,13 @@
   "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"
+    "lint:fix": "npm run lint -- --fix",
+    "deploy:prod": "npm run build && pm2 start ecosystem.config.js --only prod",
+    "deploy:dev": "pm2 start ecosystem.config.js --only dev"
   },
   "dependencies": {
     "bcrypt": "^5.0.1",
@@ -20,24 +23,21 @@
     "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",
     "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",
@@ -57,16 +57,23 @@
     "@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",
     "supertest": "^6.1.3",
-    "tsconfig-paths": "^3.10.1"
+    "tsc-alias": "^1.4.1",
+    "tsconfig-paths": "^3.10.1",
+    "ts-jest": "^27.0.3",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.3.5"
   }
 }

package/lib/default/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/default/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/default/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/default/src/index.ts

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

package/lib/default/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/default/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/default/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/default/src/services/auth.service.ts

@@ -1,6 +1,6 @@
-import bcrypt from 'bcrypt';
+import { hash, compare } 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/default/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/default/src/tests/auth.test.ts

@@ -11,8 +11,8 @@ describe('Testing Auth', () => {
   describe('[POST] /signup', () => {
     it('response should have the Create userData', () => {
       const userData: CreateUserDto = {
-        email: 'test@email.com',
-        password: 'q1w2e3r4',
+        email: 'example@email.com',
+        password: 'password',
       };
       const authRoute = new AuthRoute();
       const app = new App([authRoute]);
@@ -24,8 +24,8 @@ describe('Testing Auth', () => {
   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',
+        email: 'example1@email.com',
+        password: 'password',
       };
 
       const authRoute = new AuthRoute();

package/lib/default/src/tests/users.test.ts

@@ -34,8 +34,8 @@ describe('Testing Users', () => {
   describe('[POST] /users', () => {
     it('response statusCode 201 / created', async () => {
       const userData: CreateUserDto = {
-        email: 'test@email.com',
-        password: 'q1w2e3r4',
+        email: 'example@email.com',
+        password: 'password',
       };
       const usersRoute = new UserRoute();
       const app = new App([usersRoute]);
@@ -48,8 +48,8 @@ describe('Testing Users', () => {
     it('response statusCode 200 / updated', async () => {
       const userId = 1;
       const userData: CreateUserDto = {
-        email: 'test@email.com',
-        password: 'q1w2e3r4',
+        email: 'example@email.com',
+        password: 'password',
       };
       const usersRoute = new UserRoute();
       const app = new App([usersRoute]);

package/lib/default/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/default/src/utils/util.ts

@@ -9,7 +9,7 @@ export const isEmpty = (value: string | number | object): boolean => {
     return true;
   } else if (typeof value !== 'number' && value === '') {
     return true;
-  } else if (value === 'undefined' || value === undefined) {
+  } else if (typeof value === 'undefined' || value === undefined) {
     return true;
   } else if (value !== null && typeof value === 'object' && !Object.keys(value).length) {
     return true;

package/lib/default/tsconfig.json

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

package/lib/knex/.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/knex/Dockerfile

@@ -9,7 +9,7 @@ RUN npm install
 
 EXPOSE 3000
 
-# Dvelopment build stage
+# Development build stage
 FROM common-build-stage as development-build-stage
 
 ENV NODE_ENV development