mm_expand 2.1.2 → 2.1.3

package/lib/req.js

@@ -0,0 +1,268 @@
+const { Base } = require('./base');
+
+/**
+ * @file 请求管理类
+ * @class Req
+ */
+class Req extends Base {
+  static config = {
+    /**
+     * 作用域
+     * @type {string}
+     * @default "sys"
+     */
+    scope: "sys",
+    /**
+     * 响应格式
+     * @type {string} "json-rpc" | "json-rpc3" | "restful"
+     * @default "json-rpc"
+     */
+    format: "json-rpc"
+  };
+  /**
+   * 构造函数
+   * @constructor
+   * @param {Object} config 配置项
+   */
+  constructor(config) {
+    super(config);
+    // 方法集合
+    this._methods = {};
+  }
+}
+
+/**
+ * 生成新的ID
+ * @returns {string} 新的ID
+ */
+Req.prototype.genId = function () {
+  return this._config.scope + Date.now();
+};
+
+/**
+ * 发送请求
+ * @param {string} method 方法名
+ * @param {...any} args 参数
+ * @returns {Object} 发送的JSON格式
+ */
+Req.prototype.send = function (method, ...args) {
+  if (this._methods[method]) {
+    return this._methods[method](...args);
+  }
+  else if (this._config.format === "json-rpc") {
+    return this._sendJsonRPC(method, args);
+  }
+  else if (this._config.format === "json-rpc3") {
+    return this._sendJsonRPC3(method, ...args);
+  }
+  else {
+    return this._sendRESTful(method, ...args);
+  }
+};
+
+/**
+ * 发送JSON-RPC 2.0请求
+ * @param {string} method 方法名
+ * @param {Array} params 参数数组
+ * @param {string} [id] 请求ID
+ * @returns {Object} JSON-RPC 2.0格式
+ */
+Req.prototype._sendJsonRPC = function (method, params, id) {
+  return {
+    id: id || this.genId(),
+    method,
+    params
+  };
+}
+
+/**
+ * 发送JSON-RPC 3.0请求
+ * @param {string} method 方法名
+ * @param {Object} [query] 查询参数
+ * @param {Object} [body] 请求体
+ * @param {Array} [meta] 元数据数组
+ * @param {string} [id] 请求ID
+ * @returns {Object} JSON-RPC 3.0格式
+ */
+Req.prototype._sendJsonRPC3 = function (method, query, body, meta, id) {
+  return {
+    id: id || this.genId(),
+    method,
+    params: {
+      query: query || {},
+      body: body || {},
+      meta: meta || []
+    }
+  };
+}
+
+/**
+ * 发送RESTful请求
+ * @param {string} method 方法名
+ * @param {Object} [query] 查询参数
+ * @param {Object} [body] 请求体
+ * @param {Array} [meta] 元数据数组
+ * @param {string} [id] 请求ID
+ * @returns {Object} RESTful格式
+ */
+Req.prototype._sendRESTful = function (method, query, body, meta, id) {
+  return {
+    id: id || this.genId(),
+    method,
+    query: query || {},
+    body: body || {},
+    meta: meta || []
+  };
+}
+
+/**
+ * 解析请求
+ * @param {Object} req 请求对象
+ * @returns {Object} 解析后的对象
+ */
+Req.prototype.parse = function (req) {
+  const id = req.id;
+  const method = req.method;
+  let params = [];
+
+  if (req.params) {
+    if (Array.isArray(req.params)) {
+      params = req.params;
+    }
+    else {
+      if (typeof req.params === "object") {
+        let ctx = Object.assign({}, req.params);
+        if (ctx.query || ctx.body) {
+          params.push(ctx.query || null);
+          params.push(ctx.body || null);
+          delete ctx.query;
+          delete ctx.body;
+          for (const key in ctx) {
+            params.push(ctx[key]);
+          }
+        }
+        else {
+          params = [
+            req.params
+          ];
+        }
+      }
+      else {
+        params = [req.params];
+      }
+    }
+  }
+  else if (req.query || req.body) {
+    params.push(req.query || null);
+    params.push(req.body || null);
+    if (req.meta) {
+      params.push(req.meta || null);
+    }
+  }
+  if (this._config.format === "json-rpc") {
+    if (req.params) {
+      params = req.params;
+    }
+  }
+  else if (this._config.format === "json-rpc3") {
+    var pm = {};
+    pm.query = params.length > 0 ? params[0] || null : null;
+    pm.body = params.length > 1 ? params[1] || null : null;
+    pm.meta = params.length > 2 ? params[2] || null : null;
+    params = pm;
+  }
+  else if (this._config.format === "restful") {
+    var ret = {
+      id,
+      method,
+      query: params.length > 0 ? params[0] || null : null,
+      body: params.length > 1 ? params[1] || null : null
+    }
+    if (params.length > 2) {
+      ret.meta = params[2];
+    }
+    return ret;
+  }
+  return {
+    id,
+    method,
+    params
+  };
+}
+
+/**
+ * 设置自定义方法
+ * @param {string} method 方法名
+ * @param {Function} func 处理方法
+ */
+Req.prototype.setMethod = function (method, func) {
+  if (typeof func !== "function") {
+    throw new Error("func必须是一个函数类型");
+  }
+  this._methods[method] = func;
+};
+
+/**
+ * 删除自定义方法
+ * @param {string} method 方法名
+ */
+Req.prototype.delMethod = function (method) {
+  delete this._methods[method];
+};
+
+/**
+ * 获取自定义方法
+ * @param {string} method 方法名
+ * @returns {Function} 处理方法
+ */
+Req.prototype.getMethod = function (method) {
+  return this._methods[method];
+};
+
+/**
+ * 获取所有自定义方法
+ * @returns {Object} 所有自定义方法
+ */
+Req.prototype.getMethods = function () {
+  return this._methods;
+};
+
+/**
+ * 运行自定义方法
+ * @param {string} method 方法名
+ * @param {Array} params 参数数组
+ * @returns {Object} 处理结果
+ */
+Req.prototype.run = function (method, params) {
+  const func = this._methods[method];
+  if (func) {
+    return func.apply(this, params);
+  }
+  else {
+    throw new Error("方法不存在");
+  }
+};
+
+/**
+ * 设置请求格式
+ * @param {string} format 请求格式
+ */
+Req.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;
+  }
+};
+
+module.exports = {
+  Req
+};

