typescript-express-starter 8.0.2 → 8.1.7

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

@@ -1,7 +1,7 @@
-import config from 'config';
 import { verify } from 'jsonwebtoken';
 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 { RequestWithUser, DataStoredInToken } from '@interfaces/auth.interface';
@@ -10,7 +10,7 @@ export const authMiddleware = async req => {
   try {
     const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
     if (Authorization) {
-      const secretKey: string = config.get('secretKey');
+      const secretKey: string = SECRET_KEY;
       const { id } = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const userRepository = getRepository(UserEntity);
       const findUser = await userRepository.findOne(id, { select: ['id', 'email', 'password'] });

package/lib/graphql/src/repositories/auth.repository.ts

@@ -1,7 +1,7 @@
 import { hash, compare } from 'bcrypt';
-import config from 'config';
 import { sign } from 'jsonwebtoken';
 import { EntityRepository } from 'typeorm';
+import { SECRET_KEY } from '@config';
 import { CreateUserDto } from '@dtos/users.dto';
 import { UserEntity } from '@entities/users.entity';
 import { HttpException } from '@exceptions/HttpException';
@@ -18,7 +18,7 @@ export default class AuthRepository {
     if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
 
     const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await UserEntity.save({ ...userData, password: hashedPassword });
+    const createUserData: User = await UserEntity.create({ ...userData, password: hashedPassword }).save();
 
     return createUserData;
   }
@@ -49,7 +49,7 @@ export default class AuthRepository {
 
   public createToken(user: User): TokenData {
     const dataStoredInToken: DataStoredInToken = { id: user.id };
-    const secretKey: string = config.get('secretKey');
+    const secretKey: string = SECRET_KEY;
     const expiresIn: number = 60 * 60;
 
     return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };

package/lib/graphql/src/repositories/users.repository.ts

@@ -30,7 +30,7 @@ export default class UserRepository {
     if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
 
     const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await UserEntity.save({ ...userData, password: hashedPassword });
+    const createUserData: User = await UserEntity.create({ ...userData, password: hashedPassword }).save();
 
     return createUserData;
   }

package/lib/graphql/src/server.ts

@@ -1,6 +1,3 @@
-import 'reflect-metadata';
-import 'dotenv/config';
-import '@/index';
 import App from '@/app';
 import validateEnv from '@utils/validateEnv';
 

package/lib/graphql/src/utils/logger.ts

@@ -1,11 +1,11 @@
-import config from 'config';
 import { existsSync, mkdirSync } from 'fs';
 import { join } from 'path';
 import winston from 'winston';
 import winstonDaily from 'winston-daily-rotate-file';
+import { LOG_DIR } from '@config';
 
 // logs dir
-const logDir: string = join(__dirname, config.get('log.dir'));
+const logDir: string = join(__dirname, LOG_DIR);
 
 if (!existsSync(logDir)) {
   mkdirSync(logDir);

package/lib/graphql/tsconfig.json

@@ -22,6 +22,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@databases": ["databases"],
       "@dtos/*": ["dtos/*"],
       "@entities/*": ["entities/*"],

package/lib/knex/.env.development.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 3306
+DB_USER = root
+DB_PASSWORD = password
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/knex/.env.production.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 3306
+DB_USER = root
+DB_PASSWORD = password
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = combined
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = your.domain.com
+CREDENTIALS = true

package/lib/knex/.env.test.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 3306
+DB_USER = root
+DB_PASSWORD = password
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/knex/.swcrc

@@ -21,6 +21,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@databases": ["databases"],
       "@dtos/*": ["dtos/*"],

package/lib/knex/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/knex/knexfile.ts

@@ -1,19 +1,15 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/src/configs';
+import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from './src/config';
 
-import config from 'config';
-import { dbConfig } from './src/interfaces/db.interface';
-
-const { host, user, password, database, port }: dbConfig = config.get('dbConfig');
 export = {
   client: 'mysql',
   connection: {
     charset: 'utf8',
     timezone: 'UTC',
-    host: host,
-    user: user,
-    password: password,
-    database: database,
-    port: port,
+    host: DB_HOST,
+    port: DB_PORT,
+    user: DB_USER,
+    password: DB_PASSWORD,
+    database: DB_DATABASE
   },
   migrations: {
     directory: 'src/databases/migrations',

package/lib/knex/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "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",
@@ -25,7 +25,6 @@
     "class-transformer": "^0.4.0",
     "class-validator": "^0.13.1",
     "compression": "^1.7.4",
-    "config": "^3.3.6",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
     "dotenv": "^9.0.2",
@@ -48,7 +47,6 @@
     "@swc/core": "^1.2.108",
     "@types/bcrypt": "^5.0.0",
     "@types/compression": "^1.7.0",
-    "@types/config": "0.0.38",
     "@types/cookie-parser": "^1.4.2",
     "@types/cors": "^2.8.10",
     "@types/dotenv": "^8.2.0",

package/lib/knex/src/app.ts

@@ -1,5 +1,3 @@
-import '@/index';
-import config from 'config';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
@@ -10,6 +8,7 @@ import morgan from 'morgan';
 import { Model } from 'objection';
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
+import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
 import knex from '@databases';
 import { Routes } from '@interfaces/routes.interface';
 import errorMiddleware from '@middlewares/error.middleware';
@@ -17,13 +16,13 @@ import { logger, stream } from '@utils/logger';
 
 class App {
   public app: express.Application;
-  public port: string | number;
   public env: string;
+  public port: string | number;
 
   constructor(routes: Routes[]) {
     this.app = express();
-    this.port = process.env.PORT || 3000;
-    this.env = process.env.NODE_ENV || 'development';
+    this.env = NODE_ENV || 'development';
+    this.port = PORT || 3000;
 
     this.connectToDatabase();
     this.initializeMiddlewares();
@@ -50,8 +49,8 @@ class App {
   }
 
   private initializeMiddlewares() {
-    this.app.use(morgan(config.get('log.format'), { stream }));
-    this.app.use(cors({ origin: config.get('cors.origin'), credentials: config.get('cors.credentials') }));
+    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());

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

@@ -0,0 +1,5 @@
+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, DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;

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

@@ -1,18 +1,16 @@
-import config from 'config';
 import Knex from 'knex';
-import { dbConfig } from '@interfaces/db.interface';
+import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from '@config';
 
-const { host, port, user, password, database }: dbConfig = config.get('dbConfig');
 const dbConnection = {
   client: 'mysql',
   connection: {
     charset: 'utf8',
     timezone: 'UTC',
-    host: host,
-    port: port,
-    user: user,
-    password: password,
-    database: database,
+    host: DB_HOST,
+    port: DB_PORT,
+    user: DB_USER,
+    password: DB_PASSWORD,
+    database: DB_DATABASE,
   },
   pool: {
     min: 2,

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

@@ -1,6 +1,6 @@
-import config from 'config';
 import { NextFunction, Response } from 'express';
 import { verify } from 'jsonwebtoken';
+import { SECRET_KEY } from '@config';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
 import { User } from '@interfaces/users.interface';
@@ -11,7 +11,7 @@ const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFun
     const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
 
     if (Authorization) {
-      const secretKey: string = config.get('secretKey');
+      const secretKey: string = SECRET_KEY;
       const verificationResponse = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const userId = verificationResponse.id;
       const findUser: User = await Users.query().findById(userId);

package/lib/knex/src/server.ts

@@ -1,5 +1,3 @@
-import 'dotenv/config';
-import '@/index';
 import App from '@/app';
 import AuthRoute from '@routes/auth.route';
 import IndexRoute from '@routes/index.route';

package/lib/knex/src/services/auth.service.ts

@@ -1,6 +1,6 @@
 import { hash, compare } from 'bcrypt';
-import config from 'config';
 import { sign } from 'jsonwebtoken';
+import { SECRET_KEY } from '@config';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
@@ -55,7 +55,7 @@ class AuthService {
 
   public createToken(user: User): TokenData {
     const dataStoredInToken: DataStoredInToken = { id: user.id };
-    const secretKey: string = config.get('secretKey');
+    const secretKey: string = SECRET_KEY;
     const expiresIn: number = 60 * 60;
 
     return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };

package/lib/knex/src/utils/logger.ts

@@ -1,11 +1,11 @@
-import config from 'config';
 import { existsSync, mkdirSync } from 'fs';
 import { join } from 'path';
 import winston from 'winston';
 import winstonDaily from 'winston-daily-rotate-file';
+import { LOG_DIR } from '@config';
 
 // logs dir
-const logDir: string = join(__dirname, config.get('log.dir'));
+const logDir: string = join(__dirname, LOG_DIR);
 
 if (!existsSync(logDir)) {
   mkdirSync(logDir);

package/lib/knex/tsconfig.json

@@ -22,6 +22,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@databases": ["databases"],
       "@dtos/*": ["dtos/*"],

package/lib/mongoose/.env.development.local

@@ -0,0 +1,18 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 27017
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/mongoose/.env.production.local

@@ -0,0 +1,18 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 27017
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = combined
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = your.domain.com
+CREDENTIALS = true

package/lib/mongoose/.env.test.local

@@ -0,0 +1,18 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 27017
+DB_DATABASE = test
+
+# TOKEN
+SECRET_KEY = secretKey
+
+# LOG
+LOG_FORMAT = dev
+LOG_DIR = ../logs
+
+# CORS
+ORIGIN = *
+CREDENTIALS = true

package/lib/mongoose/.swcrc

@@ -21,6 +21,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@databases": ["databases"],
       "@dtos/*": ["dtos/*"],

package/lib/mongoose/Makefile

@@ -1,6 +1,29 @@
+# app name should be overridden.
+# ex) production-stage: make build APP_NAME=<APP_NAME>
+# ex) development-stage: make build-dev APP_NAME=<APP_NAME>
+
+APP_NAME = typescript-express
+APP_NAME := $(APP_NAME)
+
+.PHONY: build
+# Build the container image - Dvelopment
+build-dev:
+	docker build -t ${APP_NAME}\
+		--target development-build-stage\
+		-f Dockerfile .
+
+# Build the container image - Production
 build:
-	docker build -t ${tag} .
+	docker build -t ${APP_NAME}\
+		--target production-build-stage\
+		-f Dockerfile .
+
+# Clean the container image
 clean:
-	docker rmi -f ${tag}
+	docker rmi -f ${APP_NAME}
+
+# Run the container image
 run:
-	docker run -d -p ${port}:${port} --name ${name} ${tag}
+	docker run -d -it -p 3000:3000 ${APP_NAME}
+
+all: build

package/lib/mongoose/package.json

@@ -7,8 +7,8 @@
   "scripts": {
     "start": "npm run build && cross-env NODE_ENV=production node dist/server.js",
     "dev": "cross-env NODE_ENV=development nodemon",
-    "build": "tsc && tsc-alias",
-    "build:swc": "swc src -d dist --source-maps --copy-files",
+    "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",
@@ -20,7 +20,6 @@
     "class-transformer": "^0.4.0",
     "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",
@@ -41,7 +40,6 @@
     "@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",

package/lib/mongoose/src/app.ts

@@ -1,5 +1,3 @@
-import '@/index';
-import config from 'config';
 import compression from 'compression';
 import cookieParser from 'cookie-parser';
 import cors from 'cors';
@@ -10,6 +8,7 @@ import morgan from 'morgan';
 import { connect, set } from 'mongoose';
 import swaggerJSDoc from 'swagger-jsdoc';
 import swaggerUi from 'swagger-ui-express';
+import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
 import { dbConnection } from '@databases';
 import { Routes } from '@interfaces/routes.interface';
 import errorMiddleware from '@middlewares/error.middleware';
@@ -17,13 +16,13 @@ import { logger, stream } from '@utils/logger';
 
 class App {
   public app: express.Application;
-  public port: string | number;
   public env: string;
+  public port: string | number;
 
   constructor(routes: Routes[]) {
     this.app = express();
-    this.port = process.env.PORT || 3000;
-    this.env = process.env.NODE_ENV || 'development';
+    this.env = NODE_ENV || 'development';
+    this.port = PORT || 3000;
 
     this.connectToDatabase();
     this.initializeMiddlewares();
@@ -54,8 +53,8 @@ class App {
   }
 
   private initializeMiddlewares() {
-    this.app.use(morgan(config.get('log.format'), { stream }));
-    this.app.use(cors({ origin: config.get('cors.origin'), credentials: config.get('cors.credentials') }));
+    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());

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

@@ -0,0 +1,5 @@
+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, DB_HOST, DB_PORT, DB_DATABASE, SECRET_KEY, LOG_FORMAT, LOG_DIR, ORIGIN } = process.env;

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

@@ -1,10 +1,7 @@
-import config from 'config';
-import { dbConfig } from '@interfaces/db.interface';
-
-const { host, port, database }: dbConfig = config.get('dbConfig');
+import { DB_HOST, DB_PORT, DB_DATABASE } from '@config';
 
 export const dbConnection = {
-  url: `mongodb://${host}:${port}/${database}`,
+  url: `mongodb://${DB_HOST}:${DB_PORT}/${DB_DATABASE}`,
   options: {
     useNewUrlParser: true,
     useUnifiedTopology: true,

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

@@ -1,6 +1,6 @@
-import config from 'config';
 import { NextFunction, Response } from 'express';
 import { verify } from 'jsonwebtoken';
+import { SECRET_KEY } from '@config';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
 import userModel from '@models/users.model';
@@ -10,7 +10,7 @@ const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFun
     const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
 
     if (Authorization) {
-      const secretKey: string = config.get('secretKey');
+      const secretKey: string = SECRET_KEY;
       const verificationResponse = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const userId = verificationResponse._id;
       const findUser = await userModel.findById(userId);

package/lib/mongoose/src/server.ts

@@ -1,5 +1,3 @@
-import 'dotenv/config';
-import '@/index';
 import App from '@/app';
 import AuthRoute from '@routes/auth.route';
 import IndexRoute from '@routes/index.route';

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

@@ -1,6 +1,6 @@
 import { hash, compare } from 'bcrypt';
-import config from 'config';
 import { sign } from 'jsonwebtoken';
+import { SECRET_KEY } from '@config';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
@@ -49,7 +49,7 @@ class AuthService {
 
   public createToken(user: User): TokenData {
     const dataStoredInToken: DataStoredInToken = { _id: user._id };
-    const secretKey: string = config.get('secretKey');
+    const secretKey: string = SECRET_KEY;
     const expiresIn: number = 60 * 60;
 
     return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };

package/lib/mongoose/src/utils/logger.ts

@@ -1,11 +1,11 @@
-import config from 'config';
 import { existsSync, mkdirSync } from 'fs';
 import { join } from 'path';
 import winston from 'winston';
 import winstonDaily from 'winston-daily-rotate-file';
+import { LOG_DIR } from '@config';
 
 // logs dir
-const logDir: string = join(__dirname, config.get('log.dir'));
+const logDir: string = join(__dirname, LOG_DIR);
 
 if (!existsSync(logDir)) {
   mkdirSync(logDir);

package/lib/mongoose/tsconfig.json

@@ -22,6 +22,7 @@
     "baseUrl": "src",
     "paths": {
       "@/*": ["*"],
+      "@config": ["config"],
       "@controllers/*": ["controllers/*"],
       "@databases": ["databases"],
       "@dtos/*": ["dtos/*"],