node-easywechat 3.0.1 → 3.1.1

package/dist/OpenPlatform/Contracts/AccountInterface.js

@@ -0,0 +1,25 @@
+'use strict';
+class AccountInterface {
+    /**
+     * 获取appid
+     * @returns
+     */
+    getAppId() { return null; }
+    /**
+     * 获取secret
+     * @returns
+     */
+    getSecret() { return null; }
+    /**
+     * 获取token
+     * @returns
+     */
+    getToken() { return null; }
+    /**
+     * 获取aesKey
+     * @returns
+     */
+    getAesKey() { return null; }
+}
+;
+module.exports = AccountInterface;

package/dist/OpenPlatform/Contracts/ApplicationInterface.d.ts

@@ -0,0 +1,68 @@
+import ProviderInterface from "node-socialite/dist/Core/ProviderInterface";
+import CacheInterface from "../../Core/Contracts/CacheInterface";
+import ConfigInterface from "../../Core/Contracts/ConfigInterface";
+import AccessTokenAwareClient from "../../Core/HttpClient/AccessTokenAwareClient";
+import HttpClientInterface from "../../Core/HttpClient/Contracts/HttpClientInterface";
+import ServerInterface from "../../Core/Contracts/ServerInterface";
+import ServerRequestInterface from "../../Core/Http/Contracts/ServerRequestInterface";
+import Encryptor from "../../Core/Encryptor";
+import AccountInterface from "./AccountInterface";
+import AccessTokenInterface from "../../Core/Contracts/AccessTokenInterface";
+declare abstract class ApplicationInterface {
+    /**
+     * 获取当前账户实例
+     * @returns
+     */
+    getAccount(): AccountInterface;
+    /**
+     * 获取加密机实例
+     * @returns
+     */
+    getEncryptor(): Encryptor;
+    /**
+     * 获取服务端实例
+     * @returns
+     */
+    getServer(): ServerInterface;
+    /**
+     * 获取当前请求实例
+     * @returns
+     */
+    getRequest(): ServerRequestInterface;
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient(): AccessTokenAwareClient;
+    /**
+     * 创建客户端实例
+     * @returns
+     */
+    createClient(): AccessTokenAwareClient;
+    /**
+     * 获取网络请求客户端实例
+     * @returns
+     */
+    getHttpClient(): HttpClientInterface;
+    /**
+     * 获取配置信息实例
+     * @returns
+     */
+    getConfig(): ConfigInterface;
+    /**
+     * 获取AccessToken实例
+     * @returns
+     */
+    getAccessToken(): AccessTokenInterface;
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache(): CacheInterface;
+    /**
+     * 获取OAuth实例
+     * @returns
+     */
+    getOAuth(): ProviderInterface;
+}
+export = ApplicationInterface;

package/dist/OpenPlatform/Contracts/ApplicationInterface.js

@@ -0,0 +1,60 @@
+'use strict';
+class ApplicationInterface {
+    /**
+     * 获取当前账户实例
+     * @returns
+     */
+    getAccount() { return null; }
+    /**
+     * 获取加密机实例
+     * @returns
+     */
+    getEncryptor() { return null; }
+    /**
+     * 获取服务端实例
+     * @returns
+     */
+    getServer() { return null; }
+    /**
+     * 获取当前请求实例
+     * @returns
+     */
+    getRequest() { return null; }
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient() { return null; }
+    /**
+     * 创建客户端实例
+     * @returns
+     */
+    createClient() { return null; }
+    /**
+     * 获取网络请求客户端实例
+     * @returns
+     */
+    getHttpClient() { return null; }
+    /**
+     * 获取配置信息实例
+     * @returns
+     */
+    getConfig() { return null; }
+    /**
+     * 获取AccessToken实例
+     * @returns
+     */
+    getAccessToken() { return null; }
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache() { return null; }
+    /**
+     * 获取OAuth实例
+     * @returns
+     */
+    getOAuth() { return null; }
+}
+;
+module.exports = ApplicationInterface;

package/dist/OpenPlatform/Contracts/VerifyTicketInterface.d.ts

