node-easywechat 2.12.5 → 2.13.0

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # CHANGELOG
 
 
+## v2.13.0 (2023-09-15)
+
+- Feat: 新增获取通用的请求客户端方法
+- Feat: 优化客户端请求方法
+
+## v2.12.6 (2023-08-11)
+
+- Feat: 开放平台增加获取小程序版本信息接口
+
+- Fix: 公众号模版消息添加模版时增加关键字设置，同时优化各方法的注视
+- Fix: 修复通过Messenger发送客服消息时，类型丢失的问题
+
+## v2.12.5 (2023-05-02)
+
 ## v2.12.4 (2023-04-23)
 
 - Fix: 更新依赖包node-socialite

package/README.md

@@ -63,6 +63,69 @@ let app = EasyWechat.Factory.getInstance('OficialAccount', {
 });
 ```
 
+### 发起请求
+
+本工具包封装了大部分常用的微信api，您可以直接使用，而不用考虑具体的接口地址。
+
+以公众号获取用户信息为例：
+
+```js
+// 1. 创建公众号应用
+let officialAccount = new EasyWechat.Factory.OfficialAccount({
+  // ...
+});
+// 2. 获取用户信息
+let user = await officialAccount.user.get('user_openid');
+```
+
+但是，微信的api实在太多，有时可能不能及时更新，因此，自`2.13.0`版本开始，本工具提供通用的发送请求的客户端（感谢`ValueLan`的建议），具体使用方法如下：
+
+```js
+// 1. 创建公众号应用
+let officialAccount = new EasyWechat.Factory.OfficialAccount({
+  // ...
+});
+// 2. 获取客户端实例
+let client = officialAccount.getClient();
+// 3. 发送请求
+// get
+let querystring = { foo: 'bar' };
+let data = client.httpGet('/example-url', querystring);
+
+// post
+let data = { foo: 'bar' };
+let data = client.httpPost('/example-url', data);
+
+// 上传文件
+let files = { file1: '/path/to/file1', file2: fs.createReadStream('/path/to/file2') };
+let data = { foo: 'bar' };
+let querystring = { foo: 'bar' };
+let data = client.httpUpload('/example-url', files, data, querystring);
+
+// 通用请求
+let payload = { url: '/example-url', method: 'post', data: { foo: 'bar' } };
+let data = client.request(payload); // 参数为 axios 的请求参数
+
+// 通用请求（返回原始数据，可用于下载文件等）
+let payload = { url: '/example-url', method: 'post', data: { foo: 'bar' } };
+let data = client.requestRaw(payload); // 参数为 axios 的请求参数
+```
+
+**注意**：如果是 `Payment` 支付应用，则只有 `request`、`requestRaw` 方法，以及 `safeRequest` 方法（该方法请求时会携带支付证书），切请求参数也不一样
+
+```js
+// 1. 创建公众号应用
+let payment = new EasyWechat.Factory.Payment({
+  // ...
+});
+// 2. 获取客户端实例
+let client = payment.getClient();
+// 3. 发送请求 request、safeRequest、requestRaw 三个方法参数一样
+let data = { foo: 'bar' };
+let payload = {}; // axios 的请求参数
+let data = client.request('/example-url', data, 'post', payload);
+```
+
 ### 配置项示例
 
 ``` js

package/dist/Core/BaseAccessToken.js

