node-easywechat 3.1.3 → 3.2.0

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

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

package/dist/Work/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/Work/Encryptor.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="node" />
+import BaseEncryptor from '../Core/Encryptor';
+declare class Encryptor extends BaseEncryptor {
+    protected corpId: string;
+    protected token: string;
+    protected aesKey: string | Buffer;
+    constructor(corpId?: string, token?: string, aesKey?: string | Buffer);
+}
+export = Encryptor;

package/dist/Work/Encryptor.js

@@ -0,0 +1,17 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Encryptor_1 = __importDefault(require("../Core/Encryptor"));
+class Encryptor extends Encryptor_1.default {
+    constructor(corpId = null, token = null, aesKey = null) {
+        super(corpId, token, aesKey, null);
+        this.corpId = corpId;
+        this.token = token;
+        this.aesKey = aesKey;
+        if (typeof this.aesKey === 'string') {
+            this.aesKey = Buffer.from(this.aesKey + '=', 'base64');
+        }
+    }
+}
+module.exports = Encryptor;

package/dist/Work/JsApiTicket.d.ts

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

package/dist/Work/JsApiTicket.js

@@ -0,0 +1,141 @@
+'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 {
+    constructor() {
+        super(...arguments);
+        this.agentKey = null;
+    }
+    /**
+     * 获取jsapi_ticket的缓存名称
+     * @returns
+     */
+    getKey() {
+        if (!this.key) {
+            this.key = `work.jsapi_ticket.${this.corpId}`;
+        }
+        return this.key;
+    }
+    /**
+     * 获取签名凭证jsapi_ticket
+     * @returns
+     */
+    getTicket() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let key = this.getKey();
+            let ticket = '';
+            if (this.cache) {
+                ticket = yield this.cache.get(key);
+            }
+            if (!!ticket && typeof ticket === 'string') {
+                return ticket;
+            }
+            let response = (yield this.httpClient.request('get', '/cgi-bin/get_jsapi_ticket', {})).toObject();
+            if (!response['ticket']) {
+                throw new Error('Failed to get jssdk_ticket: ' + JSON.stringify(response));
+            }
+            if (this.cache) {
+                yield this.cache.set(key, response['ticket'], parseInt(response['expires_in']));
+            }
+            return response['ticket'];
+        });
+    }
+    /**
+     * 获取签名配置
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    createConfigSignature(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.corpId,
+                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');
+    }
+    /**
+     * 获取代理应用的签名配置
+     * @param agentId 代理应用的id
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    createAgentConfigSignature(agentId, 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 {
+                corpid: this.corpId,
+                agentid: agentId,
+                url,
+                nonceStr: nonce,
+                timestamp,
+                signature: this.getTicketSignature(ticket, nonce, timestamp, url),
+            };
+        });
+    }
+    /**
+     * 获取代理应用的签名凭证jsapi_ticket
+     * @param agentId 代理应用的id
+     * @returns
+     */
+    getAgentTicket(agentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let key = this.getAgentKey(agentId);
+            let ticket = '';
+            if (this.cache) {
+                ticket = yield this.cache.get(key);
+            }
+            if (!!ticket && typeof ticket === 'string') {
+                return ticket;
+            }
+            let response = (yield this.httpClient.request('get', '/cgi-bin/ticket/get', {
+                params: {
+                    type: 'agent_config',
+                }
+            })).toObject();
+            if (!response['ticket']) {
+                throw new Error('Failed to get jssdk agentTicket: ' + JSON.stringify(response));
+            }
+            if (this.cache) {
+                yield this.cache.set(key, response['ticket'], parseInt(response['expires_in']));
+            }
+            return response['ticket'];
+        });
+    }
+    /**
+     * 获取代理应用的jsapi_ticket的缓存名称
+     * @param agentId 代理应用的id
+     * @returns
+     */
+    getAgentKey(agentId) {
+        return `${this.getKey()}.${agentId}`;
+    }
+}
+;
+module.exports = JsApiTicket;

package/dist/Work/Message.d.ts

