typescript-express-starter 7.0.0 → 8.1.2

package/lib/typegoose/swagger.yaml

@@ -0,0 +1,122 @@
+tags:
+- name: users
+  description: users API
+
+paths:
+# [GET] users
+  /users:
+    get:
+      tags:
+      - users
+      summary: Find All Users
+      responses:
+        200:
+          description: 'OK'
+        500:
+          description: 'Server Error'
+
+# [POST] users
+    post:
+      tags:
+      - users
+      summary: Add User
+      parameters:
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        201:
+          description: 'Created'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [GET] users/id
+  /users/{id}:
+    get:
+      tags:
+      - users
+      summary: Find User By Id
+      parameters:
+      - name: id
+        in: path
+        description: User Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [PUT] users/id
+    put:
+      tags:
+      - users
+      summary: Update User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        200:
+          description: 'OK'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [DELETE] users/id
+    delete:
+      tags:
+      - users
+      summary: Delete User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# definitions
+definitions:
+  users:
+    type: object
+    required:
+        - email
+        - password
+    properties:
+      id:
+        description: user Id
+      email:
+        type: string
+        description: user Email
+      password:
+        type: string
+        description: user Password
+
+schemes:
+ - https
+ - http

package/lib/typegoose/tsconfig.json

@@ -0,0 +1,40 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "target": "es2017",
+    "lib": ["es2017", "esnext.asynciterable"],
+    "typeRoots": ["node_modules/@types"],
+    "allowSyntheticDefaultImports": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "module": "commonjs",
+    "pretty": true,
+    "sourceMap": true,
+    "declaration": true,
+    "outDir": "dist",
+    "allowJs": true,
+    "noEmit": false,
+    "esModuleInterop": true,
+    "resolveJsonModule": true,
+    "importHelpers": true,
+    "baseUrl": "src",
+    "paths": {
+      "@/*": ["*"],
+      "@config": ["config"],
+      "@controllers/*": ["controllers/*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@models/*": ["models/*"],
+      "@routes/*": ["routes/*"],
+      "@services/*": ["services/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.json", ".env"],
+  "exclude": ["node_modules", "src/http", "src/logs", "src/tests"]
+}

package/lib/typeorm/.env.development.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 5432
+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/typeorm/.env.production.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 5432
+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/typeorm/.env.test.local

@@ -0,0 +1,20 @@
+# PORT
+PORT = 3000
+
+# DATABASE
+DB_HOST = localhost
+DB_PORT = 5432
+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/typeorm/.swcrc

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

package/lib/typeorm/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": "swc src -d dist --source-maps --copy-files",
-    "build:tsc": "tsc && tsc-alias",
+    "build": "tsc && tsc-alias",
+    "build:swc": "swc src -d dist --source-maps --copy-files",
     "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",
@@ -43,7 +42,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/typeorm/src/app.ts

@@ -1,8 +1,6 @@
 import 'reflect-metadata';
-import '@/index';
 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';
@@ -11,6 +9,7 @@ import compression from 'compression';
 import swaggerUi from 'swagger-ui-express';
 import swaggerJSDoc from 'swagger-jsdoc';
 import { createConnection } from 'typeorm';
+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';
@@ -18,13 +17,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.env !== 'test' && this.connectToDatabase();
     this.initializeMiddlewares();
@@ -51,8 +50,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/typeorm/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/typeorm/src/databases/index.ts

@@ -1,16 +1,14 @@
-import config from 'config';
 import { join } from 'path';
 import { ConnectionOptions } from 'typeorm';
-import { dbConfig } from '@interfaces/db.interface';
+import { DB_HOST, DB_PORT, DB_USER, DB_PASSWORD, DB_DATABASE } from '@config';
 
-const { host, user, password, database }: dbConfig = config.get('dbConfig');
 export const dbConnection: ConnectionOptions = {
   type: 'postgres',
-  host: host,
-  port: 5432,
-  username: user,
-  password: password,
-  database: database,
+  host: DB_HOST,
+  port: DB_PORT,
+  username: DB_USER,
+  password: DB_PASSWORD,
+  database: DB_DATABASE,
   synchronize: true,
   logging: false,
   entities: [join(__dirname, '../**/*.entity{.ts,.js}')],

package/lib/typeorm/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 { UserEntity } from '@entities/users.entity';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
@@ -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 { id } = (await verify(Authorization, secretKey)) as DataStoredInToken;
       const findUser = await UserEntity.findOne(id, { select: ['id', 'email', 'password'] });
 

package/lib/typeorm/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/typeorm/src/services/auth.service.ts

@@ -1,7 +1,7 @@
 import { compare, hash } from 'bcrypt';
-import config from 'config';
 import { sign } from 'jsonwebtoken';
 import { EntityRepository, Repository } from 'typeorm';
+import { SECRET_KEY } from '@config';
 import { CreateUserDto } from '@dtos/users.dto';
 import { UserEntity } from '@entities/users.entity';
 import { HttpException } from '@exceptions/HttpException';
@@ -48,7 +48,7 @@ class AuthService extends Repository<UserEntity> {
 
   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/typeorm/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/typeorm/tsconfig.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "typescript-express-starter",
-  "version": "7.0.0",
+  "version": "8.1.2",
   "description": "Quick and Easy TypeScript Express Starter",
   "author": "AGUMON <ljlm0402@gmail.com>",
   "license": "MIT",
@@ -11,6 +11,7 @@
     "routing-controllers-openapi",
     "sequelize",
     "mongoose",
+    "typegoose",
     "typeorm",
     "knex",
     "prisma",

package/lib/default/.env

@@ -1 +0,0 @@
-PORT=3000

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

@@ -1,12 +0,0 @@
-{
-    "env": "development",
-    "secretKey": "secretKey",
-    "log": {
-        "format": "dev",
-        "dir": "../logs"
-    },
-    "cors": {
-        "origin": true,
-        "credentials": true
-    }
-}

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

@@ -1,12 +0,0 @@
-{
-    "env": "production",
-    "secretKey": "secretKey",
-    "log": {
-        "format": "combined",
-        "dir": "../logs"
-    },
-    "cors": {
-        "origin": "your.domain.com",
-        "credentials": true
-    }
-}

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

@@ -1,12 +0,0 @@
-{
-    "env": "test",
-    "secretKey": "secretKey",
-    "log": {
-        "format": "dev",
-        "dir": "../logs"
-    },
-    "cors": {
-        "origin": true,
-        "credentials": true
-    }
-}

package/lib/default/src/index.ts

@@ -1 +0,0 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';

package/lib/graphql/.env

@@ -1 +0,0 @@
-PORT=3000

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

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

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

@@ -1,19 +0,0 @@
-{
-    "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/index.ts

@@ -1 +0,0 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';

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

@@ -1,7 +0,0 @@
-export interface dbConfig {
-  host: string;
-  user: string;
-  port: number;
-  password: string;
-  database: string;
-}

package/lib/knex/.env

@@ -1 +0,0 @@
-PORT=3000

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

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

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

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

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

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

package/lib/knex/src/index.ts

@@ -1 +0,0 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';

package/lib/knex/src/interfaces/db.interface.ts

@@ -1,7 +0,0 @@
-export interface dbConfig {
-  host: string;
-  user: string;
-  password: string;
-  database: string;
-  port: number;
-}

package/lib/mongoose/.env

@@ -1 +0,0 @@
-PORT=3000

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

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

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

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