node-easywechat 3.0.0-beta.5 → 3.0.0

package/CHANGELOG.md

@@ -1,14 +1,35 @@
 # CHANGELOG
 
 
+## v3.0.0 (2022-07-28)
+
+- Feat: 请求后自动解析响应结果，简化获取数据的方式
+- Feat: 新增微信支付模块的公共调用方法
+- Feat: 新增支付模块
+
+- Fix: 响应内容解析时排除buffer对象
+- Fix: 修复获取框架版本异常的问题
+- Fix: 修复获取响应对象的字符串数据时异常的问题
+- Fix: 修复测试用例中post等方式模拟请求时异常的问题
+- Fix: 调整微信支付配置项
+- Fix: 修复消息参数提示缺失问题
+- Fix: 调整默认的RSA加密算法中的哈希方式为sha256
+- Fix: 调整默认Message提示的作用域为公众号和小程序
+- Fix: 修复AccessToken对象声明错误的问题
+
+- 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/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/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/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;
+}

package/dist/Core/Support/PublicKey.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicKey = void 0;
+const fs_1 = __importDefault(require("fs"));
+const crypto_1 = require("crypto");
+class PublicKey {
+    constructor(certificate) {
+        this.certificate = certificate;
+        if (fs_1.default.existsSync(certificate)) {
+            this.certificate = fs_1.default.readFileSync(certificate, 'utf8') || '';
+        }
+    }
+    /**
+     * 获取公钥的序列号
+     * @returns
+     */
+    getSerialNo() {
+        try {
+            return new crypto_1.X509Certificate(this.certificate).serialNumber;
+        }
+        catch (e) {
+            throw new Error('Read the $certificate failed, please check it whether or nor correct');
+        }
+    }
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString() {
+        return this.certificate;
+    }
+}
+exports.PublicKey = PublicKey;

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

@@ -23,7 +23,7 @@ declare class RSA {
      * 加密
      * @param plaintext 待加密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */
@@ -32,7 +32,7 @@ declare class RSA {
      * 解密
      * @param ciphertext 待解密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */

package/dist/Core/Support/RSA.js

@@ -34,11 +34,11 @@ class RSA {
      * 加密
      * @param plaintext 待加密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */
-    encrypt(plaintext, encoding = 'base64', hashType = 'sha1', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
+    encrypt(plaintext, encoding = 'base64', hashType = 'sha256', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
         let encryptedData = crypto_1.default.publicEncrypt({
             key: this.publicKey,
             padding,
@@ -50,11 +50,11 @@ class RSA {
      * 解密
      * @param ciphertext 待解密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */
-    decrypt(ciphertext, encoding = 'base64', hashType = 'sha1', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
+    decrypt(ciphertext, encoding = 'base64', hashType = 'sha256', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
         let decryptedData = crypto_1.default.privateDecrypt({
             key: this.privateKey,
             padding,

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

@@ -93,3 +93,9 @@ export declare const parseXml: (xml: string) => Promise<Record<string, any>>;
  * @returns
  */
 export declare const buildXml: (data: Record<string, any>, rootName?: string) => string;
+/**
+ * 创建UserAgent
+ * @param appends 可选，附加的字符串列表
+ * @returns
+ */
+export declare const createUserAgent: (appends?: string[]) => string;

package/dist/Core/Support/Utils.js

@@ -12,12 +12,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildXml = exports.parseXml = exports.singleItem = exports.strSnake = exports.strCamel = exports.strStudly = exports.strLcwords = exports.strUcwords = exports.rtrim = exports.ltrim = exports.trim = exports.applyMixins = exports.inArray = exports.isIp = exports.isIpv6 = exports.isIpv4 = exports.isFunction = exports.isObject = exports.isNumber = exports.isArray = exports.isString = exports.makeSignature = exports.randomString = exports.parseQueryString = exports.buildQueryString = exports.getTimestamp = exports.md5File = exports.createHmac = exports.createHash = void 0;
+exports.createUserAgent = exports.buildXml = exports.parseXml = exports.singleItem = exports.strSnake = exports.strCamel = exports.strStudly = exports.strLcwords = exports.strUcwords = exports.rtrim = exports.ltrim = exports.trim = exports.applyMixins = exports.inArray = exports.isIp = exports.isIpv6 = exports.isIpv4 = exports.isFunction = exports.isObject = exports.isNumber = exports.isArray = exports.isString = exports.makeSignature = exports.randomString = exports.parseQueryString = exports.buildQueryString = exports.getTimestamp = exports.md5File = exports.createHmac = exports.createHash = void 0;
 const crypto_1 = __importDefault(require("crypto"));
 const qs_1 = __importDefault(require("qs"));
 const xml2js_1 = __importDefault(require("xml2js"));
 const stream_1 = __importDefault(require("stream"));
 const fs_1 = __importDefault(require("fs"));
+const axios_1 = __importDefault(require("axios"));
 const createHash = function (str, type = 'sha1') {
     return crypto_1.default.createHash(type).update(str).digest('hex');
 };
@@ -321,3 +322,16 @@ const buildXml = function (data, rootName = 'xml') {
     return XmlBuilder.buildObject(data).replace('<?xml version="1.0"?>', '');
 };
 exports.buildXml = buildXml;
+/**
+ * 创建UserAgent
+ * @param appends 可选，附加的字符串列表
+ * @returns
+ */
+const createUserAgent = function (appends = []) {
+    let values = [];
+    values.push(`node-easywechat/${require('../../../package.json').version}`);
+    values.push(`axios/${axios_1.default.VERSION}`);
+    values = values.concat(appends);
+    return values.join(' ');
+};
+exports.createUserAgent = createUserAgent;