typescript-express-starter 6.1.0 → 7.0.0

package/lib/graphql/.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/graphql/.vscode/settings.json

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

package/lib/graphql/Dockerfile

@@ -0,0 +1,24 @@
+# Common build stage
+FROM node:14.14.0-alpine3.12 as common-build-stage
+
+COPY . ./app
+
+WORKDIR /app
+
+RUN npm install
+
+EXPOSE 3000
+
+# Development build stage
+FROM common-build-stage as development-build-stage
+
+ENV NODE_ENV development
+
+CMD ["npm", "run", "dev"]
+
+# Production build stage
+FROM common-build-stage as production-build-stage
+
+ENV NODE_ENV production
+
+CMD ["npm", "run", "start"]

package/lib/graphql/Makefile

@@ -0,0 +1,6 @@
+build:
+	docker build -t ${tag} .
+clean:
+	docker rmi -f ${tag}
+run:
+	docker run -d -p ${port}:${port} --name ${name} ${tag}

package/lib/graphql/docker-compose.yml

@@ -0,0 +1,50 @@
+version: '3.7'
+
+services:
+  proxy:
+    image: nginx:alpine
+    container_name: proxy
+    ports:
+      - '80:80'
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf
+    restart: 'unless-stopped'
+    networks:
+      - backend
+  server:
+    build:
+      context: ./
+      target: development-build-stage
+      dockerfile: Dockerfile
+    container_name: server
+    ports:
+      - '3000:3000'
+    volumes:
+      - ./:/app
+      - /app/node_modules
+    restart: 'unless-stopped'
+    networks:
+      - backend
+    links:
+      - pg
+    depends_on:
+      - pg
+  pg:
+    image: bitnami/postgresql:11-debian-9
+    container_name: pg
+    environment:
+      POSTGRESQL_USERNAME: root
+      POSTGRESQL_PASSWORD: password
+      POSTGRESQL_DATABASE: test
+    ports:
+      - '5432:5432'
+    networks:
+      - backend
+
+networks:
+  backend:
+    driver: bridge
+
+volumes:
+  data:
+    driver: local

package/lib/graphql/ecosystem.config.js

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

@@ -0,0 +1,12 @@
+const { pathsToModuleNameMapper } = require('ts-jest/utils');
+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/graphql/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/graphql/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"
+}