@@ -205,7 +205,8 @@ class BaseAccessToken {
         return __awaiter(this, void 0, void 0, function* () {
             payload.params = payload.params || {};
             if (!payload.params[this.queryName || this.tokenKey]) {
-                payload.params[this.queryName || this.tokenKey] = (yield this.getToken())[this.tokenKey];
+                let token = yield this.getToken();
+                payload.params[this.queryName || this.tokenKey] = token[this.tokenKey];
             }
             return payload;
         });

package/dist/Core/BaseClient.d.ts

@@ -9,11 +9,43 @@ declare abstract class BaseClient implements HttpMixin {
     constructor(app: BaseApplication, accessToken?: BaseAccessToken);
     setAccessToken(accessToken: BaseAccessToken): this;
     getAccessToken(): BaseAccessToken;
+    /**
+     * 发送请求
+     * @param payload axios请求参数
+     * @param returnResponse 是否返回axios响应对象，默认false表示直接返回数据
+     */
     request(payload: AxiosRequestConfig, returnResponse?: Boolean): Promise<AxiosResponse<any>>;
+    /**
+     * 上传文件请求
+     * @param url 地址
+     * @param files 文件键值对，键名为文件字段，键值为文件路径或可读流
+     * @param form 其它表单参数键值对
+     * @param query querystring参数键值对
+     */
     httpUpload(url: string, files?: object, form?: object, query?: object): Promise<any>;
+    /**
+     * Get请求
+     * @param url 地址
+     * @param query querystring参数键值对
+     */
     httpGet(url: string, query?: object): Promise<any>;
-    httpPost(url: string, formData?: object): Promise<any>;
+    /**
+     * Post请求
+     * @param url 地址
+     * @param data body数据，详见 axios 请求配置的 data 参数
+     */
+    httpPost(url: string, data?: object): Promise<any>;
+    /**
+     * Post请求（JSON数据）
+     * @param url 地址
+     * @param data body数据，详见 axios 请求配置的 data 参数
+     * @param query querystring参数键值对
+     */
     httpPostJson(url: string, data?: object, query?: object): Promise<any>;
+    /**
+     * 发送请求并返回原始数据，主要用于下载文件等。返回封装过的Response对象
+     * @param payload axios请求参数
+     */
     requestRaw(payload: AxiosRequestConfig): Promise<Response>;
     doRequest(payload: AxiosRequestConfig): Promise<AxiosResponse<any>>;
 }

package/dist/Core/BaseClient.js

@@ -31,6 +31,11 @@ class BaseClient {
     getAccessToken() {
         return this.accessToken;
     }
+    /**
+     * 发送请求
+     * @param payload axios请求参数
+     * @param returnResponse 是否返回axios响应对象，默认false表示直接返回数据
+     */
     request(payload, returnResponse = false) {
         return __awaiter(this, void 0, void 0, function* () {
             payload = payload || {};
@@ -47,6 +52,13 @@ class BaseClient {
             return returnResponse ? response : response.data;
         });
     }
+    /**
+     * 上传文件请求
+     * @param url 地址
+     * @param files 文件键值对，键名为文件字段，键值为文件路径或可读流
+     * @param form 其它表单参数键值对
+     * @param query querystring参数键值对
+     */
     httpUpload(url, files = {}, form = {}, query = {}) {
         let formData = new form_data_1.default;
         for (let name in files) {
@@ -67,6 +79,11 @@ class BaseClient {
             params: query,
         });
     }
+    /**
+     * Get请求
+     * @param url 地址
+     * @param query querystring参数键值对
+     */
     httpGet(url, query = {}) {
         return this.request({
             url,
@@ -74,13 +91,24 @@ class BaseClient {
             params: query,
         });
     }
-    httpPost(url, formData = {}) {
+    /**
+     * Post请求
+     * @param url 地址
+     * @param data body数据，详见 axios 请求配置的 data 参数
+     */
+    httpPost(url, data = {}) {
         return this.request({
             url,
             method: 'POST',
-            data: formData,
+            data: data,
         });
     }
+    /**
+     * Post请求（JSON数据）
+     * @param url 地址
+     * @param data body数据，详见 axios 请求配置的 data 参数
+     * @param query querystring参数键值对
+     */
     httpPostJson(url, data = {}, query = {}) {
         return this.request({
             url,
@@ -89,12 +117,31 @@ class BaseClient {
             params: query,
         });
     }
+    /**
+     * 发送请求并返回原始数据，主要用于下载文件等。返回封装过的Response对象
+     * @param payload axios请求参数
+     */
     requestRaw(payload) {
         return __awaiter(this, void 0, void 0, function* () {
             payload = payload || {};
             payload.responseType = 'arraybuffer';
             let res = yield this.request(payload, true);
-            return new Response_1.default(res.data, res.status, res.headers);
+            let config = {};
+            let keys = ['url', 'baseURL', 'method', 'params', 'headers'];
+            keys.map(key => {
+                if (typeof payload[key] === 'string' || typeof payload[key] === 'number') {
+                    config[key] = payload[key];
+                }
+                else if (typeof payload[key] === 'object') {
+                    if (payload[key] === null) {
+                        config[key] = null;
+                    }
+                    else {
+                        config[key] = JSON.parse(JSON.stringify(payload[key]));
+                    }
+                }
+            });
+            return new Response_1.default(res.data, res.status, res.headers, config);
         });
     }
     // Rewrite by HttpMixin

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

@@ -3,7 +3,8 @@ export default class Response {
     protected content: Buffer;
     protected statusCode: number;
     protected headers: object;
-    constructor(content: Buffer, statusCode?: number, headers?: object);
+    protected config: object;
+    constructor(content: Buffer, statusCode?: number, headers?: object, config?: object);
     setContent(content: Buffer): void;
     getContent(): Buffer;
     setStatusCode(statusCode: number): void;
@@ -12,4 +13,6 @@ export default class Response {
     setHeaders(headers: object): void;
     getHeaders(): object;
     getHeader(key: string): string;
+    setConfig(config: object): void;
+    getConfig(): object;
 }

package/dist/Core/Http/Response.js

@@ -1,13 +1,15 @@
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
 class Response {
-    constructor(content, statusCode = 200, headers = {}) {
+    constructor(content, statusCode = 200, headers = {}, config = {}) {
         this.content = null;
         this.statusCode = 200;
         this.headers = {};
+        this.config = {};
         this.content = content;
         this.statusCode = statusCode;
         this.headers = headers;
+        this.config = config;
     }
     setContent(content) {
         this.content = content;
@@ -33,6 +35,12 @@ class Response {
     getHeader(key) {
         return this.headers[key] || '';
     }
+    setConfig(config) {
+        this.config = config;
+    }
+    getConfig() {
+        return this.config;
+    }
 }
 exports.default = Response;
 ;

package/dist/MicroMerchant/Application.d.ts

@@ -2,12 +2,19 @@ import BaseApplication from '../Core/BaseApplication';
 import { EasyWechatConfig } from '../Core/Types';
 import MicroMerchantBase from './Base/MicroMerchantBase';
 import CertficatesClient from './Certficates/CertficatesClient';
+import BaseClient from './Core/BaseClient';
 import MediaClient from './Media/MediaClient';
 import MerchantConfigClient from './MerchantConfig/MerchantConfigClient';
 import MeterialClient from './Meterial/MeterialClient';
 import WithdrawClient from './Withdraw/WithdrawClient';
+declare class Client extends BaseClient {
+}
 export default class MicroMerchant extends BaseApplication {
     protected defaultConfig: EasyWechatConfig;
+    /**
+     * 客户端实例
+     */
+    client: Client;
     base: MicroMerchantBase;
     certficates: CertficatesClient;
     media: MediaClient;
@@ -24,4 +31,9 @@ export default class MicroMerchant extends BaseApplication {
     getStatus(): Promise<any>;
     upgrade(): Promise<any>;
     getUpgradeStatus(): Promise<any>;
+    /**
+     * 获取客户端实例
+     */
+    getClient(): Client;
 }
+export {};

package/dist/MicroMerchant/Application.js

@@ -7,10 +7,14 @@ const BaseApplication_1 = __importDefault(require("../Core/BaseApplication"));
 const Utils_1 = require("../Core/Utils");
 const MicroMerchantBase_1 = __importDefault(require("./Base/MicroMerchantBase"));
 const CertficatesClient_1 = __importDefault(require("./Certficates/CertficatesClient"));
+const BaseClient_1 = __importDefault(require("./Core/BaseClient"));
 const MediaClient_1 = __importDefault(require("./Media/MediaClient"));
 const MerchantConfigClient_1 = __importDefault(require("./MerchantConfig/MerchantConfigClient"));
 const MeterialClient_1 = __importDefault(require("./Meterial/MeterialClient"));
 const WithdrawClient_1 = __importDefault(require("./Withdraw/WithdrawClient"));
+class Client extends BaseClient_1.default {
+}
+;
 class MicroMerchant extends BaseApplication_1.default {
     constructor(config = {}, prepends = {}, id = null) {
         super(config, prepends, id);
@@ -23,6 +27,10 @@ class MicroMerchant extends BaseApplication_1.default {
                 baseURL: 'https://api.mch.weixin.qq.com/',
             },
         };
+        /**
+         * 客户端实例
+         */
+        this.client = null;
         this.registerProviders();
     }
     registerProviders() {
@@ -94,6 +102,15 @@ class MicroMerchant extends BaseApplication_1.default {
     getUpgradeStatus() {
         return this.base.getUpgradeStatus.apply(this.base, arguments);
     }
+    /**
+     * 获取客户端实例
+     */
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        return this.client = new Client(this);
+    }
 }
 exports.default = MicroMerchant;
 ;

package/dist/MicroMerchant/Core/BaseClient.d.ts

@@ -1,8 +1,10 @@
+import BaseApplication from '../Application';
 import PaymentBaseClient from '../../Payment/Core/BaseClient';
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
 declare class BaseClient extends PaymentBaseClient {
+    constructor(app: BaseApplication);
     httpUpload(url: string, files?: object, form?: object, query?: object, returnResponse?: boolean): Promise<any>;
-    protected request(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig, returnResponse?: boolean): Promise<AxiosResponse<any>>;
+    request(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig, returnResponse?: boolean): Promise<AxiosResponse<any>>;
     protected processParams(params: object): object;
     protected getSensitiveFieldsName(): string[];
 }

package/dist/MicroMerchant/Core/BaseClient.js

@@ -18,6 +18,9 @@ const RSA_1 = __importDefault(require("../../Core/RSA"));
 const fs_1 = __importDefault(require("fs"));
 const form_data_1 = __importDefault(require("form-data"));
 class BaseClient extends BaseClient_1.default {
+    constructor(app) {
+        super(app);
+    }
     httpUpload(url, files = {}, form = {}, query = {}, returnResponse = false) {
         let formData = new form_data_1.default;
         for (let name in files) {

package/dist/MiniProgram/Application.d.ts

@@ -38,7 +38,14 @@ import RiskControlClient from './RiskControl/RiskControlClient';
 import LiveClient from './Live/LiveClient';
 import BroadcastClient from './Broadcast/BroadcastClient';
 import UnionClient from './Union/UnionClient';
+import BaseClient from '../Core/BaseClient';
+declare class Client extends BaseClient {
+}
 export default class MiniProgram extends BaseApplication {
+    /**
+     * 客户端实例
+     */
+    client: Client;
     access_token: AccessToken;
     auth: AuthClient;
     encryptor: Encryptor;
@@ -80,4 +87,9 @@ export default class MiniProgram extends BaseApplication {
     constructor(config?: EasyWechatConfig, prepends?: Object, id?: String);
     registerProviders(): void;
     getPaidUnionid(): Promise<any>;
+    /**
+     * 获取客户端实例
+     */
+    getClient(): Client;
 }
+export {};

package/dist/MiniProgram/Application.js

@@ -51,9 +51,17 @@ const RiskControlClient_1 = __importDefault(require("./RiskControl/RiskControlCl
 const LiveClient_1 = __importDefault(require("./Live/LiveClient"));
 const BroadcastClient_1 = __importDefault(require("./Broadcast/BroadcastClient"));
 const UnionClient_1 = __importDefault(require("./Union/UnionClient"));
+const BaseClient_1 = __importDefault(require("../Core/BaseClient"));
+class Client extends BaseClient_1.default {
+}
+;
 class MiniProgram extends BaseApplication_1.default {
     constructor(config = {}, prepends = {}, id = null) {
         super(config, prepends, id);
+        /**
+         * 客户端实例
+         */
+        this.client = null;
         this.registerProviders();
     }
     registerProviders() {
@@ -195,6 +203,15 @@ class MiniProgram extends BaseApplication_1.default {
     getPaidUnionid() {
         return this.base.getPaidUnionid.apply(this.base, arguments);
     }
+    /**
+     * 获取客户端实例
+     */
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        return this.client = new Client(this);
+    }
 }
 exports.default = MiniProgram;
 ;

package/dist/OfficialAccount/Application.d.ts

@@ -29,8 +29,15 @@ import QrcodeClient from '../BaseService/Qrcode/QrcodeClient';
 import UrlClient from '../BaseService/Url/UrlClient';
 import { EasyWechatConfig } from '../Core/Types';
 import WeChat from 'node-socialite/dist/Providers/WeChat';
+import BaseClient from '../Core/BaseClient';
+declare class Client extends BaseClient {
+}
 export default class OfficialAccount extends BaseApplication {
     protected defaultConfig: EasyWechatConfig;
+    /**
+     * 客户端实例
+     */
+    client: Client;
     access_token: AccessToken;
     encryptor: Encryptor;
     server: Guard;
@@ -65,4 +72,9 @@ export default class OfficialAccount extends BaseApplication {
     clearQuota(): Promise<any>;
     getValidIps(): Promise<any>;
     checkCallbackUrl(): Promise<any>;
+    /**
+     * 获取客户端实例
+     */
+    getClient(): Client;
 }
+export {};

package/dist/OfficialAccount/Application.js

@@ -43,6 +43,10 @@ const MediaClient_1 = __importDefault(require("../BaseService/Media/MediaClient"
 const QrcodeClient_1 = __importDefault(require("../BaseService/Qrcode/QrcodeClient"));
 const UrlClient_1 = __importDefault(require("../BaseService/Url/UrlClient"));
 const node_socialite_1 = require("node-socialite");
+const BaseClient_1 = __importDefault(require("../Core/BaseClient"));
+class Client extends BaseClient_1.default {
+}
+;
 class OfficialAccount extends BaseApplication_1.default {
     constructor(config = {}, prepends = {}, id = null) {
         super(config, prepends, id);
@@ -54,6 +58,10 @@ class OfficialAccount extends BaseApplication_1.default {
                 callback: '',
             },
         };
+        /**
+         * 客户端实例
+         */
+        this.client = null;
         this.registerProviders();
     }
     registerProviders() {
@@ -205,6 +213,15 @@ class OfficialAccount extends BaseApplication_1.default {
     checkCallbackUrl() {
         return this.base.checkCallbackUrl.apply(this.base, arguments);
     }
+    /**
+     * 获取客户端实例
+     */
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        return this.client = new Client(this);
+    }
 }
 exports.default = OfficialAccount;
 ;

package/dist/OfficialAccount/CustomerService/CustomerServiceClient.d.ts

@@ -1,4 +1,6 @@
 import BaseClient from '../../Core/BaseClient';
+import { Message } from '../../Core/Messages/Message';
+import Messenger from './Messenger';
 export default class CustomerServiceClient extends BaseClient {
     list(): Promise<any>;
     online(): Promise<any>;
@@ -7,7 +9,7 @@ export default class CustomerServiceClient extends BaseClient {
     delete(account: string): Promise<any>;
     invite(account: string, wechatId: string): Promise<any>;
     setAvatar(account: string, path: string): Promise<any>;
-    message(message: object): object;
+    message(message: string | Message): Messenger;
     send(message: object): Promise<any>;
     showTypingStatusToUser(openid: string): Promise<any>;
     hideTypingStatusToUser(openid: string): Promise<any>;

package/dist/OfficialAccount/CustomerService/Messenger.d.ts

@@ -6,7 +6,7 @@ export default class Messenger {
     protected account: string;
     protected client: CustomerServiceClient;
     constructor(client: CustomerServiceClient);
-    message(message: any): this;
+    message(message: string | Message): this;
     by(account: string): this;
     from(account: string): this;
     to(openid: string): this;

package/dist/OfficialAccount/CustomerService/Messenger.js

@@ -1,14 +1,13 @@
 'use strict';
 Object.defineProperty(exports, "__esModule", { value: true });
 const Messages_1 = require("../../Core/Messages");
-const Utils_1 = require("../../Core/Utils");
 class Messenger {
     constructor(client) {
         this._message = null;
         this.client = client;
     }
     message(message) {
-        if ((0, Utils_1.isString)(message)) {
+        if (typeof message === 'string') {
             message = new Messages_1.Text(message);
         }
         this._message = message;

package/dist/OfficialAccount/TemplateMessage/TemplateMessageClient.d.ts

@@ -5,35 +5,47 @@ export default class Client extends BaseClient {
     protected required: Array<string>;
     /**
      * 修改账号所属行业
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#设置所属行业
      * @param industry_id1 主行业id
      * @param industry_id2 副行业id
      */
     setIndustry(industry_id1: string, industry_id2: string): Promise<any>;
     /**
      * 获取支持的行业列表
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#获取设置的行业信息
      */
     getIndustry(): Promise<any>;
     /**
      * 添加模板
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#获得模板ID
      * @param template_id_short 模板库中模板的编号，有“TM**”和“OPENTMTM**”等形式
+     * @param keyword_name_list 选用的类目模板的关键词,按顺序传入,如果为空，或者关键词不在模板库中，会返回40246错误码
      */
-    addTemplate(template_id_short: string): Promise<any>;
+    addTemplate(template_id_short: string, keyword_name_list: string[]): Promise<any>;
     /**
      * 获取所有模板列表
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#获取模板列表
      */
     getPrivateTemplates(): Promise<any>;
     /**
      * 删除模板
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#删除模板
      * @param template_id 模版id
      */
     deletePrivateTemplate(template_id: string): Promise<any>;
     /**
      * 发送模板消息
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#发送模板消息
      * @param data 模版详情
      */
     send(data: object): Promise<any>;
     /**
      * 发送一次性订阅消息
+     *
+     * （注意与订阅通知的区别，若是订阅通知请使用`subscribe_message`对应的API）
+     *
+     * @see [一次性订阅消息](https://developers.weixin.qq.com/doc/offiaccount/Message_Management/One-time_subscription_info.html)
+     * @see [订阅通知](https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/intro.html)
      * @param data 消息详情
      */
     sendSubscription(data: object): Promise<any>;

package/dist/OfficialAccount/TemplateMessage/TemplateMessageClient.js

@@ -23,6 +23,7 @@ class Client extends BaseClient_1.default {
     }
     /**
      * 修改账号所属行业
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#设置所属行业
      * @param industry_id1 主行业id
      * @param industry_id2 副行业id
      */
@@ -34,27 +35,33 @@ class Client extends BaseClient_1.default {
     }
     /**
      * 获取支持的行业列表
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#获取设置的行业信息
      */
     getIndustry() {
         return this.httpGet('cgi-bin/template/get_industry');
     }
     /**
      * 添加模板
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#获得模板ID
      * @param template_id_short 模板库中模板的编号，有“TM**”和“OPENTMTM**”等形式
+     * @param keyword_name_list 选用的类目模板的关键词,按顺序传入,如果为空，或者关键词不在模板库中，会返回40246错误码
      */
-    addTemplate(template_id_short) {
+    addTemplate(template_id_short, keyword_name_list) {
         return this.httpPostJson('cgi-bin/template/api_add_template', {
             template_id_short,
+            keyword_name_list,
         });
     }
     /**
      * 获取所有模板列表
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#获取模板列表
      */
     getPrivateTemplates() {
         return this.httpGet('cgi-bin/template/get_all_private_template');
     }
     /**
      * 删除模板
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#删除模板
      * @param template_id 模版id
      */
     deletePrivateTemplate(template_id) {
@@ -64,6 +71,7 @@ class Client extends BaseClient_1.default {
     }
     /**
      * 发送模板消息
+     * @see https://developers.weixin.qq.com/doc/offiaccount/Message_Management/Template_Message_Interface.html#发送模板消息
      * @param data 模版详情
      */
     send(data) {
@@ -72,6 +80,11 @@ class Client extends BaseClient_1.default {
     }
     /**
      * 发送一次性订阅消息
+     *
+     * （注意与订阅通知的区别，若是订阅通知请使用`subscribe_message`对应的API）
+     *
+     * @see [一次性订阅消息](https://developers.weixin.qq.com/doc/offiaccount/Message_Management/One-time_subscription_info.html)
+     * @see [订阅通知](https://developers.weixin.qq.com/doc/offiaccount/Subscription_Messages/intro.html)
      * @param data 消息详情
      */
     sendSubscription(data) {

package/dist/OpenPlatform/Application.d.ts

@@ -10,7 +10,14 @@ import OpenPlatformGuard from './Server/OpenPlatformGuard';
 import CodeTemplateClient from './CodeTemplate/CodeTemplateClient';
 import ComponentClient from './Component/ComponentClient';
 import { EasyWechatConfig } from '../Core/Types';
+import BaseClient from '../Core/BaseClient';
+declare class Client extends BaseClient {
+}
 export default class OpenPlatform extends BaseApplication {
+    /**
+     * 客户端实例
+     */
+    client: Client;
     verify_ticket: VerifyTicket;
     access_token: AccessToken;
     base: OpenPlatformBase;
@@ -85,4 +92,9 @@ export default class OpenPlatform extends BaseApplication {
      * 清零调用次数
      */
     clearQuota(...arg: any[]): Promise<any>;
+    /**
+     * 获取客户端实例
+     */
+    getClient(): Client;
 }
+export {};

package/dist/OpenPlatform/Application.js

@@ -27,9 +27,17 @@ const Encryptor_1 = __importDefault(require("../Core/Encryptor"));
 const OpenPlatformGuard_1 = __importDefault(require("./Server/OpenPlatformGuard"));
 const CodeTemplateClient_1 = __importDefault(require("./CodeTemplate/CodeTemplateClient"));
 const ComponentClient_1 = __importDefault(require("./Component/ComponentClient"));
+const BaseClient_1 = __importDefault(require("../Core/BaseClient"));
+class Client extends BaseClient_1.default {
+}
+;
 class OpenPlatform extends BaseApplication_1.default {
     constructor(config = {}, prepends = {}, id = null) {
         super(config, prepends, id);
+        /**
+         * 客户端实例
+         */
+        this.client = null;
         this.registerProviders();
     }
     registerProviders() {
@@ -211,6 +219,15 @@ class OpenPlatform extends BaseApplication_1.default {
     clearQuota(...arg) {
         return this.base.clearQuota.apply(this.base, arg);
     }
+    /**
+     * 获取客户端实例
+     */
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        return this.client = new Client(this);
+    }
 }
 exports.default = OpenPlatform;
 ;

package/dist/OpenPlatform/Authorizer/MiniProgram/Application.d.ts

@@ -1,4 +1,5 @@
 import BaseApplication from '../../../MiniProgram/Application';
+import MiniProgramBaseClient from './Base/MiniProgramBaseClient';
 import CodeClient from './Code/CodeClient';
 import DomainClient from './Domain/DomainClient';
 import MaterialClient from './Material/MaterialClient';
@@ -8,6 +9,7 @@ import AccountClient from './Account/AccountClient';
 import SettingClient from './Setting/SettingClient';
 import TesterClient from './Tester/TesterClient';
 export default class MiniProgram extends BaseApplication {
+    base: MiniProgramBaseClient;
     code: CodeClient;
     domain: DomainClient;
     material: MaterialClient;
@@ -18,4 +20,5 @@ export default class MiniProgram extends BaseApplication {
     tester: TesterClient;
     constructor(config?: Object, prepends?: Object, id?: String);
     registerExtraProviders(): void;
+    getVersionInfo(): Promise<any>;
 }

package/dist/OpenPlatform/Authorizer/MiniProgram/Application.js

@@ -4,6 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const Application_1 = __importDefault(require("../../../MiniProgram/Application"));
+const MiniProgramBaseClient_1 = __importDefault(require("./Base/MiniProgramBaseClient"));
 const CodeClient_1 = __importDefault(require("./Code/CodeClient"));
 const DomainClient_1 = __importDefault(require("./Domain/DomainClient"));
 const MaterialClient_1 = __importDefault(require("./Material/MaterialClient"));
@@ -18,6 +19,9 @@ class MiniProgram extends Application_1.default {
         this.registerExtraProviders();
     }
     registerExtraProviders() {
+        this.offsetSet('base', function (app) {
+            return new MiniProgramBaseClient_1.default(app);
+        });
         this.offsetSet('code', function (app) {
             return new CodeClient_1.default(app);
         });
@@ -43,6 +47,10 @@ class MiniProgram extends Application_1.default {
             return new TesterClient_1.default(app);
         });
     }
+    // map to `base` module
+    getVersionInfo() {
+        return this.base.getVersionInfo.apply(this.base, arguments);
+    }
 }
 exports.default = MiniProgram;
 ;

package/dist/OpenPlatform/Authorizer/MiniProgram/Base/MiniProgramBaseClient.d.ts

@@ -0,0 +1,8 @@
+import BaseClient from '../../../../MiniProgram/Base/MiniProgramBase';
+export default class MiniProgramBaseClient extends BaseClient {
+    /**
+     * 获取小程序版本信息
+     * @see https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/code/get_versioninfo.html
+     */
+    getVersionInfo(): Promise<any>;
+}

package/dist/OpenPlatform/Authorizer/MiniProgram/Base/MiniProgramBaseClient.js

@@ -0,0 +1,16 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const MiniProgramBase_1 = __importDefault(require("../../../../MiniProgram/Base/MiniProgramBase"));
+class MiniProgramBaseClient extends MiniProgramBase_1.default {
+    /**
+     * 获取小程序版本信息
+     * @see https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/code/get_versioninfo.html
+     */
+    getVersionInfo() {
+        return this.httpPostJson('wxa/getversioninfo');
+    }
+}
+exports.default = MiniProgramBaseClient;

package/dist/OpenWork/Application.d.ts

@@ -16,8 +16,15 @@ import LicenseAccountClient from './License/LicenseAccountClient';
 import LicenseAppClient from './License/LicenseAppClient';
 import LicenseAutoActiveClient from './License/LicenseAutoActiveClient';
 import MediaClient from './Media/MediaClient';
+import BaseClient from '../Core/BaseClient';
+declare class Client extends BaseClient {
+}
 export default class OpenWork extends BaseApplication {
     protected defaultConfig: EasyWechatConfig;
+    /**
+     * 客户端实例
+     */
+    client: Client;
     provider_access_token: ProviderAccessToken;
     suite_access_token: SuiteAccessToken;
     suite_ticket: SuiteTicket;
@@ -46,4 +53,9 @@ export default class OpenWork extends BaseApplication {
      * @returns
      */
     work(authCorpId: string, permanentCode: string): Work;
+    /**
+     * 获取客户端实例
+     */
+    getClient(): Client;
 }
+export {};

package/dist/OpenWork/Application.js

@@ -30,6 +30,10 @@ const LicenseAccountClient_1 = __importDefault(require("./License/LicenseAccount
 const LicenseAppClient_1 = __importDefault(require("./License/LicenseAppClient"));
 const LicenseAutoActiveClient_1 = __importDefault(require("./License/LicenseAutoActiveClient"));
 const MediaClient_1 = __importDefault(require("./Media/MediaClient"));
+const BaseClient_1 = __importDefault(require("../Core/BaseClient"));
+class Client extends BaseClient_1.default {
+}
+;
 class OpenWork extends BaseApplication_1.default {
     constructor(config = {}, prepends = {}, id = null) {
         super(config, prepends, id);
@@ -41,6 +45,10 @@ class OpenWork extends BaseApplication_1.default {
                 baseURL: 'https://qyapi.weixin.qq.com/',
             },
         };
+        /**
+         * 客户端实例
+         */
+        this.client = null;
         this.registerProviders();
     }
     registerProviders() {
@@ -150,6 +158,15 @@ class OpenWork extends BaseApplication_1.default {
     work(authCorpId, permanentCode) {
         return new Application_2.default(authCorpId, permanentCode, this);
     }
+    /**
+     * 获取客户端实例
+     */
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        return this.client = new Client(this);
+    }
 }
 exports.default = OpenWork;
 ;

package/dist/Payment/Application.d.ts

@@ -16,8 +16,12 @@ import TransferClient from './Transfer/TransferClient';
 import SecurityClient from './Security/SecurityClient';
 import ProfitSharingClient from './ProfitSharing/ProfitSharingClient';
 import { EasyWechatConfig, PaymentPaidHandler, PaymentRefundedHandler, PaymentScannedHandler } from '../Core/Types';
+import BaseClient from './Core/BaseClient';
+declare class PaymentClient extends BaseClient {
+}
 export default class Payment extends BaseApplication {
     protected defaultConfig: EasyWechatConfig;
+    client: PaymentClient;
     base: PaymentBase;
     bill: BillClient;
     coupon: CouponClient;
@@ -73,4 +77,9 @@ export default class Payment extends BaseApplication {
      * @param auth_code 扫码支付付款码
      */
     authCodeToOpenid(): Promise<any>;
+    /**
+     * 获取客户端实例
+     */
+    getClient(): PaymentClient;
 }
+export {};

package/dist/Payment/Application.js

@@ -32,6 +32,10 @@ const SandboxClient_1 = __importDefault(require("./Sandbox/SandboxClient"));
 const TransferClient_1 = __importDefault(require("./Transfer/TransferClient"));
 const SecurityClient_1 = __importDefault(require("./Security/SecurityClient"));
 const ProfitSharingClient_1 = __importDefault(require("./ProfitSharing/ProfitSharingClient"));
+const BaseClient_1 = __importDefault(require("./Core/BaseClient"));
+class PaymentClient extends BaseClient_1.default {
+}
+;
 class Payment extends BaseApplication_1.default {
     constructor(config = {}, prepends = {}, id = null) {
         super(config, prepends, id);
@@ -179,6 +183,15 @@ class Payment extends BaseApplication_1.default {
     authCodeToOpenid() {
         return this.base.authCodeToOpenid.apply(this.base, arguments);
     }
+    /**
+     * 获取客户端实例
+     */
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        return this.client = new PaymentClient(this);
+    }
 }
 exports.default = Payment;
 ;

package/dist/Payment/Core/BaseClient.d.ts

@@ -6,10 +6,10 @@ declare class BaseClient implements HttpMixin {
     protected serverIp: String;
     constructor(app: BaseApplication);
     protected prepends(): {};
-    protected request(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig, returnResponse?: boolean): Promise<AxiosResponse<any>>;
-    protected safeRequest(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig): Promise<any>;
-    protected requestRaw(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig): Promise<any>;
-    protected wrap(endpoint: string): string;
+    request(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig, returnResponse?: boolean): Promise<AxiosResponse<any>>;
+    safeRequest(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig): Promise<any>;
+    requestRaw(endpoint: string, params?: object, method?: string, options?: AxiosRequestConfig): Promise<any>;
+    wrap(endpoint: string): string;
     getServerIp(): Promise<String>;
     getClientIp(): string;
     doRequest(payload: AxiosRequestConfig): Promise<AxiosResponse<any>>;

package/dist/Payment/Core/BaseClient.js

@@ -74,7 +74,22 @@ class BaseClient {
         return __awaiter(this, void 0, void 0, function* () {
             options.responseType = 'arraybuffer';
             let res = yield this.request(endpoint, params, method, options, true);
-            return new Response_1.default(res.data, res.status, res.headers);
+            let config = {};
+            let keys = ['url', 'baseURL', 'method', 'params', 'headers'];
+            keys.map(key => {
+                if (typeof options[key] === 'string' || typeof options[key] === 'number') {
+                    config[key] = options[key];
+                }
+                else if (typeof options[key] === 'object') {
+                    if (options[key] === null) {
+                        config[key] = null;
+                    }
+                    else {
+                        config[key] = JSON.parse(JSON.stringify(options[key]));
+                    }
+                }
+            });
+            return new Response_1.default(res.data, res.status, res.headers, config);
         });
     }
     wrap(endpoint) {

package/dist/Work/Application.d.ts

@@ -38,8 +38,15 @@ import ExternalSchoolClient from './ExternalContact/SchoolClient';
 import ExternalMomentClient from './ExternalContact/MomentClient';
 import CorpGroupClient from './CorpGroup/CorpGroupClient';
 import WeWork from 'node-socialite/dist/Providers/WeWork';
+import BaseClient from '../Core/BaseClient';
+declare class Client extends BaseClient {
+}
 export default class Work extends BaseApplication {
     protected defaultConfig: EasyWechatConfig;
+    /**
+     * 客户端实例
+     */
+    client: Client;
     oa: OAClient;
     access_token: AccessToken;
     agent: AgentClient;
@@ -81,4 +88,9 @@ export default class Work extends BaseApplication {
     registerProviders(): void;
     miniProgram(): MiniProgram;
     getCallbackIp(): Promise<any>;
+    /**
+     * 获取客户端实例
+     */
+    getClient(): Client;
 }
+export {};

package/dist/Work/Application.js

@@ -52,6 +52,10 @@ const SchoolClient_1 = __importDefault(require("./ExternalContact/SchoolClient")
 const MomentClient_1 = __importDefault(require("./ExternalContact/MomentClient"));
 const CorpGroupClient_1 = __importDefault(require("./CorpGroup/CorpGroupClient"));
 const node_socialite_1 = require("node-socialite");
+const BaseClient_1 = __importDefault(require("../Core/BaseClient"));
+class Client extends BaseClient_1.default {
+}
+;
 class Work extends BaseApplication_1.default {
     constructor(config = {}, prepends = {}, id = null) {
         super(config, prepends, id);
@@ -60,6 +64,10 @@ class Work extends BaseApplication_1.default {
                 baseURL: 'https://qyapi.weixin.qq.com/',
             },
         };
+        /**
+         * 客户端实例
+         */
+        this.client = null;
         this.registerProviders();
     }
     registerProviders() {
@@ -231,6 +239,15 @@ class Work extends BaseApplication_1.default {
     getCallbackIp() {
         return this.base.getCallbackIp.apply(this.base, arguments);
     }
+    /**
+     * 获取客户端实例
+     */
+    getClient() {
+        if (this.client) {
+            return this.client;
+        }
+        return this.client = new Client(this);
+    }
 }
 exports.default = Work;
 ;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-easywechat",
-  "version": "2.12.5",
+  "version": "2.13.0",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {