node-easywechat 2.9.3 → 3.0.0-alpha.1

package/dist/Core/HttpClient/HttpClientResponse.js

@@ -0,0 +1,171 @@
+'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 fs_1 = __importDefault(require("fs"));
+const merge_1 = __importDefault(require("merge"));
+const Utils_1 = require("../Support/Utils");
+class HttpClientResponse {
+    constructor(response, failureJudge = null, throwError = true) {
+        this.response = null;
+        this.failureJudge = null;
+        this.throwError = false;
+        this.response = response;
+        this.failureJudge = failureJudge;
+        this.throwError = throwError;
+    }
+    withThrowError(throwError) {
+        this.throwError = throwError;
+        return this;
+    }
+    throwOnFailure() {
+        return this.withThrowError(true);
+    }
+    quietly() {
+        return this.withThrowError(false);
+    }
+    /**
+     * 设置错误判断方法
+     * @param closure
+     * @returns
+     */
+    judgeFailureUsing(closure) {
+        this.failureJudge = closure;
+        return this;
+    }
+    /**
+     * 获取请求是否失败
+     * @returns
+     */
+    isFailed() {
+        if (this.failureJudge) {
+            return this.failureJudge(this);
+        }
+        try {
+            return 400 <= this.getStatusCode();
+        }
+        catch (e) {
+            return true;
+        }
+    }
+    /**
+     * 获取请求是否成功
+     * @returns
+     */
+    isSuccessful() {
+        return !this.isFailed();
+    }
+    /**
+     * 返回对象格式
+     * @param throwError
+     * @returns
+     */
+    toObject(throwError = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            throwError = throwError === null ? this.throwError : throwError;
+            let content = this.response.data;
+            if (!content) {
+                throw new Error('Response body is empty.');
+            }
+            let contentType = this.getHeader('content-type') || '';
+            if (contentType && (contentType.indexOf('text/xml') > -1 || contentType.indexOf('application/xml') > -1 || content.indexOf('<xml>') > -1)) {
+                return (0, Utils_1.parseXml)(content);
+            }
+            return content;
+        });
+    }
+    /**
+     * 返回json字符串
+     * @param throwError
+     * @returns
+     */
+    toJson(throwError = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return JSON.stringify(yield this.toObject(throwError));
+        });
+    }
+    /**
+     * 返回字符串
+     * @returns
+     */
+    toString() {
+        return this.toJson();
+    }
+    /**
+     * 另存为文件
+     * @param filename 完整的文件名（含路径）
+     * @returns
+     */
+    saveAs(filename) {
+        let buffer = this.response.data;
+        let content = buffer.toString();
+        if (!content || '{' === content[0]) {
+            throw new Error('Invalid media response content.');
+        }
+        fs_1.default.writeFileSync(filename, buffer);
+        return filename;
+    }
+    /**
+     * 返回base64字符串
+     * @returns
+     */
+    toDataUrl() {
+        return 'data:' + this.getHeader('content-type') + ';base64,' + this.response.data;
+    }
+    /**
+     * 判断header是否存在
+     * @param key
+     * @returns
+     */
+    hasHeader(key) {
+        return Object.keys(this.getHeaders()).findIndex(o => o === key) > -1;
+    }
+    /**
+     * 获取单个header
+     * @param key
+     * @returns
+     */
+    getHeader(key) {
+        return this.getHeaders()[key] || null;
+    }
+    getStatusCode() {
+        return this.response.status;
+    }
+    getHeaders(throwError) {
+        let headers = merge_1.default.recursive(true, this.response.headers);
+        for (let key in this.response.headers) {
+            if (key !== key.toLowerCase()) {
+                this.response.headers[key.toLowerCase()] = this.response.headers[key];
+            }
+        }
+        return headers;
+    }
+    getContent(throwError) {
+        return this.response.data;
+    }
+    cancel() {
+    }
+    getInfo(type) {
+        return this.response.config;
+    }
+    offsetExists(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return Object.keys(yield this.toObject()).findIndex(o => o === key) > -1;
+        });
+    }
+    offsetGet(key) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.toObject())[key] || null;
+        });
+    }
+}
+module.exports = HttpClientResponse;

package/dist/Core/HttpClient/Mixins/HttpClientMethodsMixin.d.ts

@@ -0,0 +1,48 @@
+import HttpClientInterface from "../Contracts/HttpClientInterface";
+import { AxiosRequestConfig } from 'axios';
+import HttpClientResponse from "../HttpClientResponse";
+declare class HttpClientMethodsMixin extends HttpClientInterface {
+    /**
+     * 发送get请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    get(url: string, payload?: AxiosRequestConfig): Promise<HttpClientResponse>;
+    /**
+     * 发送post请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    post(url: string, payload?: AxiosRequestConfig): Promise<HttpClientResponse>;
+    /**
+     * 发送post请求（JSON数据）
+     * @param url
+     * @param payload
+     * @returns
+     */
+    postJson(url: string, payload?: AxiosRequestConfig): Promise<HttpClientResponse>;
+    /**
+     * 发送patch请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    patch(url: string, payload?: AxiosRequestConfig): Promise<HttpClientResponse>;
+    /**
+     * 发送put请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    put(url: string, payload?: AxiosRequestConfig): Promise<HttpClientResponse>;
+    /**
+     * 发送delete请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    delete(url: string, payload?: AxiosRequestConfig): Promise<HttpClientResponse>;
+}
+export = HttpClientMethodsMixin;

package/dist/Core/HttpClient/Mixins/HttpClientMethodsMixin.js

@@ -0,0 +1,88 @@
+'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 HttpClientInterface_1 = __importDefault(require("../Contracts/HttpClientInterface"));
+class HttpClientMethodsMixin extends HttpClientInterface_1.default {
+    /**
+     * 发送get请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    get(url, payload = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request('get', url, payload);
+        });
+    }
+    /**
+     * 发送post请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    post(url, payload = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request('post', url, payload);
+        });
+    }
+    /**
+     * 发送post请求（JSON数据）
+     * @param url
+     * @param payload
+     * @returns
+     */
+    postJson(url, payload = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!payload)
+                payload = {};
+            if (!payload['headers'])
+                payload['headers'] = {};
+            payload['headers']['Content-Type'] = 'application/json';
+            return this.request('post', url, payload);
+        });
+    }
+    /**
+     * 发送patch请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    patch(url, payload = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request('patch', url, payload);
+        });
+    }
+    /**
+     * 发送put请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    put(url, payload = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request('put', url, payload);
+        });
+    }
+    /**
+     * 发送delete请求
+     * @param url
+     * @param payload
+     * @returns
+     */
+    delete(url, payload = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.request('delete', url, payload);
+        });
+    }
+}
+module.exports = HttpClientMethodsMixin;

package/dist/Core/Message.d.ts

@@ -0,0 +1,144 @@
+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>;
+    getOriginalContents(): string;
+    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,74 @@
+'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);
+        });
+    }
+    getOriginalContents() {
+        return this.originContent;
+    }
+    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;