Feature: 新增、修改接口，显示所有可用table接口；修改entity config结构

Author: kevinaskin

README.md

@@ -56,8 +56,14 @@ This example repo uses the NestJS swagger module for API documentation. [NestJS
 
 # 使用文档
 
+
 > 以下例子中 默认存在两张表(Comment， User)，实际使用时，需要在添加对应的entity，在service中引入即可
 
+查看当前可用的table 可访问 `GET /table` 
+
+- 通用查询接口 `POST /apijson/get`
+- 通用新增接口 `POST /apijson/add`
+- 通用修改接口 `POST /apijson/update`
 
 已经实现的操作符
 
@@ -85,7 +91,6 @@ This example repo uses the NestJS swagger module for API documentation. [NestJS
         }
       }
     ```
-  ![list](./asserts/list.png)
 - \#
 
   操作符名称： 别名
@@ -113,10 +118,6 @@ This example repo uses the NestJS swagger module for API documentation. [NestJS
     }
   }
   ```
-
-  ![column](./asserts/column.png)
-
-
 - 联表查询
 
   例子：
@@ -132,8 +133,6 @@ This example repo uses the NestJS swagger module for API documentation. [NestJS
     }
   }
   ```
-  ![union-query](./asserts/union-query.png)
-
   ```json
   // 查询所有符合条件的comment 显示 第1页 每页2条
   // (因为默认page = 1 count = 10 所以默认最多为10条)
