typescript-express-starter 6.2.1 → 8.0.1

package/lib/graphql/src/tests/auth.test.ts

@@ -0,0 +1,52 @@
+import request from 'supertest';
+import App from '@/app';
+import { CreateUserDto } from '@dtos/users.dto';
+import AuthRoute from '@routes/auth.route';
+
+afterAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('Testing Auth', () => {
+  describe('[POST] /signup', () => {
+    it('response should have the Create userData', () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+      const authRoute = new AuthRoute();
+      const app = new App([authRoute]);
+
+      return request(app.getServer()).post('/signup').send(userData);
+    });
+  });
+
+  describe('[POST] /login', () => {
+    it('response should have the Set-Cookie header with the Authorization token', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+
+      const authRoute = new AuthRoute();
+      const app = new App([authRoute]);
+
+      return request(app.getServer())
+        .post('/login')
+        .send(userData)
+        .expect('Set-Cookie', /^Authorization=.+/);
+    });
+  });
+
+  // error: StatusCode : 404, Message : Authentication token missing
+  // describe('[POST] /logout', () => {
+  //   it('logout Set-Cookie Authorization=; Max-age=0', () => {
+  //     const authRoute = new AuthRoute();
+  //     const app = new App([authRoute]);
+
+  //     return request(app.getServer())
+  //       .post('/logout')
+  //       .expect('Set-Cookie', /^Authorization=\;/);
+  //   });
+  // });
+});

package/lib/graphql/src/tests/index.test.ts

@@ -0,0 +1,18 @@
+import request from 'supertest';
+import App from '@app';
+import IndexRoute from '@routes/index.route';
+
+afterAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('Testing Index', () => {
+  describe('[GET] /', () => {
+    it('response statusCode 200', () => {
+      const indexRoute = new IndexRoute();
+      const app = new App([indexRoute]);
+
+      return request(app.getServer()).get(`${indexRoute.path}`).expect(200);
+    });
+  });
+});

package/lib/graphql/src/tests/users.test.ts

@@ -0,0 +1,71 @@
+import request from 'supertest';
+import App from '@app';
+import { CreateUserDto } from '@dtos/users.dto';
+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('Testing Users', () => {
+  describe('[GET] /users', () => {
+    it('response statusCode 200 / findAll', () => {
+      const findUser: User[] = userModel;
+      const usersRoute = new UserRoute();
+      const app = new App([usersRoute]);
+
+      return request(app.getServer()).get(`${usersRoute.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);
+      const usersRoute = new UserRoute();
+      const app = new App([usersRoute]);
+
+      return request(app.getServer()).get(`${usersRoute.path}/${userId}`).expect(200, { data: findUser, message: 'findOne' });
+    });
+  });
+
+  describe('[POST] /users', () => {
+    it('response statusCode 201 / created', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+      const usersRoute = new UserRoute();
+      const app = new App([usersRoute]);
+
+      return request(app.getServer()).post(`${usersRoute.path}`).send(userData).expect(201);
+    });
+  });
+
+  describe('[PUT] /users/:id', () => {
+    it('response statusCode 200 / updated', async () => {
+      const userId = 1;
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+      const usersRoute = new UserRoute();
+      const app = new App([usersRoute]);
+
+      return request(app.getServer()).put(`${usersRoute.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);
+      const usersRoute = new UserRoute();
+      const app = new App([usersRoute]);
+
+      return request(app.getServer()).delete(`${usersRoute.path}/${userId}`).expect(200, { data: deleteUser, message: 'deleted' });
+    });
+  });
+});

package/lib/graphql/src/typedefs/users.type.ts

@@ -0,0 +1,13 @@
+import { Field, ObjectType } from 'type-graphql';
+
+@ObjectType()
+export class User {
+  @Field()
+  id: number;
+
+  @Field()
+  email: string;
+
+  @Field()
+  password: string;
+}

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

@@ -0,0 +1,75 @@
+import config from 'config';
+import { existsSync, mkdirSync } from 'fs';
+import { join } from 'path';
+import winston from 'winston';
+import winstonDaily from 'winston-daily-rotate-file';
+
+// logs dir
+const logDir: string = join(__dirname, config.get('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
+ */
+export 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()),
+  }),
+);
+
+export const responseLogger = request => {
+  const { query } = request.request;
+  logger.info(query);
+};
+
+export const errorLogger = error => {
+  const { validationErrors } = error.extensions.exception;
+
+  let message = '';
+  if (validationErrors) {
+    message = validationErrors.map(error => Object.values(error.constraints)).join(', ');
+  } else {
+    message = error.message;
+  }
+
+  logger.error(message);
+};

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

