node-easywechat 3.1.4 → 3.3.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,21 @@
 # CHANGELOG
 
 
+## v3.3.0 (2023-03-22)
+
+- Feat: 新增企业微信开放平台模块
+
+- Fix: 完善企业微信开放平台的配置项
+- Fix: 将企业微信开放平台添加到全局入口
+- Fix: 调整配置项提示
+- Fix: 修复各模块服务端添加的处理方法无法正确提示的问题
+
+## 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/MiniApp/Application.d.ts

@@ -1,5 +1,4 @@
 import ConfigInterface from '../Core/Contracts/ConfigInterface';
-import ServerInterface from '../Core/Contracts/ServerInterface';
 import Encryptor from '../Core/Encryptor';
 import AccessTokenAwareClient from '../Core/HttpClient/AccessTokenAwareClient';
 import CacheMixin from '../Core/Mixins/CacheMixin';
@@ -10,6 +9,7 @@ import ServerRequestMixin from '../Core/Mixins/ServerRequestMixin';
 import { MiniAppConfig } from '../Types/global';
 import AccountInterface from './Contracts/AccountInterface';
 import ApplicationInterface from './Contracts/ApplicationInterface';
+import Server from './Server';
 import Utils from './Utils';
 import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
 /**
@@ -19,7 +19,7 @@ declare class Application implements ApplicationInterface {
     constructor(config: ConfigInterface | MiniAppConfig);
     protected account: AccountInterface;
     protected encryptor: Encryptor;
-    protected server: ServerInterface;
+    protected server: Server;
     protected accessToken: AccessTokenInterface;
     getAccount(): AccountInterface;
     /**
@@ -35,13 +35,13 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     setEncryptor(encryptor: Encryptor): this;
-    getServer(): ServerInterface;
+    getServer(): Server;
     /**
      * 设置服务端实例
      * @param server
      * @returns
      */
-    setServer(server: ServerInterface): this;
+    setServer(server: Server): this;
     getAccessToken(): AccessTokenInterface;
     /**
      * 设置AccessToken实例

package/dist/OfficialAccount/Application.d.ts

@@ -1,6 +1,5 @@
 import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
 import ConfigInterface from '../Core/Contracts/ConfigInterface';
-import ServerInterface from '../Core/Contracts/ServerInterface';
 import Encryptor from '../Core/Encryptor';
 import AccessTokenAwareClient from '../Core/HttpClient/AccessTokenAwareClient';
 import CacheMixin from '../Core/Mixins/CacheMixin';
@@ -12,6 +11,7 @@ import { OfficialAccountConfig, OfficialAccountOAuthFactory } from '../Types/glo
 import AccountInterface from './Contracts/AccountInterface';
 import ApplicationInterface from './Contracts/ApplicationInterface';
 import JsApiTicket from './JsApiTicket';
+import Server from './Server';
 import Utils from './Utils';
 import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
 /**
@@ -21,7 +21,7 @@ declare class Application implements ApplicationInterface {
     constructor(config: ConfigInterface | OfficialAccountConfig);
     protected account: AccountInterface;
     protected encryptor: Encryptor;
-    protected server: ServerInterface;
+    protected server: Server;
     protected accessToken: AccessTokenInterface;
     protected oauthFactory: OfficialAccountOAuthFactory;
     protected ticket: JsApiTicket;
@@ -39,13 +39,13 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     setEncryptor(encryptor: Encryptor): this;
-    getServer(): ServerInterface;
+    getServer(): Server;
     /**
      * 设置服务端实例
      * @param server
      * @returns
      */