@@ -0,0 +1,23 @@
+declare abstract class VerifyTicketInterface {
+    /**
+     * 获取ticket缓存名
+     * @returns
+     */
+    getKey(): string;
+    /**
+     * 设置ticket缓存名
+     * @returns
+     */
+    setKey(key: string): this;
+    /**
+     * 设置ticket
+     * @returns
+     */
+    setTicket(key: string): Promise<this>;
+    /**
+     * 获取ticket
+     * @returns
+     */
+    getTicket(): Promise<string>;
+}
+export = VerifyTicketInterface;

package/dist/OpenPlatform/Contracts/VerifyTicketInterface.js

@@ -0,0 +1,25 @@
+'use strict';
+class VerifyTicketInterface {
+    /**
+     * 获取ticket缓存名
+     * @returns
+     */
+    getKey() { return null; }
+    /**
+     * 设置ticket缓存名
+     * @returns
+     */
+    setKey(key) { return null; }
+    /**
+     * 设置ticket
+     * @returns
+     */
+    setTicket(key) { return null; }
+    /**
+     * 获取ticket
+     * @returns
+     */
+    getTicket() { return null; }
+}
+;
+module.exports = VerifyTicketInterface;

package/dist/OpenPlatform/Message.d.ts

@@ -0,0 +1,43 @@
+import BaseMessage from '../Core/Message';
+declare class Message extends BaseMessage {
+}
+interface Message {
+    /**
+     * 第三方平台 appid
+     */
+    AppId?: string;
+    /**
+     * 时间戳
+     */
+    CreateTime?: number;
+    /**
+     * 通知类型
+     * - authorized：授权成功
+     * - unauthorized：取消授权
+     * - updateauthorized：更新授权
+     * - component_verify_ticket：验证票据
+     * @see [授权变更通知推送](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/Before_Develop/authorize_event.html)
+     * @see [验证票据](https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/Before_Develop/component_verify_ticket.html)
+     */
+    InfoType?: 'authorized' | 'unauthorized' | 'updateauthorized' | 'component_verify_ticket';
+    /**
+     * 公众号或小程序的 appid
+     */
+    AuthorizerAppid?: string;
+    /**
+     * 授权码，可用于获取授权信息
+     * @scope InfoType='authorized' | 'updateauthorized'
+     */
+    AuthorizationCode?: string;
+    /**
+     * 授权码过期时间，单位：秒
+     * @scope InfoType='authorized' | 'updateauthorized'
+     */
+    AuthorizationCodeExpiredTime?: number;
+    /**
+     * 预授权码
+     * @scope InfoType='authorized' | 'updateauthorized'
+     */
+    PreAuthCode?: string;
+}
+export = Message;

package/dist/OpenPlatform/Message.js

@@ -0,0 +1,9 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Message_1 = __importDefault(require("../Core/Message"));
+class Message extends Message_1.default {
+}
+;
+module.exports = Message;

package/dist/OpenPlatform/Server.d.ts

