node-easywechat 3.1.3 → 3.2.0

package/.github/workflows/build-2.yml

@@ -0,0 +1,21 @@
+# 2.x 所有提交自动构建并测试
+
+name: Build 2.x
+
+on:
+  push:
+    branches:
+      - '2.x'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm install
+      - run: npm run build
+      - run: npm test
+

package/.github/workflows/build-3.yml

@@ -0,0 +1,21 @@
+# 3.x 所有提交自动构建并测试
+
+name: Build 3.x
+
+on:
+  push:
+    branches:
+      - '3.x'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm install
+      - run: npm run build
+      - run: npm test
+

package/.github/workflows/publish-npm-2.yml

@@ -0,0 +1,24 @@
+# 构建、测试并发布2.x分支
+
+name: Publish 2.x to npm
+
+on:
+  push:
+    tags:
+      - v2.*
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+      - run: npm run build
+      - run: npm test
+      - run: npm publish --tag latest
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/.github/workflows/publish-npm-3.yml

@@ -0,0 +1,24 @@
+# 构建、测试并发布3.x分支
+
+name: Publish 3.x to npm
+
+on:
+  push:
+    tags:
+      - v3.*
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - run: npm install
+      - run: npm run build
+      - run: npm test
+      - run: npm publish --tag next
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}

package/CHANGELOG.md

@@ -1,6 +1,12 @@
 # CHANGELOG
 
 
+## v3.2.0 (2023-03-10)
+
+- Feat: 新增企业微信模块
+
+## v3.1.4 (2023-02-02)
+
 ## v3.1.3 (2023-02-01)
 
 - Fix: 修复默认的文件缓存配置项不生效问题 (#35)

package/README.md

@@ -1,7 +1,7 @@
 
 ## EasyWechat for Node.js
 
-[![Build Status](https://app.travis-ci.com/hpyer/node-easywechat.svg?branch=3.x)](https://app.travis-ci.com/hpyer/node-easywechat) [![npm](https://img.shields.io/npm/v/node-easywechat.svg)](https://www.npmjs.com/package/node-easywechat) [![License](https://img.shields.io/npm/l/node-easywechat.svg)](LICENSE)
+![Build 3.x](https://github.com/hpyer/node-easywechat/actions/workflows/build-3.yml/badge.svg) [![npm](https://img.shields.io/npm/v/node-easywechat.svg)](https://www.npmjs.com/package/node-easywechat) [![License](https://img.shields.io/npm/l/node-easywechat.svg)](LICENSE)
 
 **注：3.x分支针对 EasyWechat 的 6.x版本。**
 
@@ -53,6 +53,13 @@ let app = new OpenPlatform({
   // 配置项
 });
 
+// 企业微信
+const { Work } = require('node-easywechat');
+// 实例化应用
+let app = new Work({
+  // 配置项
+});
+
 // ----- 以下为通用的 api 调用方法 -----
 
 // 获取 api 调用客户端
@@ -165,6 +172,20 @@ let data = response.toObject();
 }
 ```
 
+``` js
+// 企业微信配置
+{
+  // 企业微信的 corp id
+  corp_id: '',
+  // 企业微信的 secret
+  secret: '',
+  // 企业微信的 token
+  token: '',
+  // EncodingAESKey
+  aes_key: '',
+}
+```
+
 ### 自定义模块（模块替换）使用方法
 
 #### 日志模块
@@ -279,6 +300,6 @@ app.setRequest(request);
 - [x] 微信支付
 - [x] 小程序
 - [x] 开放平台
-- [ ] 企业微信
+- [x] 企业微信
 - [ ] 企业微信开放平台
 - [ ] 自定义

package/dist/Types/global.d.ts

@@ -1,6 +1,7 @@
 import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
 import OfficialAccountApplicationInterface from '../OfficialAccount/Contracts/ApplicationInterface';
+import WorkApplicationInterface from '../Work/Contracts/ApplicationInterface';
 import Message from '../Core/Message';
 import HttpClientResponseInterface from '../Core/HttpClient/Contracts/HttpClientResponseInterface';
 import { PublicKey } from "../Core/Support/PublicKey";
@@ -294,6 +295,13 @@ export declare interface OpenWorkConfig extends BaseConfig {
  */
 export declare type OfficialAccountOAuthFactory = (app: OfficialAccountApplicationInterface) => ProviderInterface;
 
+/**
+ * 企业微信OAuth工厂方法
+ * @param app 企业微信应用实例
+ * @returns OAuth服务供应商实例
+ */
+export declare type WorkOAuthFactory = (app: WorkApplicationInterface) => ProviderInterface;
+
 /**
  * 服务端通知处理项
  */

package/dist/Work/AccessToken.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 AccessToken implements RefreshableAccessTokenInterface {
+    protected corpId: string;
+    protected secret: string;
+    protected key: string;
+    protected cache: CacheInterface;
+    protected httpClient: HttpClientInterface;
+    constructor(corpId: string, secret: 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 = AccessToken;

package/dist/Work/AccessToken.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 AccessToken {
+    constructor(corpId, secret, key = null, cache = null, httpClient = null) {
+        this.corpId = corpId;
+        this.secret = secret;
+        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 = `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 {
+                access_token: yield this.getToken(),
+            };
+        });
+    }
+    refresh() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let response = (yield this.httpClient.request('get', 'cgi-bin/gettoken', {
+                params: {
+                    corpid: this.corpId,
+                    corpsecret: this.secret,
+                }
+            })).toObject();
+            if (!response['access_token']) {
+                throw new Error('Failed to get access_token: ' + JSON.stringify(response));
+            }
+            if (this.cache) {
+                yield this.cache.set(this.getKey(), response['access_token'], parseInt(response['expires_in']));
+            }
+            return response['access_token'];
+        });
+    }
+}
+module.exports = AccessToken;

