node-easywechat 2.10.2 → 3.0.0-beta.1

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

@@ -0,0 +1,87 @@
+import ProviderInterface from "node-socialite/dist/Core/ProviderInterface";
+import AccessTokenInterface from "../../Core/Contracts/AccessTokenInterface";
+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 { OfficialAccountOAuthFactory } from "../../Types/global";
+import JsApiTicket from "../JsApiTicket";
+import Utils from "../Utils";
+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;
+    /**
+     * 获取JsApiTicket实例
+     * @returns
+     */
+    getTicket(): JsApiTicket;
+    /**
+     * 获取工具实例
+     * @returns
+     */
+    getUtils(): Utils;
+    /**
+     * 设置OAuth工厂方法
+     * @param oauthFactory
+     * @returns
+     */
+    setOAuthFactory(oauthFactory: OfficialAccountOAuthFactory): this;
+}
+export = ApplicationInterface;

package/dist/OfficialAccount/Contracts/ApplicationInterface.js

@@ -0,0 +1,76 @@
+'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; }
+    /**
+     * 获取JsApiTicket实例
+     * @returns
+     */
+    getTicket() { return null; }
+    /**
+     * 获取工具实例
+     * @returns
+     */
+    getUtils() { return null; }
+    /**
+     * 设置OAuth工厂方法
+     * @param oauthFactory
+     * @returns
+     */
+    setOAuthFactory(oauthFactory) { return this; }
+}
+;
+module.exports = ApplicationInterface;

package/dist/OfficialAccount/JsApiTicket.d.ts

@@ -0,0 +1,23 @@
+import AccessToken from './AccessToken';
+declare class JsApiTicket extends AccessToken {
+    /**
+     * 获取jsapi_ticket的缓存名称
+     * @returns
+     */
+    getKey(): string;
+    /**
+     * 获取签名凭证jsapi_ticket
+     * @returns
+     */
+    getTicket(): Promise<string>;
+    /**
+     * 获取签名配置
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    configSignature(url: string, nonce?: string, timestamp?: number): Promise<Record<string, any>>;
+    protected getTicketSignature(ticket: string, nonce: string, timestamp: number, url: string): string;
+}
+export = JsApiTicket;

package/dist/OfficialAccount/JsApiTicket.js

@@ -0,0 +1,76 @@
+'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 Utils_1 = require("../Core/Support/Utils");
+const AccessToken_1 = __importDefault(require("./AccessToken"));
+class JsApiTicket extends AccessToken_1.default {
+    /**
+     * 获取jsapi_ticket的缓存名称
+     * @returns
+     */
+    getKey() {
+        if (!this.key) {
+            this.key = `official_account.jsapi_ticket.${this.appId}`;
+        }
+        return this.key;
+    }
+    /**
+     * 获取签名凭证jsapi_ticket
+     * @returns
+     */
+    getTicket() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let key = this.getKey();
+            let ticket = yield this.cache.get(key);
+            if (!!ticket && typeof ticket === 'string') {
+                return ticket;
+            }
+            let response = yield (yield this.httpClient.request('get', '/cgi-bin/ticket/getticket', {
+                params: {
+                    type: 'jsapi',
+                }
+            })).toObject(false);
+            if (!response['ticket']) {
+                throw new Error('Failed to get jssdk_ticket: ' + JSON.stringify(response));
+            }
+            yield this.cache.set(key, response['ticket'], parseInt(response['expires_in']));
+            return response['ticket'];
+        });
+    }
+    /**
+     * 获取签名配置
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    configSignature(url, nonce = null, timestamp = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            nonce = nonce || (0, Utils_1.randomString)(10);
+            timestamp = timestamp || (0, Utils_1.getTimestamp)();
+            let ticket = yield this.getTicket();
+            return {
+                url,
+                nonceStr: nonce,
+                timestamp,
+                appId: this.appId,
+                signature: this.getTicketSignature(ticket, nonce, timestamp, url),
+            };
+        });
+    }
+    getTicketSignature(ticket, nonce, timestamp, url) {
+        return (0, Utils_1.createHash)(`jsapi_ticket=${ticket}&noncestr=${nonce}&timestamp=${timestamp}&url=${url}`, 'sha1');
+    }
+}
+;
+module.exports = JsApiTicket;

package/dist/OfficialAccount/Message.d.ts

@@ -0,0 +1,4 @@
+import BaseMessage from '../Core/Message';
+declare class Message extends BaseMessage {
+}
+export = Message;

package/dist/OfficialAccount/Message.js

@@ -0,0 +1,8 @@
+'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/OfficialAccount/Server.d.ts

@@ -0,0 +1,43 @@
+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 HandlersMixin from '../Core/Mixins/HandlersMixin';
+import DecryptXmlMessageMixin from '../Core/Mixins/DecryptXmlMessageMixin';
+import { ServerEventType, ServerHandlerClosure, ServerMessageType } from '../Types/global';
+import ResponseXmlMessageMixin from '../Core/Mixins/ResponseXmlMessageMixin';
+declare class Server implements ServerInterface {
+    protected request: ServerRequestInterface;
+    protected encryptor: Encryptor;
+    constructor(request?: ServerRequestInterface, encryptor?: Encryptor);
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve(): Promise<Response>;
+    /**
+     * 添加普通消息处理器
+     * @param type
+     * @param handler
+     * @returns
+     */
+    addMessageListener(type: ServerMessageType, handler: ServerHandlerClosure): this;
+    /**
+     * 添加事件消息处理器
+     * @param event
+     * @param handler
+     * @returns
+     */
+    addEventListener(event: ServerEventType, handler: ServerHandlerClosure): this;
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request?: ServerRequestInterface): Promise<Message>;
+    protected decryptRequestMessage(query: Record<string, any>): ServerHandlerClosure;
+}
+interface Server extends HandlersMixin, DecryptXmlMessageMixin, ResponseXmlMessageMixin {
+}
+export = Server;

