node-easywechat 3.1.4 → 3.3.0

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

@@ -0,0 +1,108 @@
+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 SuiteEncryptor from "../SuiteEncryptor";
+import AccountInterface from "./AccountInterface";
+import AccessTokenInterface from "../../Core/Contracts/AccessTokenInterface";
+import SuiteTicketInterface from "./SuiteTicketInterface";
+import SuiteAccessToken from "../SuiteAccessToken";
+import JsApiTicket from "../JsApiTicket";
+declare abstract class ApplicationInterface {
+    /**
+     * 获取当前账户实例
+     * @returns
+     */
+    getAccount(): AccountInterface;
+    /**
+     * 获取加密机实例
+     * @returns
+     */
+    getEncryptor(): Encryptor;
+    /**
+     * 获取授权应用的加密机实例
+     * @returns
+     */
+    getSuiteEncryptor(): SuiteEncryptor;
+    /**
+     * 获取服务端实例
+     * @returns
+     */
+    getServer(): ServerInterface;
+    /**
+     * 获取当前请求实例
+     * @returns
+     */
+    getRequest(): ServerRequestInterface;
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient(): AccessTokenAwareClient;
+    /**
+     * 创建客户端实例
+     * @returns
+     */
+    createClient(): AccessTokenAwareClient;
+    /**
+     * 获取企业的客户端实例
+     * @returns
+     */
+    getAuthorizerClient(corpId: string, permanentCode: string, suiteAccessToken?: SuiteAccessToken): Promise<AccessTokenAwareClient>;
+    /**
+     * 获取jsapi ticket
+     * @returns
+     */
+    getJsApiTicket(corpId: string, permanentCode: string, suiteAccessToken?: SuiteAccessToken): Promise<JsApiTicket>;
+    /**
+     * 获取网络请求客户端实例
+     * @returns
+     */
+    getHttpClient(): HttpClientInterface;
+    /**
+     * 获取配置信息实例
+     * @returns
+     */
+    getConfig(): ConfigInterface;
+    /**
+     * 获取开放平台应用的AccessToken实例
+     * @returns
+     */
+    getProviderAccessToken(): AccessTokenInterface;
+    /**
+     * 获取授权应用的AccessToken实例
+     * @returns
+     */
+    getSuiteAccessToken(): AccessTokenInterface;
+    /**
+     * 获取授权应用的Ticket实例
+     * @returns
+     */
+    getSuiteTicket(): SuiteTicketInterface;
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache(): CacheInterface;
+    /**
+     * 获取授权应用的OAuth实例
+     * @param suiteId
+     * @param suiteAccessToken
+     * @https://developer.work.weixin.qq.com/document/path/91120#构造第三方应用oauth2链接
+     * @returns
+     */
+    getOAuth(suiteId: string, suiteAccessToken?: SuiteAccessToken): Promise<ProviderInterface>;
+    /**
+     * 获取企业的OAuth实例
+     * @param corpId
+     * @param suiteAccessToken
+     * @see https://developer.work.weixin.qq.com/document/path/91120#构造企业oauth2链接
+     * @returns
+     */
+    getCorpOAuth(corpId: string, suiteAccessToken?: SuiteAccessToken): Promise<ProviderInterface>;
+}
+export = ApplicationInterface;

package/dist/OpenWork/Contracts/ApplicationInterface.js

@@ -0,0 +1,96 @@
+'use strict';
+class ApplicationInterface {
+    /**
+     * 获取当前账户实例
+     * @returns
+     */
+    getAccount() { return null; }
+    /**
+     * 获取加密机实例
+     * @returns
+     */
+    getEncryptor() { return null; }
+    /**
+     * 获取授权应用的加密机实例
+     * @returns
+     */
+    getSuiteEncryptor() { return null; }
+    /**
+     * 获取服务端实例
+     * @returns
+     */
+    getServer() { return null; }
+    /**
+     * 获取当前请求实例
+     * @returns
+     */
+    getRequest() { return null; }
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient() { return null; }
+    /**
+     * 创建客户端实例
+     * @returns
+     */
+    createClient() { return null; }
+    /**
+     * 获取企业的客户端实例
+     * @returns
+     */
+    getAuthorizerClient(corpId, permanentCode, suiteAccessToken = null) { return null; }
+    /**
+     * 获取jsapi ticket
+     * @returns
+     */
+    getJsApiTicket(corpId, permanentCode, suiteAccessToken = null) { return null; }
+    /**
+     * 获取网络请求客户端实例
+     * @returns
+     */
+    getHttpClient() { return null; }
+    /**
+     * 获取配置信息实例
+     * @returns
+     */
+    getConfig() { return null; }
+    /**
+     * 获取开放平台应用的AccessToken实例
+     * @returns
+     */
+    getProviderAccessToken() { return null; }
+    /**
+     * 获取授权应用的AccessToken实例
+     * @returns
+     */
+    getSuiteAccessToken() { return null; }
+    /**
+     * 获取授权应用的Ticket实例
+     * @returns
+     */
+    getSuiteTicket() { return null; }
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache() { return null; }
+    /**
+     * 获取授权应用的OAuth实例
+     * @param suiteId
+     * @param suiteAccessToken
+     * @https://developer.work.weixin.qq.com/document/path/91120#构造第三方应用oauth2链接
+     * @returns
+     */
+    getOAuth(suiteId, suiteAccessToken = null) { return null; }
+    /**
+     * 获取企业的OAuth实例
+     * @param corpId
+     * @param suiteAccessToken
+     * @see https://developer.work.weixin.qq.com/document/path/91120#构造企业oauth2链接
+     * @returns
+     */
+    getCorpOAuth(corpId, suiteAccessToken = null) { return null; }
+}
+;
+module.exports = ApplicationInterface;

