typescript-express-starter 8.1.3 → 9.1.0

package/lib/mikro-orm/src/tests/users.test.ts

@@ -0,0 +1,70 @@
+import request from 'supertest';
+import App from '../app';
+import { DI } from '../databases';
+import { CreateUserDto } from '../dtos/users.dto';
+import UsersRoute from '../routes/users.route';
+
+const usersRoute = new UsersRoute();
+
+const app = new App([usersRoute]);
+
+let userId: string;
+
+/**
+ ** MikroORM Seeding
+ ** https://mikro-orm.io/docs/seeding#use-in-tests
+ */
+
+beforeAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+
+  await DI.orm.getSchemaGenerator().refreshDatabase();
+});
+
+afterAll(async () => {
+  await DI.orm.close();
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('Testing Users', () => {
+  describe('[GET] /users', () => {
+    it('response fineAll Users', async () => {
+      return request(app.getServer()).get(`${usersRoute.path}`).expect(200);
+    });
+  });
+
+  describe('[POST] /users', () => {
+    it('response Create User', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+
+      const { body } = await request(app.getServer()).post(`${usersRoute.path}`).send(userData).expect(201);
+      userId = body.data.id;
+    });
+  });
+
+  describe('[GET] /users/:id', () => {
+    it('response findOne User', async () => {
+      return await request(app.getServer()).get(`${usersRoute.path}/${userId}`).expect(200);
+    });
+  });
+
+  describe('[PUT] /users/:id', () => {
+    it('response Update User', async () => {
+      const userData: CreateUserDto = {
+        email: 'test1@email.com',
+        password: 'q1w2e3r4',
+      };
+
+      return await request(app.getServer()).put(`${usersRoute.path}/${userId}`).send(userData).expect(200);
+    });
+  });
+
+  describe('[DELETE] /users/:id', () => {
+    it('response Delete User', async () => {
+      return request(app.getServer()).delete(`${usersRoute.path}/${userId}`).expect(200);
+    });
+  });
+});

package/lib/mikro-orm/src/utils/logger.ts

@@ -0,0 +1,65 @@
+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, LOG_DIR);
+
+if (!existsSync(logDir)) {
+  mkdirSync(logDir);
+}
+
+// Define log format
+const logFormat = winston.format.printf(({ timestamp, level, message }) => `${timestamp} ${level}: ${message}`);
+
+/*
+ * Log Level
+ * error: 0, warn: 1, info: 2, http: 3, verbose: 4, debug: 5, silly: 6
+ */
+const logger = winston.createLogger({
+  format: winston.format.combine(
+    winston.format.timestamp({
+      format: 'YYYY-MM-DD HH:mm:ss',
+    }),
+    logFormat,
+  ),
+  transports: [
+    // debug log setting
+    new winstonDaily({
+      level: 'debug',
+      datePattern: 'YYYY-MM-DD',
+      dirname: logDir + '/debug', // log file /logs/debug/*.log in save
+      filename: `%DATE%.log`,
+      maxFiles: 30, // 30 Days saved
+      json: false,
+      zippedArchive: true,
+    }),
+    // error log setting
+    new winstonDaily({
+      level: 'error',
+      datePattern: 'YYYY-MM-DD',
+      dirname: logDir + '/error', // log file /logs/error/*.log in save
+      filename: `%DATE%.log`,
+      maxFiles: 30, // 30 Days saved
+      handleExceptions: true,
+      json: false,
+      zippedArchive: true,
+    }),
+  ],
+});
+
+logger.add(
+  new winston.transports.Console({
+    format: winston.format.combine(winston.format.splat(), winston.format.colorize()),
+  }),
+);
+
+const stream = {
+  write: (message: string) => {
+    logger.info(message.substring(0, message.lastIndexOf('\n')));
+  },
+};
+
+export { logger, stream };

package/lib/mikro-orm/src/utils/util.ts

@@ -0,0 +1,19 @@
+/**
+ * @method isEmpty
+ * @param {String | Number | Object} value
+ * @returns {Boolean} true & false
+ * @description this value is Empty Check
+ */
+ export const isEmpty = (value: string | number | object): boolean => {
+  if (value === null) {
+    return true;
+  } else if (typeof value !== 'number' && value === '') {
+    return true;
+  } else if (typeof value === 'undefined' || value === undefined) {
+    return true;
+  } else if (value !== null && typeof value === 'object' && !Object.keys(value).length) {
+    return true;
+  } else {
+    return false;
+  }
+};

package/lib/mikro-orm/src/utils/validateEnv.ts

@@ -0,0 +1,10 @@
+import { cleanEnv, port, str } from 'envalid';
+
+const validateEnv = () => {
+  cleanEnv(process.env, {
+    NODE_ENV: str(),
+    PORT: port(),
+  });
+};
+
+export default validateEnv;

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

