node-easywechat 3.0.0-beta.4 → 3.0.1

package/CHANGELOG.md

@@ -1,10 +1,40 @@
 # CHANGELOG
 
 
+## v3.0.1 (2022-08-26)
+
+- Fix: 修复with方法无效的问题
+
+## v3.0.0, origin/3.x (2022-07-28)
+
+- Feat: 请求后自动解析响应结果，简化获取数据的方式
+- Feat: 新增微信支付模块的公共调用方法
+- Feat: 新增支付模块
+
+- Fix: 响应内容解析时排除buffer对象
+- Fix: 修复获取框架版本异常的问题
+- Fix: 修复获取响应对象的字符串数据时异常的问题
+- Fix: 修复测试用例中post等方式模拟请求时异常的问题
+- Fix: 调整微信支付配置项
+- Fix: 修复消息参数提示缺失问题
+- Fix: 调整默认的RSA加密算法中的哈希方式为sha256
+- Fix: 调整默认Message提示的作用域为公众号和小程序
+- Fix: 修复AccessToken对象声明错误的问题
+
+- Docs: 更新client调用方法说明
+- Docs: 增加微信支付相关说明文档
+
+## v3.0.0-beta.5 (2022-06-29)
+
+- Fix: 修复服务端获取消息异常的问题
+
 ## v3.0.0-beta.4 (2022-06-24)
 
+- Feat: 增加链式添加上传文件的方法
 - Feat: 请求接口数据增加 FormData 实例的支持
 
+- Fix: 修复接受微信回调接口验证请求时，返回对象无文件内容的问题
+
 ## v3.0.0-beta.3 (2022-06-22)
 
 - Fix: 修复获取js ticket时无法自动获取access_token的问题

package/README.md

@@ -37,16 +37,31 @@ let app = new MiniApp({
   // 配置项
 });
 
+// 微信支付
+const { Pay } = require('node-easywechat');
+// 实例化应用
+let app = new Pay({
+  // 配置项
+});
+
 // ----- 以下为通用的 api 调用方法 -----
 
 // 获取 api 调用客户端
 let client = app.getClient();
 
 // 请求 api
+// 注意，这里返回的是 HttpClientResponse 对象
 let response = await client.post('/cgi-bin/user/info/updateremark', {
   openid: 'xxxx',
   remark: 'xxxx',
 });
+// 获取具体数据
+let data = response.toObject();
+// 另外还有以下方法：
+// toJson() 转json字符串
+// toString() 转字符串
+// saveAs(filename) 保存为文件
+// toDataUrl() 转base64字符串
 ```
 
 ### 配置项示例
@@ -103,6 +118,26 @@ let response = await client.post('/cgi-bin/user/info/updateremark', {
 }
 ```
 
+``` js
+// 微信支付配置
+{
+  // 商户号
+  mch_id: '',
+  // 商户证书路径
+  certificate: '',
+  // 商户证书私钥路径
+  private_key: '',
+  // 平台证书（v3接口需要）
+  // 持路径列表或者PublicKey对象列表或者，以serial_no为key，证书内容或PublicKey对象为value的对象
+  // 下载工具：https://github.com/wechatpay-apiv3/CertificateDownloader
+  platform_certs: '',
+  // v3 API密钥
+  secret_key: '',
+  // v2 API密钥
+  v2_secret_key: '',
+}
+```
+
 ### 自定义模块（模块替换）使用方法
 
 #### 日志模块
@@ -214,7 +249,7 @@ app.setRequest(request);
 ### 模块支持情况
 
 - [x] 公众号模块
-- [ ] 微信支付
+- [x] 微信支付
 - [x] 小程序
 - [ ] 开放平台
 - [ ] 企业微信

package/dist/Core/Contracts/RefreshableAccessTokenInterface.d.ts

@@ -1,9 +1,9 @@
 import AccessTokenInterface from "./AccessTokenInterface";
