typescript-express-starter 6.3.0 → 7.0.0

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

@@ -1,6 +1,6 @@
 {
   "name": "typescript-express-starter",
-  "version": "6.3.0",
+  "version": "7.0.0",
   "description": "Quick and Easy TypeScript Express Starter",
   "author": "AGUMON <ljlm0402@gmail.com>",
   "license": "MIT",
@@ -14,6 +14,8 @@
     "typeorm",
     "knex",
     "prisma",
+    "graphql",
+    "apollo",
     "jest",
     "nodemon",
     "jsonwebtoken",