@@ -0,0 +1,39 @@
+{
+  "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": {
+      "@/*": ["*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@entities/*": ["entities/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@repositories/*": ["repositories/*"],
+      "@resolvers/*": ["resolvers/*"],
+      "@typedefs/*": ["typedefs/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.json", ".env"],
+  "exclude": ["node_modules", "src/http", "src/logs", "src/tests"]
+}

package/lib/knex/.swcrc

@@ -0,0 +1,39 @@
+{
+  "jsc": {
+    "parser": {
+      "syntax": "typescript",
+      "tsx": false,
+      "dynamicImport": true,
+      "decorators": true
+    },
+    "transform": {
+      "legacyDecorator": true,
+      "decoratorMetadata": true
+    },
+    "target": "es2017",
+    "externalHelpers": false,
+    "keepClassNames": true,
+    "loose": false,
+    "minify": {
+      "compress": false,
+      "mangle": false
+    },
+    "baseUrl": "src",
+    "paths": {
+      "@/*": ["*"],
+      "@controllers/*": ["controllers/*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@models/*": ["models/*"],
+      "@routes/*": ["routes/*"],
+      "@services/*": ["services/*"],
+      "@utils/*": ["utils/*"]
+    }
+  },
+  "module": {
+    "type": "commonjs"
+  }
+}

package/lib/knex/knexfile.ts

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

package/lib/knex/nodemon.json

@@ -5,8 +5,8 @@
     ],
     "ext": "js,ts,json",
     "ignore": [
-        "src/**/*.spec.ts",
-        "src/**/*.test.ts"
+        "src/logs/*",
+        "src/**/*.{spec,test}.ts"
     ],
     "exec": "ts-node -r tsconfig-paths/register --transpile-only src/server.ts"
 }

package/lib/knex/package.json

@@ -7,7 +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 && npx 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",
@@ -27,7 +28,6 @@
     "config": "^3.3.6",
     "cookie-parser": "^1.4.5",
     "cors": "^2.8.5",
-    "cross-env": "^7.0.3",
     "dotenv": "^9.0.2",
     "envalid": "^7.1.0",
     "express": "^4.17.1",
@@ -38,13 +38,14 @@
     "morgan": "^1.10.0",
     "mysql": "^2.18.1",
     "objection": "^2.2.15",
-    "pm2": "^5.1.0",
     "swagger-jsdoc": "^6.0.0",
     "swagger-ui-express": "^4.1.6",
     "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.0",
     "@types/config": "0.0.38",
@@ -65,21 +66,23 @@
     "@types/winston": "^2.4.4",
     "@typescript-eslint/eslint-plugin": "^4.23.0",
     "@typescript-eslint/parser": "^4.23.0",
+    "cross-env": "^7.0.3",
     "eslint": "^7.26.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^3.4.0",
     "husky": "^6.0.0",
     "jest": "^27.0.6",
-    "jest-extended": "^0.11.5",
     "lint-staged": "^11.0.0",
     "node-config": "0.0.2",
     "node-gyp": "^8.0.0",
     "nodemon": "^2.0.7",
+    "pm2": "^5.1.0",
     "prettier": "^2.3.0",
     "supertest": "^6.1.3",
-    "ts-jest": "^27.0.3",
-    "ts-node": "^10.1.0",
-    "tsconfig-paths": "^3.9.0",
-    "typescript": "^4.3.5"
+    "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/knex/src/app.ts

@@ -1,9 +1,8 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';
-
+import '@/index';
+import config from 'config';
 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';

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

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

package/lib/knex/src/http/auth.http

@@ -1,35 +1,32 @@
-# auth API
-
-###
 # baseURL
 @baseURL = http://localhost:3000
 
 ###
-# signup
-POST {{baseURL}}/signup
+# User Signup
+POST {{ baseURL }}/signup
 Content-Type: application/json
 
 {
-    "email": "example@gmail.com",
-	"password": "qwer1234"
+    "email": "example@email.com",
+    "password": "password"
 }
 
 ###
-# Login
-POST {{baseURL}}/login
+# User Login
+POST {{ baseURL }}/login
 Content-Type: application/json
 
 {
-    "email": "lim@gmail.com",
-	"password": "q1w2e3r4"
+    "email": "example@email.com",
+    "password": "password"
 }
 
 ###
-# Logout
-POST {{baseURL}}/logout
+# User Logout
+POST {{ baseURL }}/logout
 Content-Type: application/json
 
 {
-    "email": "lim@gmail.com",
-	"password": "q1w2e3r4"
+    "email": "example@email.com",
+    "password": "password"
 }

package/lib/knex/src/http/users.http

@@ -1,38 +1,34 @@
-# users API
-
-###
 # baseURL
 @baseURL = http://localhost:3000
 
 ###
 # Find All Users
-GET {{baseURL}}/users
+GET {{ baseURL }}/users
 
 ###
 # Find User By Id
-GET {{baseURL}}/users/1
-
+GET {{ baseURL }}/users/1
 
 ###
-# Add User
-POST {{baseURL}}/users
+# Create User
+POST {{ baseURL }}/users
 Content-Type: application/json
 
 {
-    "email": "example@gmail.com",
-	"password": "qwer1234"
+    "email": "example@email.com",
+    "password": "password"
 }
 
 ###
-# Edit User By Id
-PUT {{baseURL}}/users/1
+# Modify User By Id
+PUT {{ baseURL }}/users/1
 Content-Type: application/json
 
 {
-    "email": "example@gmail.com",
-	"password": "qwer1234"
+    "email": "example@email.com",
+    "password": "password"
 }
 
 ###
-# Del User By Id
-DELETE {{baseURL}}/users/1
+# Delete User By Id
+DELETE {{ baseURL }}/users/1

package/lib/knex/src/index.ts

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

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

@@ -1,18 +1,18 @@
 import config from 'config';
 import { NextFunction, Response } from 'express';
-import jwt from 'jsonwebtoken';
+import { verify } from 'jsonwebtoken';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, RequestWithUser } from '@interfaces/auth.interface';
-import { User } from '@/interfaces/users.interface';
+import { User } from '@interfaces/users.interface';
 import { Users } from '@models/users.model';
 
 const authMiddleware = async (req: RequestWithUser, res: Response, next: NextFunction) => {
   try {
-    const Authorization = req.cookies['Authorization'] || req.header('Authorization').split('Bearer ')[1] || null;
+    const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
 
     if (Authorization) {
       const secretKey: string = config.get('secretKey');
-      const verificationResponse = (await jwt.verify(Authorization, secretKey)) as DataStoredInToken;
+      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,6 +1,5 @@
-process.env['NODE_CONFIG_DIR'] = __dirname + '/configs';
-
 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 bcrypt from 'bcrypt';
+import { hash, compare } from 'bcrypt';
 import config from 'config';
-import jwt from 'jsonwebtoken';
+import { sign } from 'jsonwebtoken';
 import { CreateUserDto } from '@dtos/users.dto';
 import { HttpException } from '@exceptions/HttpException';
 import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
@@ -15,7 +15,7 @@ class AuthService {
     const findUser: Users = await Users.query().select().from('users').where('email', '=', userData.email).first();
     if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
 
-    const hashedPassword = await bcrypt.hash(userData.password, 10);
+    const hashedPassword = await hash(userData.password, 10);
     const createUserData: User = await Users.query()
       .insert({ ...userData, password: hashedPassword })
       .into('users');
@@ -29,7 +29,7 @@ class AuthService {
     const findUser: User = await Users.query().select().from('users').where('email', '=', userData.email).first();
     if (!findUser) throw new HttpException(409, `You're email ${userData.email} not found`);
 
-    const isPasswordMatching: boolean = await bcrypt.compare(userData.password, findUser.password);
+    const isPasswordMatching: boolean = await compare(userData.password, findUser.password);
     if (!isPasswordMatching) throw new HttpException(409, "You're password not matching");
 
     const tokenData = this.createToken(findUser);
@@ -58,7 +58,7 @@ class AuthService {
     const secretKey: string = config.get('secretKey');
     const expiresIn: number = 60 * 60;
 
-    return { expiresIn, token: jwt.sign(dataStoredInToken, secretKey, { expiresIn }) };
+    return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };
   }
 
   public createCookie(tokenData: TokenData): string {