mm_expand 2.3.3 → 2.3.5

package/lib/ret.js

@@ -5,52 +5,52 @@ const { Base } = require('./base');
  * @class Ret
  */
 class Ret extends Base {
-	static config = {
-		/**
-		 * 响应格式
-		 * @type {string} "json-rpc" | "restful"
-		 * @default "json-rpc"
-		 */
-		format: "json-rpc",
-		/**
-		 * 默认错误码
-		 * @type {number}
-		 * @default 10000
-		 */
-		error_code: 10000,
-		/**
-		 * 默认错误提示
-		 * @type {string}
-		 * @default "错误"
-		 */
-		error_message: "错误",
-		/**
-		 * 默认成功码
-		 * @type {number}
-		 * @default 0
-		 */
-		success_code: 0,
-		/**
-		 * 默认成功提示
-		 * @type {string}
-		 * @default "成功"
-		 */
-		success_message: "成功",
-		/**
-		 * 是否自定义错误提示
-		 * @type {boolean} 
-		 * @default false
-		 */
-		message_diy: false
-	};
-	/**
-	 * 构造函数
-	 * @param {Object} config 配置项
-	 * @constructor
-	 */
-	constructor(config) {
-		super(config);
-	}
+  static config = {
+    /**
+     * 响应格式
+     * @type {string} "json-rpc" | "restful"
+     * @default "json-rpc"
+     */
+    format: 'json-rpc',
+    /**
+     * 默认错误码
+     * @type {number}
+     * @default 10000
+     */
+    error_code: 10000,
+    /**
+     * 默认错误提示
+     * @type {string}
+     * @default "错误"
+     */
+    error_message: '错误',
+    /**
+     * 默认成功码
+     * @type {number}
+     * @default 0
+     */
+    success_code: 0,
+    /**
+     * 默认成功提示
+     * @type {string}
+     * @default "成功"
+     */
+    success_message: '成功',
+    /**
+     * 是否自定义错误提示
+     * @type {boolean} 
+     * @default false
+     */
+    message_diy: false
+  };
+  /**
+   * 构造函数
+   * @param {object} config 配置项
+   * @class
+   */
+  constructor(config) {
+    super(config);
+  }
 }
 
 /**
@@ -59,125 +59,128 @@ class Ret extends Base {
  * @returns {string} 错误提示
  */
 Ret.prototype._getMessage = function (code) {
-	var message;
-	if ($.error) {
-		message = $.error.get(code);
-	}
+  var message;
+  if ($.error) {
+    message = $.error.get(code);
+  }
 
-	if (!message) {
-		if (code === this.config.success_code) {
-			message = this.config.success_message;
-		}
-		else {
-			message = this.config.error_message;
-		}
-	}
-	return message;
-}
+  if (!message) {
+    if (code === this.config.success_code) {
+      message = this.config.success_message;
+    }
+    else {
+      message = this.config.error_message;
+    }
+  }
+  return message;
+};
 
 /**
  * 生成JSON-RPC 2.0响应格式
- * @param {Object} result 返回的结果
- * @param {Object} error 返回的错误信息
- * @param {Object.code} error.code 返回的错误码
- * @param {Object.message} error.message 返回的错误提示
+ * @param {object} result 返回的结果
+ * @param {object} error 返回的错误信息
+ * @param {object.code} error.code 返回的错误码
+ * @param {object.message} error.message 返回的错误提示
  * @param {string} id 消息ID
  * @param {boolean} diy 是否自定义错误提示
- * @returns {Object} JSON-RPC 2.0响应格式
+ * @returns {object} JSON-RPC 2.0响应格式
  */
-Ret.prototype._toJsonRPC = function (result, error, id, diy = true) {
-	const ret = {
-	};
-	if (id) {
-		ret.id = id;
-	}
-
-	if (result) {
-		ret.result = result;
-	}
-	else if (error) {
-		if (!error.code) {
-			error.code = this.config.error_code;
-		}
-		diy = diy || this.config.message_diy;
-		if (!diy) {
-			error.message = this._getMessage(error.code) || error.message;
-		}
-		else if (!error.message) {
-			error.message = this._getMessage(error.code);
-		}
-		ret.error = error;
-	}
-	else {
-		ret.error = {
-			code: this.config.error_code,
-			message: this._getMessage(this.config.error_code)
-		};
-	}
-	return ret;
-}
+Ret.prototype._toJsonRPC = function (result, error, id, _diy = true) {
+  const ret = {
+  };
+  if (id) {
+    ret.id = id;
+  }
+
+  if (result) {
+    ret.result = result;
+  }
+  else if (error) {
+    if (!error.code) {
+      error.code = this.config.error_code;
+    }
+    var diy = _diy || this.config.message_diy;
+    if (!diy) {
+      error.message = this._getMessage(error.code) || error.message;
+    }
+    else if (!error.message) {
+      error.message = this._getMessage(error.code);
+    }
+    ret.error = error;
+  }
+  else {
+    ret.error = {
+      code: this.config.error_code,
+      message: this._getMessage(this.config.error_code)
+    };
+  }
+  if (this.config.fs) {
+    ret.fs = this.config.fs;
+  }
+  return ret;
+};
 
 /**
  * 生成RESTful响应格式
  * @param {*} result 返回的结果
- * @param {Object} error 返回的错误信息
- * @param {Object.code} error.code 返回的错误码
- * @param {Object.message} error.message 返回的错误提示
+ * @param {object} error 返回的错误信息
+ * @param {object.code} error.code 返回的错误码
+ * @param {object.message} error.message 返回的错误提示
  * @param {string} id 消息ID
  * @param {boolean} diy 是否自定义错误提示
- * @returns {Object} RESTful响应格式
+ * @returns {object} RESTful响应格式
  */
