topbit 3.1.4 → 3.1.5

package/README.cn.md

@@ -2008,7 +2008,7 @@ const {ParamCheck} = Topbit.extensions
 // Query 参数检测
 let pck = new ParamCheck({
   key: 'query',
-  data : {
+  rule: {
     // 严格限制值
     say: 'hello',
     // 类型转换与范围限制
@@ -2026,7 +2026,7 @@ let paramck = new ParamCheck({
   key: 'param',
   deny: ['x-key'], // 禁止提交的字段
   deleteDeny: true,
-  data : {
+  rule: {
     errorMessage: '参数错误', // 自定义错误信息
     mobile: {
       callback: (obj, k, method) => {
@@ -2046,7 +2046,7 @@ app.use(pck, {method: 'GET'})
 ```javascript
 let pmbody = new ParamCheck({
   key: 'body',
-  data: {
+  rule: {
     username: { must: true },
     passwd: { must: true }
   }

package/README.md

@@ -1960,7 +1960,7 @@ const {ParamCheck} = Topbit.extensions
 // Query parameter check
 let pck = new ParamCheck({
   key: 'query',
-  data : {
+  rule: {
     // Strictly restrict value
     say: 'hello',
     // Type conversion and range restriction
@@ -1978,7 +1978,7 @@ let paramck = new ParamCheck({
   key: 'param',
   deny: ['x-key'], // Fields forbidden to submit
   deleteDeny: true,
-  data : {
+  rule: {
     errorMessage: 'Parameter Error', // Custom error message
     mobile: {
       callback: (obj, k, method) => {
@@ -1998,7 +1998,7 @@ app.use(pck, {method: 'GET'})
 ```javascript
 let pmbody = new ParamCheck({
   key: 'body',
-  data: {
+  rule: {
     username: { must: true },
     passwd: { must: true }
   }

package/demo/rule.js

@@ -0,0 +1,115 @@
+'use strict'
+
+let Topbit = require('../src/topbit.js')
+
+let {ParamCheck} = Topbit.extensions
+
+let app = new Topbit({
+  debug: true
+})
+
+let pck = new ParamCheck({
+  //支持query、param、body，对应于请求上下文的ctx.query、ctx.param、ctx.body。
+  key: 'query',
+
+  //要验证的数据，key值即为属性名称，验证规则可以是string|number|object。
+  //string会严格判等，number仅仅数据判等，object是最强大的功能。
+  rule: {
+    //严格限制say的值必须是hello。
+    say: 'hello',
+    offset: {
+      //如果c.query.offset是undefined，则会赋值为0。
+      default: 0,
+      //要转换的类型，只能是int、float、boolean
+      to: 'int',
+      //最小值，>=
+      min: 0,
+      //最大值，<=
+      max: 100
+    },
+    test: {
+      default: false,
+      // 转换为布尔类型，若字符串为true则转换为布尔值true，否则转换为布尔值false。
+      to: 'boolean'
+    }
+  }
+
+})
+
+let paramck = new ParamCheck({
+  //支持query或param，对应于请求上下文的ctx.query和ctx.param。
+  key: 'param',
+
+  //禁止提交的字段
+  deny: ['x-key', 'test'],
+
+  //检测到存在禁止提交的属性则自动删除，默认会返回400错误。
+  deleteDeny: true,
+
+  //要验证的数据，key值即为属性名称，验证规则可以是string|number|object。
+  //string会严格判等，number仅仅数据判等，object是最强大的功能。
+  rule: {
+    //自定义错误返回的消息，每个属性都可以有自己的错误消息提示。
+    name: {
+      errorMessage: 'name长度必须在2～8范围内。',
+
+      //obj是c.query或c.param，k是属性名称，method是当前请求方法
+      callback: (obj, k, method) => {
+        if (obj[k].length < 2 || obj[k].length > 8) {
+          return false
+        }
+        return true
+      }
+    },
+
+    age: {
+      errorMessage: '年龄必须在12～65',
+      to: 'int',
+      min: 12,
+      max: 65
+    },
+    
+    mobile: {
+      errorMessage: '手机号不符合要求',
+      //利用callback，可以实现完全自主的自定义规则。
+      callback: (obj, k, method) => {
+        let preg = /^(12|13|15|16|17|18|19)[0-9]{9}$/
+        if (!preg.test(obj[k])) {
+          return false
+        }
+        return true
+      }
+    }
+  }
+
+})
+
+let pmbody = new ParamCheck({
+  key: 'body',
+  rule: {
+    username: {
+      //必须有这个属性。
+      must: true
+    },
+    passwd: {
+      must: true
+    }
+  }
+})
+
+app.use(pck, {method: 'GET'})
+  .use(paramck, {method: 'GET'})
+  .use(pmbody, {method: ['POST', 'PUT'], name: 'login'})
+
+app.get('/user/:name/:age/:mobile', async c => {
+  c.ok({
+    query: c.query,
+    param: c.param
+  })
+})
+
+app.post('/login', async c => {
+  c.ok(c.body)
+}, {name: 'login'})
+
+app.run(1234)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "topbit",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "A Server-side web framework support http/1.1 and http/2",
   "main": "src/topbit.js",
   "directories": {

package/src/extends/paramcheck.js

@@ -13,7 +13,7 @@ class ParamCheck {
   constructor(options = {}) {
     this.type = ['query', 'param', 'body']
     this.key = 'param'
-    this.data = {}
+    this.rule = {}
     this.errorMessage = "提交数据不符合要求"
     //设置禁止提交的字段
     this.deny = null
@@ -28,9 +28,9 @@ class ParamCheck {
           }
           break
 
-        case 'data':
+        case 'rule':
           if (typeof options[k] === 'object') {
-            this.data = options[k]
+            this.rule = options[k]
           }
           break
 
@@ -57,25 +57,25 @@ class ParamCheck {
     }
 
     let data_type = ''
-    for (let k in this.data) {
-      data_type = typeof this.data[k]
+    for (let k in this.rule) {
+      data_type = typeof this.rule[k]
 
       if (data_type === 'string' || data_type === 'number') {
-        this.data[k] = {
+        this.rule[k] = {
           __is_value__: true,
-          __value__: this.data[k],
+          __value__: this.rule[k],
           __type__: data_type === 'string' ? TYPE_STRING : TYPE_NUMBER
         }
 
         continue
       }
 
-      this.data[k].__is_value__ = false
+      this.rule[k].__is_value__ = false
 
-      if (this.data[k].callback && typeof this.data[k].callback === 'function') {
-        this.data[k].__is_call__ = true
+      if (this.rule[k].callback && typeof this.rule[k].callback === 'function') {
+        this.rule[k].__is_call__ = true
       } else {
-        this.data[k].__is_call__ = false
+        this.rule[k].__is_call__ = false
       }
     }
 
@@ -194,8 +194,8 @@ class ParamCheck {
     let ost = {ok: true, key: ''}
 
     if (this.key !== 'body' || (c.body !== c.rawBody && typeof c.body === 'object')) {
-      for (let k in this.data) {
-        if (!this.checkData(d, k, this.data[k], c.method, ost)) {
+      for (let k in this.rule) {
+        if (!this.checkData(d, k, this.rule[k], c.method, ost)) {
           return ost
         }
       }
@@ -206,7 +206,7 @@ class ParamCheck {
 
   mid() {
     let self = this
-    let dataObject = this.data
+    let dataObject = this.rule
 
     if (!Array.isArray(this.deny) || this.deny.length === 0) this.deny = null