typescript-express-starter 6.1.0 → 7.0.0

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

@@ -0,0 +1,78 @@
+# 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/index.ts

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

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

@@ -0,0 +1,14 @@
+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/db.interface.ts

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

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

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

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

@@ -0,0 +1,32 @@
+import config from 'config';
+import { verify } from 'jsonwebtoken';
+import { AuthChecker } from 'type-graphql';
+import { getRepository } from 'typeorm';
+import { UserEntity } from '@entities/users.entity';
+import { HttpException } from '@exceptions/HttpException';
+import { RequestWithUser, DataStoredInToken } from '@interfaces/auth.interface';
+
+export const authMiddleware = async req => {
+  try {
+    const Authorization = req.cookies['Authorization'] || (req.header('Authorization') ? req.header('Authorization').split('Bearer ')[1] : null);
+    if (Authorization) {
+      const secretKey: string = config.get('secretKey');
+      const { id } = (await verify(Authorization, secretKey)) 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 authChecker: AuthChecker<RequestWithUser> = async ({ context: { user } }) => {
+  if (!user) {
+    throw new HttpException(404, 'Authentication token missing');
+  }
+
+  return true;
+};

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

@@ -0,0 +1,17 @@
+import { NextFunction, Request, Response } from 'express';
+import { HttpException } from '@exceptions/HttpException';
+import { logger } from '@utils/logger';
+
+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);
+  }
+};
+
+export default errorMiddleware;

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

@@ -0,0 +1,61 @@
+import { hash, compare } from 'bcrypt';
+import config from 'config';
+import { sign } from 'jsonwebtoken';
+import { EntityRepository } from 'typeorm';
+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';
+import { isEmpty } from '@utils/util';
+
+@EntityRepository(UserEntity)
+export default class AuthRepository {
+  public async userSignUp(userData: CreateUserDto): Promise<User> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await UserEntity.findOne({ where: { email: userData.email } });
+    if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
+
+    const hashedPassword = await hash(userData.password, 10);
+    const createUserData: User = await UserEntity.save({ ...userData, password: hashedPassword });
+
+    return createUserData;
+  }
+
+  public async userLogIn(userData: CreateUserDto): Promise<{ cookie: string; findUser: User }> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await UserEntity.findOne({ where: { email: userData.email } });
+    if (!findUser) throw new HttpException(409, `You're email ${userData.email} not found`);
+
+    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);
+    const cookie = this.createCookie(tokenData);
+
+    return { cookie, findUser };
+  }
+
+  public async userLogOut(userId: number): Promise<User> {
+    if (isEmpty(userId)) throw new HttpException(400, "You're not userId");
+
+    const findUser: User = await UserEntity.findOne({ where: { id: userId } });
+    if (!findUser) throw new HttpException(409, "You're not user");
+
+    return findUser;
+  }
+
+  public createToken(user: User): TokenData {
+    const dataStoredInToken: DataStoredInToken = { id: user.id };
+    const secretKey: string = config.get('secretKey');
+    const expiresIn: number = 60 * 60;
+
+    return { expiresIn, token: sign(dataStoredInToken, secretKey, { expiresIn }) };
+  }
+
+  public createCookie(tokenData: TokenData): string {
+    return `Authorization=${tokenData.token}; HttpOnly; Max-Age=${tokenData.expiresIn};`;
+  }
+}

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

@@ -0,0 +1,60 @@
+import { hash } from 'bcrypt';
+import { EntityRepository } from 'typeorm';
+import { CreateUserDto } from '@dtos/users.dto';
+import { UserEntity } from '@entities/users.entity';
+import { HttpException } from '@exceptions/HttpException';
+import { User } from '@interfaces/users.interface';
+import { isEmpty } from '@utils/util';
+
+@EntityRepository()
+export default class UserRepository {
+  public async userFindAll(): Promise<User[]> {
+    const users: User[] = await UserEntity.find();
+
+    return users;
+  }
+
+  public async userFindById(userId: number): Promise<User> {
+    if (isEmpty(userId)) throw new HttpException(400, "You're not userId");
+
+    const user: User = await UserEntity.findOne({ where: { id: userId } });
+    if (!user) throw new HttpException(409, "You're not user");
+
+    return user;
+  }
+
+  public async userCreate(userData: CreateUserDto): Promise<User> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await UserEntity.findOne({ where: { email: userData.email } });
+    if (findUser) throw new HttpException(409, `You're email ${userData.email} already exists`);
+
+    const hashedPassword = await hash(userData.password, 10);
+    const createUserData: User = await UserEntity.save({ ...userData, password: hashedPassword });
+
+    return createUserData;
+  }
+
+  public async userUpdate(userId: number, userData: CreateUserDto): Promise<User> {
+    if (isEmpty(userData)) throw new HttpException(400, "You're not userData");
+
+    const findUser: User = await UserEntity.findOne({ where: { id: userId } });
+    if (!findUser) throw new HttpException(409, "You're not user");
+
+    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> {
+    if (isEmpty(userId)) throw new HttpException(400, "You're not userId");
+
+    const findUser: User = await UserEntity.findOne({ where: { id: userId } });
+    if (!findUser) throw new HttpException(409, "You're not user");
+
+    await UserEntity.delete({ id: userId });
+    return findUser;
+  }
+}

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

@@ -0,0 +1,32 @@
+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

@@ -0,0 +1,47 @@
+import { Arg, Mutation, Query, Resolver } from 'type-graphql';
+import { CreateUserDto } 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: CreateUserDto): 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;
+  }
+}

package/lib/graphql/src/server.ts

@@ -0,0 +1,14 @@
+import 'reflect-metadata';
+import 'dotenv/config';
+import '@/index';
+import App from '@/app';
+import validateEnv from '@utils/validateEnv';
+
+import { authResolver } from '@resolvers/auth.resolver';
+import { userResolver } from '@resolvers/users.resolver';
+
+validateEnv();
+
+const app = new App([authResolver, userResolver]);
+
+app.listen();

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;