mm_ret 1.4.2 → 1.4.4

package/README.md

@@ -1,158 +1,234 @@
 # mm_ret
 
-这是一个用于输出JSON-RPC 2.0标准结果的Node.js模块。它提供了一系列便捷的方法来生成标准的JSON-RPC响应和请求。
+[![npm version](https://img.shields.io/npm/v/mm_ret.svg)](https://www.npmjs.com/package/mm_ret)
+[![License](https://img.shields.io/npm/l/mm_ret.svg)](https://github.com/qiuwenwu91/mm_ret/blob/main/LICENSE)
 
-## 安装
+A Node.js module for generating JSON-RPC 2.0 compliant responses and requests. 提供便捷的方法来生成标准的JSON-RPC 2.0响应和请求。
+
+## 安装 / Installation
 
 ```bash
 npm install mm_ret
 ```
 
-## 基本使用
+## 快速开始 / Quick Start
+
+### 基本使用 / Basic Usage
 
 ```javascript
 const { Ret, Req, Error } = require('mm_ret');
-// 或者直接使用全局变量
-require('mm_ret');
+
+// 生成成功响应 / Generate success response
+const successResponse = Ret.body('操作成功');
+console.log(successResponse);
+// 输出: {"result":"操作成功"}
+
+// 生成错误响应 / Generate error response
+const errorResponse = Ret.error(10000, '参数错误');
+console.log(errorResponse);
+// 输出: {"error":{"code":10000,"message":"参数错误"}}
+
+// 生成请求 / Generate request
+const req = new Req('user');
+const requestBody = req.send('getUser', { id: 123 });
+console.log(requestBody);
+// 输出: {"jsonrpc":"2.0","method":"user.getUser","params":{"id":123},"id":"..."}
 ```
 
-## 类说明
+## 功能特性 / Features
 
-### Error 类
+- ✅ **JSON-RPC 2.0 标准兼容** - 完全符合JSON-RPC 2.0规范
+- ✅ **多种响应类型** - 支持对象、列表、布尔值等响应格式
+- ✅ **错误码管理** - 内置标准错误码和自定义错误码
+- ✅ **请求模板** - 支持请求参数模板功能
+- ✅ **轻量级** - 无依赖，体积小巧
+- ✅ **TypeScript 支持** - 提供完整的类型定义
 
-错误代码管理类，用于管理JSON-RPC标准错误码和自定义错误码。
+## API 文档 / API Documentation
 
-#### 方法
+### Ret 类 - 响应生成器
 
-##### get(keyword)
-- 说明：根据关键词或错误码获取对应的错误信息
-- 参数：
-  - keyword: {String|Number} 关键词或错误码
-- 返回值：{Object} 错误信息对象，包含code和message
+生成符合JSON-RPC 2.0标准的响应对象。
 
-### Ret 类
+#### 方法 / Methods
 
-响应结果生成类，用于生成标准的JSON-RPC 2.0响应结果。
+##### `body(result, error, id)`
+生成基础的JSON-RPC响应体。
 
-#### 方法
+**参数:**
+- `result` {any} - 返回结果
+- `error` {Object} - 错误信息（可选）
+- `id` {String} - 请求ID（可选）
 
-##### body(result, error, id)
-- 说明：生成基础的JSON-RPC响应体
-- 参数：
-  - result: {Object} 返回的结果
-  - error: {Object} 返回的错误信息
-  - id: {String} 消息ID
-- 返回值：{Object} 标准的JSON-RPC响应对象
+**返回值:** {Object} JSON-RPC响应对象
 
-##### error(code, message, id)
-- 说明：生成错误响应
-- 参数：
-  - code: {Number} 错误码
-  - message: {String} 错误信息
-  - id: {String} 消息ID
-- 返回值：{Object} 包含错误信息的JSON-RPC响应对象
+##### `error(code, message, id)`
+生成错误响应。
 
-##### list(list, count, id)
-- 说明：生成列表类型的响应
-- 参数：
-  - list: {Array} 数据列表
-  - count: {Number} 总数量
-  - id: {String} 消息ID
-- 返回值：{Object} 包含列表数据的JSON-RPC响应对象
+**参数:**
+- `code` {Number} - 错误码
+- `message` {String} - 错误信息
+- `id` {String} - 请求ID（可选）
 
-##### obj(obj, id)
-- 说明：生成对象类型的响应
-- 参数：
-  - obj: {Object} 返回的对象
-  - id: {String} 消息ID
-- 返回值：{Object} 包含对象数据的JSON-RPC响应对象
+**返回值:** {Object} 包含错误信息的响应对象
 
-##### bl(bl, tip, id)
-- 说明：生成布尔类型的响应
-- 参数：
-  - bl: {Boolean} 布尔值
-  - tip: {String} 提示信息
-  - id: {String} 消息ID
-- 返回值：{Object} 包含布尔值和提示信息的JSON-RPC响应对象
+##### `list(list, count, id)`
+生成列表类型的响应。
 
-### Req 类
+**参数:**
+- `list` {Array} - 数据列表
+- `count` {Number} - 总数量（可选）
+- `id` {String} - 请求ID（可选）
 
-请求生成类，用于生成标准的JSON-RPC 2.0请求。
+**返回值:** {Object} 包含列表数据的响应对象
 
-#### 构造函数
+##### `obj(obj, id)`
+生成对象类型的响应。
+
+**参数:**
+- `obj` {Object} - 返回的对象
+- `id` {String} - 请求ID（可选）
+
+**返回值:** {Object} 包含对象数据的响应对象
+
+##### `bl(bl, tip, id)`
+生成布尔类型的响应。
+
+**参数:**
+- `bl` {Boolean} - 布尔值
+- `tip` {String} - 提示信息（可选）
+- `id` {String} - 请求ID（可选）
+
+**返回值:** {Object} 包含布尔值和提示信息的响应对象
+
+### Req 类 - 请求生成器
 
+生成符合JSON-RPC 2.0标准的请求对象。
+
+#### 构造函数
 ```javascript
-new Req(scope)
+new Req(scope = 'sys')
 ```
-- scope: {String} 作用域，默认为"sys"
 
-#### 方法
+**参数:**
+- `scope` {String} - 作用域，默认为"sys"
+
+#### 方法 / Methods
+
+##### `send(method, params)`
+生成JSON-RPC请求。
+
+**参数:**
+- `method` {String} - 方法名
+- `params` {Object} - 参数对象
+
+**返回值:** {Object} 标准的JSON-RPC请求对象
+
+### Error 类 - 错误码管理
+
+管理JSON-RPC标准错误码和自定义错误码。
+
+#### 方法 / Methods
 
-##### send(method, params)
-- 说明：生成JSON-RPC请求
-- 参数：
-  - method: {String} 方法名
-  - params: {Object} 参数对象
-- 返回值：{Object} 标准的JSON-RPC请求对象
+##### `get(keyword)`
+根据关键词或错误码获取对应的错误信息。
 
-## 使用示例
+**参数:**
+- `keyword` {String|Number} - 关键词或错误码
 
-### 响应结果示例
+**返回值:** {Object} 错误信息对象，包含code和message
+
+## 使用示例 / Examples
+
+### 响应示例 / Response Examples
 
 ```javascript
-// 错误响应
-var body = $.ret.error(10000, '错误');
-// 输出: {"error":{"code":10000,"message":"错误"}}
+const { Ret } = require('mm_ret');
 
-// 普通结果响应
-body = $.ret.body("这是一个结果");
-// 输出: {"result":"这是一个结果"}
+// 成功响应
+const success = Ret.body({ message: '操作成功' });
+// {"result":{"message":"操作成功"}}
 
-// 对象响应
-body = $.ret.obj({ "name": "张三", age: 18});
-// 输出: {"result":{"obj":{"name":"张三","age":18}}}
+// 错误响应
+const error = Ret.error(400, '参数验证失败');
+// {"error":{"code":400,"message":"参数验证失败"}}
 
 // 列表响应
-body = $.ret.list([{ "name": "张三", age: 18}, { "name": "李四", age: 24}]);
-// 输出: {"result":{"list":[{"name":"张三","age":18},{"name":"李四","age":24}]}}
+const list = Ret.list([{ id: 1, name: '用户1' }, { id: 2, name: '用户2' }], 2);
+// {"result":{"list":[{...}],"count":2}}
+
+// 对象响应
+const obj = Ret.obj({ id: 1, name: '张三', age: 25 });
+// {"result":{"obj":{...}}}
 
 // 布尔响应
-body = $.ret.bl(true, "修改成功");
-// 输出: {"result":{"bl":true,"tip":"修改成功"}}
+const bool = Ret.bl(true, '操作成功');
+// {"result":{"bl":true,"tip":"操作成功"}}
 ```
 
-### 请求示例
+### 请求示例 / Request Examples
 
 ```javascript
-// 基本请求
-var body = $.req.send('test', "你好吗");
+const { Req } = require('mm_ret');
 
-// 使用模板的请求
-$.req.tpl.message = {
-    "to_user": "",
-    "from_user": "",
-    "content": ""
+// 基本请求
+const req = new Req('user');
+const request = req.send('getProfile', { userId: 123 });
+// {"method":"user.getProfile","params":{"userId":123},"id":"..."}
+
+// 使用模板
+const reqWithTemplate = new Req('message');
+reqWithTemplate.tpl.message = {
+    to_user: '',
+    from_user: '',
+    content: ''
 };
-body = $.req.send('message', { content: "你好吗?", "media": { "title": "牛" } });
-// 输出的请求会自动合并模板中的字段
+const templateRequest = reqWithTemplate.send('message', { 
+    content: 'Hello!',
+    media: { title: '重要通知' }
+});
+// 自动合并模板字段
 ```
 
-## 错误码说明
-
-| 错误码 | 说明 |
-|--------|------|
-| -32700 | not well formed |
-| -32701 | unsupported encoding |
-| -32702 | invalid character for encoding |
-| -32600 | invalid json-rpc. not conforming to spec |
-| -32601 | requested method not found |
-| -32602 | invalid method parameters |
-| -32603 | internal json-rpc error |
-| -32500 | application error |
-| -32400 | system error |
-| -32300 | transport error |
-| 10000 | 业务逻辑脚本错误 |
-| 30000 | 身份验证失败 |
-| 40000 | 数据库执行错误 |
-| 50000 | 服务端执行错误 |
-| 70000 | 参数不正确 |
+## 错误码参考 / Error Codes
+
+### 标准JSON-RPC错误码
+| 错误码 | 说明 | Description |
+|--------|------|-------------|
+| -32700 | 格式错误 | Parse error - Not well-formed |
+| -32701 | 编码不支持 | Parse error - Unsupported encoding |
+| -32702 | 无效字符 | Parse error - Invalid character for encoding |
+| -32600 | 无效请求 | Invalid Request - Not conforming to JSON-RPC 2.0 |
+| -32601 | 方法不存在 | Method not found |
+| -32602 | 无效参数 | Invalid params |
+| -32603 | 内部错误 | Internal error |
+| -32500 | 应用错误 | Application error |
+| -32400 | 系统错误 | System error |
+| -32300 | 传输错误 | Transport error |
+
+### 自定义错误码
+| 错误码 | 说明 | Description |
+|--------|------|-------------|
+| 10000 | 业务逻辑错误 | Business logic error |
+| 30000 | 身份验证失败 | Authentication failed |
+| 40000 | 数据库执行错误 | Database execution error |
+| 50000 | 服务端执行错误 | Server execution error |
+| 70000 | 参数不正确 | Invalid parameters |
+
+## 测试 / Testing
+
+```bash
+npm test
+```
+
+## 许可证 / License
+
+ISC License
+
+## 贡献 / Contributing
+
+欢迎提交 Issue 和 Pull Request！
+
+## 更新日志 / Changelog
+
+查看 [GitHub Releases](https://github.com/qiuwenwu91/mm_ret/releases) 获取详细更新信息。

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_ret",
-    "version": "1.4.2",
+    "version": "1.4.4",
     "description": "这是超级美眉http请求结果输出类函数模块，用于输出json-rpc2.0标准结果",
     "main": "index.js",
     "scripts": {
@@ -30,6 +30,6 @@
     },
     "homepage": "https://gitee.com/qiuwenwu91/mm_ret#readme",
     "dependencies": {
-        "mm_expand": "^1.9.6"
+        "mm_expand": "^1.9.7"
     }
 }

package/test.js

@@ -18,7 +18,7 @@ async function retTest(out) {
 	$.log.debug("封装:", JSON.stringify(body));
 	$.log.debug("解析结果:", out.parse(body));
 
-	body = $.ret.list([{ "name": "张三", age: 18 }, { "name": "李四", age: 24 }]);
+	body = $.ret.list([{ "name": "张三", age: 18 }, { "name": "李四", age: 24 }], 35);
 	$.log.debug("封装:", JSON.stringify(body));
 	$.log.debug("解析结果:", out.parse(body));
 
@@ -90,4 +90,15 @@ function reqDemo() {
 	reqTest(new Req({ format: "restful" }));
 }
 
-reqDemo();
+reqDemo();
+
+// var reqCS = new Req();
+// const request = reqCS.send('getProfile', { userId: 123 });
+// $.log.debug("封装:", JSON.stringify(request));
+
+// var model = reqCS.parse({
+// 	id: "1231233",
+// 	method: 'getProfile',
+// 	params: [{ userId: 123 }]
+// });
+// $.log.debug("解析:", model);