@@ -0,0 +1,41 @@
+{
+  "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/*"],
+      "@entities/*": ["entities/*"],
+      "@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/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",
@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "bcrypt": "^5.0.1",
-    "class-transformer": "^0.4.0",
+    "class-transformer": "^0.5.1",
     "class-validator": "^0.13.1",
     "compression": "^1.7.4",
     "cookie-parser": "^1.4.5",
@@ -42,11 +42,9 @@
     "@types/compression": "^1.7.1",
     "@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/jest": "27.4.x",
     "@types/jsonwebtoken": "^8.5.4",
     "@types/mongoose": "^5.10.1",
     "@types/morgan": "^1.9.3",
@@ -54,7 +52,6 @@
     "@types/supertest": "^2.0.11",
     "@types/swagger-jsdoc": "^6.0.1",
     "@types/swagger-ui-express": "^4.1.3",
-    "@types/winston": "^2.4.4",
     "@typescript-eslint/eslint-plugin": "^4.28.2",
     "@typescript-eslint/parser": "^4.28.2",
     "cross-env": "^7.0.3",
@@ -62,15 +59,15 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
     "husky": "^7.0.1",
-    "jest": "^27.0.6",
+    "jest": "27.4.x",
     "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",
+    "supertest": "^6.2.2",
+    "ts-jest": "^27.1.4",
     "ts-node": "^10.4.0",
     "tsc-alias": "^1.4.1",
     "tsconfig-paths": "^3.10.1",

package/lib/prisma/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/prisma/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",
@@ -24,7 +24,7 @@
   "dependencies": {
     "@prisma/client": "^3.7.0",
     "bcrypt": "^5.0.1",
-    "class-transformer": "^0.4.0",
+    "class-transformer": "^0.5.1",
     "class-validator": "^0.13.1",
     "compression": "^1.7.4",
     "cookie-parser": "^1.4.5",
@@ -48,18 +48,15 @@
     "@types/compression": "^1.7.1",
     "@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/jest": "27.4.x",
     "@types/jsonwebtoken": "^8.5.4",
     "@types/morgan": "^1.9.3",
     "@types/node": "^16.0.1",
     "@types/supertest": "^2.0.11",
     "@types/swagger-jsdoc": "^6.0.1",
     "@types/swagger-ui-express": "^4.1.3",
-    "@types/winston": "^2.4.4",
     "@typescript-eslint/eslint-plugin": "^4.28.2",
     "@typescript-eslint/parser": "^4.28.2",
     "cross-env": "^7.0.3",
@@ -67,7 +64,7 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
     "husky": "^7.0.1",
-    "jest": "^27.0.6",
+    "jest": "27.4.x",
     "lint-staged": "^11.0.0",
     "node-config": "^0.0.2",
     "node-gyp": "^8.1.0",
@@ -75,8 +72,8 @@
     "pm2": "^5.1.0",
     "prettier": "^2.3.2",
     "prisma": "^3.7.0",
-    "supertest": "^6.1.3",
-    "ts-jest": "^27.0.7",
+    "supertest": "^6.2.2",
+    "ts-jest": "^27.1.4",
     "ts-node": "^10.4.0",
     "tsc-alias": "^1.4.1",
     "tsconfig-paths": "^3.10.1",

package/lib/routing-controllers/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/routing-controllers/package.json

@@ -1,14 +1,14 @@
 {
   "name": "typescript-express-starter",
   "version": "0.0.0",
-  "description": "TypeScript + Express + Routing Controllers API Server",
+  "description": "TypeScript + Routing Controllers + 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": "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",
@@ -17,7 +17,7 @@
   },
   "dependencies": {
     "bcrypt": "^5.0.1",
-    "class-transformer": "^0.4.0",
+    "class-transformer": "^0.5.1",
     "class-validator": "^0.13.1",
     "class-validator-jsonschema": "^3.0.2",
     "compression": "^1.7.4",
@@ -44,17 +44,14 @@
     "@types/compression": "^1.7.1",
     "@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/jest": "27.4.x",
     "@types/jsonwebtoken": "^8.5.4",
     "@types/morgan": "^1.9.3",
     "@types/node": "^16.0.1",
     "@types/supertest": "^2.0.11",
     "@types/swagger-ui-express": "^4.1.3",
-    "@types/winston": "^2.4.4",
     "@typescript-eslint/eslint-plugin": "^4.28.2",
     "@typescript-eslint/parser": "^4.28.2",
     "cross-env": "^7.0.3",
@@ -62,14 +59,15 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
     "husky": "^7.0.1",
-    "jest": "^27.0.5",
+    "jest": "27.4.x",
     "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",
-    "ts-jest": "^27.0.7",
+    "supertest": "^6.2.2",
+    "ts-jest": "^27.1.4",
     "ts-node": "^10.4.0",
     "tsc-alias": "^1.4.1",
     "tsconfig-paths": "^3.10.1",

package/lib/sequelize/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