mm_ret 1.4.4 → 1.4.5

package/README.md

@@ -3,64 +3,64 @@
 [![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响应和请求。
+一个用于生成符合 JSON-RPC 2.0 标准的响应和请求的 Node.js 模块。
 
-## 安装 / Installation
+## 特性
+
+- ✅ **JSON-RPC 2.0 标准兼容** - 完全符合 JSON-RPC 2.0 规范
+- ✅ **多种响应类型** - 支持对象、列表、布尔值等响应格式
+- ✅ **错误码管理** - 内置标准错误码和自定义错误码
+- ✅ **请求模板** - 支持请求参数模板功能
+- ✅ **轻量级** - 无依赖，体积小巧
+- ✅ **TypeScript 支持** - 提供完整的类型定义
+
+## 安装
 
 ```bash
 npm install mm_ret
 ```
 
-## 快速开始 / Quick Start
+## 快速开始
 
-### 基本使用 / Basic Usage
+### 基本使用
 
 ```javascript
 const { Ret, Req, Error } = 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
-
-- ✅ **JSON-RPC 2.0 标准兼容** - 完全符合JSON-RPC 2.0规范
-- ✅ **多种响应类型** - 支持对象、列表、布尔值等响应格式
-- ✅ **错误码管理** - 内置标准错误码和自定义错误码
-- ✅ **请求模板** - 支持请求参数模板功能
-- ✅ **轻量级** - 无依赖，体积小巧
-- ✅ **TypeScript 支持** - 提供完整的类型定义
-
-## API 文档 / API Documentation
+## API 文档
 
 ### Ret 类 - 响应生成器
 
-生成符合JSON-RPC 2.0标准的响应对象。
+生成符合 JSON-RPC 2.0 标准的响应对象。
 
-#### 方法 / Methods
+#### 方法
 
 ##### `body(result, error, id)`
-生成基础的JSON-RPC响应体。
+生成基础的 JSON-RPC 响应体。
 
 **参数:**
 - `result` {any} - 返回结果
 - `error` {Object} - 错误信息（可选）
 - `id` {String} - 请求ID（可选）
 
-**返回值:** {Object} JSON-RPC响应对象
+**返回值:** {Object} JSON-RPC 响应对象
 
 ##### `error(code, message, id)`
 生成错误响应。
@@ -103,7 +103,7 @@ console.log(requestBody);
 
 ### Req 类 - 请求生成器
 
-生成符合JSON-RPC 2.0标准的请求对象。
+生成符合 JSON-RPC 2.0 标准的请求对象。
 
 #### 构造函数
 ```javascript
@@ -113,22 +113,22 @@ new Req(scope = 'sys')
 **参数:**
 - `scope` {String} - 作用域，默认为"sys"
 
-#### 方法 / Methods
+#### 方法
 
 ##### `send(method, params)`
-生成JSON-RPC请求。
+生成 JSON-RPC 请求。
 
 **参数:**
 - `method` {String} - 方法名
 - `params` {Object} - 参数对象
 
-**返回值:** {Object} 标准的JSON-RPC请求对象
+**返回值:** {Object} 标准的 JSON-RPC 请求对象
 
 ### Error 类 - 错误码管理
 
-管理JSON-RPC标准错误码和自定义错误码。
+管理 JSON-RPC 标准错误码和自定义错误码。
 
-#### 方法 / Methods
+#### 方法
 
 ##### `get(keyword)`
 根据关键词或错误码获取对应的错误信息。
@@ -136,11 +136,11 @@ new Req(scope = 'sys')
 **参数:**
 - `keyword` {String|Number} - 关键词或错误码
 
-**返回值:** {Object} 错误信息对象，包含code和message
+**返回值:** {Object} 错误信息对象，包含 code 和 message
 
-## 使用示例 / Examples
+## 使用示例
 
-### 响应示例 / Response Examples
+### 响应示例
 
 ```javascript
 const { Ret } = require('mm_ret');
@@ -166,7 +166,7 @@ const bool = Ret.bl(true, '操作成功');
 // {"result":{"bl":true,"tip":"操作成功"}}
 ```
 
-### 请求示例 / Request Examples
+### 请求示例
 
 ```javascript
 const { Req } = require('mm_ret');
@@ -190,45 +190,45 @@ const templateRequest = reqWithTemplate.send('message', {
 // 自动合并模板字段
 ```
 
-## 错误码参考 / 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 |
+## 错误码参考
+
+### 标准 JSON-RPC 错误码
+| 错误码 | 说明 |
+|--------|------|
+| -32700 | 格式错误 |
+| -32701 | 编码不支持 |
+| -32702 | 无效字符 |
+| -32600 | 无效请求 |
+| -32601 | 方法不存在 |
+| -32602 | 无效参数 |
+| -32603 | 内部错误 |
+| -32500 | 应用错误 |
+| -32400 | 系统错误 |
+| -32300 | 传输错误 |
 
 ### 自定义错误码
-| 错误码 | 说明 | Description |
-|--------|------|-------------|
-| 10000 | 业务逻辑错误 | Business logic error |
-| 30000 | 身份验证失败 | Authentication failed |
-| 40000 | 数据库执行错误 | Database execution error |
-| 50000 | 服务端执行错误 | Server execution error |
-| 70000 | 参数不正确 | Invalid parameters |
+| 错误码 | 说明 |
+|--------|------|
+| 10000 | 业务逻辑错误 |
+| 30000 | 身份验证失败 |
+| 40000 | 数据库执行错误 |
+| 50000 | 服务端执行错误 |
+| 70000 | 参数不正确 |
 
-## 测试 / Testing
+## 测试
 
 ```bash
 npm test
 ```
 
-## 许可证 / License
+## 许可证
 
 ISC License
 
-## 贡献 / Contributing
+## 贡献
 
 欢迎提交 Issue 和 Pull Request！
 
-## 更新日志 / Changelog
+## 更新日志
 
 查看 [GitHub Releases](https://github.com/qiuwenwu91/mm_ret/releases) 获取详细更新信息。

package/README_EN.md

@@ -0,0 +1,234 @@
+# mm_ret
+
+[![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.
+
+## Features
+
+- ✅ **JSON-RPC 2.0 Compliant** - Fully conforms to JSON-RPC 2.0 specification
+- ✅ **Multiple Response Types** - Supports object, list, boolean, and other response formats
+- ✅ **Error Code Management** - Built-in standard error codes and custom error codes
+- ✅ **Request Templates** - Supports request parameter template functionality
+- ✅ **Lightweight** - No dependencies, small footprint
+- ✅ **TypeScript Support** - Provides complete type definitions
+
+## Installation
+
+```bash
+npm install mm_ret
+```
+
+## Quick Start
+
+### Basic Usage
+
+```javascript
+const { Ret, Req, Error } = require('mm_ret');
+
+// Generate success response
+const successResponse = Ret.body('Operation successful');
+console.log(successResponse);
+// Output: {"result":"Operation successful"}
+
+// Generate error response
+const errorResponse = Ret.error(10000, 'Parameter error');
+console.log(errorResponse);
+// Output: {"error":{"code":10000,"message":"Parameter error"}}
+
+// Generate request
+const req = new Req('user');
+const requestBody = req.send('getUser', { id: 123 });
+console.log(requestBody);
+// Output: {"jsonrpc":"2.0","method":"user.getUser","params":{"id":123},"id":"..."}
+```
+
+## API Documentation
+
+### Ret Class - Response Generator
+
+Generates JSON-RPC 2.0 compliant response objects.
+
+#### Methods
+
+##### `body(result, error, id)`
+Generates a basic JSON-RPC response body.
+
+**Parameters:**
+- `result` {any} - Return result
+- `error` {Object} - Error information (optional)
+- `id` {String} - Request ID (optional)
+
+**Returns:** {Object} JSON-RPC response object
+
+##### `error(code, message, id)`
+Generates an error response.
+
+**Parameters:**
+- `code` {Number} - Error code
+- `message` {String} - Error message
+- `id` {String} - Request ID (optional)
+
+**Returns:** {Object} Response object containing error information
+
+##### `list(list, count, id)`
+Generates a list-type response.
+
+**Parameters:**
+- `list` {Array} - Data list
+- `count` {Number} - Total count (optional)
+- `id` {String} - Request ID (optional)
+
+**Returns:** {Object} Response object containing list data
+
+##### `obj(obj, id)`
+Generates an object-type response.
+
+**Parameters:**
+- `obj` {Object} - Return object
+- `id` {String} - Request ID (optional)
+
+**Returns:** {Object} Response object containing object data
+
+##### `bl(bl, tip, id)`
+Generates a boolean-type response.
+
+**Parameters:**
+- `bl` {Boolean} - Boolean value
+- `tip` {String} - Tip message (optional)
+- `id` {String} - Request ID (optional)
+
+**Returns:** {Object} Response object containing boolean value and tip message
+
+### Req Class - Request Generator
+
+Generates JSON-RPC 2.0 compliant request objects.
+
+#### Constructor
+```javascript
+new Req(scope = 'sys')
+```
+
+**Parameters:**
+- `scope` {String} - Scope, defaults to "sys"
+
+#### Methods
+
+##### `send(method, params)`
+Generates a JSON-RPC request.
+
+**Parameters:**
+- `method` {String} - Method name
+- `params` {Object} - Parameter object
+
+**Returns:** {Object} Standard JSON-RPC request object
+
+### Error Class - Error Code Management
+
+Manages JSON-RPC standard error codes and custom error codes.
+
+#### Methods
+
+##### `get(keyword)`
+Retrieves corresponding error information based on keyword or error code.
+
+**Parameters:**
+- `keyword` {String|Number} - Keyword or error code
+
+**Returns:** {Object} Error information object containing code and message
+
+## Usage Examples
+
+### Response Examples
+
+```javascript
+const { Ret } = require('mm_ret');
+
+// Success response
+const success = Ret.body({ message: 'Operation successful' });
+// {"result":{"message":"Operation successful"}}
+
+// Error response
+const error = Ret.error(400, 'Parameter validation failed');
+// {"error":{"code":400,"message":"Parameter validation failed"}}
+
+// List response
+const list = Ret.list([{ id: 1, name: 'User1' }, { id: 2, name: 'User2' }], 2);
+// {"result":{"list":[{...}],"count":2}}
+
+// Object response
+const obj = Ret.obj({ id: 1, name: 'John', age: 25 });
+// {"result":{"obj":{...}}}
+
+// Boolean response
+const bool = Ret.bl(true, 'Operation successful');
+// {"result":{"bl":true,"tip":"Operation successful"}}
+```
+
+### Request Examples
+
+```javascript
+const { Req } = require('mm_ret');
+
+// Basic request
+const req = new Req('user');
+const request = req.send('getProfile', { userId: 123 });
+// {"method":"user.getProfile","params":{"userId":123},"id":"..."}
+
+// Using templates
+const reqWithTemplate = new Req('message');
+reqWithTemplate.tpl.message = {
+    to_user: '',
+    from_user: '',
+    content: ''
+};
+const templateRequest = reqWithTemplate.send('message', { 
+    content: 'Hello!',
+    media: { title: 'Important Notice' }
+});
+// Automatically merges template fields
+```
+
+## Error Code Reference
+
+### Standard JSON-RPC Error Codes
+| Code | 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 |
+
+### Custom Error Codes
+| Code | 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
+
+Welcome to submit issues and pull requests!
+
+## Changelog
+
+Check [GitHub Releases](https://github.com/qiuwenwu91/mm_ret/releases) for detailed update information.

package/eslint.config.js

@@ -0,0 +1,68 @@
+const jsdoc = require('eslint-plugin-jsdoc');
+
+module.exports = [
+  {
+    files: ['index.js','lib/**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      sourceType: 'script'
+    },
+    plugins: {
+      jsdoc: jsdoc
+    },
+    rules: {
+      // JSDoc相关规则 - 设置为error级别强制要求
+      'jsdoc/require-jsdoc': ['error', {
+        require: {
+          FunctionDeclaration: true,
+          MethodDefinition: true,
+          ClassDeclaration: true,
+          ArrowFunctionExpression: true
+        }
+      }],
+      'jsdoc/check-param-names': 'off',
+      'jsdoc/check-tag-names': 'off',
+      'jsdoc/check-types': 'off',
+      'jsdoc/require-param': 'off',
+      'jsdoc/require-param-description': 'off',
+      'jsdoc/require-returns': 'off',
+      'jsdoc/require-returns-description': 'off',
+      
+      // 基础语法规则
+      'no-unused-vars': ['error', { args: 'none', vars: 'all' }],
+      'no-console': 'warn',
+      
+      // 代码风格规则
+      'indent': ['error', 2],
+      'quotes': ['error', 'single'],
+      'semi': ['error', 'always'],
+      'comma-dangle': ['error', 'never'],
+      'no-trailing-spaces': 'error',
+      'eol-last': 'error',
+      'max-len': ['error', { code: 100 }],
+      'max-lines-per-function': ['error', { max: 40 }],
+      'complexity': ['error', 12],
+      'max-depth': ['error', 4],
+      'max-params': ['error', 4],
+      
+      // 命名规则
+      'id-length': ['error', {
+        min: 1,
+        max: 20,
+        properties: 'always'
+      }]
+    }
+  },
+  {
+    files: ['test/**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      sourceType: 'script'
+    },
+    rules: {
+      // 测试文件中允许使用console
+      'no-console': 'off',
+      'no-unused-vars': 'off'
+    }
+  }
+];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_ret",
-    "version": "1.4.4",
+    "version": "1.4.5",
     "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.7"
+        "mm_expand": "^2.0.0"
     }
 }

package/test.js

@@ -91,14 +91,3 @@ function 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);