@@ -0,0 +1,61 @@
+import ServerRequestInterface from '../Core/Http/Contracts/ServerRequestInterface';
+import Encryptor from '../Core/Encryptor';
+import ServerInterface from '../Core/Contracts/ServerInterface';
+import Response from '../Core/Http/Response';
+import Message from './Message';
+import { ServerHandlerClosure } from '../Types/global';
+declare class Server extends ServerInterface {
+    protected encryptor: Encryptor;
+    protected request: ServerRequestInterface;
+    protected defaultVerifyTicketHandler: ServerHandlerClosure;
+    constructor(encryptor: Encryptor, request?: ServerRequestInterface);
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve(): Promise<Response>;
+    /**
+     * 处理授权成功通知
+     * @param handler
+     * @returns
+     */
+    handleAuthorized(handler: ServerHandlerClosure): this;
+    /**
+     * 处理取消授权通知
+     * @param handler
+     * @returns
+     */
+    handleUnauthorized(handler: ServerHandlerClosure): this;
+    /**
+     * 处理授权更新通知
+     * @param handler
+     * @returns
+     */
+    handleAuthorizeUpdated(handler: ServerHandlerClosure): this;
+    /**
+     * 设置默认的验证票据通知处理回调
+     * @param handler
+     * @returns
+     */
+    withDefaultVerifyTicketHandler(handler: ServerHandlerClosure): void;
+    /**
+     * 处理验证票据通知
+     * @param handler
+     * @returns
+     */
+    handleVerifyTicketRefreshed(handler: ServerHandlerClosure): this;
+    protected decryptRequestMessage(): ServerHandlerClosure;
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request?: ServerRequestInterface): Promise<Message>;
+    /**
+     * 获取来自微信服务器的推送消息（解密后）
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getDecryptedMessage(request?: ServerRequestInterface): Promise<Message>;
+}
+export = Server;

package/dist/OpenPlatform/Server.js

@@ -0,0 +1,136 @@
+'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 };
+};
+const ServerInterface_1 = __importDefault(require("../Core/Contracts/ServerInterface"));
+const Response_1 = __importDefault(require("../Core/Http/Response"));
+const Message_1 = __importDefault(require("./Message"));
+class Server extends ServerInterface_1.default {
+    constructor(encryptor, request = null) {
+        super();
+        this.encryptor = encryptor;
+        this.request = request;
+        this.defaultVerifyTicketHandler = null;
+    }
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let echostr = this.request.getQueryParams()['echostr'] || '';
+            if (!!echostr) {
+                return new Response_1.default(200, { 'Content-Type': 'text/html' }, echostr);
+            }
+            let message = yield this.getRequestMessage(this.request);
+            this.prepend(this.decryptRequestMessage());
+            let response = yield this.handle(new Response_1.default(200, {}, 'success'), message);
+            if (!(response instanceof Response_1.default)) {
+                response = yield this.transformToReply(response, message, this.encryptor);
+            }
+            return response;
+        });
+    }
+    /**
+     * 处理授权成功通知
+     * @param handler
+     * @returns
+     */
+    handleAuthorized(handler) {
+        return this.with(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.InfoType === 'authorized' ? handler(message, next) : next(message);
+            });
+        });
+    }
+    /**
+     * 处理取消授权通知
+     * @param handler
+     * @returns
+     */
+    handleUnauthorized(handler) {
+        return this.with(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.InfoType === 'unauthorized' ? handler(message, next) : next(message);
+            });
+        });
+    }
+    /**
+     * 处理授权更新通知
+     * @param handler
+     * @returns
+     */
+    handleAuthorizeUpdated(handler) {
+        return this.with(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.InfoType === 'updateauthorized' ? handler(message, next) : next(message);
+            });
+        });
+    }
+    /**
+     * 设置默认的验证票据通知处理回调
+     * @param handler
+     * @returns
+     */
+    withDefaultVerifyTicketHandler(handler) {
+        this.defaultVerifyTicketHandler = () => {
+            return handler.call(this, arguments);
+        };
+        this.handleVerifyTicketRefreshed(this.defaultVerifyTicketHandler);
+    }
+    /**
+     * 处理验证票据通知
+     * @param handler
+     * @returns
+     */
+    handleVerifyTicketRefreshed(handler) {
+        if (this.defaultVerifyTicketHandler) {
+            this.withoutHandler(this.defaultVerifyTicketHandler);
+        }
+        return this.with(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.InfoType === 'component_verify_ticket' ? handler(message, next) : next(message);
+            });
+        });
+    }
+    decryptRequestMessage() {
+        let query = this.request.getQueryParams();
+        return (message, next) => __awaiter(this, void 0, void 0, function* () {
+            yield this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
+            return next(message);
+        });
+    }
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request = null) {
+        return Message_1.default.createFromRequest(request || this.request);
+    }
+    /**
+     * 获取来自微信服务器的推送消息（解密后）
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getDecryptedMessage(request = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!request)
+                request = this.request;
+            let message = yield Message_1.default.createFromRequest(request);
+            let query = request.getQueryParams();
+            return this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
+        });
+    }
+}
+;
+module.exports = Server;

package/dist/OpenPlatform/VerifyTicket.d.ts

@@ -0,0 +1,13 @@
+import CacheInterface from '../Core/Contracts/CacheInterface';
+import VerifyTicketInterface from './Contracts/VerifyTicketInterface';
+declare class VerifyTicket implements VerifyTicketInterface {
+    protected appId: string;
+    protected key: string;
+    protected cache: CacheInterface;
+    constructor(appId: string, key?: string, cache?: CacheInterface);
+    getKey(): string;
+    setKey(key: string): this;
+    setTicket(ticket: string): Promise<this>;
+    getTicket(): Promise<string>;
+}
+export = VerifyTicket;

package/dist/OpenPlatform/VerifyTicket.js

@@ -0,0 +1,49 @@
+'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 };
+};
+const FileCache_1 = __importDefault(require("../Core/Cache/FileCache"));
+class VerifyTicket {
+    constructor(appId, key = null, cache = null) {
+        this.appId = appId;
+        this.key = key;
+        this.cache = cache;
+        this.cache = cache !== null && cache !== void 0 ? cache : new FileCache_1.default();
+    }
+    getKey() {
+        if (!this.key) {
+            this.key = `open_platform.verify_ticket.${this.appId}`;
+        }
+        return this.key;
+    }
+    setKey(key) {
+        this.key = key;
+        return this;
+    }
+    setTicket(ticket) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.cache.set(this.getKey(), ticket, 6000);
+            return this;
+        });
+    }
+    getTicket() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let ticket = yield this.cache.get(this.getKey());
+            if (!ticket || typeof ticket != 'string') {
+                throw new Error('No component_verify_ticket found.');
+            }
+            return ticket;
+        });
+    }
+}
+;
+module.exports = VerifyTicket;

package/dist/Pay/Client.js

@@ -16,7 +16,6 @@ const Utils_1 = require("../Core/Support/Utils");
 const HttpClient_1 = __importDefault(require("../Core/HttpClient/HttpClient"));
 const HttpClientMethodsMixin_1 = __importDefault(require("../Core/HttpClient/Mixins/HttpClientMethodsMixin"));
 const PresetMixin_1 = __importDefault(require("../Core/HttpClient/Mixins/PresetMixin"));
-const url_1 = __importDefault(require("url"));
 const Signature_1 = __importDefault(require("./Signature"));
 const LegacySignature_1 = __importDefault(require("./LegacySignature"));
 class Client {
@@ -96,9 +95,13 @@ class Client {
      * @returns
      */
     isV3Request(url) {
-        let urlObj = url_1.default.parse(url);
+        let pathname = url;
+        if (url.startsWith('https://') || url.startsWith('http://')) {
+            let urlObj = new URL(url);
+            pathname = urlObj.pathname;
+        }
         for (let i = 0; i < this.V3_URI_PREFIXES.length; i++) {
-            if (urlObj.pathname.startsWith(this.V3_URI_PREFIXES[i])) {
+            if (pathname.startsWith(this.V3_URI_PREFIXES[i])) {
                 return true;
             }
         }

package/dist/Pay/Signature.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const Utils_1 = require("../Core/Support/Utils");
 const merge_1 = __importDefault(require("merge"));
-const url_1 = __importDefault(require("url"));
 const RSA_1 = __importDefault(require("../Core/Support/RSA"));
 class Signature {
     constructor(merchant) {
@@ -18,12 +17,14 @@ class Signature {
      * @returns
      */
     createHeader(method, url, payload) {
-        let uri = url_1.default.parse(url);
-        let query = (0, Utils_1.parseQueryString)(uri.query);
-        uri.query = (0, Utils_1.buildQueryString)((0, merge_1.default)(true, query, payload.params));
+        let pathname = url;
+        if (url.startsWith('https://') || url.startsWith('http://')) {
+            let urlObj = new URL(url);
+            let search = (0, Utils_1.buildQueryString)((0, merge_1.default)(true, urlObj.searchParams, payload.params));
+            pathname = urlObj.pathname + (search ? '?' + search : '');
+        }
         let nonce = (0, Utils_1.randomString)();
         let timestamp = (0, Utils_1.getTimestamp)();
-        let path = uri.pathname + (uri.query ? '?' + uri.query : '');
         let body = '';
         if (payload.data) {
             if (typeof payload.data === 'object') {
@@ -33,7 +34,7 @@ class Signature {
                 body = payload.data;
             }
         }
-        let signString = `${method.toUpperCase()}\n${path}\n${timestamp}\n${nonce}\n${body}`;
+        let signString = `${method.toUpperCase()}\n${pathname}\n${timestamp}\n${nonce}\n${body}`;
         let rsa = new RSA_1.default;
         rsa.setPublicKey(this.merchant.getCertificate().toString());
         rsa.setPrivateKey(this.merchant.getPrivateKey().toString());

package/dist/Types/global.d.ts

@@ -74,6 +74,35 @@ export declare interface CacheFileConfig {
   ext: string
 }
 
+/**
+ * 网络请求配置
+ */
+export declare interface HttpConfig extends AxiosRequestConfig {
+  /**
+   * 是否抛出异常
+   */
+  throw?: boolean;
+  /**
+   * 是否抛出异常
+   * @see https://github.com/softonic/axios-retry#options
+   */
+  retry?: IAxiosRetry.IAxiosRetryConfig;
+  // retry?: {
+  //   /**
+  //    * 仅以下状态码重试
+  //    */
+  //   http_codes: number[];
+  //   /**
+  //    * 最大重试次数
+  //    */
+  //   max_retries: number;
+  //   /**
+  //    * 请求间隔 (毫秒)
+  //    */
+  //   delay: number;
+  // };
+}
+
 /**
  * 基础配置
  */
@@ -81,7 +110,7 @@ export declare interface BaseConfig {
   /**
    * 网络请求相关配置
    */
-  http?: AxiosRequestConfig;
+  http?: HttpConfig;
 
   /**
    * 文件缓存相关配置

package/dist/index.d.ts

@@ -1,11 +1,12 @@
-import { OfficialAccountConfig, MiniAppConfig, LogHandler, ServerEventType, ServerHandlerClosure, PayConfig } from './Types/global';
+import { OfficialAccountConfig, MiniAppConfig, LogHandler, ServerEventType, ServerHandlerClosure, PayConfig, OpenPlatformConfig } from './Types/global';
 import OfficialAccount from './OfficialAccount/Application';
 import MiniApp from './MiniApp/Application';
 import Pay from './Pay/Application';
+import OpenPlatform from './OpenPlatform/Application';
 import CacheInterface from './Core/Contracts/CacheInterface';
 import ServerRequest from './Core/Http/ServerRequest';
 import FormData from 'form-data';
-export { OfficialAccount, OfficialAccountConfig, MiniApp, MiniAppConfig, Pay, PayConfig, CacheInterface, ServerRequest, LogHandler, ServerEventType, ServerHandlerClosure, 
+export { OfficialAccount, OfficialAccountConfig, MiniApp, MiniAppConfig, Pay, PayConfig, OpenPlatform, OpenPlatformConfig, CacheInterface, ServerRequest, LogHandler, ServerEventType, ServerHandlerClosure, 
 /**
  * 表单对象
  * @see https://github.com/axios/axios#formdata

package/dist/index.js

@@ -3,13 +3,15 @@ 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.Pay = exports.MiniApp = exports.OfficialAccount = void 0;
+exports.FormData = exports.ServerRequest = exports.CacheInterface = 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"));
 exports.MiniApp = Application_2.default;
 const Application_3 = __importDefault(require("./Pay/Application"));
 exports.Pay = Application_3.default;
+const Application_4 = __importDefault(require("./OpenPlatform/Application"));
+exports.OpenPlatform = Application_4.default;
 const CacheInterface_1 = __importDefault(require("./Core/Contracts/CacheInterface"));
 exports.CacheInterface = CacheInterface_1.default;
 const ServerRequest_1 = __importDefault(require("./Core/Http/ServerRequest"));