node-easywechat 2.10.1 → 3.0.0-alpha.2

package/dist/Core/Message.d.ts

@@ -0,0 +1,155 @@
+import ServerRequestInterface from "./Http/Contracts/ServerRequestInterface";
+import HasAttributesMixin from "./Mixins/HasAttributesMixin";
+declare class Message {
+    /**
+     * 原始消息内容
+     */
+    protected originContent: string;
+    constructor(attributes: Record<string, any>, originContent?: string);
+    /**
+     * 根据请求内容生成消息对象
+     * @param request
+     * @returns
+     */
+    static createFromRequest(request: ServerRequestInterface): Promise<Message>;
+    /**
+     * 获取原始消息内容
+     * @returns
+     */
+    getOriginalContents(): string;
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString(): string;
+}
+interface Message extends HasAttributesMixin {
+    /**
+     * 消息密文，兼容模式、安全模式才有
+     */
+    Encrypt?: string;
+    /**
+     * 开发者微信号
+     */
+    ToUserName?: string;
+    /**
+     * 发送方帐号 OpenId
+     */
+    FromUserName?: string;
+    /**
+     * 消息创建时间
+     */
+    CreateTime?: number;
+    /**
+     * 消息类型，'event'：事件，'text'：文本，'image'：图片，'voice'：语音，'video'：视频，'shortvideo'：小视频，'location'：地理位置，'link'：链接
+     */
+    MsgType?: string;
+    /**
+     * 消息id，64位整型
+     * @scope MsgType='text' | 'image' | 'voice' | 'video' | 'shortvideo' | 'location'
+     */
+    MsgId?: string;
+    /**
+     * 文本消息内容
+     * @scope MsgType='text'
+     */
+    Content?: string;
+    /**
+     * 图片链接
+     * @scope MsgType='image'
+     */
+    PicUrl?: string;
+    /**
+     * 媒体id，可以调用获取临时素材接口拉取数据
+     * @scope MsgType='image' | 'voice'
+     */
+    MediaId?: string;
+    /**
+     * 语音格式，如amr，speex等
+     * @scope MsgType='voice'
+     */
+    Format?: string;
+    /**
+     * 语音识别结果，UTF8编码
+     * @scope MsgType='voice'
+     */
+    Recognition?: string;
+    /**
+     * 缩略图的媒体id
+     * @scope MsgType='video' | 'shortvideo'
+     */
+    ThumbMediaId?: string;
+    /**
+     * 纬度
+     * @scope MsgType='location'
+     */
+    Location_X?: number;
+    /**
+     * 经度
+     * @scope MsgType='location'
+     */
+    Location_Y?: number;
+    /**
+     * 地图缩放大小
+     * @scope MsgType='location'
+     */
+    Scale?: number;
+    /**
+     * 地理位置信息
+     * @scope MsgType='location'
+     */
+    Label?: number;
+    /**
+     * 消息标题
+     * @scope MsgType='link'
+     */
+    Title?: string;
+    /**
+     * 消息描述
+     * @scope MsgType='link'
+     */
+    Description?: string;
+    /**
+     * 消息链接
+     * @scope MsgType='link'
+     */
+    Url?: string;
+    /**
+     * 事件类型，subscribe：关注，unsubscribe：取消关注，SCAN：扫描（用户已关注），LOCATION：地理位置；CLICK：自定义菜单事件，VIEW：点击菜单跳转链接
+     * @scope MsgType='event'
+     */
+    Event?: string;
+    /**
+     * 事件KEY值
+     *
+     * Event='subscribe' | 'SCAN'时：qrscene_为前缀，后面为二维码的参数值
+     *
+     * Event='CLICK'时：自定义菜单接口中KEY值对应
+     *
+     * Event='VIEW'时：设置的跳转URL
+     *
+     * @scope MsgType='event' && Event='subscribe' | 'SCAN' | 'CLICK' | 'VIEW'
+     */
+    EventKey?: string;
+    /**
+     * 二维码的ticket，可用来换取二维码图片
+     * @scope MsgType='event' && Event='subscribe' | 'SCAN'
+     */
+    Ticket?: string;
+    /**
+     * 纬度
+     * @scope MsgType='event' && Event='LOCATION'
+     */
+    Latitude?: number;
+    /**
+     * 经度
+     * @scope MsgType='event' && Event='LOCATION'
+     */
+    Longitude?: number;
+    /**
+     * 位置精度
+     * @scope MsgType='event' && Event='LOCATION'
+     */
+    Precision?: number;
+}
+export = Message;

package/dist/Core/Message.js