-Ret.prototype._toRESTful = function (result, error, id, diy = true) {
-	let ret = {};
-	if (id) {
-		ret.id = id;
-	}
-	var code;
-	var msg;
-	if (result) {
-		code = this.config.success_code;
-		msg = this._getMessage(this.config.success_code);
-	}
-	else if (error) {
-		code = error.code || this.config.error_code;
-		diy = diy || this.config.message_diy;
-		if (!diy) {
-			msg = this._getMessage(code) || error.message || error.msg;
-		}
-		else if (!error.message && !error.msg) {
-			msg = this._getMessage(code);
-		}
-		else {
-			msg = error.message || error.msg || this._getMessage(code);
-		}
-	}
-	else {
-		code = this.config.error_code;
-		msg = this._getMessage(code);
-	}
-	ret.code = code;
-	ret.msg = msg;
-	if (result) {
-		ret.data = result;
-	}
-	return ret;
+Ret.prototype._toRESTful = function (result, error, id, _diy = true) {
+  let ret = {};
+  if (id) {
+    ret.id = id;
+  }
+  var code;
+  var msg;
+  if (result) {
+    code = this.config.success_code;
+    msg = this._getMessage(this.config.success_code);
+  }
+  else if (error) {
+    code = error.code || this.config.error_code;
+    var diy = _diy || this.config.message_diy;
+    if (!diy) {
+      msg = this._getMessage(code) || error.message || error.msg;
+    }
+    else if (!error.message && !error.msg) {
+      msg = this._getMessage(code);
+    }
+    else {
+      msg = error.message || error.msg || this._getMessage(code);
+    }
+  }
+  else {
+    code = this.config.error_code;
+    msg = this._getMessage(code);
+  }
+  ret.code = code;
+  ret.msg = msg;
+  if (result) {
+    ret.data = result;
+  }
+  return ret;
 };
 
 /**
  * 生成响应体
- * @param {Object} result 返回的结果
- * @param {Object} error 返回的错误信息
+ * @param {object} result 返回的结果
+ * @param {object} error 返回的错误信息
  * @param {string} id 消息ID
  * @param {boolean} diy 是否自定义错误提示
- * @returns {Object} 响应格式
+ * @returns {object} 响应格式
  */
 Ret.prototype.body = function (result, error, id, diy = true) {
-	if (this.config.format === "json-rpc") {
-		return this._toJsonRPC(result, error, id, diy);
-	}
-	else {
-		return this._toRESTful(result, error, id, diy);
-	}
+  if (this.config.format === 'json-rpc') {
+    return this._toJsonRPC(result, error, id, diy);
+  }
+  else {
+    return this._toRESTful(result, error, id, diy);
+  }
 };
 
 /**
@@ -186,14 +189,14 @@ Ret.prototype.body = function (result, error, id, diy = true) {
  * @param {string} message 错误信息
  * @param {string} id 消息ID
  * @param {boolean} diy 是否自定义错误提示
- * @returns {Object} 错误响应格式
+ * @returns {object} 错误响应格式
  */
 Ret.prototype.error = function (code, message, id, diy = true) {
-	const error = {
-		code,
-		message
-	};
-	return this.body(null, error, id, diy);
+  const error = {
+    code,
+    message
+  };
+  return this.body(null, error, id, diy);
 };
 
 /**
@@ -202,32 +205,30 @@ Ret.prototype.error = function (code, message, id, diy = true) {
  * @param {number} count 查询结果数
  * @param {string} id 消息ID
  * @param {boolean} diy 是否自定义错误提示
- * @returns {Object} 列表响应格式
+ * @returns {object} 列表响应格式
  */
 Ret.prototype.list = function (list, count, id, diy = true) {
-	if (!list) {
-		list = [];
-	}
-	const result = {
-		list: list
-	};
-	if (count !== undefined) {
-		result.count = count;
-	}
-	return this.body(result, null, id, diy);
+  var list_val = list || [];
+  const result = {
+    list: list_val
+  };
+  if (count !== undefined) {
+    result.count = count;
+  }
+  return this.body(result, null, id, diy);
 };
 
 /**
  * 生成对象响应
- * @param {Object} obj 返回对象
+ * @param {object} obj 返回对象
  * @param {string} id 消息ID
- * @returns {Object} 对象响应格式
+ * @returns {object} 对象响应格式
  */
 Ret.prototype.obj = function (obj, id) {
-	const result = {
-		obj: obj
-	};
-	return this.body(result, null, id);
+  const result = {
+    obj: obj
+  };
+  return this.body(result, null, id);
 };
 
 /**
@@ -235,112 +236,110 @@ Ret.prototype.obj = function (obj, id) {
  * @param {boolean} bl 布尔结果
  * @param {string} tip 提示信息
  * @param {string} id 消息ID
- * @returns {Object} 布尔响应格式
+ * @returns {object} 布尔响应格式
  */
-Ret.prototype.bl = function (bl, tip, id) {
-	if (!tip) {
-		tip = bl ? this.config.success_message : this.config.error_message;
-	}
-	return this.body({
-		bl,
-		tip
-	}, null, id);
+Ret.prototype.bl = function (bl, _tip, id) {
+  var tip = _tip || (bl ? this.config.success_message : this.config.error_message);
+  return this.body({
+    bl,
+    tip
+  }, null, id);
 };
 
 /**
  * 添加数据项到响应结果
- * @param {Object} res 响应对象
+ * @param {object} res 响应对象
  * @param {string} key 数据项键
  * @param {*} value 数据项值
  */
 Ret.prototype.add = function (res, key, value) {
-	if (this.config.format === "json-rpc") {
-		if (!res.result) {
-			res.result = {};
-		}
-		res.result[key] = value;
-	}
-	else {
-		if (!res.data) {
-			res.data = {};
-		}
-		res.data[key] = value;
-	}
-}
+  if (this.config.format === 'json-rpc') {
+    if (!res.result) {
+      res.result = {};
+    }
+    res.result[key] = value;
+  }
+  else {
+    if (!res.data) {
+      res.data = {};
+    }
+    res.data[key] = value;
+  }
+};
 
 /**
  * 解析响应
- * @param {Object} res 响应对象
- * @returns {Object} 解析后的格式
+ * @param {object} res 响应对象
+ * @returns {object} 解析后的格式
  */
 Ret.prototype.parse = function (res) {
-	let error;
-	let result;
+  let error;
+  let result;
 
-	if (res.error) {
-		error = res.error;
-	}
-	else if (res.result) {
-		result = res.result;
-	} else if (res.data) {
-		result = res.data;
-	}
-	else if (res.msg || res.message) {
-		error = {
-			code: res.code || this.config.error_code,
-			message: res.msg || res.message || this.config.error_message
-		};
-	}
+  if (res.error) {
+    error = res.error;
+  }
+  else if (res.result) {
+    result = res.result;
+  } else if (res.data) {
+    result = res.data;
+  }
+  else if (res.msg || res.message) {
+    error = {
+      code: res.code || this.config.error_code,
+      message: res.msg || res.message || this.config.error_message
+    };
+  }
 
-	const ret = {};
-	if (this.config.format === "json-rpc") {
-		if (error) {
-			ret.error = error;
-		}
-		else if (result) {
-			ret.result = result;
-		}
-	}
-	else {
-		if (error) {
-			ret.code = error.code || this.config.error_code;
-			ret.msg = error.message || this.config.error_message;
-			ret.data = null;
-		}
-		else if (result) {
-			ret.code = this.config.success_code;
-			ret.msg = this._getMessage(this.config.success_code);
-			ret.data = result;
-		}
-		else {
-			ret.code = this.config.success_code;
-			ret.msg = this._getMessage(this.config.success_code);
-		}
-	}
-	return ret;
-}
+  const ret = {};
+  if (this.config.format === 'json-rpc') {
+    if (error) {
+      ret.error = error;
+    }
+    else if (result) {
+      ret.result = result;
+    }
+  }
+  else {
+    if (error) {
+      ret.code = error.code || this.config.error_code;
+      ret.msg = error.message || this.config.error_message;
+      ret.data = null;
+    }
+    else if (result) {
+      ret.code = this.config.success_code;
+      ret.msg = this._getMessage(this.config.success_code);
+      ret.data = result;
+    }
+    else {
+      ret.code = this.config.success_code;
+      ret.msg = this._getMessage(this.config.success_code);
+    }
+  }
+  return ret;
+};
 
 /**
  * 设置响应格式
  * @param {string} format 响应格式
  */
 Ret.prototype.setFormat = function (format) {
-	switch (format?.toLowerCase()) {
-		case "json":
-		case "json-rpc":
-			this.config.format = "json-rpc";
-			break;
-		case "json3":
-		case "json-rpc3":
-			this.config.format = "json-rpc3";
-			break;
-		default:
-			this.config.format = "restful";
-			break;
-	}
-	return this;
+  switch (format?.toLowerCase()) {
+    case 'json':
+    case 'json-rpc':
+      this.config.format = 'json-rpc';
+      break;
+    case 'json3':
+    case 'json-rpc3':
+      this.config.format = 'json-rpc3';
+      break;
+    default:
+      this.config.format = 'restful';
+      break;
+  }
+  return this;
 };
 
 module.exports = {
-	Ret
+  Ret
 };