node-easywechat 3.3.6 → 3.5.0

package/CHANGELOG.md

@@ -1,6 +1,14 @@
 # CHANGELOG
 
 
+## v3.5.0 (2023-07-18)
+
+- Feat: 优化ts的提示，并新增定义配置、定义服务端处理方法的工具函数
+
+## v3.4.0 (2023-06-13)
+
+- Feat: 公众号、小程序配置项新增是否使用稳定版接口调用凭据的选项
+
 ## v3.3.6 (2023-05-12)
 
 - Fix: 修复微信支付v3签名错误

package/README.md

@@ -67,6 +67,20 @@ let app = new OpenWork({
   // 配置项
 });
 
+// ----- 定义配置项（v3.5.0+） -----
+
+// 这种方式设置配置项时可获得编辑器的代码提示（如：VS Code）
+
+// 公众号配置
+const config = defineOfficialAccountConfig({
+  // 配置项
+});
+// 小程序: defineMiniAppConfig()
+// 支付: definePayConfig()
+// 开放平台: defineOpenPlatformConfig()
+// 企业微信: defineWorkConfig()
+// 企业微信开放平台: defineOpenWorkConfig()
+
 // ----- 以下为通用的 api 调用方法 -----
 
 // 获取 api 调用客户端
@@ -127,7 +141,9 @@ let data = response.toObject();
     scope: 'snsapi_userinfo',
     // 网页授权回调地址，完整的URL
     redirect: 'http://node-easywechat.hpyer.cn/wxlogin/callback'
-  }
+  },
+  // 是否使用稳定版接口调用凭据，默认：false
+  use_stable_access_token: false
 }
 ```
 
@@ -141,7 +157,9 @@ let data = response.toObject();
   // 小程序的 token
   token: '',
   // EncodingAESKey
-  aes_key: ''
+  aes_key: '',
+  // 是否使用稳定版接口调用凭据，默认：false
+  use_stable_access_token: false
 }
 ```
 

package/dist/Core/Config.d.ts

@@ -13,7 +13,7 @@ declare class Config extends ConfigInterface {
      * 获取所有配置项
      * @returns
      */
-    all(): object;
+    all(): Record<string, any>;
     /**
      * 判断配置项是否存在
      * @param key
@@ -38,7 +38,7 @@ declare class Config extends ConfigInterface {
      * @param keys 键名列表 或者 {键名:默认值} 格式的对象
      * @returns
      */
-    getMany(keys: string[] | Record<string, any>): object;
+    getMany(keys: string[] | Record<string, any>): Record<string, any>;
     /**
      * 判断配置项是否存在
      * @param key

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

@@ -4,7 +4,7 @@ declare abstract class ConfigInterface extends ObjectAccessInterface {
      * 获取全部配置项
      * @returns
      */
-    all(): object;
+    all(): Record<string, any>;
     /**
      * 判断配置项是否存在
      * @param key 键名

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

@@ -11,7 +11,7 @@ export declare const getTimestamp: (datetime?: string) => number;
 export declare const buildQueryString: (data: Record<string, any>, options?: Record<string, any>) => string;
 export declare const parseQueryString: (data: string, options?: Record<string, any>) => Record<string, any>;
 export declare const randomString: (len?: number) => string;
-export declare const makeSignature: (params: object, key?: string, type?: string) => string;
+export declare const makeSignature: (params: Record<string, any>, key?: string, type?: string) => string;
 export declare const isString: (data: any) => boolean;
 export declare const isArray: (data: any) => boolean;
 export declare const isNumber: (data: any) => boolean;

package/dist/MiniApp/Application.js

@@ -90,7 +90,7 @@ class Application {
     }
     getAccessToken() {
         if (!this.accessToken) {
-            this.accessToken = new AccessToken_1.default(this.getAccount().getAppId(), this.getAccount().getSecret(), null, this.getCache(), this.getHttpClient());
+            this.accessToken = new AccessToken_1.default(this.getAccount().getAppId(), this.getAccount().getSecret(), null, this.getCache(), this.getHttpClient(), this.config.get('use_stable_access_token', false));
         }
         return this.accessToken;
     }

package/dist/MiniApp/Decryptor.d.ts

@@ -1,4 +1,4 @@
 declare class Decryptor {
-    static decrypt(sessionKey: string, iv: string, ciphertext: string): object;
+    static decrypt(sessionKey: string, iv: string, ciphertext: string): Record<string, any>;
 }
 export = Decryptor;

package/dist/MiniApp/Utils.d.ts

@@ -17,6 +17,6 @@ declare class Utils {
      * @param ciphertext
      * @returns
      */
-    decryptSession(sessionKey: string, iv: string, ciphertext: string): object;
+    decryptSession(sessionKey: string, iv: string, ciphertext: string): Record<string, any>;
 }
 export = Utils;