@@ -0,0 +1,142 @@
+import BaseMessage from '../Core/Message';
+declare class Message extends BaseMessage {
+}
+interface Message extends Record<string, any> {
+    /**
+     * 消息密文，兼容模式、安全模式才有
+     */
+    Encrypt?: string;
+    /**
+     * 开发者微信号
+     */
+    ToUserName?: string;
+    /**
+     * 发送方帐号 OpenId
+     */
+    FromUserName?: string;
+    /**
+     * 消息创建时间
+     */
+    CreateTime?: number;
+    /**
+     * 消息类型
+     * - `event` 事件
+     * - `text` 文本
+     * - `image` 图片
+     * - `voice` 语音
+     * - `video` 视频
+     * - `location` 地理位置
+     * - `link` 链接
+     */
+    MsgType?: string;
+    /**
+     * 事件类型
+     * - `change_contact` 通讯录变更事件
+     * - `change_chain` 上下游变更事件
+     * - `batch_job_result` 上下游异步任务完成事件
+     * @scope MsgType='event'
+     */
+    Event?: string;
+    /**
+     * 变更类型
+     *
+     * 通讯录变更事件：
+     * - `create_user` 新增成员
+     * - `update_user` 更新成员
+     * - `delete_user` 删除成员
+     * - `create_party` 新增部门
+     * - `update_party` 更新部门
+     * - `delete_party` 删除部门
+     * - `update_tag` 标签变更
+     *
+     * 上下游变更事件：
+     * - `create_chain` 新增上下游空间
+     * - `update_chain` 更新上下游空间
+     * - `delete_chain` 删除上下游空间
+     * - `create_group` 新增上下游分组
+     * - `update_group` 更新上下游空间
+     * - `delete_group` 删除上下游空间
+     * - `corp_join` 企业加入上下游
+     * - `update_corp` 更新加入上下游企业
+     * - `remove_corp` 删除上下游企业
+     *
+     * @scope Event='change_contact' | 'change_chain'
+     */
+    ChangeType?: string;
+    /**
+     * 企业应用的id
+     * @scope MsgType='text' | 'image' | 'voice' | 'video' | 'location' | 'link'
+     */
+    AgentID?: string;
+    /**
+     * 消息id，64位整型
+     * @scope MsgType='text' | 'image' | 'voice' | 'video' | 'location' | 'link'
+     */
+    MsgId?: string;
+    /**
+     * 文本消息内容
+     * @scope MsgType='text'
+     */
+    Content?: string;
+    /**
+     * 图片链接
+     * @scope MsgType='image' | 'link'
+     */
+    PicUrl?: string;
+    /**
+     * 媒体id，可以调用获取临时素材接口拉取数据
+     * @scope MsgType='image' | 'voice' | 'video'
+     */
+    MediaId?: string;
+    /**
+     * 语音格式，如amr，speex等
+     * @scope MsgType='voice'
+     */
+    Format?: string;
+    /**
+     * 缩略图的媒体id
+     * @scope MsgType='video'
+     */
+    ThumbMediaId?: string;
+    /**
+     * 纬度
+     * @scope MsgType='location'
+     */
+    Location_X?: number;
+    /**
+     * 经度
+     * @scope MsgType='location'
+     */
+    Location_Y?: number;
+    /**
+     * 地图缩放大小
+     * @scope MsgType='location'
+     */
+    Scale?: number;
+    /**
+     * 地理位置信息
+     * @scope MsgType='location'
+     */
+    Label?: number;
+    /**
+     * app类型，在企业微信固定返回wxwork，在微信不返回该字段
+     * @scope MsgType='location'
+     */
+    AppType?: number;
+    /**
+     * 消息标题
+     * @scope MsgType='link'
+     */
+    Title?: string;
+    /**
+     * 消息描述
+     * @scope MsgType='link'
+     */
+    Description?: string;
+    /**
+     * 消息链接
+     * @scope MsgType='link'
+     */
+    Url?: string;
+}
+export = Message;

package/dist/Work/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/Work/Server.d.ts

@@ -0,0 +1,90 @@
+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 { ServerEventType, ServerHandlerClosure, ServerMessageType } from '../Types/global';
+declare class Server extends ServerInterface {
+    protected encryptor: Encryptor;
+    protected request: ServerRequestInterface;
+    constructor(encryptor: Encryptor, request?: ServerRequestInterface);
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve(): Promise<Response>;
+    /**
+     * 设置联系人变化的消息处理器
+     * @param handler
+     */
+    handleContactChanged(handler: ServerHandlerClosure): this;
+    /**
+     * 设置用户标签变化的消息处理器
+     * @param handler
+     */
+    handleUserTagUpdated(handler: ServerHandlerClosure): this;
+    /**
+     * 设置用户创建的消息处理器
+     * @param handler
+     */
+    handleUserCreated(handler: ServerHandlerClosure): this;
+    /**
+     * 设置用户更新的消息处理器
+     * @param handler
+     */
+    handleUserUpdated(handler: ServerHandlerClosure): this;
+    /**
+     * 设置用户删除的消息处理器
+     * @param handler
+     */
+    handleUserDeleted(handler: ServerHandlerClosure): this;
+    /**
+     * 设置部门创建的消息处理器
+     * @param handler
+     */
+    handlePartyCreated(handler: ServerHandlerClosure): this;
+    /**
+     * 设置部门更新的消息处理器
+     * @param handler
+     */
+    handlePartyUpdated(handler: ServerHandlerClosure): this;
+    /**
+     * 设置部门删除的消息处理器
+     * @param handler
+     */
+    handlePartyDeleted(handler: ServerHandlerClosure): this;
+    /**
+     * 设置异步任务完成的消息处理器
+     * @param handler
+     */
+    handleBatchJobsFinished(handler: ServerHandlerClosure): this;
+    /**
+     * 添加普通消息处理器
+     * @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 validateUrl(): (message: Message, next: ServerHandlerClosure) => Promise<Response>;
+    protected decryptRequestMessage(query: Record<string, any>): ServerHandlerClosure;
+    /**
+     * 获取解密后的消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getDecryptedMessage(request?: ServerRequestInterface): Promise<import("../Core/Message")>;
+}
+export = Server;