typescript-express-starter 10.2.1 → 11.0.0

package/lib/knex/nodemon.json

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

package/lib/knex/package.json

@@ -1,85 +0,0 @@
-{
-  "name": "typescript-express-starter",
-  "version": "0.0.0",
-  "description": "TypeScript + Knex + MySQL + 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": "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",
-    "seed": "knex seed:run --knexfile=knexfile.ts --verbose",
-    "migrate": "knex migrate:latest --knexfile=knexfile.ts --verbose",
-    "rollback": "knex migrate:rollback --knexfile=knexfile.ts --verbose",
-    "make:seeder": "knex seed:make --knexfile=knexfile.ts -x ts --env development",
-    "make:migration": "knex migrate:make --knexfile=knexfile.ts -x ts --env development",
-    "deploy:prod": "npm run build && pm2 start ecosystem.config.js --only prod",
-    "deploy:dev": "pm2 start ecosystem.config.js --only dev"
-  },
-  "dependencies": {
-    "bcrypt": "^5.0.1",
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.13.2",
-    "compression": "^1.7.4",
-    "cookie-parser": "^1.4.6",
-    "cors": "^2.8.5",
-    "dotenv": "^16.0.1",
-    "envalid": "^7.3.1",
-    "express": "^4.18.1",
-    "helmet": "^5.1.1",
-    "hpp": "^0.2.3",
-    "jsonwebtoken": "^8.5.1",
-    "knex": "^2.2.0",
-    "morgan": "^1.10.0",
-    "mysql": "^2.18.1",
-    "objection": "^3.0.1",
-    "reflect-metadata": "^0.1.13",
-    "swagger-jsdoc": "^6.2.1",
-    "swagger-ui-express": "^4.5.0",
-    "typedi": "^0.10.0",
-    "winston": "^3.8.1",
-    "winston-daily-rotate-file": "^4.7.1"
-  },
-  "devDependencies": {
-    "@swc/cli": "^0.1.57",
-    "@swc/core": "^1.2.220",
-    "@types/bcrypt": "^5.0.0",
-    "@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.2",
-    "@types/jest": "^28.1.6",
-    "@types/jsonwebtoken": "^8.5.8",
-    "@types/knex": "^0.16.1",
-    "@types/morgan": "^1.9.3",
-    "@types/node": "^17.0.45",
-    "@types/supertest": "^2.0.12",
-    "@types/swagger-jsdoc": "^6.0.1",
-    "@types/swagger-ui-express": "^4.1.3",
-    "@typescript-eslint/eslint-plugin": "^5.29.0",
-    "@typescript-eslint/parser": "^5.29.0",
-    "cross-env": "^7.0.3",
-    "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": "^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/knex/src/app.ts

@@ -1,87 +0,0 @@
-import 'reflect-metadata';
-import compression from 'compression';
-import cookieParser from 'cookie-parser';
-import cors from 'cors';
-import express from 'express';
-import helmet from 'helmet';
-import hpp from 'hpp';
-import morgan from 'morgan';
-import swaggerJSDoc from 'swagger-jsdoc';
-import swaggerUi from 'swagger-ui-express';
-import { NODE_ENV, PORT, LOG_FORMAT, ORIGIN, CREDENTIALS } from '@config';
-import { dbConnection } from '@database';
-import { Routes } from '@interfaces/routes.interface';
-import { ErrorMiddleware } from '@middlewares/error.middleware';
-import { logger, stream } from '@utils/logger';
-
-export class App {
-  public app: express.Application;
-  public env: string;
-  public port: string | number;
-
-  constructor(routes: Routes[]) {
-    this.app = express();
-    this.env = NODE_ENV || 'development';
-    this.port = PORT || 3000;
-
-    this.connectToDatabase();
-    this.initializeMiddlewares();
-    this.initializeRoutes(routes);
-    this.initializeSwagger();
-    this.initializeErrorHandling();
-  }
-
-  public listen() {
-    this.app.listen(this.port, () => {
-      logger.info(`=================================`);
-      logger.info(`======= ENV: ${this.env} =======`);
-      logger.info(`🚀 App listening on the port ${this.port}`);
-      logger.info(`=================================`);
-    });
-  }
-
-  public getServer() {
-    return this.app;
-  }
-
-  private async connectToDatabase() {
-    await dbConnection();
-  }
-
-  private initializeMiddlewares() {
-    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());
-    this.app.use(express.json());
-    this.app.use(express.urlencoded({ extended: true }));
-    this.app.use(cookieParser());
-  }
-
-  private initializeRoutes(routes: Routes[]) {
-    routes.forEach(route => {
-      this.app.use('/', route.router);
-    });
-  }
-
-  private initializeSwagger() {
-    const options = {
-      swaggerDefinition: {
-        info: {
-          title: 'REST API',
-          version: '1.0.0',
-          description: 'Example docs',
-        },
-      },
-      apis: ['swagger.yaml'],
-    };
-
-    const specs = swaggerJSDoc(options);
-    this.app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
-  }
-
-  private initializeErrorHandling() {
-    this.app.use(ErrorMiddleware);
-  }
-}

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

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