-    setServer(server: ServerInterface): this;
+    setServer(server: Server): this;
     getAccessToken(): AccessTokenInterface;
     /**
      * 设置AccessToken实例

package/dist/OpenPlatform/Application.d.ts

@@ -1,6 +1,5 @@
 import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
 import ConfigInterface from '../Core/Contracts/ConfigInterface';
-import ServerInterface from '../Core/Contracts/ServerInterface';
 import Encryptor from '../Core/Encryptor';
 import AccessTokenAwareClient from '../Core/HttpClient/AccessTokenAwareClient';
 import CacheMixin from '../Core/Mixins/CacheMixin';
@@ -13,18 +12,19 @@ import MiniAppApplication from '../MiniApp/Application';
 import { OfficialAccountConfig, OfficialAccountOAuthFactory, MiniAppConfig } from '../Types/global';
 import AccountInterface from './Contracts/AccountInterface';
 import ApplicationInterface from './Contracts/ApplicationInterface';
+import Server from './Server';
 import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
 import VerifyTicketInterface from './Contracts/VerifyTicketInterface';
 import Authorization from './Authorization';
 import AuthorizerAccessToken from './AuthorizerAccessToken';
 /**
- * 公众号应用
+ * 开放平台应用
  */
 declare class Application implements ApplicationInterface {
     constructor(config: ConfigInterface | OfficialAccountConfig);
     protected account: AccountInterface;
     protected encryptor: Encryptor;
-    protected server: ServerInterface;
+    protected server: Server;
     protected componentAccessToken: AccessTokenInterface;
     protected verifyTicket: VerifyTicketInterface;
     getAccount(): AccountInterface;
@@ -43,13 +43,13 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     setEncryptor(encryptor: Encryptor): this;
-    getServer(): ServerInterface;
+    getServer(): Server;
     /**
      * 设置服务端实例
      * @param server
      * @returns
      */
-    setServer(server: ServerInterface): this;
+    setServer(server: Server): this;
     getAccessToken(): AccessTokenInterface;
     getComponentAccessToken(): AccessTokenInterface;
     /**

package/dist/OpenPlatform/Application.js

@@ -33,7 +33,7 @@ const ComponentAccessToken_1 = __importDefault(require("./ComponentAccessToken")
 const Authorization_1 = __importDefault(require("./Authorization"));
 const AuthorizerAccessToken_1 = __importDefault(require("./AuthorizerAccessToken"));
 /**
- * 公众号应用
+ * 开放平台应用
  */
 class Application {
     constructor(config) {

package/dist/OpenWork/Account.d.ts

@@ -0,0 +1,17 @@
+import AccountInterface from "./Contracts/AccountInterface";
+declare class Account implements AccountInterface {
+    protected corpId: string;
+    protected providerSecret: string;
+    protected suiteId: string;
+    protected suiteSecret: string;
+    protected token: string;
+    protected aesKey: string;
+    constructor(corpId: string, providerSecret: string, suiteId: string, suiteSecret: string, token?: string, aesKey?: string);
+    getCorpId(): string;
+    getProviderSecret(): string;
+    getSuiteId(): string;
+    getSuiteSecret(): string;
+    getToken(): string;
+    getAesKey(): string;
+}
+export = Account;

package/dist/OpenWork/Account.js

@@ -0,0 +1,30 @@
+'use strict';
+class Account {
+    constructor(corpId, providerSecret, suiteId, suiteSecret, token = null, aesKey = null) {
+        this.corpId = corpId;
+        this.providerSecret = providerSecret;
+        this.suiteId = suiteId;
+        this.suiteSecret = suiteSecret;
+        this.token = token;
+        this.aesKey = aesKey;
+    }
+    getCorpId() {
+        return this.corpId;
+    }
+    getProviderSecret() {
+        return this.providerSecret;
+    }
+    getSuiteId() {
+        return this.suiteId;
+    }
+    getSuiteSecret() {
+        return this.suiteSecret;
+    }
+    getToken() {
+        return this.token;
+    }
+    getAesKey() {
+        return this.aesKey;
+    }
+}
+module.exports = Account;

package/dist/OpenWork/Application.d.ts

@@ -0,0 +1,120 @@
+import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
+import ConfigInterface from '../Core/Contracts/ConfigInterface';
+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 { OpenWorkConfig } from '../Types/global';
+import AccountInterface from './Contracts/AccountInterface';
+import ApplicationInterface from './Contracts/ApplicationInterface';
+import Server from './Server';
+import SuiteTicketInterface from './Contracts/SuiteTicketInterface';
+import SuiteEncryptor from './SuiteEncryptor';
+import SuiteAccessToken from './SuiteAccessToken';
+import Authorization from './Authorization';
+import AuthorizerAccessToken from './AuthorizerAccessToken';
+import ProviderAccessToken from './ProviderAccessToken';
+import JsApiTicket from './JsApiTicket';
+/**
+ * 企业微信开放平台应用
+ */
+declare class Application implements ApplicationInterface {
+    constructor(config: ConfigInterface | OpenWorkConfig);
+    protected account: AccountInterface;
+    protected encryptor: Encryptor;
+    protected server: Server;
+    protected accessToken: ProviderAccessToken;
+    protected suiteEncryptor: SuiteEncryptor;
+    protected suiteAccessToken: SuiteAccessToken;
+    protected suiteTicket: SuiteTicketInterface;
+    protected authorizerAccessToken: AuthorizerAccessToken;
+    getAccount(): AccountInterface;
+    /**
+     * 设置当前账户实例
+     * @param account
+     * @returns
+     */
+    setAccount(account: AccountInterface): this;
+    getEncryptor(): Encryptor;
+    /**
+     * 设置加密机实例
+     * @param encryptor
+     * @returns
+     */
+    setEncryptor(encryptor: Encryptor): this;
+    getSuiteEncryptor(): SuiteEncryptor;
+    /**
+     * 设置授权应用的加密机实例
+     * @param suiteEncryptor
+     * @returns
+     */
+    setSuiteEncryptor(suiteEncryptor: SuiteEncryptor): this;
+    getServer(): Server;
+    /**
+     * 设置服务端实例
+     * @param server
+     * @returns
+     */
+    setServer(server: Server): this;
+    getProviderAccessToken(): ProviderAccessToken;
+    /**
+     * 设置开放平台应用的AccessToken实例
+     * @param accessToken
+     * @returns
+     */
+    setProviderAccessToken(accessToken: ProviderAccessToken): this;
+    getSuiteAccessToken(): SuiteAccessToken;
+    /**
+     * 设置授权应用的AccessToken实例
+     * @param suiteAccessToken
+     * @returns
+     */
+    setSuiteAccessToken(suiteAccessToken: SuiteAccessToken): this;
+    getSuiteTicket(): SuiteTicketInterface;
+    /**
+     * 设置授权应用的Ticket实例
+     * @param suiteTicket
+     * @returns
+     */
+    setSuiteTicket(suiteTicket: SuiteTicketInterface): this;
+    /**
+     * 获取企业授权信息
+     * @see https://developer.work.weixin.qq.com/document/10975#获取企业授权信息
+     * @param corpId 授权方corpid
+     * @param permanentCode 永久授权码，通过get_permanent_code获取
+     * @param suiteAccessToken
+     * @returns
+     */
+    getAuthorization(corpId: string, permanentCode: string, suiteAccessToken?: SuiteAccessToken): Promise<Authorization>;
+    /**
+     * 获取预授权码
+     * @see https://developer.work.weixin.qq.com/document/10975#获取预授权码
+     * @param suiteAccessToken
+     * @returns
+     */
+    createPreAuthorizationCode(suiteAccessToken?: SuiteAccessToken): Promise<import("../Types/global").WeixinResponse>;
+    /**
+     * 获取企业授权令牌
+     * @param corpId
+     * @param permanentCode
+     * @param suiteAccessToken
+     * @returns
+     */
+    getAuthorizerAccessToken(corpId: string, permanentCode: string, suiteAccessToken?: SuiteAccessToken): Promise<AuthorizerAccessToken>;
+    createClient(): AccessTokenAwareClient;
+    getAuthorizerClient(corpId: string, permanentCode: string, suiteAccessToken?: SuiteAccessToken): Promise<AccessTokenAwareClient>;
+    getJsApiTicket(corpId: string, permanentCode: string, suiteAccessToken?: SuiteAccessToken): Promise<JsApiTicket>;
+    getOAuth(suiteId: string, suiteAccessToken?: SuiteAccessToken): Promise<ProviderInterface>;
+    getCorpOAuth(corpId: string, suiteAccessToken?: SuiteAccessToken): Promise<ProviderInterface>;
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    protected getHttpClientDefaultOptions(): Record<string, any>;
+}
+interface Application extends ConfigMixin, CacheMixin, ClientMixin, ServerRequestMixin, HttpClientMixin {
+}
+export = Application;