typescript-express-starter 10.2.1 → 11.0.0

package/lib/typegoose/Makefile

@@ -1,46 +0,0 @@
-# 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 - Development
-	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 ${APP_NAME}
-
-clean: ## Clean the images
-	docker rmi -f ${APP_NAME}
-
-remove: ## Remove the volumes
-	docker volume rm -f ${APP_NAME}
-
-#-- Database
-db: ## Start the local database MongoDB
-	docker-compose up -d mongo

package/lib/typegoose/docker-compose.yml

@@ -1,55 +0,0 @@
-version: "3.9"
-
-services:
-  proxy:
-    container_name: proxy
-    image: nginx:alpine
-    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:
-      DB_HOST: localhost
-      DB_PORT: 27017
-      DB_DATABASE: dev
-    volumes:
-      - ./:/app
-      - /app/node_modules
-    restart: "unless-stopped"
-    networks:
-      - backend
-    links:
-      - mongo
-    depends_on:
-      - mongo
-
-  mongo:
-    container_name: mongo
-    image: mongo
-    ports:
-      - "27017:27017"
-    environment:
-      DB_HOST: localhost
-      DB_PORT: 27017
-      DB_DATABASE: dev
-    networks:
-      - backend
-
-networks:
-  backend:
-    driver: bridge
-
-volumes:
-  data:
-    driver: local

package/lib/typegoose/ecosystem.config.js