package/lib/knex/src/controllers/auth.controller.ts

@@ -1,44 +0,0 @@
-import { NextFunction, Request, Response } from 'express';
-import { Container } from 'typedi';
-import { RequestWithUser } from '@interfaces/auth.interface';
-import { User } from '@interfaces/users.interface';
-import { AuthService } from '@services/auth.service';
-
-export class AuthController {
-  public auth = Container.get(AuthService);
-
-  public signUp = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const userData: User = req.body;
-      const signUpUserData: User = await this.auth.signup(userData);
-
-      res.status(201).json({ data: signUpUserData, message: 'signup' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public logIn = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const userData: User = req.body;
-      const { cookie, findUser } = await this.auth.login(userData);
-
-      res.setHeader('Set-Cookie', [cookie]);
-      res.status(200).json({ data: findUser, message: 'login' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public logOut = async (req: RequestWithUser, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const userData: User = req.user;
-      const logOutUserData: User = await this.auth.logout(userData);
-
-      res.setHeader('Set-Cookie', ['Authorization=; Max-age=0']);
-      res.status(200).json({ data: logOutUserData, message: 'logout' });
-    } catch (error) {
-      next(error);
-    }
-  };
-}

package/lib/knex/src/controllers/users.controller.ts

@@ -1,63 +0,0 @@
-import { NextFunction, Request, Response } from 'express';
-import { Container } from 'typedi'
-import { User } from '@interfaces/users.interface';
-import { UserService } from '@services/users.service';
-
-export class UserController {
-  public user = Container.get(UserService);
-
-  public getUsers = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const findAllUsersData: User[] = await this.user.findAllUser();
-
-      res.status(200).json({ data: findAllUsersData, message: 'findAll' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public getUserById = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const userId = Number(req.params.id);
-      const findOneUserData: User = await this.user.findUserById(userId);
-
-      res.status(200).json({ data: findOneUserData, message: 'findOne' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public createUser = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const userData: User = req.body;
-      const createUserData: User = await this.user.createUser(userData);
-
-      res.status(201).json({ data: createUserData, message: 'created' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public updateUser = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const userId = Number(req.params.id);
-      const userData: User = req.body;
-      const updateUserData: User = await this.user.updateUser(userId, userData);
-
-      res.status(200).json({ data: updateUserData, message: 'updated' });
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  public deleteUser = async (req: Request, res: Response, next: NextFunction): Promise<void> => {
-    try {
-      const userId = Number(req.params.id);
-      const deleteUserData: User = await this.user.deleteUser(userId);
-
-      res.status(200).json({ data: deleteUserData, message: 'deleted' });
-    } catch (error) {
-      next(error);
-    }
-  };
-}

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

@@ -1,24 +0,0 @@
-import { Model } from 'objection';
-import Knex from 'knex';
-import { DB_USER, DB_PASSWORD, DB_HOST, DB_PORT, DB_DATABASE } from '@config';
-
-export const dbConnection = async () => {
-  const dbConfig = {
-    client: 'mysql',
-    connection: {
-      charset: 'utf8',
-      timezone: 'UTC',
-      user: DB_USER,
-      password: DB_PASSWORD,
-      host: DB_HOST,
-      port: DB_PORT,
-      database: DB_DATABASE,
-    },
-    pool: {
-      min: 2,
-      max: 10,
-    },
-  };
-
-  await Model.knex(Knex(dbConfig));
-};

package/lib/knex/src/database/migrations/20210713110926_initial.ts

@@ -1,17 +0,0 @@
-import { Knex } from 'knex';
-
-const up = (knex: Knex): Promise<void> => {
-  return knex.schema.createTable('users', table => {
-    table.bigIncrements('id').unsigned().primary();
-    table.string('email', 45).notNullable();
-    table.string('password', 255).notNullable();
-    table.timestamp('createdAt').defaultTo(knex.fn.now());
-    table.timestamp('updatedAt').defaultTo(knex.fn.now());
-  });
-};
-
-const down = (knex: Knex): Promise<void> => {
-  return knex.schema.dropTable('users');
-};
-
-export default { up, down };

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

@@ -1,20 +0,0 @@
-import { IsEmail, IsString, IsNotEmpty, MinLength, MaxLength } from 'class-validator';
-
-export class CreateUserDto {
-  @IsEmail()
-  public email: string;
-
-  @IsString()
-  @IsNotEmpty()
-  @MinLength(9)
-  @MaxLength(32)
-  public password: string;
-}
-
-export class UpdateUserDto {
-  @IsString()
-  @IsNotEmpty()
-  @MinLength(9)
-  @MaxLength(32)
-  public password: string;
-}

package/lib/knex/src/exceptions/HttpException.ts

@@ -1,10 +0,0 @@
-export class HttpException extends Error {
-  public status: number;
-  public message: string;
-
-  constructor(status: number, message: string) {
-    super(message);
-    this.status = status;
-    this.message = message;
-  }
-}

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

@@ -1,27 +0,0 @@
-# baseURL
-@baseURL = http://localhost:3000
-
-###
-# User Signup
-POST {{ baseURL }}/signup
-Content-Type: application/json
-
-{
-    "email": "example@email.com",
-    "password": "password"
-}
-
-###
-# User Login
-POST {{ baseURL }}/login
-Content-Type: application/json
-
-{
-    "email": "example@email.com",
-    "password": "password"
-}
-
-###
-# User Logout
-POST {{ baseURL }}/logout
-Content-Type: application/json

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

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

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

@@ -1,6 +0,0 @@
-import { Router } from 'express';
-
-export interface Routes {
-  path?: string;
-  router: Router;
-}

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

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

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

@@ -1,40 +0,0 @@
-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';
-import { UserModel } from '@models/users.model';
-
-const getAuthorization = req => {
-  const coockie = req.cookies['Authorization'];
-  if (coockie) return coockie;
-
-  const header = req.header('Authorization');
-  if (header) return header.split('Bearer ')[1];
-
-  return null;
-};
-
-export const AuthMiddleware = async (req: RequestWithUser, res: Response, next: NextFunction) => {
-  try {
-    const Authorization = getAuthorization(req);
-
-    if (Authorization) {
-      const verificationResponse = (await verify(Authorization, SECRET_KEY)) as DataStoredInToken;
-      const { id } = verificationResponse;
-      const findUser: User = await UserModel.query().findById(id);
-
-      if (findUser) {
-        req.user = findUser;
-        next();
-      } else {
-        next(new HttpException(401, 'Wrong authentication token'));
-      }
-    } else {
-      next(new HttpException(404, 'Authentication token missing'));
-    }
-  } catch (error) {
-    next(new HttpException(401, 'Wrong authentication token'));
-  }
-};

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

@@ -1,15 +0,0 @@
-import { NextFunction, Request, Response } from 'express';
-import { HttpException } from '@exceptions/httpException';
-import { logger } from '@utils/logger';
-
-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';
-
-    logger.error(`[${req.method}] ${req.path} >> StatusCode:: ${status}, Message:: ${message}`);
-    res.status(status).json({ message });
-  } catch (error) {
-    next(error);
-  }
-};

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

@@ -1,27 +0,0 @@
-import { plainToInstance } from 'class-transformer';
-import { validateOrReject, ValidationError } from 'class-validator';
-import { NextFunction, Request, Response } from 'express';
-import { HttpException } from '@exceptions/httpException';
-
-/**
- * @name ValidationMiddleware
- * @description Allows use of decorator and non-decorator based validation
- * @param type dto
- * @param skipMissingProperties When skipping missing properties
- * @param whitelist Even if your object is an instance of a validation class it can contain additional properties that are not defined
- * @param forbidNonWhitelisted If you would rather to have an error thrown when any non-whitelisted properties are present
- */
-export const ValidationMiddleware = (type: any, skipMissingProperties = false, whitelist = false, forbidNonWhitelisted = false) => {
-  return (req: Request, res: Response, next: NextFunction) => {
-    const dto = plainToInstance(type, req.body);
-    validateOrReject(dto, { skipMissingProperties, whitelist, forbidNonWhitelisted })
-      .then(() => {
-        req.body = dto;
-        next();
-      })
-      .catch((errors: ValidationError[]) => {
-        const message = errors.map((error: ValidationError) => Object.values(error.constraints)).join(', ');
-        next(new HttpException(400, message));
-      });
-  };
-};

package/lib/knex/src/models/users.model.ts

@@ -1,13 +0,0 @@
-import { Model, ModelObject } from 'objection';
-import { User } from '@interfaces/users.interface';
-
-export class UserModel extends Model implements User {
-  id!: number;
-  email!: string;
-  password!: string;
-
-  static tableName = 'users'; // database table name
-  static idColumn = 'id'; // id column name
-}
-
-export type UserShape = ModelObject<UserModel>;

package/lib/knex/src/routes/auth.route.ts

@@ -1,22 +0,0 @@
-import { Router } from 'express';
-import { AuthController } from '@/controllers/auth.controller';
-import { CreateUserDto } from '@dtos/users.dto';
-import { Routes } from '@interfaces/routes.interface';
-import { AuthMiddleware } from '@middlewares/auth.middleware';
-import { ValidationMiddleware } from '@middlewares/validation.middleware';
-
-export class AuthRoute implements Routes {
-  public path = '/';
-  public router = Router();
-  public auth = new AuthController();
-
-  constructor() {
-    this.initializeRoutes();
-  }
-
-  private initializeRoutes() {
-    this.router.post(`${this.path}signup`, ValidationMiddleware(CreateUserDto), this.auth.signUp);
-    this.router.post(`${this.path}login`, ValidationMiddleware(CreateUserDto), this.auth.logIn);
-    this.router.post(`${this.path}logout`, AuthMiddleware, this.auth.logOut);
-  }
-}

package/lib/knex/src/routes/users.route.ts

@@ -1,23 +0,0 @@
-import { Router } from 'express';
-import { UserController } from '@/controllers/users.controller';
-import { CreateUserDto, UpdateUserDto } from '@dtos/users.dto';
-import { Routes } from '@interfaces/routes.interface';
-import { ValidationMiddleware } from '@middlewares/validation.middleware';
-
-export class UserRoute implements Routes {
-  public path = '/users';
-  public router = Router();
-  public user = new UserController();
-
-  constructor() {
-    this.initializeRoutes();
-  }
-
-  private initializeRoutes() {
-    this.router.get(`${this.path}`, this.user.getUsers);
-    this.router.get(`${this.path}/:id(\\d+)`, this.user.getUserById);
-    this.router.post(`${this.path}`, ValidationMiddleware(CreateUserDto), this.user.createUser);
-    this.router.put(`${this.path}/:id(\\d+)`, ValidationMiddleware(UpdateUserDto), this.user.updateUser);
-    this.router.delete(`${this.path}/:id(\\d+)`, this.user.deleteUser);
-  }
-}

package/lib/knex/src/server.ts

@@ -1,10 +0,0 @@
-import { App } from '@/app';
-import { AuthRoute } from '@routes/auth.route';
-import { UserRoute } from '@routes/users.route';
-import { ValidateEnv } from '@utils/validateEnv';
-
-ValidateEnv();
-
-const app = new App([new UserRoute(), new AuthRoute()]);
-
-app.listen();