package/dist/OfficialAccount/Server.js

@@ -0,0 +1,94 @@
+'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 Response_1 = __importDefault(require("../Core/Http/Response"));
+const Message_1 = __importDefault(require("./Message"));
+const HandlersMixin_1 = __importDefault(require("../Core/Mixins/HandlersMixin"));
+const Utils_1 = require("../Core/Support/Utils");
+const DecryptXmlMessageMixin_1 = __importDefault(require("../Core/Mixins/DecryptXmlMessageMixin"));
+const ResponseXmlMessageMixin_1 = __importDefault(require("../Core/Mixins/ResponseXmlMessageMixin"));
+class Server {
+    constructor(request = null, encryptor = null) {
+        this.request = request;
+        this.encryptor = encryptor;
+        this.handlers = [];
+    }
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let echostr = this.request.getQueryParams()['echostr'] || '';
+            if (!!echostr) {
+                return new Response_1.default(200, {}, echostr);
+            }
+            let message = yield this.getRequestMessage(this.request);
+            let query = this.request.getQueryParams();
+            if (this.encryptor && query['msg_signature']) {
+                this.prepend(this.decryptRequestMessage(query));
+            }
+            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 type
+     * @param handler
+     * @returns
+     */
+    addMessageListener(type, handler) {
+        return this.withHandler(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.MsgType === type ? handler(message, next) : next(message);
+            });
+        });
+    }
+    /**
+     * 添加事件消息处理器
+     * @param event
+     * @param handler
+     * @returns
+     */
+    addEventListener(event, handler) {
+        return this.withHandler(function (message, next) {
+            return __awaiter(this, void 0, void 0, function* () {
+                return message.Event === event ? handler(message, next) : next(message);
+            });
+        });
+    }
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request = null) {
+        return Message_1.default.createFromRequest(request || this.request);
+    }
+    decryptRequestMessage(query) {
+        return (message, next) => __awaiter(this, void 0, void 0, function* () {
+            if (!this.encryptor)
+                return null;
+            yield this.decryptMessage(message, this.encryptor, query['msg_signature'] || '', query['timestamp'] || '', query['nonce'] || '');
+            return next(message);
+        });
+    }
+}
+;
+;
+(0, Utils_1.applyMixins)(Server, [HandlersMixin_1.default, DecryptXmlMessageMixin_1.default, ResponseXmlMessageMixin_1.default]);
+module.exports = Server;

package/dist/OfficialAccount/Utils.d.ts

@@ -0,0 +1,7 @@
+import Application from './Application';
+declare class Utils {
+    protected app: Application;
+    constructor(app: Application);
+    buildJsSdkConfig(url: string, jsApiList?: string[], openTagList?: string[], debug?: boolean): Promise<Record<string, any>>;
+}
+export = Utils;

package/dist/OfficialAccount/{Server/Guard.js → Utils.js}

@@ -11,14 +11,20 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-const ServerGuard_1 = __importDefault(require("../../Core/ServerGuard"));
-class Guard extends ServerGuard_1.default {
-    shouldReturnRawResponse() {
+const merge_1 = __importDefault(require("merge"));
+class Utils {
+    constructor(app) {
+        this.app = app;
+    }
+    buildJsSdkConfig(url, jsApiList = [], openTagList = [], debug = false) {
         return __awaiter(this, void 0, void 0, function* () {
-            return !((yield this.app.request.get('echostr')) == null);
+            return (0, merge_1.default)({
+                jsApiList,
+                openTagList,
+                debug,
+            }, yield this.app.getTicket().configSignature(url));
         });
     }
 }
-exports.default = Guard;
 ;
+module.exports = Utils;