typescript-express-starter 9.1.2 → 10.0.0

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

@@ -1,45 +1,37 @@
 import { hash } from 'bcrypt';
-import { CreateUserDto } from '@dtos/users.dto';
-import { HttpException } from '@exceptions/HttpException';
+import { Service } from 'typedi';
+import { HttpException } from '@exceptions/httpException';
 import { User } from '@interfaces/users.interface';
-import userModel from '@models/users.model';
-import { isEmpty } from '@utils/util';
-
-class UserService {
-  public users = userModel;
+import { UserModel } from '@models/users.model';
 
+@Service()
+export class UserService {
   public async findAllUser(): Promise<User[]> {
-    const users: User[] = await this.users.find();
+    const users: User[] = await UserModel.find();
     return users;
   }
 
   public async findUserById(userId: string): Promise<User> {
-    if (isEmpty(userId)) throw new HttpException(400, "You're not userId");
-
-    const findUser: User = await this.users.findOne({ _id: userId });
-    if (!findUser) throw new HttpException(409, "You're not user");
+    const findUser: User = await UserModel.findOne({ _id: 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, "You're not userData");
-
-    const findUser: User = await this.users.findOne({ email: userData.email });
-    if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
+  public async createUser(userData: User): Promise<User> {
+    const findUser: User = await UserModel.findOne({ 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 UserModel.create({ ...userData, password: hashedPassword });
 
     return createUserData;
   }
 
-  public async updateUser(userId: string, userData: CreateUserDto): Promise<User> {
-    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
-
+  public async updateUser(userId: string, userData: User): Promise<User> {
     if (userData.email) {
-      const findUser: User = await this.users.findOne({ email: userData.email });
-      if (findUser && findUser._id != userId) throw new HttpException(409, `You're email ${userData.email} already exists`);
+      const findUser: User = await UserModel.findOne({ email: userData.email });
+      if (findUser && findUser._id != userId) throw new HttpException(409, `This email ${userData.email} already exists`);
     }
 
     if (userData.password) {
@@ -47,18 +39,16 @@ class UserService {
       userData = { ...userData, password: hashedPassword };
     }
 
-    const updateUserById: User = await this.users.findByIdAndUpdate(userId, { userData });
-    if (!updateUserById) throw new HttpException(409, "You're not user");
+    const updateUserById: User = await UserModel.findByIdAndUpdate(userId, { userData });
+    if (!updateUserById) throw new HttpException(409, "User doesn't exist");
 
     return updateUserById;
   }
 
   public async deleteUser(userId: string): Promise<User> {
-    const deleteUserById: User = await this.users.findByIdAndDelete(userId);
-    if (!deleteUserById) throw new HttpException(409, "You're not user");
+    const deleteUserById: User = await UserModel.findByIdAndDelete(userId);
+    if (!deleteUserById) throw new HttpException(409, "User doesn't exist");
 
     return deleteUserById;
   }
 }
-
-export default UserService;

package/lib/{typegoose/src/tests → mongoose/src/test}/users.test.ts

@@ -1,9 +1,9 @@
 import bcrypt from 'bcrypt';
 import mongoose from 'mongoose';
 import request from 'supertest';
-import App from '@/app';
+import { App } from '@/app';
 import { CreateUserDto } from '@dtos/users.dto';
-import UsersRoute from '@routes/users.route';
+import { UserRoute } from '@routes/users.route';
 
 afterAll(async () => {
   await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
@@ -12,7 +12,7 @@ afterAll(async () => {
 describe('Testing Users', () => {
   describe('[GET] /users', () => {
     it('response fineAll Users', async () => {
-      const usersRoute = new UsersRoute();
+      const usersRoute = new UserRoute();
       const users = usersRoute.usersController.userService.users;
 
       users.find = jest.fn().mockReturnValue([
@@ -43,7 +43,7 @@ describe('Testing Users', () => {
     it('response findOne User', async () => {
       const userId = 'qpwoeiruty';
 
-      const usersRoute = new UsersRoute();
+      const usersRoute = new UserRoute();
       const users = usersRoute.usersController.userService.users;
 
       users.findOne = jest.fn().mockReturnValue({
@@ -65,7 +65,7 @@ describe('Testing Users', () => {
         password: 'q1w2e3r4',
       };
 
-      const usersRoute = new UsersRoute();
+      const usersRoute = new UserRoute();
       const users = usersRoute.usersController.userService.users;
 
       users.findOne = jest.fn().mockReturnValue(null);
@@ -89,7 +89,7 @@ describe('Testing Users', () => {
         password: 'q1w2e3r4',
       };
 
-      const usersRoute = new UsersRoute();
+      const usersRoute = new UserRoute();
       const users = usersRoute.usersController.userService.users;
 
       if (userData.email) {
@@ -116,7 +116,7 @@ describe('Testing Users', () => {
     it('response Delete User', async () => {
       const userId = '60706478aad6c9ad19a31c84';
 
-      const usersRoute = new UsersRoute();
+      const usersRoute = new UserRoute();
       const users = usersRoute.usersController.userService.users;
 
       users.findByIdAndDelete = jest.fn().mockReturnValue({

package/lib/mongoose/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/mongoose/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/node-postgres/.dockerignore

@@ -0,0 +1,18 @@
+# compiled output
+.vscode
+/node_modules
+
+# code formatter
+.eslintrc
+.eslintignore
+.editorconfig
+.huskyrc
+.lintstagedrc.json
+.prettierrc
+
+# test
+jest.config.js
+
+# docker
+Dockerfile
+docker-compose.yml

package/lib/node-postgres/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

package/lib/node-postgres/.env.development.local

@@ -0,0 +1,13 @@
+# PORT
+PORT = 3000
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/node-postgres/.env.production.local

@@ -0,0 +1,13 @@
+# PORT
+PORT = 3000
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = combined
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = your.domain.com
+CREDENTIALS = true

package/lib/node-postgres/.env.test.local

@@ -0,0 +1,13 @@
+# PORT
+PORT = 3000
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/node-postgres/.eslintignore

@@ -0,0 +1 @@
+/dist

package/lib/node-postgres/.eslintrc

@@ -0,0 +1,18 @@
+{
+    "parser": "@typescript-eslint/parser",
+    "extends": ["prettier", "plugin:@typescript-eslint/recommended", "plugin:prettier/recommended"],
+    "parserOptions": {
+      "ecmaVersion": 2018,
+      "sourceType": "module"
+    },
+    "rules": {
+      "@typescript-eslint/explicit-member-accessibility": 0,
+      "@typescript-eslint/explicit-function-return-type": 0,
+      "@typescript-eslint/no-parameter-properties": 0,
+      "@typescript-eslint/interface-name-prefix": 0,
+      "@typescript-eslint/explicit-module-boundary-types": 0,
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/ban-types": "off",
+      "@typescript-eslint/no-var-requires": "off"
+    }
+  }

package/lib/node-postgres/.huskyrc

@@ -0,0 +1,5 @@
+{
+  "hooks": {
+    "pre-commit": "lint-staged"
+  }
+}

package/lib/node-postgres/.lintstagedrc.json

@@ -0,0 +1,5 @@
+{
+    "*.ts": [
+      "npm run lint"
+    ]
+  }

package/lib/node-postgres/.prettierrc

@@ -0,0 +1,8 @@
+{
+    "printWidth": 150,
+    "tabWidth": 2,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "semi": true,
+    "arrowParens": "avoid"
+}

package/lib/node-postgres/.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": {
+        "@/*": ["*"],
+        "@config": ["config"],
+        "@controllers/*": ["controllers/*"],
+        "@dtos/*": ["dtos/*"],
+        "@database": ["database"],
+        "@exceptions/*": ["exceptions/*"],
+        "@interfaces/*": ["interfaces/*"],
+        "@middlewares/*": ["middlewares/*"],
+        "@models/*": ["models/*"],
+        "@services/*": ["services/*"],
+        "@utils/*": ["utils/*"]
+      }
+    },
+    "module": {
+      "type": "commonjs"
+    }
+  }

package/lib/node-postgres/.vscode/launch.json

@@ -0,0 +1,35 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Dev typescript-express-starter",
+            "command": "npm run dev"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Start typescript-express-starter",
+            "command": "npm run start"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Test typescript-express-starter",
+            "command": "npm run test"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Lint typescript-express-starter",
+            "command": "npm run lint"
+        },
+        {
+            "type": "node-terminal",
+            "request": "launch",
+            "name": "Lint:Fix typescript-express-starter",
+            "command": "npm run lint:fix"
+        }
+    ]
+}

package/lib/node-postgres/.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "editor.codeActionsOnSave": {
+      "source.fixAll.eslint": true
+    },
+    "editor.formatOnSave": false
+  }

package/lib/node-postgres/Dockerfile.dev

@@ -0,0 +1,17 @@
+# 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
+
+# Cmd script
+CMD ["npm", "run", "dev"]

package/lib/node-postgres/Dockerfile.prod

@@ -0,0 +1,17 @@
+# 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
+
+# Cmd script
+CMD ["npm", "run", "start"]

package/lib/node-postgres/Makefile

@@ -0,0 +1,46 @@
+# app name should be overridden.
+# 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: 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}\
+		-f Dockerfile.prod .
+
+build-dev: ## Build the container image - Dvelopment
+	docker build -t ${APP_NAME}\
+		-f Dockerfile.dev .
+
+run: ## Run the container image
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+pause: ## Pause the containers
+	docker container rm -f $(shell docker ps -aq)
+
+clean: ## Clean the images
+	docker rmi -f $(shell docker images -a -q)
+
+remove: ## Remove the volumes
+	docker volume rm -f $(shell docker volume ls -q)
+
+#-- Database
+db: ## Start the local database
+	docker-compose up -d pg

package/lib/node-postgres/docker-compose.yml

@@ -0,0 +1,61 @@
+version: "3.9"
+
+services:
+  proxy:
+    image: nginx:alpine
+    container_name: proxy
+    ports:
+      - "80:80"
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf
+    restart: "unless-stopped"
+    networks:
+      - backend
+
+  server:
+    container_name: server
+    build:
+      context: ./
+      dockerfile: Dockerfile.dev
+    ports:
+      - "3000:3000"
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: password
+      POSTGRES_HOST: pg
+      POSTGRES_PORT: 5432
+      POSTGRES_DB: dev
+    volumes:
+      - ./:/app
+      - /app/node_modules
+    restart: "unless-stopped"
+    networks:
+      - backend
+    links:
+      - pg
+    depends_on:
+      - pg
+
+  pg:
+    container_name: pg
+    image: postgres:14.5-alpine
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: dev
+    volumes:
+      # - ./postgresdata:/var/lib/postgresql/data
+      - ./src/database/init.sql:/docker-entrypoint-initdb.d/init.sql
+    restart: "always"
+    networks:
+      - backend
+
+networks:
+  backend:
+    driver: bridge
+
+volumes:
+  data:
+    driver: local

package/lib/node-postgres/ecosystem.config.js

@@ -0,0 +1,57 @@
+/**
+ * @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: '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',
+      },
+    },
+    {
+      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',
+      },
+    },
+  ],
+  deploy: {
+    production: {
+      user: 'user',
+      host: '0.0.0.0',
+      ref: 'origin/master',
+      repo: 'git@github.com:repo.git',
+      path: 'dist/server.js',
+      'post-deploy': 'npm install && npm run build && pm2 reload ecosystem.config.js --only prod',
+    },
+  },
+};

package/lib/node-postgres/jest.config.js

@@ -0,0 +1,12 @@
+const { pathsToModuleNameMapper } = require('ts-jest');
+const { compilerOptions } = require('./tsconfig.json');
+
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/src'],
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  moduleNameMapper: pathsToModuleNameMapper(compilerOptions.paths, { prefix: '<rootDir>/src' }),
+};

package/lib/node-postgres/nginx.conf

@@ -0,0 +1,40 @@
+user  nginx;
+worker_processes  1;
+
+error_log  /var/log/nginx/error.log warn;
+pid        /var/run/nginx.pid;
+
+events {
+    worker_connections  1024;
+}
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+
+    upstream api-server {
+        server server:3000;
+        keepalive 100;
+    }
+
+    server {
+        listen 80;
+        server_name localhost;
+
+        location / {
+		proxy_http_version 1.1;
+            	proxy_pass         http://api-server;
+        }
+
+    }
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    access_log  /var/log/nginx/access.log  main;
+
+    sendfile        on;
+    keepalive_timeout  65;
+    include /etc/nginx/conf.d/*.conf;
+}

package/lib/node-postgres/nodemon.json

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