package/lib/graphql/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "graphql",
+  "version": "0.0.0",
+  "description": "TypeScript + GraphQL + TypeORM + 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": {
+    "apollo-server-core": "^3.5.0",
+    "apollo-server-express": "^3.5.0",
+    "bcrypt": "^5.0.1",
+    "class-validator": "^0.13.1",
+    "compression": "^1.7.4",
+    "config": "^3.3.6",
+    "cookie-parser": "^1.4.5",
+    "cors": "^2.8.5",
+    "dotenv": "^10.0.0",
+    "envalid": "^7.1.0",
+    "express": "^4.17.1",
+    "graphql": "^15.8.0",
+    "helmet": "^4.6.0",
+    "hpp": "^0.2.3",
+    "jsonwebtoken": "^8.5.1",
+    "pg": "^8.7.1",
+    "reflect-metadata": "^0.1.13",
+    "type-graphql": "^1.1.1",
+    "typeorm": "^0.2.34",
+    "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",
+    "@types/cookie-parser": "^1.4.2",
+    "@types/cors": "^2.8.11",
+    "@types/dotenv": "^8.2.0",
+    "@types/express": "^4.17.13",
+    "@types/helmet": "^4.0.0",
+    "@types/hpp": "^0.2.1",
+    "@types/jest": "^26.0.24",
+    "@types/jsonwebtoken": "^8.5.4",
+    "@types/node": "^16.0.1",
+    "@types/supertest": "^2.0.11",
+    "@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",
+    "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/graphql/src/app.ts

@@ -0,0 +1,105 @@
+import 'reflect-metadata';
+import '@/index';
+import { ApolloServerPluginLandingPageProductionDefault, ApolloServerPluginLandingPageLocalDefault } from 'apollo-server-core';
+import { ApolloServer } from 'apollo-server-express';
+import compression from 'compression';
+import cookieParser from 'cookie-parser';
+import cors from 'cors';
+import config from 'config';
+import express from 'express';
+import helmet from 'helmet';
+import hpp from 'hpp';
+import { buildSchema } from 'type-graphql';
+import { createConnection } from 'typeorm';
+import { dbConnection } from '@databases';
+import { authMiddleware, authChecker } from '@middlewares/auth.middleware';
+import errorMiddleware from '@middlewares/error.middleware';
+import { logger, responseLogger, errorLogger } from '@utils/logger';
+
+class App {
+  public app: express.Application;
+  public port: string | number;
+  public env: string;
+
+  constructor(resolvers) {
+    this.app = express();
+    this.port = process.env.PORT || 3000;
+    this.env = process.env.NODE_ENV || 'development';
+
+    this.connectToDatabase();
+    this.initializeMiddlewares();
+    this.initApolloServer(resolvers);
+    this.initializeErrorHandling();
+  }
+
+  public async listen() {
+    this.app.listen(this.port, () => {
+      logger.info(`=================================`);
+      logger.info(`======= ENV: ${this.env} =======`);
+      logger.info(`🚀 App listening on the port ${this.port}`);
+      logger.info(`🎮 http://localhost:${this.port}/graphql`);
+      logger.info(`=================================`);
+    });
+  }
+
+  public getServer() {
+    return this.app;
+  }
+
+  private connectToDatabase() {
+    createConnection(dbConnection);
+  }
+
+  private initializeMiddlewares() {
+    this.app.use(cors({ origin: config.get('cors.origin'), credentials: config.get('cors.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 async initApolloServer(resolvers) {
+    const schema = await buildSchema({
+      resolvers: resolvers,
+      authChecker: authChecker,
+    });
+
+    const apolloServer = new ApolloServer({
+      schema: schema,
+      plugins: [
+        process.env.NODE_ENV === 'production'
+          ? ApolloServerPluginLandingPageProductionDefault({ footer: false })
+          : ApolloServerPluginLandingPageLocalDefault({ footer: false }),
+      ],
+      context: async ({ req }) => {
+        try {
+          const user = await authMiddleware(req);
+          return { user };
+        } catch (error) {
+          throw new Error(error);
+        }
+      },
+      formatResponse: (response, request) => {
+        responseLogger(request);
+
+        return response;
+      },
+      formatError: error => {
+        errorLogger(error);
+
+        return error;
+      },
+    });
+
+    await apolloServer.start();
+    apolloServer.applyMiddleware({ app: this.app, cors: true, path: '/graphql' });
+  }
+
+  private initializeErrorHandling() {
+    this.app.use(errorMiddleware);
+  }
+}
+
+export default App;

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

@@ -0,0 +1,19 @@
+{
+    "env": "development",
+    "dbConfig": {
+        "host": "localhost",
+        "user": "root",
+        "port": 5432,
+        "password": "password",
+        "database": "test"
+    },
+    "secretKey": "secretKey",
+    "log": {
+        "format": "dev",
+        "dir": "../logs"
+    },
+    "cors": {
+        "origin": true,
+        "credentials": true
+    }
+}

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

@@ -0,0 +1,19 @@
+{
+    "env": "production",
+    "dbConfig": {
+        "host": "localhost",
+        "user": "root",
+        "port": 5432,
+        "password": "password",
+        "database": "test"
+    },
+    "secretKey": "secretKey",
+    "log": {
+        "format": "combined",
+        "dir": "../logs"
+    },
+    "cors": {
+        "origin": "your.domain.com",
+        "credentials": true
+    }
+}

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

@@ -0,0 +1,19 @@
+{
+    "env": "test",
+    "dbConfig": {
+        "host": "localhost",
+        "user": "root",
+        "port": 5432,
+        "password": "password",
+        "database": "test"
+    },
+    "secretKey": "secretKey",
+    "log": {
+        "format": "dev",
+        "dir": "../logs"
+    },
+    "cors": {
+        "origin": true,
+        "credentials": true
+    }
+}

package/lib/graphql/src/databases/index.ts

@@ -0,0 +1,24 @@
+import config from 'config';
+import { join } from 'path';
+import { ConnectionOptions } from 'typeorm';
+import { dbConfig } from '@interfaces/db.interface';
+
+const { host, port, user, password, database }: dbConfig = config.get('dbConfig');
+export const dbConnection: ConnectionOptions = {
+  type: 'postgres',
+  host: host,
+  port: port,
+  username: user,
+  password: password,
+  database: database,
+  synchronize: true,
+  logging: false,
+  entities: [join(__dirname, '../**/*.entity{.ts,.js}')],
+  migrations: [join(__dirname, '../**/*.migration{.ts,.js}')],
+  subscribers: [join(__dirname, '../**/*.subscriber{.ts,.js}')],
+  cli: {
+    entitiesDir: 'src/entities',
+    migrationsDir: 'src/migration',
+    subscribersDir: 'src/subscriber',
+  },
+};

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

@@ -0,0 +1,14 @@
+import { IsEmail, IsString } from 'class-validator';
+import { InputType, Field } from 'type-graphql';
+import { User } from '@typedefs/users.type';
+
+@InputType()
+export class CreateUserDto implements Partial<User> {
+  @Field()
+  @IsEmail()
+  email: string;
+
+  @Field()
+  @IsString()
+  password: string;
+}

package/lib/{typeorm/src/entity → graphql/src/entities}/users.entity.ts

@@ -1,15 +1,15 @@
 import { IsNotEmpty } from 'class-validator';
-import { Entity, PrimaryGeneratedColumn, Column, Unique, CreateDateColumn, UpdateDateColumn } from 'typeorm';
+import { BaseEntity, Entity, PrimaryGeneratedColumn, Column, Unique, CreateDateColumn, UpdateDateColumn } from 'typeorm';
 import { User } from '@interfaces/users.interface';
 
 @Entity()
-@Unique(['email'])
-export class UserEntity implements User {
+export class UserEntity extends BaseEntity implements User {
   @PrimaryGeneratedColumn()
   id: number;
 
   @Column()
   @IsNotEmpty()
+  @Unique()
   email: string;
 
   @Column()

package/lib/graphql/src/exceptions/HttpException.ts

@@ -0,0 +1,10 @@
+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/graphql/src/http/auth.http

@@ -0,0 +1,49 @@
+# baseURL
+@baseURL = http://localhost:3000/graphql
+
+###
+# User Signup
+POST {{ baseURL }}
+Content-Type: application/json
+X-REQUEST-TYPE: GraphQL
+
+mutation {
+    signup (userData: {
+        email: "example@email.com",
+        password: "password"
+    }) {
+        id,
+        email,
+        password
+    }
+}
+
+###
+# User Login
+POST {{ baseURL }}
+Content-Type: application/json
+X-REQUEST-TYPE: GraphQL
+
+mutation {
+    login (userData: {
+        email: "example@email.com",
+        password: "password"
+    }) {
+        email,
+        password
+    }
+}
+
+###
+# User Logout
+POST {{ baseURL }}
+Content-Type: application/json
+X-REQUEST-TYPE: GraphQL
+Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MiwiaWF0IjoxNjM5MDQ3MjM3LCJleHAiOjE2MzkwNTA4Mzd9.HD0AvZl1s-mycKxo0IJ1QT-oSKhjeArXrlNBffZUanY;
+
+mutation {
+    logout {
+        email,
+        password
+    }
+}