node-easywechat 3.0.0-beta.3 → 3.0.0

package/CHANGELOG.md

@@ -1,6 +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/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.d.ts

@@ -2,6 +2,7 @@ import { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
 import HttpClientInterface from './Contracts/HttpClientInterface';
 import HttpClientResponse from './HttpClientResponse';
 import { HttpClientFailureJudgeClosure, LogHandler } from '../../Types/global';
+import FormData from 'form-data';
 declare class HttpClient implements HttpClientInterface {
     protected axios: AxiosInstance;
     protected failureJudge: HttpClientFailureJudgeClosure;
@@ -19,6 +20,12 @@ declare class HttpClient implements HttpClientInterface {
     request(method: Method, url: string, payload?: AxiosRequestConfig<any>): Promise<HttpClientResponse>;
     getInstance(): AxiosInstance;
     setInstance(instance: AxiosInstance): this;
+    /**
+     * 获取 FormData 对象的 headers
+     * @param formData
+     * @returns
+     */
+    protected getFormDataHeaders(formData: FormData): Promise<Record<string, string | number>>;
     /**
      * 创建http客户端
      * @param config

package/dist/Core/HttpClient/HttpClient.js

@@ -11,10 +11,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-const merge_1 = __importDefault(require("merge"));
 const axios_1 = __importDefault(require("axios"));
 const HttpClientResponse_1 = __importDefault(require("./HttpClientResponse"));
 const Utils_1 = require("../Support/Utils");
+const form_data_1 = __importDefault(require("form-data"));
 class HttpClient {
     constructor(axios, failureJudge = null, throwError = false) {
         this.axios = axios;
@@ -35,7 +35,9 @@ class HttpClient {
     }
     request(method, url, payload = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            let options = merge_1.default.recursive(true, payload);
+            let options = Object.assign({}, payload);
+            if (!options.headers)
+                options.headers = {};
             options.method = method;
             options.url = url;
             if (options['xml'] !== undefined) {
@@ -49,8 +51,6 @@ class HttpClient {
                 else {
                     throw new Error('The type of `xml` must be string or object.');
                 }
-                if (!options.headers)
-                    options.headers = {};
                 if (!options.headers['Content-Type'] && !options.headers['content-type']) {
                     options.headers['content-type'] = 'text/xml';
                 }
@@ -69,8 +69,6 @@ class HttpClient {
                 else {
                     throw new Error('The type of `json` must be string or object.');
                 }
-                if (!options.headers)
-                    options.headers = {};
                 if (!options.headers['Content-Type'] && !options.headers['content-type']) {
                     options.headers['content-type'] = 'application/json';
                 }
@@ -78,6 +76,23 @@ class HttpClient {
                 options['json'] = undefined;
                 delete options['json'];
             }
+            if (options['formData'] && Object.keys(options['formData']).length > 0) {
+                let formData = new form_data_1.default();
+                for (let key in options['formData']) {
+                    formData.append(key, options['formData'][key]);
+                }
+                if (options.data)
+                    for (let key in options.data) {
+                        formData.append(key, options.data[key]);
+                    }
+                options.data = formData;
+                options['formData'] = undefined;
+                delete options['formData'];
+            }
+            // 如果 data 是 FormData 对象，则从中提取 headers
+            if (options.data && options.data instanceof form_data_1.default) {
+                options.headers = Object.assign(Object.assign({}, (yield this.getFormDataHeaders(options.data))), options.headers);
+            }
             let starttime = Date.now();
             if (typeof this.logger === 'function') {
                 yield this.logger('before', options);
@@ -87,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() {
@@ -97,6 +114,25 @@ class HttpClient {
         this.axios = instance;
         return this;
     }
+    /**
+     * 获取 FormData 对象的 headers
+     * @param formData
+     * @returns
+     */
+    getFormDataHeaders(formData) {
+        return new Promise((resolve, reject) => {
+            let headers = formData.getHeaders();
+            formData.getLength(function (err, length) {
+                if (err) {
+                    headers['content-length'] = 0;
+                }
+                else {
+                    headers['content-length'] = length;
+                }
+                resolve(headers);
+            });
+        });
+    }
     /**
      * 创建http客户端
      * @param config

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

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import { AxiosRequestConfig, Method } from "axios";
+import fs from "fs";
 declare class PresetMixin {
     /**
      * 存储预置参数
@@ -12,6 +14,10 @@ declare class PresetMixin {
      * 存储预置数据
      */
     protected prependData: Record<string, any>;
+    /**
+     * 存储预置文件数据
+     */
+    protected prependFiles: Record<string, fs.ReadStream>;
     /**
      * 设置预置参数
      * @param presets
@@ -68,12 +74,25 @@ declare class PresetMixin {
      * @returns
      */
     withMchIdAs(new_alias?: string): this;
+    /**
+     * 预设置文件
+     * @param file  文件路径或可读文件流
+     * @param key 参数名，默认：'file'
+     * @returns
+     */
+    withFile(file: string | fs.ReadStream, key?: string): this;
+    /**
+     * 预设置多个文件
+     * @param files  键名：文件名，键值：文件路径或可读文件流
+     * @returns
+     */
+    withFiles(files: Record<string, string | fs.ReadStream>): this;
     /**
      * 合并预置参数并清空预置数据
      * @param payload
      * @param method
      * @returns
      */
-    mergeThenResetPrepends(payload: AxiosRequestConfig, method?: Method): any;
+    mergeThenResetPrepends(payload: AxiosRequestConfig, method?: Method): AxiosRequestConfig<any>;
 }
 export = PresetMixin;

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

@@ -2,7 +2,7 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-const merge_1 = __importDefault(require("merge"));
+const fs_1 = __importDefault(require("fs"));
 class PresetMixin {
     constructor() {
         /**
@@ -17,6 +17,10 @@ class PresetMixin {
          * 存储预置数据
          */
         this.prependData = {};
+        /**
+         * 存储预置文件数据
+         */
+        this.prependFiles = {};
     }
     /**
      * 设置预置参数
@@ -123,6 +127,35 @@ class PresetMixin {
         this.with(new_alias, this.presets['mch_id']);
         return this;
     }
+    /**
+     * 预设置文件
+     * @param file  文件路径或可读文件流
+     * @param key 参数名，默认：'file'
+     * @returns
+     */
+    withFile(file, key = 'file') {
+        if (typeof this.prependFiles !== 'object') {
+            this.prependFiles = {};
+        }
+        if (file instanceof fs_1.default.ReadStream) {
+            this.prependFiles[key] = file;
+        }
+        else if (typeof file === 'string') {
+            this.prependFiles[key] = fs_1.default.createReadStream(file);
+        }
+        return this;
+    }
+    /**
+     * 预设置多个文件
+     * @param files  键名：文件名，键值：文件路径或可读文件流
+     * @returns
+     */
+    withFiles(files) {
+        for (const key in files) {
+            this.withFile(files[key], key);
+        }
+        return this;
+    }
     /**
      * 合并预置参数并清空预置数据
      * @param payload
@@ -132,9 +165,11 @@ class PresetMixin {
     mergeThenResetPrepends(payload, method = 'get') {
         var _a, _b, _c, _d;
         let field = method.toLowerCase() === 'get' ? 'params' : 'data';
-        let options = merge_1.default.recursive(true, payload);
+        let options = Object.assign({}, payload);
         if (!options.headers)
             options.headers = {};
+        if (!options.formData)
+            options.formData = {};
         if (((_b = (_a = options.headers['Content-Type']) !== null && _a !== void 0 ? _a : options.headers['content-type']) !== null && _b !== void 0 ? _b : null) === 'application/json' || !!options.json) {
             field = 'json';
         }
@@ -147,8 +182,12 @@ class PresetMixin {
         if (this.prependHeaders && Object.keys(this.prependHeaders).length > 0) {
             options.headers = Object.assign(Object.assign({}, this.prependHeaders), options.headers);
         }
+        if (this.prependFiles && Object.keys(this.prependFiles).length > 0) {
+            options.formData = Object.assign(Object.assign({}, this.prependFiles), options.formData);
+        }
         this.prependData = {};
         this.prependHeaders = {};
+        this.prependFiles = {};
         return options;
     }
 }