typescript-express-starter 10.2.1 → 11.0.0

package/lib/graphql/package.json

@@ -1,75 +0,0 @@
-{
-  "name": "typescript-express-starter",
-  "version": "0.0.0",
-  "description": "TypeScript + GraphQL + TypeORM + PostgreSQL + 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",
-    "deploy:prod": "npm run build && pm2 start ecosystem.config.js --only prod",
-    "deploy:dev": "pm2 start ecosystem.config.js --only dev"
-  },
-  "dependencies": {
-    "apollo-server-core": "^3.10.0",
-    "apollo-server-express": "^3.10.0",
-    "bcrypt": "^5.0.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",
-    "graphql": "^15.8.0",
-    "helmet": "^5.1.1",
-    "hpp": "^0.2.3",
-    "jsonwebtoken": "^8.5.1",
-    "pg": "^8.7.3",
-    "reflect-metadata": "^0.1.13",
-    "type-graphql": "^1.1.1",
-    "typedi": "^0.10.0",
-    "typeorm": "^0.2.45",
-    "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/node": "^17.0.45",
-    "@types/supertest": "^2.0.12",
-    "@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/graphql/src/app.ts

@@ -1,107 +0,0 @@
-import 'reflect-metadata';
-import { ApolloServerPluginLandingPageProductionDefault, ApolloServerPluginLandingPageLocalDefault } from 'apollo-server-core';
-import { ApolloServer } from 'apollo-server-express';
-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 { buildSchema } from 'type-graphql';
-import { NODE_ENV, PORT, ORIGIN, CREDENTIALS } from '@config';
-import { dbConnection } from '@database';
-import { AuthMiddleware, AuthCheckerMiddleware } from '@middlewares/auth.middleware';
-import { ErrorMiddleware } from '@middlewares/error.middleware';
-import { logger, responseLogger, errorLogger } from '@utils/logger';
-
-export class App {
-  public app: express.Application;
-  public env: string;
-  public port: string | number;
-
-  constructor(resolvers) {
-    this.app = express();
-    this.env = NODE_ENV || 'development';
-    this.port = PORT || 3000;
-
-    this.connectToDatabase();
-    this.initializeMiddlewares();
-    this.initApolloServer(resolvers);
-    this.initializeErrorHandling();
-  }
-
-  public async listen() {
-    this.app.listen(this.port, () => {
-      logger.info(`=================================`);
-      logger.info(`======= ENV: ${this.env} =======`);
-      logger.info(`🚀 App listening on the port ${this.port}`);
-      logger.info(`🎮 http://localhost:${this.port}/graphql`);
-      logger.info(`=================================`);
-    });
-  }
-
-  public getServer() {
-    return this.app;
-  }
-
-  private async connectToDatabase() {
-    await dbConnection();
-  }
-
-  private initializeMiddlewares() {
-    if (this.env === 'production') {
-      this.app.use(hpp());
-      this.app.use(helmet());
-    }
-
-    this.app.use(cors({ origin: ORIGIN, credentials: CREDENTIALS }));
-    this.app.use(compression());
-    this.app.use(express.json());
-    this.app.use(express.urlencoded({ extended: true }));
-    this.app.use(cookieParser());
-  }
-
-  private async initApolloServer(resolvers) {
-    const schema = await buildSchema({
-      resolvers: resolvers,
-      authChecker: AuthCheckerMiddleware,
-    });
-
-    const apolloServer = new ApolloServer({
-      schema: schema,
-      plugins: [
-        this.env === 'production'
-          ? ApolloServerPluginLandingPageProductionDefault({ footer: false })
-          : ApolloServerPluginLandingPageLocalDefault({ footer: false }),
-      ],
-      context: async ({ req }) => {
-        try {
-          const user = await AuthMiddleware(req);
-          return { user };
-        } catch (error) {
-          throw new Error(error);
-        }
-      },
-      formatResponse: (response, request) => {
-        responseLogger(request);
-
-        return response;
-      },
-      formatError: error => {
-        try {
-          errorLogger(error);
-          return error;
-        } catch (err) {
-          return new Error(err);
-        }
-      },
-    });
-
-    await apolloServer.start();
-    apolloServer.applyMiddleware({ app: this.app, cors: false, path: '/graphql' });
-  }
-
-  private initializeErrorHandling() {
-    this.app.use(ErrorMiddleware);
-  }
-}

package/lib/graphql/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 { POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_HOST, POSTGRES_PORT, POSTGRES_DB } = process.env;

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

@@ -1,26 +0,0 @@
-import { join } from 'path';
-import { createConnection, ConnectionOptions } from 'typeorm';
-import { POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_HOST, POSTGRES_PORT, POSTGRES_DB } from '@config';
-
-export const dbConnection = async () => {
-  const dbConfig: ConnectionOptions = {
-    type: 'postgres',
-    username: POSTGRES_USER,
-    password: POSTGRES_PASSWORD,
-    host: POSTGRES_HOST,
-    port: Number(POSTGRES_PORT),
-    database: POSTGRES_DB,
-    synchronize: true,
-    logging: false,
-    entities: [join(__dirname, '../**/*.entity{.ts,.js}')],
-    migrations: [join(__dirname, '../**/*.migration{.ts,.js}')],
-    subscribers: [join(__dirname, '../**/*.subscriber{.ts,.js}')],
-    cli: {
-      entitiesDir: 'src/entities',
-      migrationsDir: 'src/migration',
-      subscribersDir: 'src/subscriber',
-    },
-  };
-
-  await createConnection(dbConfig);
-}

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

@@ -1,27 +0,0 @@
-import { IsEmail, IsString, IsNotEmpty, MinLength, MaxLength } from 'class-validator';
-import { InputType, Field } from 'type-graphql';
-import { User } from '@typedefs/users.type';
-
-@InputType()
-export class CreateUserDto implements Partial<User> {
-  @Field()
-  @IsEmail()
-  email: string;
-
-  @Field()
-  @IsString()
-  @IsNotEmpty()
-  @MinLength(9)
-  @MaxLength(32)
-  password: string;
-}
-
-@InputType()
-export class UpdateUserDto implements Partial<User> {
-  @Field()
-  @IsString()
-  @IsNotEmpty()
-  @MinLength(9)
-  @MaxLength(32)
-  password: string;
-}

package/lib/graphql/src/entities/users.entity.ts

@@ -1,26 +0,0 @@
-import { IsNotEmpty } from 'class-validator';
-import { BaseEntity, Entity, PrimaryGeneratedColumn, Column, Unique, CreateDateColumn, UpdateDateColumn } from 'typeorm';
-import { User } from '@interfaces/users.interface';
-
-@Entity()
-export class UserEntity extends BaseEntity implements User {
-  @PrimaryGeneratedColumn()
-  id: number;
-
-  @Column()
-  @IsNotEmpty()
-  @Unique(['email'])
-  email: string;
-
-  @Column()
-  @IsNotEmpty()
-  password: string;
-
-  @Column()
-  @CreateDateColumn()
-  createdAt: Date;
-
-  @Column()
-  @UpdateDateColumn()
-  updatedAt: Date;
-}

package/lib/graphql/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/graphql/src/http/auth.http

@@ -1,49 +0,0 @@
-# baseURL
-@baseURL = http://localhost:3000/graphql
-
-###
-# User Signup
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-
-mutation {
-    signup (userData: {
-        email: "example@email.com",
-        password: "password"
-    }) {
-        id,
-        email,
-        password
-    }
-}
-
-###
-# User Login
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-
-mutation {
-    login (userData: {
-        email: "example@email.com",
-        password: "password"
-    }) {
-        email,
-        password
-    }
-}
-
-###
-# User Logout
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MiwiaWF0IjoxNjM5MDQ3MjM3LCJleHAiOjE2MzkwNTA4Mzd9.HD0AvZl1s-mycKxo0IJ1QT-oSKhjeArXrlNBffZUanY;
-
-mutation {
-    logout {
-        email,
-        password
-    }
-}

package/lib/graphql/src/http/users.http

@@ -1,78 +0,0 @@
-# baseURL
-@baseURL = http://localhost:3000/graphql
-
-###
-# Find All Users
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-
-query {
-    getUsers {
-        id,
-        email,
-        password
-    }
-}
-
-###
-# Find User By Id
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-
-query {
-    getUserById(userId: 1) {
-        id,
-        email,
-        password
-    }
-}
-
-###
-# Create User
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-
-mutation {
-    createUser (userData: {
-        email: "example@email.com",
-        password: "password"
-    }) {
-        id,
-        email,
-        password
-    }
-}
-
-###
-# Modify User By Id
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-
-mutation {
-    updateUser (userId: 1, userData: {
-        email: "example@email.com",
-        password: "password"
-    }) {
-        id,
-        email,
-        password
-    }
-}
-
-###
-# Delete User By Id
-POST {{ baseURL }}
-Content-Type: application/json
-X-REQUEST-TYPE: GraphQL
-
-mutation {
-    deleteUser (userId: 1) {
-        id,
-        email,
-        password
-    }
-}

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

@@ -1,14 +0,0 @@
-import { User } from '@interfaces/users.interface';
-
-export interface DataStoredInToken {
-  id: number;
-}
-
-export interface TokenData {
-  token: string;
-  expiresIn: number;
-}
-
-export interface RequestWithUser {
-  user: User;
-}

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

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

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

@@ -1,42 +0,0 @@
-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';
-
-const getAuthorization = req => {
-  const cookie = req.cookies['Authorization'];
-  if (cookie) return cookie;
-
-  const header = req.header('Authorization');
-  if (header) return header.split('Bearer ')[1];
-
-  return null;
-};
-
-export const AuthMiddleware = async req => {
-  try {
-    const Authorization = getAuthorization(req);
-
-    if (Authorization) {
-      const { id } = verify(Authorization, SECRET_KEY) as DataStoredInToken;
-      const userRepository = getRepository(UserEntity);
-      const findUser = await userRepository.findOne(id, { select: ['id', 'email', 'password'] });
-      return findUser;
-    }
-
-    return null;
-  } catch (error) {
-    throw new HttpException(401, 'Wrong authentication token');
-  }
-};
-
-export const AuthCheckerMiddleware: AuthChecker<RequestWithUser> = async ({ context: { user } }) => {
-  if (!user) {
-    throw new HttpException(404, 'Authentication token missing');
-  }
-
-  return true;
-};

package/lib/graphql/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/graphql/src/repositories/auth.repository.ts

@@ -1,53 +0,0 @@
-import { hash, compare } from 'bcrypt';
-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';
-import { DataStoredInToken, TokenData } from '@interfaces/auth.interface';
-import { User } from '@interfaces/users.interface';
-
-const createToken = (user: User): TokenData => {
-  const dataStoredInToken: DataStoredInToken = { id: user.id };
-  const expiresIn: number = 60 * 60;
-
-  return { expiresIn, token: sign(dataStoredInToken, SECRET_KEY, { expiresIn }) };
-};
-
-const createCookie = (tokenData: TokenData): string => {
-  return `Authorization=${tokenData.token}; HttpOnly; Max-Age=${tokenData.expiresIn};`;
-};
-
-@EntityRepository(UserEntity)
-export class AuthRepository {
-  public async userSignUp(userData: CreateUserDto): Promise<User> {
-    const findUser: User = await UserEntity.findOne({ where: { email: userData.email } });
-    if (findUser) throw new HttpException(409, `This email ${userData.email} already exists`);
-
-    const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await UserEntity.create({ ...userData, password: hashedPassword }).save();
-
-    return createUserData;
-  }
-
-  public async userLogIn(userData: CreateUserDto): Promise<{ cookie: string; findUser: User }> {
-    const findUser: User = await UserEntity.findOne({ where: { email: userData.email } });
-    if (!findUser) throw new HttpException(409, `This email ${userData.email} was not found`);
-
-    const isPasswordMatching: boolean = await compare(userData.password, findUser.password);
-    if (!isPasswordMatching) throw new HttpException(409, 'Password is not matching');
-
-    const tokenData = createToken(findUser);
-    const cookie = createCookie(tokenData);
-
-    return { cookie, findUser };
-  }
-
-  public async userLogOut(userId: number): Promise<User> {
-    const findUser: User = await UserEntity.findOne({ where: { id: userId } });
-    if (!findUser) throw new HttpException(409, "User doesn't exist");
-
-    return findUser;
-  }
-}

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

@@ -1,51 +0,0 @@
-import { hash } from 'bcrypt';
-import { EntityRepository } from 'typeorm';
-import { CreateUserDto, UpdateUserDto } from '@dtos/users.dto';
-import { UserEntity } from '@entities/users.entity';
-import { HttpException } from '@exceptions/httpException';
-import { User } from '@interfaces/users.interface';
-
-@EntityRepository(UserEntity)
-export class UserRepository {
-  public async userFindAll(): Promise<User[]> {
-    const users: User[] = await UserEntity.find();
-
-    return users;
-  }
-
-  public async userFindById(userId: number): Promise<User> {
-    const user: User = await UserEntity.findOne({ where: { id: userId } });
-    if (!user) throw new HttpException(409, "User doesn't exist");
-
-    return user;
-  }
-
-  public async userCreate(userData: CreateUserDto): Promise<User> {
-    const findUser: User = await UserEntity.findOne({ where: { email: userData.email } });
-    if (findUser) throw new HttpException(409, `This email ${userData.email} already exists`);
-
-    const hashedPassword = await hash(userData.password, 10);
-    const createUserData: User = await UserEntity.create({ ...userData, password: hashedPassword }).save();
-
-    return createUserData;
-  }
-
-  public async userUpdate(userId: number, userData: UpdateUserDto): Promise<User> {
-    const findUser: User = await UserEntity.findOne({ where: { id: userId } });
-    if (!findUser) throw new HttpException(409, "User doesn't exist");
-
-    const hashedPassword = await hash(userData.password, 10);
-    await UserEntity.update(userId, { ...userData, password: hashedPassword });
-
-    const updateUser: User = await UserEntity.findOne({ where: { id: userId } });
-    return updateUser;
-  }
-
-  public async userDelete(userId: number): Promise<User> {
-    const findUser: User = await UserEntity.findOne({ where: { id: userId } });
-    if (!findUser) throw new HttpException(409, "User doesn't exist");
-
-    await UserEntity.delete({ id: userId });
-    return findUser;
-  }
-}

package/lib/graphql/src/resolvers/auth.resolver.ts

@@ -1,32 +0,0 @@
-import { Authorized, Arg, Ctx, Mutation, Resolver } from 'type-graphql';
-import { CreateUserDto } from '@dtos/users.dto';
-import { AuthRepository } from '@repositories/auth.repository';
-import { User } from '@typedefs/users.type';
-
-@Resolver()
-export class AuthResolver extends AuthRepository {
-  @Mutation(() => User, {
-    description: 'User signup',
-  })
-  async signup(@Arg('userData') userData: CreateUserDto): Promise<User> {
-    const user: User = await this.userSignUp(userData);
-    return user;
-  }
-
-  @Mutation(() => User, {
-    description: 'User login',
-  })
-  async login(@Arg('userData') userData: CreateUserDto): Promise<User> {
-    const { findUser } = await this.userLogIn(userData);
-    return findUser;
-  }
-
-  @Authorized()
-  @Mutation(() => User, {
-    description: 'User logout',
-  })
-  async logout(@Ctx('user') userData: any): Promise<User> {
-    const user = await this.userLogOut(userData);
-    return user;
-  }
-}

package/lib/graphql/src/resolvers/users.resolver.ts

@@ -1,47 +0,0 @@
-import { Arg, Mutation, Query, Resolver } from 'type-graphql';
-import { CreateUserDto, UpdateUserDto } from '@dtos/users.dto';
-import { UserRepository } from '@repositories/users.repository';
-import { User } from '@typedefs/users.type';
-
-@Resolver()
-export class UserResolver extends UserRepository {
-  @Query(() => [User], {
-    description: 'User find list',
-  })
-  async getUsers(): Promise<User[]> {
-    const users: User[] = await this.userFindAll();
-    return users;
-  }
-
-  @Query(() => User, {
-    description: 'User find by id',
-  })
-  async getUserById(@Arg('userId') userId: number): Promise<User> {
-    const user: User = await this.userFindById(userId);
-    return user;
-  }
-
-  @Mutation(() => User, {
-    description: 'User create',
-  })
-  async createUser(@Arg('userData') userData: CreateUserDto): Promise<User> {
-    const user: User = await this.userCreate(userData);
-    return user;
-  }
-
-  @Mutation(() => User, {
-    description: 'User update',
-  })
-  async updateUser(@Arg('userId') userId: number, @Arg('userData') userData: UpdateUserDto): Promise<User> {
-    const user: User = await this.userUpdate(userId, userData);
-    return user;
-  }
-
-  @Mutation(() => User, {
-    description: 'User delete',
-  })
-  async deleteUser(@Arg('userId') userId: number): Promise<User> {
-    const user: User = await this.userDelete(userId);
-    return user;
-  }
-}