package/dist/Work/Account.d.ts

@@ -0,0 +1,13 @@
+import AccountInterface from "./Contracts/AccountInterface";
+declare class Account implements AccountInterface {
+    protected corpId: string;
+    protected secret: string;
+    protected token: string;
+    protected aesKey: string;
+    constructor(corpId: string, secret: string, token?: string, aesKey?: string);
+    getCorpId(): string;
+    getSecret(): string;
+    getToken(): string;
+    getAesKey(): string;
+}
+export = Account;

package/dist/Work/Account.js

@@ -0,0 +1,25 @@
+'use strict';
+class Account {
+    constructor(corpId, secret, token = null, aesKey = null) {
+        this.corpId = corpId;
+        this.secret = secret;
+        this.token = token;
+        this.aesKey = aesKey;
+    }
+    getCorpId() {
+        return this.corpId;
+    }
+    getSecret() {
+        if (null === this.secret) {
+            throw new Error("No secret configured.");
+        }
+        return this.secret;
+    }
+    getToken() {
+        return this.token;
+    }
+    getAesKey() {
+        return this.aesKey;
+    }
+}
+module.exports = Account;

package/dist/Work/Application.d.ts

@@ -0,0 +1,75 @@
+import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
+import ConfigInterface from '../Core/Contracts/ConfigInterface';
+import ServerInterface from '../Core/Contracts/ServerInterface';
+import Encryptor from './Encryptor';
+import AccessTokenAwareClient from '../Core/HttpClient/AccessTokenAwareClient';
+import CacheMixin from '../Core/Mixins/CacheMixin';
+import ClientMixin from '../Core/Mixins/ClientMixin';
+import ConfigMixin from '../Core/Mixins/ConfigMixin';
+import HttpClientMixin from '../Core/Mixins/HttpClientMixin';
+import ServerRequestMixin from '../Core/Mixins/ServerRequestMixin';
+import { WorkConfig, WorkOAuthFactory } from '../Types/global';
+import AccountInterface from './Contracts/AccountInterface';
+import ApplicationInterface from './Contracts/ApplicationInterface';
+import JsApiTicket from './JsApiTicket';
+import Utils from './Utils';
+import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
+/**
+ * 公众号应用
+ */
+declare class Application implements ApplicationInterface {
+    constructor(config: ConfigInterface | WorkConfig);
+    protected account: AccountInterface;
+    protected encryptor: Encryptor;
+    protected server: ServerInterface;
+    protected accessToken: AccessTokenInterface;
+    protected oauthFactory: WorkOAuthFactory;
+    protected ticket: JsApiTicket;
+    getAccount(): AccountInterface;
+    /**
+     * 设置当前账户实例
+     * @param account
+     * @returns
+     */
+    setAccount(account: AccountInterface): this;
+    getEncryptor(): Encryptor;
+    /**
+     * 设置加密机实例
+     * @param encryptor
+     * @returns
+     */
+    setEncryptor(encryptor: Encryptor): this;
+    getServer(): ServerInterface;
+    /**
+     * 设置服务端实例
+     * @param server
+     * @returns
+     */
+    setServer(server: ServerInterface): this;
+    getAccessToken(): AccessTokenInterface;
+    /**
+     * 设置AccessToken实例
+     * @param accessToken
+     * @returns
+     */
+    setAccessToken(accessToken: AccessTokenInterface): this;
+    setOAuthFactory(oauthFactory: WorkOAuthFactory): this;
+    getOAuth(): Promise<ProviderInterface>;
+    getTicket(): JsApiTicket;
+    /**
+     * 设置JsApiTicket实例
+     * @param ticket
+     * @returns
+     */
+    setTicket(ticket: JsApiTicket): this;
+    getUtils(): Utils;
+    createClient(): AccessTokenAwareClient;
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    protected getHttpClientDefaultOptions(): Record<string, any>;
+}
+interface Application extends ConfigMixin, CacheMixin, ClientMixin, ServerRequestMixin, HttpClientMixin {
+}
+export = Application;