package/lib/ret.js

@@ -0,0 +1,338 @@
+const { Base } = require('./base');
+
+/**
+ * @file 响应管理类
+ * @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);
+	}
+}
+
+/**
+ * 获取错误提示
+ * @param {number} code 错误码
+ * @returns {string} 错误提示
+ */
+Ret.prototype._getMessage = function (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;
+}
+
+/**
+ * 生成JSON-RPC 2.0响应格式
+ * @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响应格式
+ */
+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;
+}
+
+/**
+ * 生成RESTful响应格式
+ * @param {*} result 返回的结果
+ * @param {Object} error 返回的错误信息
+ * @param {Object.code} error.code 返回的错误码
+ * @param {Object.message} error.message 返回的错误提示
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @returns {Object} RESTful响应格式
+ */
+Ret.prototype._toRESTful = function (result, error, id, diy = true) {
+	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);
+	}
+	return {
+		id,
+		code,
+		msg,
+		data: result
+	};
+}
+
+/**
+ * 生成响应体
+ * @param {Object} result 返回的结果
+ * @param {Object} error 返回的错误信息
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @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);
+	}
+};
+
+/**
+ * 生成错误响应
+ * @param {number} code 错误码
+ * @param {string} message 错误信息
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @returns {Object} 错误响应格式
+ */
+Ret.prototype.error = function (code, message, id, diy = true) {
+	const error = {
+		code,
+		message
+	};
+	return this.body(null, error, id, diy);
+};
+
+/**
+ * 生成列表响应
+ * @param {Array} list 返回列表
+ * @param {number} count 查询结果数
+ * @param {string} id 消息ID
+ * @param {boolean} diy 是否自定义错误提示
+ * @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);
+};
+
+/**
+ * 生成对象响应
+ * @param {Object} obj 返回对象
+ * @param {string} id 消息ID
+ * @returns {Object} 对象响应格式
+ */
+Ret.prototype.obj = function (obj, id) {
+	return this.body(obj, null, id);
+};
+
+/**
+ * 生成布尔型响应
+ * @param {boolean} bl 布尔结果
+ * @param {string} tip 提示信息
+ * @param {string} id 消息ID
+ * @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);
+};
+
+/**
+ * 添加数据项到响应结果
+ * @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;
+	}
+}
+
+/**
+ * 解析响应
+ * @param {Object} res 响应对象
+ * @returns {Object} 解析后的格式
+ */
+Ret.prototype.parse = function (res) {
+	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
+		};
+	}
+
+	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;
+	}
+}
+
+module.exports = {
+	Ret
+};

package/lib/timer.js

@@ -16,10 +16,7 @@ class Timer extends Base {
    * @param {object} config 配置参数
    */
   constructor(config) {
-    super({
-      ...Timer.config,
-      ...config || {}
-    });
+    super(config);
     // 是否为插件
     this.is_plugin = false;
     // 定时器核心