package/dist/OpenWork/Contracts/SuiteTicketInterface.d.ts

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

package/dist/OpenWork/Contracts/SuiteTicketInterface.js

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

package/dist/OpenWork/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/OpenWork/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/OpenWork/JsApiTicket.d.ts

@@ -0,0 +1,50 @@
+import CacheInterface from '../Core/Contracts/CacheInterface';
+import HttpClientInterface from '../Core/HttpClient/Contracts/HttpClientInterface';
+declare class JsApiTicket {
+    protected corpId: string;
+    protected key: string;
+    protected cache: CacheInterface;
+    protected httpClient: HttpClientInterface;
+    constructor(corpId: string, key?: string, cache?: CacheInterface, httpClient?: HttpClientInterface);
+    /**
+     * 获取签名配置
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    createConfigSignature(url: string, nonce?: string, timestamp?: number, jsApiList?: string[], debug?: boolean, beta?: boolean): Promise<Record<string, any>>;
+    protected getTicketSignature(ticket: string, nonce: string, timestamp: number, url: string): string;
+    /**
+     * 获取jsapi_ticket的缓存名称
+     * @returns
+     */
+    getKey(): string;
+    /**
+     * 获取签名凭证jsapi_ticket
+     * @returns
+     */
+    getTicket(): Promise<string>;
+    /**
+     * 获取代理应用的签名配置
+     * @param agentId 代理应用的id
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    createAgentConfigSignature(agentId: number, url: string, nonce?: string, timestamp?: number, jsApiList?: string[]): 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/OpenWork/JsApiTicket.js

@@ -0,0 +1,152 @@
+'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 HttpClient_1 = __importDefault(require("../Core/HttpClient/HttpClient"));
+const Utils_1 = require("../Core/Support/Utils");
+class JsApiTicket {
+    constructor(corpId, key = null, cache = null, httpClient = null) {
+        this.corpId = corpId;
+        this.key = key;
+        this.cache = cache;
+        this.httpClient = httpClient;
+        if (!this.httpClient) {
+            this.httpClient = HttpClient_1.default.create({
+                baseURL: 'https://qyapi.weixin.qq.com/',
+            });
+        }
+    }
+    /**
+     * 获取签名配置
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    createConfigSignature(url, nonce = null, timestamp = null, jsApiList = [], debug = false, beta = true) {
+        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 {
+                appId: this.corpId,
+                nonceStr: nonce,
+                timestamp,
+                url,
+                signature: this.getTicketSignature(ticket, nonce, timestamp, url),
+                jsApiList,
+                debug,
+                beta,
+            };
+        });
+    }
+    getTicketSignature(ticket, nonce, timestamp, url) {
+        return (0, Utils_1.createHash)(`jsapi_ticket=${ticket}&noncestr=${nonce}&timestamp=${timestamp}&url=${url}`, 'sha1');
+    }
+    /**
+     * 获取jsapi_ticket的缓存名称
+     * @returns
+     */
+    getKey() {
+        if (!this.key) {
+            this.key = `open_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 agentId 代理应用的id
+     * @param url 完整URL地址
+     * @param nonce 随机字符串，默认：随机10位
+     * @param timestamp 时间长，默认：当前时间
+     * @returns
+     */
+    createAgentConfigSignature(agentId, url, nonce = null, timestamp = null, jsApiList = []) {
+        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),
+                jsApiList,
+            };
+        });
+    }
+    /**
+     * 获取代理应用的签名凭证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/OpenWork/Message.d.ts

@@ -0,0 +1,78 @@
+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;
+    /**
+     * 信息类型
+     * - `suite_ticket` [推送suite_ticket](https://developer.work.weixin.qq.com/document/path/90628)
+     * - `create_auth` [授权成功](https://developer.work.weixin.qq.com/document/path/90642#授权成功通知)
+     * - `change_auth` [变更授权](https://developer.work.weixin.qq.com/document/path/90642#变更授权通知)
+     * - `cancel_auth` [取消授权](https://developer.work.weixin.qq.com/document/path/90642#取消授权通知)
+     * - `change_contact` [成员通知事件](https://developer.work.weixin.qq.com/document/path/90639)、[部门通知事件](https://developer.work.weixin.qq.com/document/path/90640)、[标签通知事件](https://developer.work.weixin.qq.com/document/path/90641)
+     * - `share_agent_change` [共享应用事件回调](https://developer.work.weixin.qq.com/document/path/93373)
+     * - `reset_permanent_code` [重置永久授权码通知](https://developer.work.weixin.qq.com/document/path/94758)
+     * - `corp_arch_auth` [授权组织架构权限通知](https://developer.work.weixin.qq.com/document/path/97378)
+     */
+    InfoType?: string;
+    /**
+     * 消息类型
+     * - `event` 事件
+     */
+    MsgType?: string;
+    /**
+     * 事件类型
+     * - `change_app_admin` [应用管理员变更](https://developer.work.weixin.qq.com/document/path/95038)
+     * @scope MsgType='event'
+     */
+    Event?: string;
+    /**
+     * 第三方应用的SuiteId或者代开发应用模板id
+     */
+    SuiteId?: string;
+    /**
+     * 变更类型
+     *
+     * [成员通知事件](https://developer.work.weixin.qq.com/document/path/90639)：
+     * - `create_user` 新增成员
+     * - `update_user` 更新成员
+     * - `delete_user` 删除成员
+     *
+     * [部门通知事件](https://developer.work.weixin.qq.com/document/path/90640)：
+     * - `create_party` 新增部门
+     * - `update_party` 更新部门
+     * - `delete_party` 删除部门
+     *
+     * [标签通知事件](https://developer.work.weixin.qq.com/document/path/90641)：
+     * - `update_tag` 标签变更
+     *
+     * @scope InfoType='change_contact'
+     */
+    ChangeType?: string;
+    /**
+     * 授权企业的CorpID
+     * @scope InfoType='change_contact' | 'corp_arch_auth'
+     */
+    AuthCorpId?: string;
+    /**
+     * 企业应用的id
+     * @scope MsgType='text' | 'image' | 'voice' | 'video' | 'location' | 'link'
+     */
+    AgentID?: string;
+}
+export = Message;

package/dist/OpenWork/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/OpenWork/ProviderAccessToken.d.ts

@@ -0,0 +1,26 @@
+import CacheInterface from "../Core/Contracts/CacheInterface";
+import HttpClientInterface from "../Core/HttpClient/Contracts/HttpClientInterface";
+import RefreshableAccessTokenInterface from "../Core/Contracts/RefreshableAccessTokenInterface";
+declare class ProviderAccessToken implements RefreshableAccessTokenInterface {
+    protected corpId: string;
+    protected providerSecret: string;
+    protected key: string;
+    protected cache: CacheInterface;
+    protected httpClient: HttpClientInterface;
+    constructor(corpId: string, providerSecret: string, key?: string, cache?: CacheInterface, httpClient?: HttpClientInterface);
+    /**
+     * 获取access_token的缓存名称
+     * @returns
+     */
+    getKey(): string;
+    /**
+     * 设置access_token的缓存名称
+     * @param key
+     * @returns
+     */
+    setKey(key: string): this;
+    getToken(): Promise<string>;
+    toQuery(): Promise<Record<string, any>>;
+    refresh(): Promise<string>;
+}
+export = ProviderAccessToken;

package/dist/OpenWork/ProviderAccessToken.js

@@ -0,0 +1,84 @@
+'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 HttpClient_1 = __importDefault(require("../Core/HttpClient/HttpClient"));
+class ProviderAccessToken {
+    constructor(corpId, providerSecret, key = null, cache = null, httpClient = null) {
+        this.corpId = corpId;
+        this.providerSecret = providerSecret;
+        this.key = key;
+        this.cache = cache;
+        this.httpClient = httpClient;
+        if (!this.httpClient) {
+            this.httpClient = HttpClient_1.default.create({
+                baseURL: 'https://qyapi.weixin.qq.com/',
+            });
+        }
+    }
+    /**
+     * 获取access_token的缓存名称
+     * @returns
+     */
+    getKey() {
+        if (!this.key) {
+            this.key = `open_work.access_token.${this.corpId}`;
+        }
+        return this.key;
+    }
+    /**
+     * 设置access_token的缓存名称
+     * @param key
+     * @returns
+     */
+    setKey(key) {
+        this.key = key;
+        return this;
+    }
+    getToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let token = '';
+            if (this.cache) {
+                token = yield this.cache.get(this.getKey());
+            }
+            if (!!token && typeof token === 'string') {
+                return token;
+            }
+            return this.refresh();
+        });
+    }
+    toQuery() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                provider_access_token: yield this.getToken(),
+            };
+        });
+    }
+    refresh() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let response = (yield this.httpClient.request('post', 'cgi-bin/service/get_provider_token', {
+                json: {
+                    corpid: this.corpId,
+                    provider_secret: this.providerSecret,
+                }
+            })).toObject();
+            if (!response['provider_access_token']) {
+                throw new Error('Failed to get provider_access_token: ' + JSON.stringify(response));
+            }
+            if (this.cache) {
+                yield this.cache.set(this.getKey(), response['provider_access_token'], parseInt(response['expires_in']) - 100);
+            }
+            return response['provider_access_token'];
+        });
+    }
+}
+module.exports = ProviderAccessToken;