typescript-express-starter 9.1.2 → 10.0.0

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

@@ -0,0 +1,62 @@
+import request from 'supertest';
+import { App } from '@/app';
+import { User } from '@interfaces/users.interface';
+import { UserModel } from '@models/users.model';
+import { UserRoute } from '@routes/users.route';
+
+afterAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('TEST Users API', () => {
+  const route = new UserRoute();
+  const app = new App([route]);
+
+  describe('[GET] /users', () => {
+    it('response statusCode 200 /findAll', () => {
+      const findUser: User[] = UserModel;
+
+      return request(app.getServer()).get(`${route.path}`).expect(200, { data: findUser, message: 'findAll' });
+    });
+  });
+
+  describe('[GET] /users/:id', () => {
+    it('response statusCode 200 /findOne', () => {
+      const userId = 1;
+      const findUser: User = UserModel.find(user => user.id === userId);
+
+      return request(app.getServer()).get(`${route.path}/${userId}`).expect(200, { data: findUser, message: 'findOne' });
+    });
+  });
+
+  describe('[POST] /users', () => {
+    it('response statusCode 201 /created', async () => {
+      const userData: User = {
+        email: 'example@email.com',
+        password: 'password123456789',
+      };
+
+      return request(app.getServer()).post(`${route.path}`).send(userData).expect(201);
+    });
+  });
+
+  describe('[PUT] /users/:id', () => {
+    it('response statusCode 200 /updated', async () => {
+      const userId = 1;
+      const userData: User = {
+        password: 'password123456789',
+      };
+
+      return request(app.getServer()).put(`${route.path}/${userId}`).send(userData).expect(200);
+    });
+  });
+
+  describe('[DELETE] /users/:id', () => {
+    it('response statusCode 200 /deleted', () => {
+      const userId = 1;
+      const deleteUser: User[] = UserModel.filter(user => user.id !== userId);
+
+      return request(app.getServer()).delete(`${route.path}/${userId}`).expect(200, { data: deleteUser, message: 'deleted' });
+    });
+  });
+});

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

@@ -35,5 +35,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/graphql/.env.development.local

@@ -2,11 +2,11 @@
 PORT = 3000
 
 # DATABASE
-DB_HOST = localhost
-DB_PORT = 5432
-DB_USER = root
-DB_PASSWORD = password
-DB_DATABASE = dev
+POSTGRES_USER = root
+POSTGRES_PASSWORD = password
+POSTGRES_HOST = localhost
+POSTGRES_PORT = 5432
+POSTGRES_DB = dev
 
 # TOKEN
 SECRET_KEY = secretKey
@@ -16,5 +16,5 @@ LOG_FORMAT = dev
 LOG_DIR = ../logs
 
 # CORS
-ORIGIN = true
+ORIGIN = *
 CREDENTIALS = true

package/lib/graphql/.env.production.local

@@ -2,11 +2,11 @@
 PORT = 3000
 
 # DATABASE
-DB_HOST = localhost
-DB_PORT = 5432
-DB_USER = root
-DB_PASSWORD = password
-DB_DATABASE = prod
+POSTGRES_USER = root
+POSTGRES_PASSWORD = password
+POSTGRES_HOST = localhost
+POSTGRES_PORT = 5432
+POSTGRES_DB = dev
 
 # TOKEN
 SECRET_KEY = secretKey
@@ -16,5 +16,5 @@ LOG_FORMAT = combined
 LOG_DIR = ../logs
 
 # CORS
-ORIGIN = false
+ORIGIN = your.domain.com
 CREDENTIALS = true

package/lib/graphql/.env.test.local

@@ -2,11 +2,11 @@
 PORT = 3000
 
 # DATABASE
-DB_HOST = localhost
-DB_PORT = 5432
-DB_USER = root
-DB_PASSWORD = password
-DB_DATABASE = test
+POSTGRES_USER = root
+POSTGRES_PASSWORD = password
+POSTGRES_HOST = localhost
+POSTGRES_PORT = 5432
+POSTGRES_DB = dev
 
 # TOKEN
 SECRET_KEY = secretKey