@@ -0,0 +1,85 @@
+'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 HasAttributesMixin_1 = __importDefault(require("./Mixins/HasAttributesMixin"));
+const Utils_1 = require("./Support/Utils");
+class Message {
+    constructor(attributes, originContent = '') {
+        /**
+         * 原始消息内容
+         */
+        this.originContent = '';
+        this.attributes = attributes;
+        this.originContent = originContent;
+        return new Proxy(this, {
+            set: function (obj, key, val) {
+                if (typeof obj[key] !== 'undefined') {
+                    obj[key] = val;
+                }
+                else {
+                    obj.set(key, val);
+                }
+                return true;
+            },
+            get: function (obj, key) {
+                if (typeof obj[key] !== 'undefined') {
+                    return obj[key];
+                }
+                return obj.get(key);
+            }
+        });
+    }
+    /**
+     * 根据请求内容生成消息对象
+     * @param request
+     * @returns
+     */
+    static createFromRequest(request) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let originContent = request.getBody().toString();
+            let attributes = {};
+            if ('<' === originContent.substring(0, 1)) {
+                attributes = yield (0, Utils_1.parseXml)(originContent);
+            }
+            else {
+                // Handle JSON format.
+                try {
+                    attributes = JSON.parse(originContent);
+                }
+                catch (e) { }
+            }
+            if (Object.keys(attributes).length === 0) {
+                throw new Error('Failed to decode request contents.');
+            }
+            return new Message(attributes, originContent);
+        });
+    }
+    /**
+     * 获取原始消息内容
+     * @returns
+     */
+    getOriginalContents() {
+        return this.originContent;
+    }
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString() {
+        return this.toJson();
+    }
+}
+;
+;
+(0, Utils_1.applyMixins)(Message, [HasAttributesMixin_1.default]);
+module.exports = Message;

package/dist/Core/Mixins/CacheMixin.d.ts

@@ -0,0 +1,40 @@
+import CacheInterface from "../Contracts/CacheInterface";
+declare class CacheMixin {
+    protected cache: CacheInterface;
+    protected cacheLifetime: number;
+    protected cacheNamespace: string;
+    /**
+     * 获取缓存过期时间，单位：秒
+     * @returns
+     */
+    getCacheLifetime(): number;
+    /**
+     * 设置缓存过期时间，单位：秒
+     * @param cacheLifetime
+     * @returns
+     */
+    setCacheLifetime(cacheLifetime: number): void;
+    /**
+     * 获取缓存命名空间
+     * @returns
+     */
+    getCacheNamespace(): string;
+    /**
+     * 设置缓存命名空间
+     * @param cacheNamespace
+     * @returns
+     */
+    setCacheNamespace(cacheNamespace: string): void;
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache(): CacheInterface;
+    /**
+     * 设置缓存实例
+     * @param cache
+     * @returns
+     */
+    setCache(cache: CacheInterface): this;
+}
+export = CacheMixin;

package/dist/Core/Mixins/CacheMixin.js

@@ -0,0 +1,63 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const FileCache_1 = __importDefault(require("../Cache/FileCache"));
+class CacheMixin {
+    constructor() {
+        this.cache = null;
+        this.cacheLifetime = 1500;
+        this.cacheNamespace = 'easywechat';
+    }
+    /**
+     * 获取缓存过期时间，单位：秒
+     * @returns
+     */
+    getCacheLifetime() {
+        return this.cacheLifetime;
+    }
+    /**
+     * 设置缓存过期时间，单位：秒
+     * @param cacheLifetime
+     * @returns
+     */
+    setCacheLifetime(cacheLifetime) {
+        this.cacheLifetime = cacheLifetime;
+    }
+    /**
+     * 获取缓存命名空间
+     * @returns
+     */
+    getCacheNamespace() {
+        return this.cacheNamespace;
+    }
+    /**
+     * 设置缓存命名空间
+     * @param cacheNamespace
+     * @returns
+     */
+    setCacheNamespace(cacheNamespace) {
+        this.cacheNamespace = cacheNamespace;
+    }
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache() {
+        if (!this.cache) {
+            this.cache = new FileCache_1.default();
+        }
+        return this.cache;
+    }
+    /**
+     * 设置缓存实例
+     * @param cache
+     * @returns
+     */
+    setCache(cache) {
+        this.cache = cache;
+        return this;
+    }
+}
+;
+module.exports = CacheMixin;

package/dist/Core/Mixins/ClientMixin.d.ts

@@ -0,0 +1,16 @@
+import AccessTokenAwareClient from "../HttpClient/AccessTokenAwareClient";
+declare class ClientMixin {
+    protected client: AccessTokenAwareClient;
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient(): AccessTokenAwareClient;
+    /**
+     * 设置客户端实例
+     * @param client
+     * @returns
+     */
+    setClient(client: AccessTokenAwareClient): this;
+}
+export = ClientMixin;

package/dist/Core/Mixins/ClientMixin.js

@@ -0,0 +1,21 @@
+'use strict';
+class ClientMixin {
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient() {
+        return this.client;
+    }
+    /**
+     * 设置客户端实例
+     * @param client
+     * @returns
+     */
+    setClient(client) {
+        this.client = client;
+        return this;
+    }
+}
+;
+module.exports = ClientMixin;

package/dist/Core/Mixins/ConfigMixin.d.ts

