typescript-express-starter 7.0.0 → 8.0.0

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

@@ -0,0 +1,83 @@
+import bcrypt from 'bcrypt';
+import mongoose from 'mongoose';
+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', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4!',
+      };
+
+      const authRoute = new AuthRoute();
+      const users = authRoute.authController.authService.users;
+
+      users.findOne = jest.fn().mockReturnValue(null);
+      users.create = jest.fn().mockReturnValue({
+        _id: '60706478aad6c9ad19a31c84',
+        email: userData.email,
+        password: await bcrypt.hash(userData.password, 10),
+      });
+
+      (mongoose as any).connect = jest.fn();
+      const app = new App([authRoute]);
+      return request(app.getServer()).post(`${authRoute.path}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 users = authRoute.authController.authService.users;
+
+      users.findOne = jest.fn().mockReturnValue({
+        _id: '60706478aad6c9ad19a31c84',
+        email: userData.email,
+        password: await bcrypt.hash(userData.password, 10),
+      });
+
+      (mongoose as any).connect = jest.fn();
+      const app = new App([authRoute]);
+      return request(app.getServer())
+        .post(`${authRoute.path}login`)
+        .send(userData)
+        .expect('Set-Cookie', /^Authorization=.+/);
+    });
+  });
+
+  // describe('[POST] /logout', () => {
+  //   it('logout Set-Cookie Authorization=; Max-age=0', async () => {
+  //     const userData: User = {
+  //       _id: '60706478aad6c9ad19a31c84',
+  //       email: 'test@email.com',
+  //       password: await bcrypt.hash('q1w2e3r4!', 10),
+  //     };
+
+  //     const authRoute = new AuthRoute();
+  //     const users = authRoute.authController.authService.users;
+
+  //     users.findOne = jest.fn().mockReturnValue(userData);
+
+  //     (mongoose as any).connect = jest.fn();
+  //     const app = new App([authRoute]);
+  //     return request(app.getServer())
+  //       .post(`${authRoute.path}logout`)
+  //       .send(userData)
+  //       .set('Set-Cookie', 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ')
+  //       .expect('Set-Cookie', /^Authorization=\; Max-age=0/);
+  //   });
+  // });
+});

package/lib/typegoose/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/typegoose/src/tests/users.test.ts

@@ -0,0 +1,133 @@
+import bcrypt from 'bcrypt';
+import mongoose from 'mongoose';
+import request from 'supertest';
+import App from '@/app';
+import { CreateUserDto } from '@dtos/users.dto';
+import UsersRoute from '@routes/users.route';
+
+afterAll(async () => {
+  await new Promise<void>(resolve => setTimeout(() => resolve(), 500));
+});
+
+describe('Testing Users', () => {
+  describe('[GET] /users', () => {
+    it('response fineAll Users', async () => {
+      const usersRoute = new UsersRoute();
+      const users = usersRoute.usersController.userService.users;
+
+      users.find = jest.fn().mockReturnValue([
+        {
+          _id: 'qpwoeiruty',
+          email: 'a@email.com',
+          password: await bcrypt.hash('q1w2e3r4!', 10),
+        },
+        {
+          _id: 'alskdjfhg',
+          email: 'b@email.com',
+          password: await bcrypt.hash('a1s2d3f4!', 10),
+        },
+        {
+          _id: 'zmxncbv',
+          email: 'c@email.com',
+          password: await bcrypt.hash('z1x2c3v4!', 10),
+        },
+      ]);
+
+      (mongoose as any).connect = jest.fn();
+      const app = new App([usersRoute]);
+      return request(app.getServer()).get(`${usersRoute.path}`).expect(200);
+    });
+  });
+
+  describe('[GET] /users/:id', () => {
+    it('response findOne User', async () => {
+      const userId = 'qpwoeiruty';
+
+      const usersRoute = new UsersRoute();
+      const users = usersRoute.usersController.userService.users;
+
+      users.findOne = jest.fn().mockReturnValue({
+        _id: 'qpwoeiruty',
+        email: 'a@email.com',
+        password: await bcrypt.hash('q1w2e3r4!', 10),
+      });
+
+      (mongoose as any).connect = jest.fn();
+      const app = new App([usersRoute]);
+      return request(app.getServer()).get(`${usersRoute.path}/${userId}`).expect(200);
+    });
+  });
+
+  describe('[POST] /users', () => {
+    it('response Create User', async () => {
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+
+      const usersRoute = new UsersRoute();
+      const users = usersRoute.usersController.userService.users;
+
+      users.findOne = jest.fn().mockReturnValue(null);
+      users.create = jest.fn().mockReturnValue({
+        _id: '60706478aad6c9ad19a31c84',
+        email: userData.email,
+        password: await bcrypt.hash(userData.password, 10),
+      });
+
+      (mongoose as any).connect = jest.fn();
+      const app = new App([usersRoute]);
+      return request(app.getServer()).post(`${usersRoute.path}`).send(userData).expect(201);
+    });
+  });
+
+  describe('[PUT] /users/:id', () => {
+    it('response Update User', async () => {
+      const userId = '60706478aad6c9ad19a31c84';
+      const userData: CreateUserDto = {
+        email: 'test@email.com',
+        password: 'q1w2e3r4',
+      };
+
+      const usersRoute = new UsersRoute();
+      const users = usersRoute.usersController.userService.users;
+
+      if (userData.email) {
+        users.findOne = jest.fn().mockReturnValue({
+          _id: userId,
+          email: userData.email,
+          password: await bcrypt.hash(userData.password, 10),
+        });
+      }
+
+      users.findByIdAndUpdate = jest.fn().mockReturnValue({
+        _id: userId,
+        email: userData.email,
+        password: await bcrypt.hash(userData.password, 10),
+      });
+
+      (mongoose as any).connect = jest.fn();
+      const app = new App([usersRoute]);
+      return request(app.getServer()).put(`${usersRoute.path}/${userId}`).send(userData);
+    });
+  });
+
+  describe('[DELETE] /users/:id', () => {
+    it('response Delete User', async () => {
+      const userId = '60706478aad6c9ad19a31c84';
+
+      const usersRoute = new UsersRoute();
+      const users = usersRoute.usersController.userService.users;
+
+      users.findByIdAndDelete = jest.fn().mockReturnValue({
+        _id: '60706478aad6c9ad19a31c84',
+        email: 'test@email.com',
+        password: await bcrypt.hash('q1w2e3r4!', 10),
+      });
+
+      (mongoose as any).connect = jest.fn();
+      const app = new App([usersRoute]);
+      return request(app.getServer()).delete(`${usersRoute.path}/${userId}`).expect(200);
+    });
+  });
+});

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

@@ -0,0 +1,65 @@
+import { existsSync, mkdirSync } from 'fs';
+import { join } from 'path';
+import winston from 'winston';
+import winstonDaily from 'winston-daily-rotate-file';
+import { LOG_DIR } from '@config';
+
+// logs dir
+const logDir: string = join(__dirname, 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
+ */
+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()),
+  }),
+);
+
+const stream = {
+  write: (message: string) => {
+    logger.info(message.substring(0, message.lastIndexOf('\n')));
+  },
+};
+
+export { logger, stream };

package/lib/typegoose/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/typegoose/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/typegoose/swagger.yaml

@@ -0,0 +1,122 @@
+tags:
+- name: users
+  description: users API
+
+paths:
+# [GET] users
+  /users:
+    get:
+      tags:
+      - users
+      summary: Find All Users
+      responses:
+        200:
+          description: 'OK'
+        500:
+          description: 'Server Error'
+
+# [POST] users
+    post:
+      tags:
+      - users
+      summary: Add User
+      parameters:
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        201:
+          description: 'Created'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [GET] users/id
+  /users/{id}:
+    get:
+      tags:
+      - users
+      summary: Find User By Id
+      parameters:
+      - name: id
+        in: path
+        description: User Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [PUT] users/id
+    put:
+      tags:
+      - users
+      summary: Update User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      - name: body
+        in: body
+        description: user Data
+        required: true
+        schema:
+          $ref: '#/definitions/users'
+      responses:
+        200:
+          description: 'OK'
+        400:
+          description: 'Bad Request'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# [DELETE] users/id
+    delete:
+      tags:
+      - users
+      summary: Delete User By Id
+      parameters:
+      - name: id
+        in: path
+        description: user Id
+        required: true
+      responses:
+        200:
+          description: 'OK'
+        409:
+          description: 'Conflict'
+        500:
+          description: 'Server Error'
+
+# definitions
+definitions:
+  users:
+    type: object
+    required:
+        - email
+        - password
+    properties:
+      id:
+        description: user Id
+      email:
+        type: string
+        description: user Email
+      password:
+        type: string
+        description: user Password
+
+schemes:
+ - https
+ - http

package/lib/typegoose/tsconfig.json

@@ -0,0 +1,40 @@
+{
+  "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": {
+      "@/*": ["*"],
+      "@config": ["config"],
+      "@controllers/*": ["controllers/*"],
+      "@databases": ["databases"],
+      "@dtos/*": ["dtos/*"],
+      "@exceptions/*": ["exceptions/*"],
+      "@interfaces/*": ["interfaces/*"],
+      "@middlewares/*": ["middlewares/*"],
+      "@models/*": ["models/*"],
+      "@routes/*": ["routes/*"],
+      "@services/*": ["services/*"],
+      "@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": "7.0.0",
+  "version": "8.0.0",
   "description": "Quick and Easy TypeScript Express Starter",
   "author": "AGUMON <ljlm0402@gmail.com>",
   "license": "MIT",
@@ -11,6 +11,7 @@
     "routing-controllers-openapi",
     "sequelize",
     "mongoose",
+    "typegoose",
     "typeorm",
     "knex",
     "prisma",