package/dist/Work/Application.js

@@ -0,0 +1,177 @@
+'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 merge_1 = __importDefault(require("merge"));
+const WeWork_1 = __importDefault(require("node-socialite/dist/Providers/WeWork"));
+const Config_1 = __importDefault(require("./Config"));
+const ConfigInterface_1 = __importDefault(require("../Core/Contracts/ConfigInterface"));
+const Encryptor_1 = __importDefault(require("./Encryptor"));
+const AccessTokenAwareClient_1 = __importDefault(require("../Core/HttpClient/AccessTokenAwareClient"));
+const CacheMixin_1 = __importDefault(require("../Core/Mixins/CacheMixin"));
+const ClientMixin_1 = __importDefault(require("../Core/Mixins/ClientMixin"));
+const ConfigMixin_1 = __importDefault(require("../Core/Mixins/ConfigMixin"));
+const HttpClientMixin_1 = __importDefault(require("../Core/Mixins/HttpClientMixin"));
+const ServerRequestMixin_1 = __importDefault(require("../Core/Mixins/ServerRequestMixin"));
+const Utils_1 = require("../Core/Support/Utils");
+const AccessToken_1 = __importDefault(require("./AccessToken"));
+const Account_1 = __importDefault(require("./Account"));
+const JsApiTicket_1 = __importDefault(require("./JsApiTicket"));
+const Server_1 = __importDefault(require("./Server"));
+const Utils_2 = __importDefault(require("./Utils"));
+/**
+ * 公众号应用
+ */
+class Application {
+    constructor(config) {
+        this.account = null;
+        this.encryptor = null;
+        this.server = null;
+        this.accessToken = null;
+        this.oauthFactory = null;
+        this.ticket = null;
+        if (config instanceof ConfigInterface_1.default) {
+            this.setConfig(config);
+        }
+        else {
+            this.setConfig(new Config_1.default(config));
+        }
+    }
+    getAccount() {
+        if (!this.account) {
+            this.account = new Account_1.default(this.config.get('corp_id'), this.config.get('secret'), this.config.get('token'), this.config.get('aes_key'));
+        }
+        return this.account;
+    }
+    /**
+     * 设置当前账户实例
+     * @param account
+     * @returns
+     */
+    setAccount(account) {
+        this.account = account;
+        return this;
+    }
+    getEncryptor() {
+        if (!this.encryptor) {
+            let token = this.getAccount().getToken();
+            let aesKey = this.getAccount().getAesKey();
+            if (!token || !aesKey) {
+                throw new Error('token or aes_key cannot be empty.');
+            }
+            this.encryptor = new Encryptor_1.default(this.getAccount().getCorpId(), token, aesKey);
+        }
+        return this.encryptor;
+    }
+    /**
+     * 设置加密机实例
+     * @param encryptor
+     * @returns
+     */
+    setEncryptor(encryptor) {
+        this.encryptor = encryptor;
+        return this;
+    }
+    getServer() {
+        if (!this.server) {
+            this.server = new Server_1.default(this.getEncryptor(), this.getRequest());
+        }
+        return this.server;
+    }
+    /**
+     * 设置服务端实例
+     * @param server
+     * @returns
+     */
+    setServer(server) {
+        this.server = server;
+        return this;
+    }
+    getAccessToken() {
+        if (!this.accessToken) {
+            this.accessToken = new AccessToken_1.default(this.getAccount().getCorpId(), this.getAccount().getSecret(), null, this.getCache(), this.getHttpClient());
+        }
+        return this.accessToken;
+    }
+    /**
+     * 设置AccessToken实例
+     * @param accessToken
+     * @returns
+     */
+    setAccessToken(accessToken) {
+        this.accessToken = accessToken;
+        return this;
+    }
+    setOAuthFactory(oauthFactory) {
+        this.oauthFactory = oauthFactory;
+        return this;
+    }
+    getOAuth() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.oauthFactory) {
+                this.oauthFactory = ((app) => {
+                    return new WeWork_1.default({
+                        client_id: app.getAccount().getCorpId(),
+                        client_secret: app.getAccount().getSecret(),
+                        redirect: app.getConfig().get('oauth.redirect_url'),
+                    });
+                });
+            }
+            let provider = this.oauthFactory.call(null, this);
+            if (!(provider instanceof WeWork_1.default)) {
+                throw new Error(`The factory must return a \`ProviderInterface\` instance.`);
+            }
+            provider.withApiAccessToken(yield this.getAccessToken().getToken());
+            provider.scopes(this.getConfig().get('oauth.scopes', 'snsapi_userinfo'));
+            let agent_id = parseInt(this.config.get('agent_id')) || null;
+            if (agent_id) {
+                provider.setAgentId(agent_id);
+            }
+            return provider;
+        });
+    }
+    getTicket() {
+        if (!this.ticket) {
+            this.ticket = new JsApiTicket_1.default(this.getAccount().getCorpId(), this.getAccount().getSecret(), null, this.getCache(), this.getClient());
+        }
+        return this.ticket;
+    }
+    /**
+     * 设置JsApiTicket实例
+     * @param ticket
+     * @returns
+     */
+    setTicket(ticket) {
+        this.ticket = ticket;
+        return this;
+    }
+    getUtils() {
+        return new Utils_2.default(this);
+    }
+    createClient() {
+        return (new AccessTokenAwareClient_1.default(this.getHttpClient(), this.getAccessToken(), (response) => { var _a; return (_a = response.toObject()['errcode']) !== null && _a !== void 0 ? _a : 0; }, this.getConfig().get('http.throw', true)))
+            .setPresets(this.getConfig().all());
+    }
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    getHttpClientDefaultOptions() {
+        return (0, merge_1.default)(true, {
+            baseURL: 'https://qyapi.weixin.qq.com/',
+        }, this.getConfig().get('http'));
+    }
+}
+;
+;
+(0, Utils_1.applyMixins)(Application, [ConfigMixin_1.default, CacheMixin_1.default, ClientMixin_1.default, ServerRequestMixin_1.default, HttpClientMixin_1.default]);
+module.exports = Application;