@@ -16,5 +16,5 @@ LOG_FORMAT = dev
 LOG_DIR = ../logs
 
 # CORS
-ORIGIN = true
+ORIGIN = *
 CREDENTIALS = true

package/lib/graphql/.swcrc

@@ -22,7 +22,7 @@
     "paths": {
       "@/*": ["*"],
       "@config": ["config"],
-      "@databases": ["databases"],
+      "@database": ["database"],
       "@dtos/*": ["dtos/*"],
       "@entities/*": ["entities/*"],
       "@exceptions/*": ["exceptions/*"],

package/lib/graphql/Dockerfile.dev

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

package/lib/graphql/Dockerfile.prod

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

package/lib/graphql/Makefile

@@ -2,28 +2,45 @@
 # 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: build
-# Build the container image - Dvelopment
-build-dev:
+.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}\
-		--target development-build-stage\
-		-f Dockerfile .
+		-f Dockerfile.prod .
 
-# Build the container image - Production
-build:
+build-dev: ## Build the container image - Dvelopment
 	docker build -t ${APP_NAME}\
-		--target production-build-stage\
-		-f Dockerfile .
+		-f Dockerfile.dev .
 
-# Clean the container image
-clean:
+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}
 
-# Run the container image
-run:
-	docker run -d -it -p 3000:3000 ${APP_NAME}
+remove: ## Remove the volumes
+	docker volume rm -f ${APP_NAME}
 
-all: build
+#-- Database
+db: ## Start the local database PostgreSQL
+	docker-compose up -d pg

package/lib/graphql/docker-compose.yml

@@ -1,43 +1,51 @@
-version: '3.7'
+version: "3.9"
 
 services:
   proxy:
-    image: nginx:alpine
     container_name: proxy
+    image: nginx:alpine
     ports:
-      - '80:80'
+      - "80:80"
     volumes:
       - ./nginx.conf:/etc/nginx/nginx.conf
-    restart: 'unless-stopped'
+    restart: "unless-stopped"
     networks:
       - backend
+
   server:
+    container_name: server
     build:
       context: ./
-      target: development-build-stage
-      dockerfile: Dockerfile
-    container_name: server
+      dockerfile: Dockerfile.dev
     ports:
-      - '3000:3000'
+      - "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'
+    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
+    image: postgres:14.5-alpine
     ports:
-      - '5432:5432'
+      - "5432:5432"
+    environment:
+      POSTGRES_USER: root
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: dev
+    restart: "always"
     networks:
       - backend
 

package/lib/graphql/jest.config.js