package/dist/OfficialAccount/AccessToken.d.ts

@@ -7,7 +7,8 @@ declare class AccessToken implements RefreshableAccessTokenInterface {
     protected key: string;
     protected cache: CacheInterface;
     protected httpClient: HttpClientInterface;
-    constructor(appId: string, secret: string, key?: string, cache?: CacheInterface, httpClient?: HttpClientInterface);
+    protected stable: boolean;
+    constructor(appId: string, secret: string, key?: string, cache?: CacheInterface, httpClient?: HttpClientInterface, stable?: boolean);
     /**
      * 获取access_token的缓存名称
      * @returns
@@ -22,5 +23,14 @@ declare class AccessToken implements RefreshableAccessTokenInterface {
     getToken(): Promise<string>;
     toQuery(): Promise<Record<string, any>>;
     refresh(): Promise<string>;
+    /**
+     * 获取稳定版接口调用凭据
+     * @param forceRefresh 是否强制刷新，默认：false
+     */
+    getStableAccessToken(forceRefresh?: boolean): Promise<string>;
+    /**
+     * 获取接口调用凭据
+     */
+    getAccessToken(): Promise<string>;
 }
 export = AccessToken;

package/dist/OfficialAccount/AccessToken.js

@@ -13,12 +13,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const HttpClient_1 = __importDefault(require("../Core/HttpClient/HttpClient"));
 class AccessToken {
-    constructor(appId, secret, key = null, cache = null, httpClient = null) {
+    constructor(appId, secret, key = null, cache = null, httpClient = null, stable = false) {
         this.appId = appId;
         this.secret = secret;
         this.key = key;
         this.cache = cache;
         this.httpClient = httpClient;
+        this.stable = stable;
         if (!this.httpClient) {
             this.httpClient = HttpClient_1.default.create({
                 baseURL: 'https://api.weixin.qq.com/',
@@ -64,6 +65,35 @@ class AccessToken {
         });
     }
     refresh() {
+        return this.stable ? this.getStableAccessToken() : this.getAccessToken();
+    }
+    /**
+     * 获取稳定版接口调用凭据
+     * @param forceRefresh 是否强制刷新，默认：false
+     */
+    getStableAccessToken(forceRefresh = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let response = (yield this.httpClient.request('post', 'cgi-bin/stable_token', {
+                json: {
+                    grant_type: 'client_credential',
+                    appid: this.appId,
+                    secret: this.secret,
+                    force_refresh: forceRefresh,
+                }
+            })).toObject();
+            if (!response['access_token']) {
+                throw new Error('Failed to get stable access_token: ' + JSON.stringify(response));
+            }
+            if (this.cache) {
+                yield this.cache.set(this.getKey(), response['access_token'], parseInt(response['expires_in']));
+            }
+            return response['access_token'];
+        });
+    }
+    /**
+     * 获取接口调用凭据
+     */
+    getAccessToken() {
         return __awaiter(this, void 0, void 0, function* () {
             let response = (yield this.httpClient.request('get', 'cgi-bin/token', {
                 params: {

package/dist/OfficialAccount/Application.js

@@ -90,7 +90,7 @@ class Application {
     }
     getAccessToken() {
         if (!this.accessToken) {
-            this.accessToken = new AccessToken_1.default(this.getAccount().getAppId(), this.getAccount().getSecret(), null, this.getCache(), this.getHttpClient());
+            this.accessToken = new AccessToken_1.default(this.getAccount().getAppId(), this.getAccount().getSecret(), null, this.getCache(), this.getHttpClient(), this.config.get('use_stable_access_token', false));
         }
         return this.accessToken;
     }

package/dist/OpenPlatform/Application.d.ts

@@ -9,7 +9,7 @@ import HttpClientMixin from '../Core/Mixins/HttpClientMixin';
 import ServerRequestMixin from '../Core/Mixins/ServerRequestMixin';
 import OfficialAccountApplication from '../OfficialAccount/Application';
 import MiniAppApplication from '../MiniApp/Application';
-import { OfficialAccountConfig, OfficialAccountOAuthFactory, MiniAppConfig } from '../Types/global';
+import { OpenPlatformConfig, OfficialAccountConfig, OfficialAccountOAuthFactory, MiniAppConfig } from '../Types/global';
 import AccountInterface from './Contracts/AccountInterface';
 import ApplicationInterface from './Contracts/ApplicationInterface';
 import Server from './Server';
@@ -21,7 +21,7 @@ import AuthorizerAccessToken from './AuthorizerAccessToken';
  * 开放平台应用
  */
 declare class Application implements ApplicationInterface {
-    constructor(config: ConfigInterface | OfficialAccountConfig);
+    constructor(config: ConfigInterface | OpenPlatformConfig);
     protected account: AccountInterface;
     protected encryptor: Encryptor;
     protected server: Server;

package/dist/Types/global.d.ts

@@ -3,30 +3,18 @@ import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
 import OfficialAccountApplicationInterface from '../OfficialAccount/Contracts/ApplicationInterface';
 import WorkApplicationInterface from '../Work/Contracts/ApplicationInterface';
 import Message from '../Core/Message';
+import OfficialAccountMessage from '../OfficialAccount/Message';
+import PayMessage from '../Pay/Message';
+import WorkMessage from '../Work/Message';
+import OpenPlatformMessage from '../OpenPlatform/Message';
+import OpenWorkMessage from '../OpenWork/Message';
 import HttpClientResponseInterface from '../Core/HttpClient/Contracts/HttpClientResponseInterface';
 import { PublicKey } from "../Core/Support/PublicKey";
 
-declare module 'axios' {
-  export interface AxiosRequestConfig {
-    /**
-     * 要发送的xml数据，会自动解析并赋值到data属性，同时设置content-type=text/xml
-     */
-    xml?: string | Record<string, any>;
-    /**
-     * 要发送的json数据，会自动解析并赋值到data属性，同时设置content-type=application/json
-     */
-    json?: string | Record<string, any>;
-    /**
-     * 要发送的FormData数据，会自动解析并赋值到data属性，同时设置根据内容提取headers
-     */
-    formData?: Record<string, any>;
-  }
-}
-
 /**
  * 微信接口响应数据格式
  */
-export declare interface WeixinResponse extends Record<string, any> {
+export interface WeixinResponse extends Record<string, any> {
   /**
    * 错误代码
    */
@@ -41,7 +29,7 @@ export declare interface WeixinResponse extends Record<string, any> {
 /**
  * 公众号网页授权相关配置
  */
-export declare interface OauthConfig {
+export interface OauthConfig {
   /**
    * 网页授权权限，可选值：snsapi_userinfo、snsapi_base
    */
@@ -56,7 +44,7 @@ export declare interface OauthConfig {
 /**
  * 文件缓存相关配置
  */
-export declare interface CacheFileConfig {
+export interface CacheFileConfig {
   /**
    * 缓存文件保存路径，默认：./
    */
@@ -78,7 +66,7 @@ export declare interface CacheFileConfig {
 /**
  * 网络请求配置
  */
-export declare interface HttpConfig extends AxiosRequestConfig {
+export interface HttpConfig extends AxiosRequestConfig {
   /**
    * 是否抛出异常
    */
@@ -107,7 +95,7 @@ export declare interface HttpConfig extends AxiosRequestConfig {
 /**
  * 基础配置
  */
-export declare interface BaseConfig {
+export interface BaseConfig {
   /**
    * 网络请求相关配置
    */
@@ -122,7 +110,7 @@ export declare interface BaseConfig {
 /**
  * 公众号配置
  */
-export declare interface OfficialAccountConfig extends BaseConfig {
+export interface OfficialAccountConfig extends BaseConfig {
   /**
    * 公众号 app_id
    */
@@ -147,12 +135,18 @@ export declare interface OfficialAccountConfig extends BaseConfig {
    * 网页授权相关配置
    */
   oauth?: OauthConfig;
+
+  /**
+   * 是否使用稳定版接口调用凭据，默认：false
+   * @see https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/getStableAccessToken.html
+   */
+  use_stable_access_token?: boolean;
 }
 
 /**
  * 小程序配置
  */
-export declare interface MiniAppConfig extends BaseConfig {
+export interface MiniAppConfig extends BaseConfig {
   /**
    * 小程序 app_id
    */
@@ -172,12 +166,18 @@ export declare interface MiniAppConfig extends BaseConfig {
    * 服务端消息加解密密钥 aes_key
    */
   aes_key?: string;
+
+  /**
+   * 是否使用稳定版接口调用凭据，默认：false
+   * @see https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/mp-access-token/getStableAccessToken.html
+   */
+  use_stable_access_token?: boolean;
 }
 
 /**
  * 微信支付配置
  */
-export declare interface PayConfig extends BaseConfig {
+export interface PayConfig extends BaseConfig {
   /**
    * 商户号
    */
@@ -216,7 +216,7 @@ export declare interface PayConfig extends BaseConfig {
 /**
  * 开发平台配置
  */
-export declare interface OpenPlatformConfig extends BaseConfig {
+export interface OpenPlatformConfig extends BaseConfig {
   /**
    * 开发平台 app_id
    */
@@ -241,7 +241,7 @@ export declare interface OpenPlatformConfig extends BaseConfig {
 /**
  * 企业微信配置
  */
-export declare interface WorkConfig extends BaseConfig {
+export interface WorkConfig extends BaseConfig {
   /**
    * 企业微信 corp_id
    */
@@ -266,7 +266,7 @@ export declare interface WorkConfig extends BaseConfig {
 /**
  * 企业微信开放平台配置
  */
-export declare interface OpenWorkConfig extends BaseConfig {
+export interface OpenWorkConfig extends BaseConfig {
   /**
    * 企业微信 corp_id
    */
@@ -303,19 +303,19 @@ export declare interface OpenWorkConfig extends BaseConfig {
  * @param app 公众号应用实例
  * @returns OAuth服务供应商实例
  */
-export declare type OfficialAccountOAuthFactory = (app: OfficialAccountApplicationInterface) => ProviderInterface;
+export type OfficialAccountOAuthFactory = (app: OfficialAccountApplicationInterface) => ProviderInterface;
 
 /**
  * 企业微信OAuth工厂方法
  * @param app 企业微信应用实例
  * @returns OAuth服务供应商实例
  */
-export declare type WorkOAuthFactory = (app: WorkApplicationInterface) => ProviderInterface;
+export type WorkOAuthFactory = (app: WorkApplicationInterface) => ProviderInterface;
 
 /**
  * 服务端通知处理项
  */
-export declare interface ServerHandlerItem {
+export interface ServerHandlerItem {
   hash: string;
   handler: ServerHandlerClosure;
 };
@@ -323,44 +323,44 @@ export declare interface ServerHandlerItem {
 /**
  * 服务端普通消息类型
  */
-export declare type ServerMessageType = 'text' | 'image' | 'voice' | 'video' | 'shortvideo' | 'location';
+export type ServerMessageType = 'text' | 'image' | 'voice' | 'video' | 'shortvideo' | 'location';
 
 /**
  * 服务端事件消息类型
  */
-export declare type ServerEventType = 'subscribe' | 'unsubscribe' | 'SCAN' | 'LOCATION' | 'CLICK' | 'VIEW';
+export type ServerEventType = 'subscribe' | 'unsubscribe' | 'SCAN' | 'LOCATION' | 'CLICK' | 'VIEW';
 
 /**
  * 服务端消息处理器
  * @param message 微信信息
  * @param next 下一个消息处理器
  */
-export declare type ServerHandlerClosure = (message: Message, next?: ServerHandlerClosure) => any;
+export type ServerHandlerClosure<T = Message> = (message: T extends OfficialAccountMessage | PayMessage | WorkMessage | OpenPlatformMessage | OpenWorkMessage ? T : Message, next?: ServerHandler<T>) => any;
 
 /**
  * HttpClient错误判定回调
  * @param response 响应对象
  */
-export declare type HttpClientFailureJudgeClosure = (response: HttpClientResponseInterface) => boolean;
+export type HttpClientFailureJudgeClosure = (response: HttpClientResponseInterface) => boolean;
 
 /**
  * Payment通知错误处理
  * @param error 错误信息
  */
-export declare type PaymentFailHandler = (error: string) => void;
+export type PaymentFailHandler = (error: string) => void;
 
 /**
  * Payment业务错误处理
  * @param error 错误信息
  */
-export declare type PaymentAlertHandler = (error: string) => void;
+export type PaymentAlertHandler = (error: string) => void;
 
 /**
  * Payment支付结果处理回调函数
  * @param message 微信通知信息
  * @param fail 通知错误处理函数
  */
-export declare type PaymentPaidHandler = (message: Message, fail: PaymentFailHandler) => void;
+export type PaymentPaidHandler = (message: PayMessage, fail: PaymentFailHandler) => void;
 
 /**
  * Payment退款结果处理回调函数
@@ -368,7 +368,7 @@ export declare type PaymentPaidHandler = (message: Message, fail: PaymentFailHan
  * @param reqInfo 微信通知信息中 req_info 解密后的信息
  * @param fail 通知错误处理函数
  */
-export declare type PaymentRefundedHandler = (message: Message, reqInfo: object, fail: PaymentFailHandler) => void;
+export type PaymentRefundedHandler = (message: PayMessage, reqInfo: Record<string, any>, fail: PaymentFailHandler) => void;
 
 /**
  * Payment扫码支付结果处理回调函数
@@ -376,7 +376,7 @@ export declare type PaymentRefundedHandler = (message: Message, reqInfo: object,
  * @param fail 通知错误处理函数
  * @param alert 业务错误处理函数
  */
-export declare type PaymentScannedHandler = (message: Message, fail: PaymentFailHandler, alert: PaymentAlertHandler) => void;
+export type PaymentScannedHandler = (message: PayMessage, fail: PaymentFailHandler, alert: PaymentAlertHandler) => void;
 
 /**
  * 日志处理方法
@@ -385,12 +385,12 @@ export declare type PaymentScannedHandler = (message: Message, fail: PaymentFail
  * @param usedTime 请求耗时，单位ms，仅在 type 为 after 时返回
  * @param response 响应对象，仅在 type 为 after 时返回
  */
-export declare type LogHandler = (type: 'before' | 'after', options: AxiosRequestConfig, usedTime?: number, response?: AxiosResponse) => void | Promise<void>;
+export type LogHandler = (type: 'before' | 'after', options: AxiosRequestConfig, usedTime?: number, response?: AxiosResponse) => void | Promise<void>;
 
 /**
  * 支付参数 JsBridge
  */
-export declare interface PayBridgeConfig {
+export interface PayBridgeConfig {
   /**
    * 应用id
    */
@@ -420,7 +420,7 @@ export declare interface PayBridgeConfig {
 /**
  * 支付参数 JsSdk
  */
-export declare interface PaySdkConfig {
+export interface PaySdkConfig {
   /**
    * 应用id
    */
@@ -450,7 +450,7 @@ export declare interface PaySdkConfig {
 /**
  * 支付参数 App
  */
-export declare interface PayAppConfig {
+export interface PayAppConfig {
   /**
    * 应用id
    */

package/dist/Types/shim-axios.d.ts

@@ -0,0 +1,31 @@
+
+import axios from 'axios';
+
+declare module 'axios' {
+
+  interface AxiosInstance {
+    <T = Recordable, R = ApiResponse<T>>(config: AxiosRequestConfig): Promise<R>;
+    request<T = Recordable, R = ApiResponse<T>>(config: AxiosRequestConfig): Promise<R>;
+    get<T = Recordable, R = ApiResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    delete<T = Recordable, R = ApiResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    head<T = Recordable, R = ApiResponse<T>>(url: string, config?: AxiosRequestConfig): Promise<R>;
+    post<T = Recordable, R = ApiResponse<T>>(url: string, data?: Recordable, config?: AxiosRequestConfig): Promise<R>;
+    put<T = Recordable, R = ApiResponse<T>>(url: string, data?: Recordable, config?: AxiosRequestConfig): Promise<R>;
+    patch<T = Recordable, R = ApiResponse<T>>(url: string, data?: Recordable, config?: AxiosRequestConfig): Promise<R>;
+  }
+
+  interface AxiosRequestConfig {
+    /**
+     * 要发送的xml数据，会自动解析并赋值到data属性，同时设置content-type=text/xml
+     */
+    xml?: string | Recordable;
+    /**
+     * 要发送的json数据，会自动解析并赋值到data属性，同时设置content-type=application/json
+     */
+    json?: string | Recordable;
+    /**
+     * 要发送的FormData数据，会自动解析并赋值到data属性，同时设置根据内容提取headers
+     */
+    formData?: Recordable;
+  }
+}

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { OfficialAccountConfig, MiniAppConfig, LogHandler, ServerEventType, ServerHandlerClosure, PayConfig, OpenPlatformConfig, WorkConfig, OpenWorkConfig } from './Types/global';
+import { OfficialAccountConfig, MiniAppConfig, LogHandler, ServerEventType, ServerHandlerClosure, PayConfig, OpenPlatformConfig, WorkConfig, OpenWorkConfig, HttpClientFailureJudgeClosure, PaymentFailHandler, PaymentAlertHandler, PaymentPaidHandler, PaymentRefundedHandler, PaymentScannedHandler } from './Types/global';
 import OfficialAccount from './OfficialAccount/Application';
 import MiniApp from './MiniApp/Application';
 import Pay from './Pay/Application';
@@ -8,6 +8,10 @@ import OpenWork from './OpenWork/Application';
 import CacheInterface from './Core/Contracts/CacheInterface';
 import ServerRequest from './Core/Http/ServerRequest';
 import FormData from 'form-data';
+import OfficialAccountMessage from './OfficialAccount/Message';
+import WorkMessage from './Work/Message';
+import OpenPlatformMessage from './OpenPlatform/Message';
+import OpenWorkMessage from './OpenWork/Message';
 export { OfficialAccount, OfficialAccountConfig, MiniApp, MiniAppConfig, Pay, PayConfig, OpenPlatform, OpenPlatformConfig, Work, WorkConfig, OpenWork, OpenWorkConfig, CacheInterface, ServerRequest, LogHandler, ServerEventType, ServerHandlerClosure, 
 /**
  * 表单对象
@@ -15,3 +19,93 @@ export { OfficialAccount, OfficialAccountConfig, MiniApp, MiniAppConfig, Pay, Pa
  * @see https://github.com/form-data/form-data#readme
  */
 FormData, };
+/**
+ * 定义公众号配置
+ * @param config
+ */
+export declare function defineOfficialAccountConfig(config: OfficialAccountConfig): OfficialAccountConfig;
+/**
+ * 定义小程序配置
+ * @param config
+ */
+export declare function defineMiniAppConfig(config: MiniAppConfig): MiniAppConfig;
+/**
+ * 定义支付配置
+ * @param config
+ */
+export declare function definePayConfig(config: PayConfig): PayConfig;
+/**
+ * 定义开放平台配置
+ * @param config
+ */
+export declare function defineOpenPlatformConfig(config: OpenPlatformConfig): OpenPlatformConfig;
+/**
+ * 定义企业微信配置
+ * @param config
+ */
+export declare function defineWorkConfig(config: WorkConfig): WorkConfig;
+/**
+ * 定义企业微信开放平台配置
+ * @param config
+ */
+export declare function defineOpenWorkConfig(config: OpenWorkConfig): OpenWorkConfig;
+/**
+ * 定义日志处理函数
+ * @param func
+ */
+export declare function defineLogHandler(func: LogHandler): LogHandler;
+/**
+ * 定义公众号服务端消息处理函数
+ * @param func
+ */
+export declare function defineOfficeAccountServerHandler(func: ServerHandlerClosure<OfficialAccountMessage>): ServerHandlerClosure<OfficialAccountMessage>;
+/**
+ * 定义小程序服务端消息处理函数
+ * @param func
+ */
+export declare function defineMiniAppServerHandler(func: ServerHandlerClosure<OfficialAccountMessage>): ServerHandlerClosure<OfficialAccountMessage>;
+/**
+ * 定义企业微信服务端消息处理函数
+ * @param func
+ */
+export declare function defineWorkServerHandler(func: ServerHandlerClosure<WorkMessage>): ServerHandlerClosure<WorkMessage>;
+/**
+ * 定义开放平台服务端消息处理函数
+ * @param func
+ */
+export declare function defineOpenPlatformServerHandler(func: ServerHandlerClosure<OpenPlatformMessage>): ServerHandlerClosure<OpenPlatformMessage>;
+/**
+ * 定义企业微信开放平台服务端消息处理函数
+ * @param func
+ */
+export declare function defineOpenWorkServerHandler(func: ServerHandlerClosure<OpenWorkMessage>): ServerHandlerClosure<OpenWorkMessage>;
+/**
+ * 定义HttpClient错误判定回调
+ * @param func
+ */
+export declare function defineHttpClientFailureJudgeClosure(func: HttpClientFailureJudgeClosure): HttpClientFailureJudgeClosure;
+/**
+ * 定义支付通知错误处理函数
+ * @param func
+ */
+export declare function definePaymentFailHandler(func: PaymentFailHandler): PaymentFailHandler;
+/**
+ * 定义支付业务错误处理函数
+ * @param func
+ */
+export declare function definePaymentAlertHandler(func: PaymentAlertHandler): PaymentAlertHandler;
+/**
+ * 定义支付结果处理回调函数
+ * @param func
+ */
+export declare function definePaymentPaidHandler(func: PaymentPaidHandler): PaymentPaidHandler;
+/**
+ * 定义退款结果处理回调函数
+ * @param func
+ */
+export declare function definePaymentRefundedHandler(func: PaymentRefundedHandler): PaymentRefundedHandler;
+/**
+ * 定义扫码支付结果处理回调函数
+ * @param func
+ */
+export declare function definePaymentScannedHandler(func: PaymentScannedHandler): PaymentScannedHandler;

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormData = exports.ServerRequest = exports.CacheInterface = exports.OpenWork = exports.Work = exports.OpenPlatform = exports.Pay = exports.MiniApp = exports.OfficialAccount = void 0;
+exports.definePaymentScannedHandler = exports.definePaymentRefundedHandler = exports.definePaymentPaidHandler = exports.definePaymentAlertHandler = exports.definePaymentFailHandler = exports.defineHttpClientFailureJudgeClosure = exports.defineOpenWorkServerHandler = exports.defineOpenPlatformServerHandler = exports.defineWorkServerHandler = exports.defineMiniAppServerHandler = exports.defineOfficeAccountServerHandler = exports.defineLogHandler = exports.defineOpenWorkConfig = exports.defineWorkConfig = exports.defineOpenPlatformConfig = exports.definePayConfig = exports.defineMiniAppConfig = exports.defineOfficialAccountConfig = exports.FormData = exports.ServerRequest = exports.CacheInterface = exports.OpenWork = exports.Work = exports.OpenPlatform = exports.Pay = exports.MiniApp = exports.OfficialAccount = void 0;
 const Application_1 = __importDefault(require("./OfficialAccount/Application"));
 exports.OfficialAccount = Application_1.default;
 const Application_2 = __importDefault(require("./MiniApp/Application"));
@@ -22,3 +22,147 @@ const ServerRequest_1 = __importDefault(require("./Core/Http/ServerRequest"));
 exports.ServerRequest = ServerRequest_1.default;
 const form_data_1 = __importDefault(require("form-data"));
 exports.FormData = form_data_1.default;
+/**
+ * 定义公众号配置
+ * @param config
+ */
+function defineOfficialAccountConfig(config) {
+    return config;
+}
+exports.defineOfficialAccountConfig = defineOfficialAccountConfig;
+/**
+ * 定义小程序配置
+ * @param config
+ */
+function defineMiniAppConfig(config) {
+    return config;
+}
+exports.defineMiniAppConfig = defineMiniAppConfig;
+/**
+ * 定义支付配置
+ * @param config
+ */
+function definePayConfig(config) {
+    return config;
+}
+exports.definePayConfig = definePayConfig;
+/**
+ * 定义开放平台配置
+ * @param config
+ */
+function defineOpenPlatformConfig(config) {
+    return config;
+}
+exports.defineOpenPlatformConfig = defineOpenPlatformConfig;
+/**
+ * 定义企业微信配置
+ * @param config
+ */
+function defineWorkConfig(config) {
+    return config;
+}
+exports.defineWorkConfig = defineWorkConfig;
+/**
+ * 定义企业微信开放平台配置
+ * @param config
+ */
+function defineOpenWorkConfig(config) {
+    return config;
+}
+exports.defineOpenWorkConfig = defineOpenWorkConfig;
+/**
+ * 定义日志处理函数
+ * @param func
+ */
+function defineLogHandler(func) {
+    return func;
+}
+exports.defineLogHandler = defineLogHandler;
+/**
+ * 定义公众号服务端消息处理函数
+ * @param func
+ */
+function defineOfficeAccountServerHandler(func) {
+    return func;
+}
+exports.defineOfficeAccountServerHandler = defineOfficeAccountServerHandler;
+/**
+ * 定义小程序服务端消息处理函数
+ * @param func
+ */
+function defineMiniAppServerHandler(func) {
+    return func;
+}
+exports.defineMiniAppServerHandler = defineMiniAppServerHandler;
+/**
+ * 定义企业微信服务端消息处理函数
+ * @param func
+ */
+function defineWorkServerHandler(func) {
+    return func;
+}
+exports.defineWorkServerHandler = defineWorkServerHandler;
+/**
+ * 定义开放平台服务端消息处理函数
+ * @param func
+ */
+function defineOpenPlatformServerHandler(func) {
+    return func;
+}
+exports.defineOpenPlatformServerHandler = defineOpenPlatformServerHandler;
+/**
+ * 定义企业微信开放平台服务端消息处理函数
+ * @param func
+ */
+function defineOpenWorkServerHandler(func) {
+    return func;
+}
+exports.defineOpenWorkServerHandler = defineOpenWorkServerHandler;
+/**
+ * 定义HttpClient错误判定回调
+ * @param func
+ */
+function defineHttpClientFailureJudgeClosure(func) {
+    return func;
+}
+exports.defineHttpClientFailureJudgeClosure = defineHttpClientFailureJudgeClosure;
+/**
+ * 定义支付通知错误处理函数
+ * @param func
+ */
+function definePaymentFailHandler(func) {
+    return func;
+}
+exports.definePaymentFailHandler = definePaymentFailHandler;
+/**
+ * 定义支付业务错误处理函数
+ * @param func
+ */
+function definePaymentAlertHandler(func) {
+    return func;
+}
+exports.definePaymentAlertHandler = definePaymentAlertHandler;
+/**
+ * 定义支付结果处理回调函数
+ * @param func
+ */
+function definePaymentPaidHandler(func) {
+    return func;
+}
+exports.definePaymentPaidHandler = definePaymentPaidHandler;
+/**
+ * 定义退款结果处理回调函数
+ * @param func
+ */
+function definePaymentRefundedHandler(func) {
+    return func;
+}
+exports.definePaymentRefundedHandler = definePaymentRefundedHandler;
+/**
+ * 定义扫码支付结果处理回调函数
+ * @param func
+ */
+function definePaymentScannedHandler(func) {
+    return func;
+}
+exports.definePaymentScannedHandler = definePaymentScannedHandler;

package/package.json

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