package/dist/Work/Config.d.ts

@@ -0,0 +1,5 @@
+import BaseConfig from '../Core/Config';
+declare class Config extends BaseConfig {
+    protected requiredKeys: string[];
+}
+export = Config;

package/dist/Work/Config.js

@@ -0,0 +1,17 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Config_1 = __importDefault(require("../Core/Config"));
+class Config extends Config_1.default {
+    constructor() {
+        super(...arguments);
+        this.requiredKeys = [
+            'corp_id',
+            'secret',
+            'token',
+            'aes_key',
+        ];
+    }
+}
+module.exports = Config;

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

@@ -0,0 +1,23 @@
+declare abstract class AccountInterface {
+    /**
+     * 获取corpid
+     * @returns
+     */
+    getCorpId(): string;
+    /**
+     * 获取secret
+     * @returns
+     */
+    getSecret(): string;
+    /**
+     * 获取token
+     * @returns
+     */
+    getToken(): string;
+    /**
+     * 获取aesKey
+     * @returns
+     */
+    getAesKey(): string;
+}
+export = AccountInterface;

package/dist/Work/Contracts/AccountInterface.js

@@ -0,0 +1,25 @@
+'use strict';
+class AccountInterface {
+    /**
+     * 获取corpid
+     * @returns
+     */
+    getCorpId() { return null; }
+    /**
+     * 获取secret
+     * @returns
+     */
+    getSecret() { return null; }
+    /**
+     * 获取token
+     * @returns
+     */
+    getToken() { return null; }
+    /**
+     * 获取aesKey
+     * @returns
+     */
+    getAesKey() { return null; }
+}
+;
+module.exports = AccountInterface;