@@ -0,0 +1,16 @@
+import ConfigInterface from "../Contracts/ConfigInterface";
+declare class ConfigMixin {
+    protected config: ConfigInterface;
+    /**
+     * 获取配置实例
+     * @returns
+     */
+    getConfig(): ConfigInterface;
+    /**
+     * 设置配置实例
+     * @param config
+     * @returns
+     */
+    setConfig(config: ConfigInterface): this;
+}
+export = ConfigMixin;

package/dist/Core/Mixins/ConfigMixin.js

@@ -0,0 +1,21 @@
+'use strict';
+class ConfigMixin {
+    /**
+     * 获取配置实例
+     * @returns
+     */
+    getConfig() {
+        return this.config;
+    }
+    /**
+     * 设置配置实例
+     * @param config
+     * @returns
+     */
+    setConfig(config) {
+        this.config = config;
+        return this;
+    }
+}
+;
+module.exports = ConfigMixin;

package/dist/Core/Mixins/DecryptXmlMessageMixin.d.ts

@@ -0,0 +1,11 @@
+import Encryptor from "../Encryptor";
+import Message from "../Message";
+declare class DecryptXmlMessageMixin {
+    /**
+     * 解密消息
+     * @returns
+     */
+    decryptMessage(message: Message, encryptor: Encryptor, signature: string, timestamp: number, nonce: string): Promise<Message>;
+    protected validateSignature(token: string, ciphertext: string, signature: string, timestamp: number, nonce: string): void;
+}
+export = DecryptXmlMessageMixin;

package/dist/Core/Mixins/DecryptXmlMessageMixin.js

@@ -0,0 +1,38 @@
+'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());
+    });
+};
+const Utils_1 = require("../Support/Utils");
+class DecryptXmlMessageMixin {
+    /**
+     * 解密消息
+     * @returns
+     */
+    decryptMessage(message, encryptor, signature, timestamp, nonce) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let ciphertext = message.Encrypt;
+            this.validateSignature(encryptor.getToken(), ciphertext, signature, timestamp, nonce);
+            let attributes = yield (0, Utils_1.parseXml)(encryptor.decrypt(ciphertext, signature, nonce, timestamp));
+            message.merge(attributes);
+            return message;
+        });
+    }
+    validateSignature(token, ciphertext, signature, timestamp, nonce) {
+        if (!signature) {
+            throw new Error('Request signature must not be empty.');
+        }
+        let params = [token, timestamp, nonce, ciphertext];
+        params.sort();
+        if (signature !== (0, Utils_1.createHash)(params.join(''), 'sha1')) {
+            throw new Error('Invalid request signature.');
+        }
+    }
+}
+;
+module.exports = DecryptXmlMessageMixin;

package/dist/Core/Mixins/HandlersMixin.d.ts

@@ -0,0 +1,79 @@
+import { ServerHandlerClosure, ServerHandlerItem } from "../../Types/global";
+import Message from "../Message";
+declare class HandlersMixin {
+    protected handlers: ServerHandlerItem[];
+    /**
+     * 获取所有处理器
+     * @returns
+     */
+    getHandlers(): ServerHandlerItem[];
+    /**
+     * 创建处理器项
+     * @param handler
+     * @returns
+     */
+    createHandlerItem(handler: ServerHandlerClosure): ServerHandlerItem;
+    /**
+     * 计算处理器hash
+     * @param handler
+     * @returns
+     */
+    protected getHandlerHash(handler: ServerHandlerClosure): string;
+    /**
+     * @alias withHandler()
+     */
+    with(handler: ServerHandlerClosure): this;
+    /**
+     * 从最后添加处理器
+     * @param handler
+     * @returns
+     */
+    withHandler(handler: ServerHandlerClosure): this;
+    /**
+     * @alias prependHandler()
+     */
+    prepend(handler: ServerHandlerClosure): this;
+    /**
+     * 从最前添加处理器
+     * @param handler
+     * @returns
+     */
+    prependHandler(handler: ServerHandlerClosure): this;
+    /**
+     * @alias withoutHandler()
+     */
+    without(handler: ServerHandlerClosure): this;
+    /**
+     * 删除处理器
+     * @param handler
+     * @returns
+     */
+    withoutHandler(handler: ServerHandlerClosure): this;
+    /**
+     * 获取处理器的索引
+     * @param handler
+     * @returns
+     */
+    indexOf(handler: ServerHandlerClosure): number;
+    /**
+     * 当 value 为true或者返回true时，添加处理器
+     * @param value
+     * @param handler
+     * @returns
+     */
+    when(value: boolean | Function | Promise<boolean>, handler: ServerHandlerClosure): this;
+    /**
+     * 执行处理器
+     * @param result
+     * @param payload
+     * @returns
+     */
+    handle(result: any, payload: Message): Promise<any>;
+    /**
+     * 判断处理器是否已存在
+     * @param handler
+     * @returns
+     */
+    has(handler: ServerHandlerClosure): boolean;
+}
+export = HandlersMixin;