Merge pull request #1 from masb0ymas/master

merge from fork

Author: chornos13

README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Welcome to boilerplate-express-typescript-sequelize 👋</h1>
 <p>
-  <img alt="Version" src="https://img.shields.io/badge/version-1.2.2-blue.svg?cacheSeconds=2592000" />
+  <img alt="Version" src="https://img.shields.io/badge/version-2.0.0-blue.svg?cacheSeconds=2592000" />
   <img src="https://img.shields.io/badge/npm-%3E%3D6.10.0-blue.svg" />
   <img src="https://img.shields.io/badge/node-%3E%3D10.x-blue.svg" />
   <a href="https://github.com/masb0ymas/boilerplate-express-typescript-sequelize#readme" target="_blank">

package.json

@@ -1,6 +1,6 @@
 {
   "name": "boilerplate-express-typescript",
-  "version": "1.2.2",
+  "version": "2.0.0",
   "description": "Just Boilerplate Express with TypeScript ( 🦊 )",
   "private": true,
   "scripts": {
@@ -69,16 +69,16 @@
     "yup": "^0.29.3"
   },
   "devDependencies": {
-    "@babel/cli": "^7.11.6",
-    "@babel/core": "^7.11.6",
-    "@babel/node": "^7.10.4",
-    "@babel/plugin-proposal-class-properties": "^7.8.3",
-    "@babel/plugin-proposal-object-rest-spread": "^7.11.0",
+    "@babel/cli": "^7.12.1",
+    "@babel/core": "^7.12.3",
+    "@babel/node": "^7.12.1",
+    "@babel/plugin-proposal-class-properties": "^7.12.1",
+    "@babel/plugin-proposal-object-rest-spread": "^7.12.1",
     "@babel/plugin-transform-runtime": "^7.11.5",
-    "@babel/preset-env": "^7.11.5",
-    "@babel/preset-typescript": "^7.8.3",
-    "@babel/register": "^7.11.5",
-    "@babel/runtime": "^7.11.2",
+    "@babel/preset-env": "^7.12.1",
+    "@babel/preset-typescript": "^7.12.1",
+    "@babel/register": "^7.12.1",
+    "@babel/runtime": "^7.12.1",
     "@types/bcrypt": "^3.0.0",
     "@types/body-parser": "^1.19.0",
     "@types/cors": "^2.8.8",
@@ -89,7 +89,7 @@
     "@types/jsonwebtoken": "^8.3.7",
     "@types/lodash": "^4.14.162",
     "@types/multer": "^1.4.4",
-    "@types/node": "^14.11.8",
+    "@types/node": "^14.11.10",
     "@types/nodemailer": "^6.4.0",
     "@types/nodemailer-mailgun-transport": "^1.4.1",
     "@types/passport": "^1.0.2",
@@ -105,7 +105,7 @@
     "babel-plugin-module-resolver": "^4.0.0",
     "eslint": "^7.11.0",
     "eslint-config-airbnb-base": "^14.0.0",
-    "eslint-config-prettier": "^6.12.0",
+    "eslint-config-prettier": "^6.13.0",
     "eslint-import-resolver-babel-module": "^5.1.2",
     "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-prettier": "^3.1.4",

src/controllers/Auth/controller.ts

@@ -20,11 +20,9 @@ routes.post(
   '/auth/sign-in',
   asyncHandler(async function signIn(req: Request, res: Response) {
     const formData = req.getBody()
-    const { token, expiresIn, tokenType, uid } = await AuthService.signIn(
-      formData
-    )
+    const { token, expiresIn, tokenType } = await AuthService.signIn(formData)
 
-    return res.status(200).json({ token, expiresIn, tokenType, uid })
+    return res.status(200).json({ token, expiresIn, tokenType })
   })
 )
 

src/controllers/Auth/service.ts

@@ -2,7 +2,6 @@
 import path from 'path'
 import models from 'models'
 import jwt from 'jsonwebtoken'
-import { Request } from 'express'
 import { isObject } from 'lodash'
 import handlebars from 'handlebars'
 import EmailProvider from 'config/email'

src/controllers/Role/controller.ts

@@ -1,5 +1,4 @@
 /* eslint-disable no-unused-vars */
-import { FilterQueryAttributes } from 'models'
 import { Request, Response } from 'express'
 import routes from 'routes/public'
 import asyncHandler from 'helpers/asyncHandler'
@@ -13,20 +12,7 @@ const keyGetAll = `${APP_KEY_REDIS}_role:getAll`
 routes.get(
   '/role',
   asyncHandler(async function getAll(req: Request, res: Response) {
-    const {
-      page,
-      pageSize,
-      filtered,
-      sorted,
-    }: FilterQueryAttributes = req.getQuery()
-
-    const { data, total } = await RoleService.getAll(
-      page,
-      pageSize,
-      filtered,
-      sorted
-    )
-
+    const { data, total } = await RoleService.getAll(req)
     return res.status(200).json({ data, total })
   })
 )

src/controllers/Role/service.ts

@@ -1,10 +1,9 @@
 /* eslint-disable no-unused-vars */
-/* eslint-disable no-param-reassign */
 import models from 'models'
-import { filterQueryObject } from 'helpers/Common'
 import ResponseError from 'modules/ResponseError'
 import useValidation from 'helpers/useValidation'
 import { RoleAttributes } from 'models/role'
+import PluginSqlizeQuery from 'modules/SqlizeQuery/PluginSqlizeQuery'
 import schema from './schema'
 
 const { Role } = models
@@ -13,25 +12,20 @@ class RoleService {
   /**
    * Get All Role
    */
-  public static async getAll(
-    page: string | number,
-    pageSize: string | number,
-    filtered: string,
-    sorted: string
-  ) {
-    if (!page) page = 0
-    if (!pageSize) pageSize = 10
-
-    const filterObject = filtered ? filterQueryObject(JSON.parse(filtered)) : []
+  public static async getAll(req: any) {
+    const { includeCount, order, ...queryFind } = PluginSqlizeQuery.generate(
+      req,
+      Role,
+      []
+    )
 
     const data = await Role.findAll({
-      where: filterObject,
-      offset: Number(pageSize) * Number(page),
-      limit: Number(pageSize),
-      order: [['createdAt', 'desc']],
+      ...queryFind,
+      order: order.length ? order : [['createdAt', 'desc']],
     })
     const total = await Role.count({
-      where: filterObject,
+      include: includeCount,
+      where: queryFind.where,
     })
 
     return { data, total }

src/controllers/User/service.ts

@@ -5,7 +5,6 @@ import db from 'models/_instance'
 import ResponseError from 'modules/ResponseError'
 import useValidation from 'helpers/useValidation'
 import { UserAttributes } from 'models/user'
-import UserRole from 'models/userrole'
 import { Transaction } from 'sequelize/types'
 import UserRoleService from 'controllers/UserRole/service'
 import PluginSqlizeQuery from 'modules/SqlizeQuery/PluginSqlizeQuery'
@@ -14,7 +13,7 @@ import schema from './schema'
 const { Sequelize } = db
 const { Op } = Sequelize
 
-const { User, Role } = models
+const { User, Role, UserRole } = models
 const including = [{ model: Role }]
 
 class UserService {

src/helpers/Common.ts

@@ -1,7 +1,6 @@
 /* eslint-disable no-unused-vars */
 import fs from 'fs'
 import db from 'models/_instance'
-import { FilterAttributes } from 'models'
 
 const { Sequelize } = db
 const { Op } = Sequelize
@@ -19,26 +18,6 @@ function getUniqueCodev2(length = 32) {
   return result
 }
 
-// Filter Query Object
-function filterQueryObject(filtered: FilterAttributes[]) {
-  const resultObject = {}
-  if (typeof filtered !== 'object') {
-    throw new Error(`Filtered must be an object, expected ${typeof filtered}`)
-  }
-
-  for (let i = 0; i < filtered.length; i += 1) {
-    // eslint-disable-next-line prefer-const
-    let { id, value } = filtered[i]
-    if (id.split('.').length > 1) {
-      id = `$${id}$`
-    }
-    // @ts-ignore
-    resultObject[id] = { [Op.like]: `%${value}%` }
-  }
-
-  return resultObject
-}
-
 // Read HTML File
 function readHTMLFile(path: any, callback: any) {
   fs.readFile(path, { encoding: 'utf-8' }, function (err, html) {
@@ -50,4 +29,4 @@ function readHTMLFile(path: any, callback: any) {
   })
 }
 
-export { getUniqueCodev2, readHTMLFile, filterQueryObject, invalidValues }
+export { getUniqueCodev2, readHTMLFile, invalidValues }

src/models/index.ts

@@ -2,23 +2,6 @@ import Role from './role'
 import User from './user'
 import UserRole from './userrole'
 
-export interface FilterAttributes {
-  id: string
-  value: string
-}
-
-export interface SortAttributes {
-  id: string
-  desc: string
-}
-
-export interface FilterQueryAttributes {
-  page: string | number
-  pageSize: string | number
-  filtered: string
-  sorted: string
-}
-
 const models = {
   Role,
   User,

src/modules/SqlizeQuery/PluginSqlizeQuery.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-unused-vars */
 import SqlizeQuery from 'modules/SqlizeQuery/index'
 import {
   getPrimitiveDataType,

src/modules/SqlizeQuery/QueryHelper.ts

@@ -0,0 +1,32 @@
+class QueryHelper {
+  private valueQuery: any = {}
+
+  private data: any[]
+
+  constructor(data: any[]) {
+    this.data = data
+  }
+
+  getDataValueById(id: any) {
+    return this.data.find((x) => x.id === id)?.value
+  }
+
+  setQuery(id: any, value: any) {
+    // set(this.valueQuery, id, value)
+    this.valueQuery[id] = value
+  }
+
+  getQuery() {
+    return this.valueQuery
+  }
+
+  getQueryById(id: any) {
+    return this.valueQuery[id]
+  }
+
+  deleteQuery(id: any) {
+    return delete this.valueQuery[id]
+  }
+}
+
+export default QueryHelper

src/modules/SqlizeQuery/SqlizeQuery.ts

@@ -1,4 +1,7 @@
+/* eslint-disable no-unused-vars */
 import { DataTypes, Includeable, IncludeOptions, Model } from 'sequelize'
+import QueryHelper from 'modules/SqlizeQuery/QueryHelper'
+import TransformHelper from 'modules/SqlizeQuery/TransformHelper'
 
 type ValueParsers = (value: any) => any
 type TransformBuild = (value: any, transformHelper: TransformHelper) => any
@@ -80,54 +83,11 @@ export function getPrimitiveDataType<T>(dataType: T) {
   return 'string'
 }
 
-class TransformHelper<T = any> {
-  private value: T | undefined
-
-  constructor(initialValue: any) {
-    this.setValue(initialValue)
-  }
-
-  setValue(value: any) {
-    this.value = value
-  }
-
-  getValue() {
-    return this.value
-  }
-}
-
-class QueryHelper {
-  private valueQuery: any = {}
-  private data: any[]
-  constructor(data: any[]) {
-    this.data = data
-  }
-
-  getDataValueById(id: any) {
-    return this.data.find((x) => x.id === id)?.value
-  }
-
-  setQuery(id: any, value: any) {
-    // set(this.valueQuery, id, value)
-    this.valueQuery[id] = value
-  }
-
-  getQuery() {
-    return this.valueQuery
-  }
-
-  getQueryById(id: any) {
-    return this.valueQuery[id]
-  }
-
-  deleteQuery(id: any) {
-    return delete this.valueQuery[id]
-  }
-}
-
 class SqlizeQuery {
   private valueParsers: ValueParsers[] = []
+
   private transformBuilds: TransformBuild[] = []
+
   private queryBuilders: QueryBuilders[] = []
 
   addValueParser(fn: ValueParsers) {
@@ -144,24 +104,24 @@ class SqlizeQuery {
 
   build(value: any) {
     let parserValue = value as any[]
-    for (let i = 0; i < this.valueParsers.length; i++) {
+    for (let i = 0; i < this.valueParsers.length; i += 1) {
       const getterValue = this.valueParsers[i]
       parserValue = getterValue(value)
     }
 
     const queryHelper = new QueryHelper(parserValue)
     // executed queryBuilder min 1, when parserValue no data
-    for (let i = 0; i < (parserValue.length || 1); i++) {
+    for (let i = 0; i < (parserValue.length || 1); i += 1) {
       const valueP = parserValue[i]
-      for (let k = 0; k < this.queryBuilders.length; k++) {
+      for (let k = 0; k < this.queryBuilders.length; k += 1) {
         const queryBuilder = this.queryBuilders[k]
         queryBuilder(valueP, queryHelper)
       }
     }
 
-    let result = queryHelper.getQuery()
+    const result = queryHelper.getQuery()
     const transformHelper = new TransformHelper(result)
-    for (let i = 0; i < this.transformBuilds.length; i++) {
+    for (let i = 0; i < this.transformBuilds.length; i += 1) {
       const transformBuild = this.transformBuilds[i]
       transformBuild(result, transformHelper)
     }
@@ -184,7 +144,7 @@ export function transfromIncludeToQueryable(
       return value
     }
   function wrapFiltered(includes: Includeable[], parent?: IncludeOptions) {
-    for (let i = 0; i < includes.length; i++) {
+    for (let i = 0; i < includes.length; i += 1) {
       const include = includes[i] as CustomIncludeOptions
 
       const { model, key, include: oriInclude, ...restInclude } = include
@@ -200,6 +160,7 @@ export function transfromIncludeToQueryable(
       } as IncludeOptions)
 
       if (parent) {
+        // eslint-disable-next-line no-param-reassign
         parent.include = parent.include || []
         parent.include.push(data)
       } else {