@@ -151,8 +150,6 @@ This example repo uses the NestJS swagger module for API documentation. [NestJS
   }
 
   ```
-  ![union-list-query](./asserts/union-list-query.png)
-
 
 - 综合例子
 
@@ -174,6 +171,4 @@ This example repo uses the NestJS swagger module for API documentation. [NestJS
 	    }
 	  }
 	}
-	```
-
-  ![mix](./asserts/mix.png)
+	```

asserts/column.png

@@ -1,5 +1,5 @@
 {
-  "name": "nestjs-realworld-example-app",
+  "name": "apijson-node",
   "version": "1.0.0",
   "description": "",
   "main": "index.js",

asserts/list.png

@@ -1,6 +1,6 @@
 {
   "apps": [{
-    "name": "api-json-node",
+    "name": "apijson-node",
     "script": "./dist/http/main.js",
     "log_date_format": "YYYY-MM-DD HH:mm:ss",
     "instances" : 4,

asserts/mix.png

@@ -7,7 +7,8 @@ export interface JobInterface {
   table: string,
   options: any,
   ListOptions?: any,
-  replacePath: string[]
+  replacePath: string[],
+  config?: any
 }
 
 interface listUnionOptionsInterface {
@@ -74,7 +75,7 @@ export class RequestParser {
         return
       }
       // 校验column合法性，entity合法性，或为别名（#结尾）的情况
-      const COLUMN_LIST = safeGet(TABLE_CONFIG, `${parentTableName}.column`, [])
+      const COLUMN_LIST = safeGet(TABLE_CONFIG, `${parentTableName}.column`, []).map(i => i.key)
       if ([
         ...ENTITY_LIST, 
         ...COLUMN_LIST, 
@@ -161,7 +162,7 @@ export class RequestParser {
       return
     } else {
       let queryTable = targetTables[0]
-      const { column } = TABLE_CONFIG[queryTable] || []
+      const column = TABLE_CONFIG[queryTable] && TABLE_CONFIG[queryTable].column.map(i => i.key) || []
       const options = {}
       const ListOptions = {
         page: 1,
@@ -180,7 +181,6 @@ export class RequestParser {
             } else if (column.indexOf(normalizedKey) > -1) {
               // 数组中的联表查询
               LIST_JOB_FLAG = false
-              console.log('??', key, subKey, field, parentPath)
               listUnionOptions = {
                 key: subKey, 
                 body: body[field][subKey], 
@@ -223,7 +223,7 @@ export class RequestParser {
 
   handleSingleJob(key: string, body: any, parentPath: string[]): void {
     console.log('start SINGLE_JOB', key, body, parentPath)
-    const column = TABLE_CONFIG[key] && TABLE_CONFIG[key].column || []
+    const column = TABLE_CONFIG[key] && TABLE_CONFIG[key].column.map(i => i.key) || []
 
     let SINGLE_JOB_FLAG = true
 
@@ -263,6 +263,12 @@ export class RequestParser {
   }
 
   createJob (job: JobInterface, tail: boolean = true) {
+    job = {
+      config: {
+        primary: safeGet(TABLE_CONFIG, `${job.table}.primary`, '')
+      },
+      ...job
+    }
     if (tail) {
       this.queue.push(job)
     } else {

asserts/union-list-query.png

@@ -13,5 +13,16 @@ export class CommentEntity {
 }
 
 export const Comment = {
-  column: ['id', 'comment', 'userId']
+  column: [{
+    key: 'id',
+    desc: 'ID'
+  }, {
+    key: 'comment',
+    desc: '评论'
+  }, {
+    key: 'userId',
+    desc: '关联的用户Id'
+  }],
+  primary: 'id',
+  desc: '评论表'
 }

asserts/union-query.png

@@ -16,5 +16,19 @@ export class UserEntity {
 }
 
 export const User = {
-  column: ['id', 'user', 'nickname', 'role']
+  column: [{
+    key: 'id',
+    desc: 'ID'
+  }, {
+    key: 'user',
+    desc: '用户名'
+  }, {
+    key: 'nickname',
+    desc: '昵称'
+  }, {
+    key: 'role',
+    desc: '角色'
+  }],
+  primary: ['id'],
+  desc: '用户表'
 }

package.json

@@ -1,4 +1,5 @@
 import { Get, Controller } from '@nestjs/common'
+import { config } from '../entities'
 
 @Controller()
 export class AppController {
@@ -9,4 +10,9 @@ export class AppController {
   root(): string {
     return 'ok'
   }
+
+  @Get('/table')
+  getTable(): any {
+    return config
+  }
 }

pm2.config.json

@@ -1,4 +1,4 @@
-import { Post, Controller, Body, HttpException, HttpStatus } from '@nestjs/common'
+import { Post, Controller, Body, HttpException, HttpStatus, Logger } from '@nestjs/common'
 import { ApiUseTags, ApiBearerAuth } from '@nestjs/swagger'
 import { set as safeSet, get as safeGet } from 'lodash'
 
@@ -7,25 +7,129 @@ import { jsonBodyParser } from '../../core'
 import { successHandler, baseHandler, HTTP_CODE } from '../../helper'
 import { JOB_TYPE } from '../../core/traverse'
 
+function throwError(msg: string, code: number) {
+  Logger.error(msg)
+  throw new HttpException(msg, code)
+}
+
 @ApiBearerAuth()
 @ApiUseTags('apijson')
 @Controller('apijson')
 export class JsonController {
   constructor(private readonly jsonService: JsonService) {}
 
-  @Post()
+  @Post('/update')
+  async update(@Body() queryBody: object): Promise<any> {
+
+    const parserResult = jsonBodyParser(queryBody)
+    if (!parserResult) {
+      throwError('Too many requests, please try again later', HttpStatus.TOO_MANY_REQUESTS)
+    }
+
+    const { queue:jobList, errors, originalJson, RequestParser } = parserResult
+    console.log('RELEASE requestParser instance')
+    RequestParser.flushJob()
+    if (errors.length) {
+      throwError(errors.join('; '), HttpStatus.BAD_REQUEST)
+    }
+
+    if (jobList.find(job => {
+      return job.$$type === JOB_TYPE.LIST_UNION || job.$$type === JOB_TYPE.UNION
+    })) {
+      throwError(
+        `[ERROR] update request is not support union operation "@", please check your request body`,
+        HttpStatus.BAD_REQUEST)
+    }
+
+    if (jobList.length > 1) {
+      throwError(
+        `[ERROR] update request is not support transaction insert, please request single table payload.`,
+        HttpStatus.BAD_REQUEST)
+    }
+
+    while (jobList.length) {
+      let currentJob = jobList.pop()
+      console.log('JOB ID =>', currentJob.id)
+      const primaryKey = currentJob.config.primary
+      if (!currentJob.options[primaryKey]) {
+        throwError(`[ERROR] "${primaryKey}" is required in update method`, HttpStatus.BAD_REQUEST)
+      }
+      try {
+        await this.jsonService.update(
+          currentJob.options[primaryKey], 
+          currentJob.table, 
+          currentJob.options
+        )
+      } catch (e) {
+        throwError(e.message, HttpStatus.BAD_REQUEST)
+      }
+    }
+
+    return successHandler({
+      message: '[INFO] update success',
+      requestBody: originalJson
+    })
+  }
+
+  @Post('/add')
+  async add(@Body() queryBody: object): Promise<any> {
+
+    const parserResult = jsonBodyParser(queryBody)
+    if (!parserResult) {
+      throwError('Too many requests, please try again later', HttpStatus.TOO_MANY_REQUESTS)
+    }
+
+    const { queue:jobList, errors, originalJson, RequestParser } = parserResult
+    console.log('RELEASE requestParser instance')
+    RequestParser.flushJob()
+    if (errors.length) {
+      throwError(errors.join('; '), HttpStatus.BAD_REQUEST)
+    }
+
+    if (jobList.find(job => {
+      return job.$$type === JOB_TYPE.LIST_UNION || job.$$type === JOB_TYPE.UNION
+    })) {
+      throwError(
+        `[ERROR] add request is not support union operation "@", please check your request body`,
+        HttpStatus.BAD_REQUEST)
+    }
+
+    if (jobList.length > 1) {
+      throwError(
+        `[ERROR] add request is not support transaction insert, please request single table payload.`,
+        HttpStatus.BAD_REQUEST)
+    }
+    while (jobList.length) {
+      let currentJob = jobList.pop()
+      console.log('JOB ID =>', currentJob.id)
+
+      const {...payload} = currentJob.options // incase for functional column
+      try {
+        await this.jsonService.insert(currentJob.table, payload)
+      } catch (e) {
+        throwError(e.message, HttpStatus.BAD_REQUEST)
+      }
+    }
+
+    return successHandler({
+      message: '[INFO] insert success',
+      requestBody: originalJson
+    })
+  }
+
+  @Post('/get')
   async query(@Body() queryBody: object): Promise<any> {
 
     const parserResult = jsonBodyParser(queryBody)
     if (!parserResult) {
-      throw new HttpException('Too many requests, please try again later', HttpStatus.TOO_MANY_REQUESTS)
+      throwError('Too many requests, please try again later', HttpStatus.TOO_MANY_REQUESTS)
     }
 
     const { queue:jobList, errors, originalJson, RequestParser } = parserResult
     console.log('RELEASE requestParser instance')
     RequestParser.flushJob()
     if (errors.length) {
-      throw new HttpException(errors.join('; '), HttpStatus.BAD_REQUEST)
+      throwError(errors.join('; '), HttpStatus.BAD_REQUEST)
     }
     let res = JSON.parse(JSON.stringify(originalJson))
     if (!jobList.length) {
@@ -37,6 +141,7 @@ export class JsonController {
     }
 
     const normalizedData = data => {
+      if (!data) return {}
       Object.keys(data).forEach(key => {
         const normalizedKey = key
           .replace(/\#/g, '') // replace "#" operation arg
@@ -76,7 +181,7 @@ export class JsonController {
         const { referArgs, referVar } = currentJob.options
         const referData = safeGet(res, referArgs, undefined)
         if (!referData) {
-          throw new HttpException(`[ERROR] union job exec failed, for "${referArgs.join('/')}" is undefined`, HttpStatus.BAD_REQUEST)
+          throwError(`[ERROR] union job exec failed, for "${referArgs.join('/')}" is undefined`, HttpStatus.BAD_REQUEST)
         }
         data = await this.jsonService.findOne(currentJob.table, {
           [referVar]: referData
@@ -89,7 +194,7 @@ export class JsonController {
 
         const referData = safeGet(res, referArgs, undefined)
         if (!referData) {
-          throw new HttpException(`[ERROR] union job exec failed, for "${referArgs.join('/')}" is undefined`, HttpStatus.BAD_REQUEST)
+          throwError(`[ERROR] union job exec failed, for "${referArgs.join('/')}" is undefined`, HttpStatus.BAD_REQUEST)
         }
         data = await this.jsonService.find(currentJob.table, {
           [referVar]: referData,

src/core/traverse.ts

@@ -7,20 +7,31 @@ import { UserEntity, CommentEntity } from '../../entities'
 @Injectable()
 export class JsonService {
   @InjectRepository(UserEntity)
-  private readonly userRepository: Repository<UserEntity>
+  private readonly UserRepository: Repository<UserEntity>
   @InjectRepository(CommentEntity)
-  private readonly commentRepository: Repository<CommentEntity>
+  private readonly CommentRepository: Repository<CommentEntity>
+
+  async insert(entityName: string, payload: any = {}): Promise<any> {
+    const currentRepository = this[`${entityName}Repository`]
+
+    return currentRepository && currentRepository.insert(payload)
+  }
+
+  async update(id: any, entityName: string, payload: any = {}): Promise<any> {
+    const currentRepository = this[`${entityName}Repository`]
+    return currentRepository && currentRepository.update(id, payload)
+  }
 
   async findOne(entityName: string, options: any = {}): Promise<any> {
-    const currentRepository = this[`${entityName.toLowerCase()}Repository`]
+    const currentRepository = this[`${entityName}Repository`]
 
     return currentRepository && currentRepository.findOne(options)
   }
 
   async find(entityName: string, options: any = {}, listOptions: any = {
     page: 1, count: 10
   }): Promise<any[]> {
-    const currentRepository = this[`${entityName.toLowerCase()}Repository`]
+    const currentRepository = this[`${entityName}Repository`]
     const { select, ...restOptions} = options
     return currentRepository && currentRepository.find({
       where: {