@@ -1,57 +0,0 @@
-/**
- * @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/typegoose/jest.config.js

@@ -1,12 +0,0 @@
-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/typegoose/nginx.conf

@@ -1,40 +0,0 @@
-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/typegoose/nodemon.json

@@ -1,12 +0,0 @@
-{
-    "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"
-}

package/lib/typegoose/package.json

@@ -1,79 +0,0 @@
-{
-  "name": "typescript-express-starter",
-  "version": "0.0.0",
-  "description": "TypeScript + Typegoose + MongoDB + Express API Server",
-  "author": "",
-  "license": "ISC",
-  "scripts": {
-    "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
-    "dev": "cross-env NODE_ENV=development nodemon",
-    "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",
-    "deploy:prod": "npm run build && pm2 start ecosystem.config.js --only prod",
-    "deploy:dev": "pm2 start ecosystem.config.js --only dev"
-  },
-  "dependencies": {
-    "@typegoose/typegoose": "^9.10.1",
-    "bcrypt": "^5.0.1",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.13.2",
-    "compression": "^1.7.4",
-    "cookie-parser": "^1.4.6",
-    "cors": "^2.8.5",
-    "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",
-    "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.57",
-    "@swc/core": "^1.2.220",
-    "@types/bcrypt": "^5.0.0",
-    "@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.2",
-    "@types/jest": "^28.1.6",
-    "@types/jsonwebtoken": "^8.5.8",
-    "@types/mongoose": "^5.10.1",
-    "@types/morgan": "^1.9.3",
-    "@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": "^5.29.0",
-    "@typescript-eslint/parser": "^5.29.0",
-    "cross-env": "^7.0.3",
-    "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": "^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,90 +0,0 @@
-import 'reflect-metadata';
-import compression from 'compression';
-import cookieParser from 'cookie-parser';
-import cors from 'cors';
-import express from 'express';
-import helmet from 'helmet';
-import hpp from 'hpp';
-import morgan from 'morgan';
-
-import swaggerJSDoc from 'swagger-jsdoc';
-import swaggerUi from 'swagger-ui-express';
-import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
-import { dbConnection } from '@database';
-import { Routes } from '@interfaces/routes.interface';
-import { ErrorMiddleware } from '@middlewares/error.middleware';
-import { logger, stream } from '@utils/logger';
-
-class App {
-  public app: express.Application;
-  public env: string;
-  public port: string | number;
-
-  constructor(routes: Routes[]) {
-    this.app = express();
-    this.env = NODE_ENV || 'development';
-    this.port = PORT || 3000;
-
-    this.connectToDatabase();
-    this.initializeMiddlewares();
-    this.initializeRoutes(routes);
-    this.initializeSwagger();
-    this.initializeErrorHandling();
-  }
-
-  public listen() {
-    this.app.listen(this.port, () => {
-      logger.info(`=================================`);
-      logger.info(`======= ENV: ${this.env} =======`);
-      logger.info(`🚀 App listening on the port ${this.port}`);
-      logger.info(`=================================`);
-    });
-  }
-
-  public getServer() {
-    return this.app;
-  }
-
-  private async connectToDatabase() {
-    await dbConnection();
-  }
-
-  private initializeMiddlewares() {
-    this.app.use(morgan(LOG_FORMAT, { stream }));
-    this.app.use(cors({ origin: ORIGIN, credentials: CREDENTIALS }));
-    this.app.use(hpp());
-    this.app.use(helmet());
-    this.app.use(compression());
-    this.app.use(express.json());
-    this.app.use(express.urlencoded({ extended: true }));
-    this.app.use(cookieParser());
-  }
-
-  private initializeRoutes(routes: Routes[]) {
-    routes.forEach(route => {
-      this.app.use('/', route.router);
-    });
-  }
-
-  private initializeSwagger() {
-    const options = {
-      swaggerDefinition: {
-        info: {
-          title: 'REST API',
-          version: '1.0.0',
-          description: 'Example docs',
-        },
-      },
-      apis: ['swagger.yaml'],
-    };
-
-    const specs = swaggerJSDoc(options);
-    this.app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
-  }
-
-  private initializeErrorHandling() {
-    this.app.use(ErrorMiddleware);
-  }
-}
-
-export default App;

package/lib/typegoose/src/config/index.ts

@@ -1,6 +0,0 @@
-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, 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,44 +0,0 @@
-import { NextFunction, Request, Response } from 'express';
-import { Container } from 'typedi';
-import { RequestWithUser } from '@interfaces/auth.interface';
-import { User } from '@interfaces/users.interface';
-import { AuthService } from '@services/auth.service';
-
-export class AuthController {
-  public auth =  Container.get(AuthService);
-
-  public signUp = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-      const userData: User = req.body;
-      const signUpUserData: User = await this.auth.signup(userData);
-
-      res.status(201).json({ data: signUpUserData, message: 'signup' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public logIn = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-      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' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public logOut = async (req: RequestWithUser, res: Response, next: NextFunction) => {
-    try {
-      const userData: User = req.user;
-      const logOutUserData: User = await this.auth.logout(userData);
-
-      res.setHeader('Set-Cookie', ['Authorization=; Max-age=0']);
-      res.status(200).json({ data: logOutUserData, message: 'logout' });
-    } catch (error) {
-      next(error);
-    }
-  };
-}

package/lib/typegoose/src/controllers/users.controller.ts

@@ -1,63 +0,0 @@
-import { NextFunction, Request, Response } from 'express';
-import { Container } from 'typedi';
-import { User } from '@interfaces/users.interface';
-import { UserService } from '@services/users.service';
-
-export class UserController {
-  public user = Container.get(UserService);
-
-  public getUsers = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-      const findAllUsersData: User[] = await this.user.findAllUser();
-
-      res.status(200).json({ data: findAllUsersData, message: 'findAll' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public getUserById = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-      const userId: string = req.params.id;
-      const findOneUserData: User = await this.user.findUserById(userId);
-
-      res.status(200).json({ data: findOneUserData, message: 'findOne' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public createUser = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-      const userData: User = req.body;
-      const createUserData: User = await this.user.createUser(userData);
-
-      res.status(201).json({ data: createUserData, message: 'created' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public updateUser = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-      const userId: string = req.params.id;
-      const userData: User = req.body;
-      const updateUserData: User = await this.user.updateUser(userId, userData);
-
-      res.status(200).json({ data: updateUserData, message: 'updated' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public deleteUser = async (req: Request, res: Response, next: NextFunction) => {
-    try {
-      const userId: string = req.params.id;
-      const deleteUserData: User = await this.user.deleteUser(userId);
-
-      res.status(200).json({ data: deleteUserData, message: 'deleted' });
-    } catch (error) {
-      next(error);
-    }
-  };
-}

package/lib/typegoose/src/database/index.ts

@@ -1,18 +0,0 @@
-import { connect, set } from 'mongoose';
-import { NODE_ENV, DB_HOST, DB_PORT, DB_DATABASE } from '@config';
-
-export const dbConnection = async () => {
-  const dbConfing = {
-    url: `mongodb://${DB_HOST}:${DB_PORT}/${DB_DATABASE}`,
-    options: {
-      useNewUrlParser: true,
-      useUnifiedTopology: true
-    },
-  };
-
-  if (NODE_ENV !== 'production') {
-    set('debug', true);
-  }
-
-  await connect(dbConfing);
-};

package/lib/typegoose/src/dtos/users.dto.ts

@@ -1,20 +0,0 @@
-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/exceptions/HttpException.ts

@@ -1,10 +0,0 @@
-export class HttpException extends Error {
-  public status: number;
-  public message: string;
-
-  constructor(status: number, message: string) {
-    super(message);
-    this.status = status;
-    this.message = message;
-  }
-}

package/lib/typegoose/src/http/auth.http

@@ -1,27 +0,0 @@
-# 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

package/lib/typegoose/src/http/users.http

@@ -1,34 +0,0 @@
-# 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/typegoose/src/interfaces/auth.interface.ts

@@ -1,15 +0,0 @@
-import { Request } from 'express';
-import { User } from '@interfaces/users.interface';
-
-export interface DataStoredInToken {
-  _id: string;
-}
-
-export interface TokenData {
-  token: string;
-  expiresIn: number;
-}
-
-export interface RequestWithUser extends Request {
-  user: User;
-}

package/lib/typegoose/src/interfaces/routes.interface.ts

@@ -1,6 +0,0 @@
-import { Router } from 'express';
-
-export interface Routes {
-  path?: string;
-  router: Router;
-}

package/lib/typegoose/src/interfaces/users.interface.ts

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