@@ -1,4 +1,4 @@
-const { pathsToModuleNameMapper } = require('ts-jest/utils');
+const { pathsToModuleNameMapper } = require('ts-jest');
 const { compilerOptions } = require('./tsconfig.json');
 
 module.exports = {

package/lib/graphql/package.json

@@ -16,59 +16,60 @@
     "deploy:dev": "pm2 start ecosystem.config.js --only dev"
   },
   "dependencies": {
-    "apollo-server-core": "^3.5.0",
-    "apollo-server-express": "^3.5.0",
+    "apollo-server-core": "^3.10.0",
+    "apollo-server-express": "^3.10.0",
     "bcrypt": "^5.0.1",
-    "class-validator": "^0.13.1",
+    "class-validator": "^0.13.2",
     "compression": "^1.7.4",
-    "cookie-parser": "^1.4.5",
+    "cookie-parser": "^1.4.6",
     "cors": "^2.8.5",
-    "dotenv": "^10.0.0",
-    "envalid": "^7.1.0",
-    "express": "^4.17.1",
+    "dotenv": "^16.0.1",
+    "envalid": "^7.3.1",
+    "express": "^4.18.1",
     "graphql": "^15.8.0",
-    "helmet": "^4.6.0",
+    "helmet": "^5.1.1",
     "hpp": "^0.2.3",
     "jsonwebtoken": "^8.5.1",
-    "pg": "^8.7.1",
+    "pg": "^8.7.3",
     "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"
+    "typedi": "^0.10.0",
+    "typeorm": "^0.2.45",
+    "winston": "^3.8.1",
+    "winston-daily-rotate-file": "^4.7.1"
   },
   "devDependencies": {
-    "@swc/cli": "^0.1.51",
-    "@swc/core": "^1.2.108",
+    "@swc/cli": "^0.1.57",
+    "@swc/core": "^1.2.220",
     "@types/bcrypt": "^5.0.0",
-    "@types/compression": "^1.7.1",
-    "@types/cookie-parser": "^1.4.2",
-    "@types/cors": "^2.8.11",
+    "@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.1",
-    "@types/jest": "27.4.x",
-    "@types/jsonwebtoken": "^8.5.4",
-    "@types/node": "^16.0.1",
-    "@types/supertest": "^2.0.11",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
+    "@types/hpp": "^0.2.2",
+    "@types/jest": "^28.1.6",
+    "@types/jsonwebtoken": "^8.5.8",
+    "@types/node": "^17.0.45",
+    "@types/supertest": "^2.0.12",
+    "@typescript-eslint/eslint-plugin": "^5.29.0",
+    "@typescript-eslint/parser": "^5.29.0",
     "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.4.x",
-    "lint-staged": "^11.0.0",
+    "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": "^8.1.0",
-    "nodemon": "^2.0.9",
-    "pm2": "^5.1.0",
-    "prettier": "^2.3.2",
-    "supertest": "^6.2.2",
-    "ts-jest": "^27.1.4",
-    "ts-node": "^10.4.0",
-    "tsc-alias": "^1.4.1",
-    "tsconfig-paths": "^3.10.1",
-    "typescript": "^4.5.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/graphql/src/app.ts

@@ -10,12 +10,12 @@ import hpp from 'hpp';
 import { buildSchema } from 'type-graphql';
 import { createConnection } from 'typeorm';
 import { NODE_ENV, PORT, ORIGIN, CREDENTIALS } from '@config';
-import { dbConnection } from '@databases';
-import { authMiddleware, authChecker } from '@middlewares/auth.middleware';
-import errorMiddleware from '@middlewares/error.middleware';
+import { dbConnection } from '@database';
+import { AuthMiddleware, AuthCheckerMiddleware } from '@middlewares/auth.middleware';
+import { ErrorMiddleware } from '@middlewares/error.middleware';
 import { logger, responseLogger, errorLogger } from '@utils/logger';
 
-class App {
+export class App {
   public app: express.Application;
   public env: string;
   public port: string | number;
@@ -65,7 +65,7 @@ class App {
   private async initApolloServer(resolvers) {
     const schema = await buildSchema({
       resolvers: resolvers,
-      authChecker: authChecker,
+      authChecker: AuthCheckerMiddleware,
     });
 
     const apolloServer = new ApolloServer({
@@ -77,7 +77,7 @@ class App {
       ],
       context: async ({ req }) => {
         try {
-          const user = await authMiddleware(req);
+          const user = await AuthMiddleware(req);
           return { user };
         } catch (error) {
           throw new Error(error);
@@ -89,19 +89,20 @@ class App {
         return response;
       },
       formatError: error => {
-        errorLogger(error);
-
-        return error;
+        try {
+          errorLogger(error);
+          return error;
+        } catch (err) {
+          return new Error(err);
+        }
       },
     });
 
     await apolloServer.start();
-    apolloServer.applyMiddleware({ app: this.app, cors: ORIGIN, path: '/graphql' });
+    apolloServer.applyMiddleware({ app: this.app, cors: false, path: '/graphql' });
   }
 
   private initializeErrorHandling() {
-    this.app.use(errorMiddleware);
+    this.app.use(ErrorMiddleware);
   }
 }
-
-export default App;

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

@@ -2,5 +2,5 @@ import { config } from 'dotenv';
 config({ path: `.env.${process.env.NODE_ENV || 'development'}.local` });
 
 export const CREDENTIALS = process.env.CREDENTIALS === 'true';
-export const ORIGIN = process.env.ORIGIN === 'true';
-export const { NODE_ENV, PORT, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE, SECRET_KEY, LOG_FORMAT, LOG_DIR } = process.env;
+export const { NODE_ENV, PORT, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;
+export const { POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_HOST, POSTGRES_PORT, POSTGRES_DB } = process.env;

package/lib/{typeorm/src/databases → graphql/src/database}/index.ts

@@ -1,14 +1,14 @@
 import { join } from 'path';
 import { ConnectionOptions } from 'typeorm';
-import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from '@config';
+import { POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_HOST, POSTGRES_PORT, POSTGRES_DB } from '@config';
 
 export const dbConnection: ConnectionOptions = {
   type: 'postgres',
-  host: DB_HOST,
-  port: DB_PORT,
-  username: DB_USER,
-  password: DB_PASSWORD,
-  database: DB_DATABASE,
+  username: POSTGRES_USER,
+  password: POSTGRES_PASSWORD,
+  host: POSTGRES_HOST,
+  port: Number(POSTGRES_PORT),
+  database: POSTGRES_DB,
   synchronize: true,
   logging: false,
   entities: [join(__dirname, '../**/*.entity{.ts,.js}')],

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

@@ -1,4 +1,4 @@
-import { IsEmail, IsString } from 'class-validator';
+import { IsEmail, IsString, IsNotEmpty, MinLength, MaxLength } from 'class-validator';
 import { InputType, Field } from 'type-graphql';
 import { User } from '@typedefs/users.type';
 
@@ -10,5 +10,18 @@ export class CreateUserDto implements Partial<User> {
 
   @Field()
   @IsString()
+  @IsNotEmpty()
+  @MinLength(9)
+  @MaxLength(32)
+  password: string;
+}
+
+@InputType()
+export class UpdateUserDto implements Partial<User> {
+  @Field()
+  @IsString()
+  @IsNotEmpty()
+  @MinLength(9)
+  @MaxLength(32)
   password: string;
 }

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

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

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

@@ -3,15 +3,25 @@ import { AuthChecker } from 'type-graphql';
 import { getRepository } from 'typeorm';
 import { SECRET_KEY } from '@config';
 import { UserEntity } from '@entities/users.entity';
-import { HttpException } from '@exceptions/HttpException';
+import { HttpException } from '@exceptions/httpException';
 import { RequestWithUser, DataStoredInToken } from '@interfaces/auth.interface';
 
-export const authMiddleware = async req => {
+const getAuthorization = req => {
+  const cookie = req.cookies['Authorization'];
+  if (cookie) return cookie;
+
+  const header = req.header('Authorization');
+  if (header) return header.split('Bearer ')[1];
+
+  return null;
+};
+
+export const AuthMiddleware = async req => {
   try {
-    const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
+    const Authorization = getAuthorization(req);
+
     if (Authorization) {
-      const secretKey: string = SECRET_KEY;
-      const { id } = (await verify(Authorization, secretKey)) as DataStoredInToken;
+      const { id } = verify(Authorization, SECRET_KEY) as DataStoredInToken;
       const userRepository = getRepository(UserEntity);
       const findUser = await userRepository.findOne(id, { select: ['id', 'email', 'password'] });
       return findUser;
@@ -23,7 +33,7 @@ export const authMiddleware = async req => {
   }
 };
 
-export const authChecker: AuthChecker<RequestWithUser> = async ({ context: { user } }) => {
+export const AuthCheckerMiddleware: AuthChecker<RequestWithUser> = async ({ context: { user } }) => {
   if (!user) {
     throw new HttpException(404, 'Authentication token missing');
   }

package/lib/graphql/src/middlewares/error.middleware.ts

@@ -1,8 +1,8 @@
 import { NextFunction, Request, Response } from 'express';
-import { HttpException } from '@exceptions/HttpException';
+import { HttpException } from '@exceptions/httpException';
 import { logger } from '@utils/logger';
 
-const errorMiddleware = (error: HttpException, req: Request, res: Response, next: NextFunction) => {
+export const ErrorMiddleware = (error: HttpException, req: Request, res: Response, next: NextFunction) => {
   try {
     const status: number = error.status || 500;
     const message: string = error.message || 'Something went wrong';
@@ -13,5 +13,3 @@ const errorMiddleware = (error: HttpException, req: Request, res: Response, next
     next(error);
   }
 };
-
-export default errorMiddleware;