-declare abstract class RefreshableAccessToken extends AccessTokenInterface {
+declare abstract class RefreshableAccessTokenInterface extends AccessTokenInterface {
     /**
      * 刷新token
      * @returns
      */
     refresh(): Promise<string>;
 }
-export = RefreshableAccessToken;
+export = RefreshableAccessTokenInterface;

package/dist/Core/Contracts/RefreshableAccessTokenInterface.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 const AccessTokenInterface_1 = __importDefault(require("./AccessTokenInterface"));
-class RefreshableAccessToken extends AccessTokenInterface_1.default {
+class RefreshableAccessTokenInterface extends AccessTokenInterface_1.default {
     /**
      * 刷新token
      * @returns
@@ -22,4 +22,4 @@ class RefreshableAccessToken extends AccessTokenInterface_1.default {
     }
 }
 ;
-module.exports = RefreshableAccessToken;
+module.exports = RefreshableAccessTokenInterface;

package/dist/Core/Http/Minxins/MessageMixin.js

@@ -63,8 +63,7 @@ class MessageMixin {
     }
     withBody(body) {
         if (Buffer.isBuffer(body)) {
-            this.content = Buffer.from('');
-            this.content.copy(body);
+            this.content = body;
         }
         else if (typeof body === 'string') {
             this.content = Buffer.from(body);

package/dist/Core/Http/ServerRequest.d.ts

@@ -43,7 +43,7 @@ declare class ServerRequest implements ServerRequestInterface {
      * @param body 支持 Buffer、object对象、JSON字符串、XML字符串、QueryString格式的 body 内容字符串
      * @returns
      */
-    static createFromIncomingMessage(req: IncomingMessage, body?: Buffer | Record<string, any> | string): ServerRequest;
+    static createFromIncomingMessage(req: IncomingMessage, body?: Buffer | Record<string, any> | string): Promise<ServerRequest>;
 }
 interface ServerRequest extends MessageMixin, RequestMixin {
 }

package/dist/Core/Http/ServerRequest.js

@@ -1,4 +1,13 @@
 'use strict';
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -124,13 +133,14 @@ class ServerRequest {
      * @returns
      */
     static createFromIncomingMessage(req, body = null) {
-        let request = new ServerRequest(req.method, req.url, req.headers || {}, body, req.httpVersion, (0, url_1.parse)(req.url, true).query || {});
-        if (!body) {
-            (0, raw_body_1.default)(req).then(res => {
+        return __awaiter(this, void 0, void 0, function* () {
+            let request = new ServerRequest(req.method, req.url, req.headers || {}, body, req.httpVersion);
+            if (!body) {
+                let res = yield (0, raw_body_1.default)(req);
                 request.withBody(res);
-            });
-        }
-        return request;
+            }
+            return request;
+        });
     }
 }
 ;

package/dist/Core/HttpClient/HttpClient.js

@@ -102,7 +102,9 @@ class HttpClient {
                 let usedTime = Date.now() - starttime;
                 yield this.logger('after', options, usedTime, response);
             }
-            return new HttpClientResponse_1.default(response, this.failureJudge, this.throwError);
+            let resp = new HttpClientResponse_1.default(response, this.failureJudge, this.throwError);
+            yield resp.parseContent(this.throwError);
+            return resp;
         });
     }
     getInstance() {

package/dist/Core/HttpClient/HttpClientResponse.d.ts

@@ -5,7 +5,20 @@ declare class HttpClientResponse implements HttpClientResponseInterface {
     protected response: AxiosResponse;
     protected failureJudge: HttpClientFailureJudgeClosure;
     protected throwError: boolean;
+    protected parsedContent: Record<string, any>;
     constructor(response: AxiosResponse, failureJudge?: HttpClientFailureJudgeClosure, throwError?: boolean);
+    /**
+     * 设置解析后的body内容
+     * @param content
+     * @returns
+     */
+    setParsedContent(content: Record<string, any>): this;
+    /**
+     * 解析body内容
+     * @param throwError
+     * @returns
+     */
+    parseContent(throwError?: boolean): Promise<void>;
     withThrowError(throwError: boolean): this;
     throwOnFailure(): this;
     quietly(): this;
@@ -27,21 +40,19 @@ declare class HttpClientResponse implements HttpClientResponseInterface {
     isSuccessful(): boolean;
     /**
      * 返回对象格式
-     * @param throwError
      * @returns
      */
-    toObject<T = WeixinResponse>(throwError?: boolean): Promise<T>;
+    toObject<T = WeixinResponse>(): T;
     /**
      * 返回json字符串
-     * @param throwError
      * @returns
      */
-    toJson(throwError?: boolean): Promise<string>;
+    toJson(): string;
     /**
      * 返回字符串
      * @returns
      */
-    toString(): Promise<string>;
+    toString(): string;
     /**
      * 另存为文件
      * @param filename 完整的文件名（含路径）

package/dist/Core/HttpClient/HttpClientResponse.js

@@ -15,10 +15,65 @@ const fs_1 = __importDefault(require("fs"));
 const merge_1 = __importDefault(require("merge"));
 const Utils_1 = require("../Support/Utils");
 class HttpClientResponse {
-    constructor(response, failureJudge = null, throwError = true) {
+    constructor(response, failureJudge = null, throwError = false) {
         this.response = response;
         this.failureJudge = failureJudge;
         this.throwError = throwError;
+        this.parsedContent = null;
+    }
+    /**
+     * 设置解析后的body内容
+     * @param content
+     * @returns
+     */
+    setParsedContent(content) {
+        this.parsedContent = content;
+        return this;
+    }
+    /**
+     * 解析body内容
+     * @param throwError
+     * @returns
+     */
+    parseContent(throwError = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throwError = throwError !== null && throwError !== void 0 ? throwError : this.throwError;
+            let content = this.response.data;
+            if (!content) {
+                if (throwError) {
+                    throw new Error('Response body is empty.');
+                }
+                return;
+            }
+            if (typeof content === 'string') {
+                if (this.is('xml') && content.indexOf('<xml>') > -1) {
+                    this.parsedContent = yield (0, Utils_1.parseXml)(content);
+                }
+                else if (this.is('json')) {
+                    try {
+                        this.parsedContent = JSON.parse(content);
+                    }
+                    catch (e) {
+                        if (throwError) {
+                            throw new Error('Fail to parse JSON content.');
+                        }
+                    }
+                }
+                else if (this.is('text')) {
+                    try {
+                        this.parsedContent = (0, Utils_1.parseQueryString)(content);
+                    }
+                    catch (e) {
+                        if (throwError) {
+                            throw new Error('Fail to parse QueryString content.');
+                        }
+                    }
+                }
+            }
+            else if (!Buffer.isBuffer(content)) {
+                this.parsedContent = content;
+            }
+        });
     }
     withThrowError(throwError) {
         this.throwError = throwError;
@@ -63,40 +118,25 @@ class HttpClientResponse {
     }
     /**
      * 返回对象格式
-     * @param throwError
      * @returns
      */
-    toObject(throwError = null) {
-        return __awaiter(this, void 0, void 0, function* () {
-            throwError = throwError === null ? this.throwError : throwError;
-            let content = this.response.data;
-            if (!content) {
-                throw new Error('Response body is empty.');
-            }
-            if (typeof content === 'string') {
-                if (this.is('xml') && content.indexOf('<xml>') > -1) {
-                    return (0, Utils_1.parseXml)(content);
-                }
-            }
-            return content;
-        });
+    toObject() {
+        return this.parsedContent;
     }
     /**
      * 返回json字符串
-     * @param throwError
      * @returns
      */
-    toJson(throwError = null) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return JSON.stringify(yield this.toObject(throwError));
-        });
+    toJson() {
+        return JSON.stringify(this.toObject());
     }
     /**
      * 返回字符串
      * @returns
      */
     toString() {
-        return this.toJson();
+        let obj = this.getContent();
+        return (typeof obj === 'object' && obj !== null) ? JSON.stringify(obj) : String(obj);
     }
     /**
      * 另存为文件
@@ -126,6 +166,8 @@ class HttpClientResponse {
      */
     is(type) {
         let contentType = this.getHeader('content-type');
+        if (!contentType)
+            return false;
         let res = false;
         switch (type.toLowerCase()) {
             case 'json':

package/dist/Core/HttpClient/Mixins/PresetMixin.d.ts

@@ -62,18 +62,6 @@ declare class PresetMixin {
      * @returns
      */
     withSecret(new_secret?: string): this;
-    /**
-     * 预设置mch_id（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_mch_id
-     * @returns
-     */
-    withMchId(new_mch_id?: string): this;
-    /**
-     * 预设置mch_id别名（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_alias
-     * @returns
-     */
-    withMchIdAs(new_alias?: string): this;
     /**
      * 预设置文件
      * @param file  文件路径或可读文件流

package/dist/Core/HttpClient/Mixins/PresetMixin.js

@@ -109,24 +109,6 @@ class PresetMixin {
         this.with('secret', new_secret);
         return this;
     }
-    /**
-     * 预设置mch_id（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_mch_id
-     * @returns
-     */
-    withMchId(new_mch_id = null) {
-        this.with('mch_id', new_mch_id);
-        return this;
-    }
-    /**
-     * 预设置mch_id别名（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_alias
-     * @returns
-     */
-    withMchIdAs(new_alias = null) {
-        this.with(new_alias, this.presets['mch_id']);
-        return this;
-    }
     /**
      * 预设置文件
      * @param file  文件路径或可读文件流

package/dist/Core/Message.d.ts

@@ -27,132 +27,5 @@ declare class Message {
     toString(): string;
 }
 interface Message extends HasAttributesMixin {
-    /**
-     * 消息密文，兼容模式、安全模式才有
-     */
-    Encrypt?: string;
-    /**
-     * 开发者微信号
-     */
-    ToUserName?: string;
-    /**
-     * 发送方帐号 OpenId
-     */
-    FromUserName?: string;
-    /**
-     * 消息创建时间
-     */
-    CreateTime?: number;
-    /**
-     * 消息类型，'event'：事件，'text'：文本，'image'：图片，'voice'：语音，'video'：视频，'shortvideo'：小视频，'location'：地理位置，'link'：链接
-     */
-    MsgType?: string;
-    /**
-     * 消息id，64位整型
-     * @scope MsgType='text' | 'image' | 'voice' | 'video' | 'shortvideo' | 'location'
-     */
-    MsgId?: string;
-    /**
-     * 文本消息内容
-     * @scope MsgType='text'
-     */
-    Content?: string;
-    /**
-     * 图片链接
-     * @scope MsgType='image'
-     */
-    PicUrl?: string;
-    /**
-     * 媒体id，可以调用获取临时素材接口拉取数据
-     * @scope MsgType='image' | 'voice'
-     */
-    MediaId?: string;
-    /**
-     * 语音格式，如amr，speex等
-     * @scope MsgType='voice'
-     */
-    Format?: string;
-    /**
-     * 语音识别结果，UTF8编码
-     * @scope MsgType='voice'
-     */
-    Recognition?: string;
-    /**
-     * 缩略图的媒体id
-     * @scope MsgType='video' | 'shortvideo'
-     */
-    ThumbMediaId?: string;
-    /**
-     * 纬度
-     * @scope MsgType='location'
-     */
-    Location_X?: number;
-    /**
-     * 经度
-     * @scope MsgType='location'
-     */
-    Location_Y?: number;
-    /**
-     * 地图缩放大小
-     * @scope MsgType='location'
-     */
-    Scale?: number;
-    /**
-     * 地理位置信息
-     * @scope MsgType='location'
-     */
-    Label?: number;
-    /**
-     * 消息标题
-     * @scope MsgType='link'
-     */
-    Title?: string;
-    /**
-     * 消息描述
-     * @scope MsgType='link'
-     */
-    Description?: string;
-    /**
-     * 消息链接
-     * @scope MsgType='link'
-     */
-    Url?: string;
-    /**
-     * 事件类型，subscribe：关注，unsubscribe：取消关注，SCAN：扫描（用户已关注），LOCATION：地理位置；CLICK：自定义菜单事件，VIEW：点击菜单跳转链接
-     * @scope MsgType='event'
-     */
-    Event?: string;
-    /**
-     * 事件KEY值
-     *
-     * Event='subscribe' | 'SCAN'时：qrscene_为前缀，后面为二维码的参数值
-     *
-     * Event='CLICK'时：自定义菜单接口中KEY值对应
-     *
-     * Event='VIEW'时：设置的跳转URL
-     *
-     * @scope MsgType='event' && Event='subscribe' | 'SCAN' | 'CLICK' | 'VIEW'
-     */
-    EventKey?: string;
-    /**
-     * 二维码的ticket，可用来换取二维码图片
-     * @scope MsgType='event' && Event='subscribe' | 'SCAN'
-     */
-    Ticket?: string;
-    /**
-     * 纬度
-     * @scope MsgType='event' && Event='LOCATION'
-     */
-    Latitude?: number;
-    /**
-     * 经度
-     * @scope MsgType='event' && Event='LOCATION'
-     */
-    Longitude?: number;
-    /**
-     * 位置精度
-     * @scope MsgType='event' && Event='LOCATION'
-     */
-    Precision?: number;
 }
 export = Message;

package/dist/Core/Message.js

@@ -49,7 +49,11 @@ class Message {
      */
     static createFromRequest(request) {
         return __awaiter(this, void 0, void 0, function* () {
-            let originContent = request.getBody().toString();
+            let originContent = '';
+            let body = request.getBody();
+            if (body) {
+                originContent = body.toString();
+            }
             let attributes = {};
             if ('<' === originContent.substring(0, 1)) {
                 attributes = yield (0, Utils_1.parseXml)(originContent);

package/dist/Core/Mixins/DecryptXmlMessageMixin.js

@@ -16,7 +16,7 @@ class DecryptXmlMessageMixin {
      */
     decryptMessage(message, encryptor, signature, timestamp, nonce) {
         return __awaiter(this, void 0, void 0, function* () {
-            let ciphertext = message.Encrypt;
+            let ciphertext = message['Encrypt'];
             this.validateSignature(encryptor.getToken(), ciphertext, signature, timestamp, nonce);
             let attributes = yield (0, Utils_1.parseXml)(encryptor.decrypt(ciphertext, signature, nonce, timestamp));
             message.merge(attributes);

package/dist/Core/Mixins/ResponseXmlMessageMixin.js

@@ -25,8 +25,8 @@ class ResponseXmlMessageMixin {
                 return new Response_1.default(200, {}, 'success');
             }
             let attributes = merge_1.default.recursive({
-                ToUserName: message.FromUserName,
-                FromUserName: message.ToUserName,
+                ToUserName: message['FromUserName'],
+                FromUserName: message['ToUserName'],
                 CreateTime: (0, Utils_1.getTimestamp)(),
             }, yield this.normalizeResponse(response));
             return this.createXmlResponse(attributes, encryptor);

package/dist/Core/Support/PrivateKey.d.ts

@@ -0,0 +1,20 @@
+export declare class PrivateKey {
+    protected key: string;
+    protected passphrase?: string;
+    constructor(key: string, passphrase?: string);
+    /**
+     * 获取私钥
+     * @returns
+     */
+    getKey(): string;
+    /**
+     * 获取密码
+     * @returns
+     */
+    getPassphrase(): string;
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString(): string;
+}

package/dist/Core/Support/PrivateKey.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrivateKey = void 0;
+const fs_1 = __importDefault(require("fs"));
+class PrivateKey {
+    constructor(key, passphrase) {
+        this.key = key;
+        this.passphrase = passphrase;
+        if (fs_1.default.existsSync(key)) {
+            this.key = fs_1.default.readFileSync(key, 'utf8') || '';
+        }
+    }
+    /**
+     * 获取私钥
+     * @returns
+     */
+    getKey() {
+        return this.key;
+    }
+    /**
+     * 获取密码
+     * @returns
+     */
+    getPassphrase() {
+        return this.passphrase;
+    }
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString() {
+        return this.getKey();
+    }
+}
+exports.PrivateKey = PrivateKey;

package/dist/Core/Support/PublicKey.d.ts

@@ -0,0 +1,14 @@
+export declare class PublicKey {
+    certificate: string;
+    constructor(certificate: string);
+    /**
+     * 获取公钥的序列号
+     * @returns
+     */
+    getSerialNo(): string;
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString(): string;
+}