node-easywechat 3.6.3 → 3.7.0

package/CHANGELOG.md

@@ -1,6 +1,13 @@
 # CHANGELOG
 
 
+## v3.7.0 (2024-05-16)
+
+- Feat: 增加视频号模块
+- Feat: 服务端消息处理，增加JSON格式支持
+
+- Fix: typo
+
 ## v3.6.3 (2024-05-08)
 
 - Fix: 修复微信支付(v3)时签名错误的问题 (#76)

package/README.md

@@ -67,6 +67,13 @@ let app = new OpenWork({
   // 配置项
 });
 
+// 视频号
+const { Channel } = require('node-easywechat');
+// 实例化应用
+let app = new Channel({
+  // 配置项
+});
+
 // ----- 定义配置项（v3.5.0+） -----
 
 // 这种方式可以让你在需要单独设置配置项时，也能获得编辑器的代码提示
@@ -80,6 +87,7 @@ const config = defineOfficialAccountConfig({
 // 开放平台: defineOpenPlatformConfig()
 // 企业微信: defineWorkConfig()
 // 企业微信开放平台: defineOpenWorkConfig()
+// 视频号: defineChannelConfig()
 
 // ----- 以下为通用的 api 调用方法 -----
 
@@ -229,6 +237,22 @@ let data = response.toObject();
 }
 ```
 
+``` js
+// 视频号配置
+{
+  // 视频号的 app key
+  app_id: '',
+  // 视频号的 app secret
+  secret: '',
+  // 视频号的 token
+  token: '',
+  // EncodingAESKey
+  aes_key: '',
+  // 是否使用稳定版接口调用凭据，默认：false
+  use_stable_access_token: false
+}
+```
+
 ### 自定义模块（模块替换）使用方法
 
 #### 日志模块
@@ -345,4 +369,5 @@ app.setRequest(request);
 - [x] 开放平台
 - [x] 企业微信
 - [x] 企业微信开放平台
+- [x] 视频号
 - [x] 自定义

package/dist/Channel/AccessToken.d.ts

@@ -0,0 +1,8 @@
+import BaseAccessToken from "../OfficialAccount/AccessToken";
+declare class AccessToken extends BaseAccessToken {
+    /**
+     * 缓存前缀
+     */
+    protected CACHE_KEY_PREFIX: string;
+}
+export = AccessToken;

package/dist/Channel/AccessToken.js

@@ -0,0 +1,15 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const AccessToken_1 = __importDefault(require("../OfficialAccount/AccessToken"));
+class AccessToken extends AccessToken_1.default {
+    constructor() {
+        super(...arguments);
+        /**
+         * 缓存前缀
+         */
+        this.CACHE_KEY_PREFIX = 'channel';
+    }
+}
+module.exports = AccessToken;

package/dist/Channel/Account.d.ts

@@ -0,0 +1,4 @@
+import BaseAccount from "../OfficialAccount/Account";
+declare class Account extends BaseAccount {
+}
+export = Account;

package/dist/Channel/Account.js

@@ -0,0 +1,8 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Account_1 = __importDefault(require("../OfficialAccount/Account"));
+class Account extends Account_1.default {
+}
+module.exports = Account;

package/dist/Channel/Application.d.ts

@@ -0,0 +1,60 @@
+import ConfigInterface from '../Core/Contracts/ConfigInterface';
+import Encryptor from '../Core/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 { ChannelConfig } from '../Types/global';
+import AccountInterface from './Contracts/AccountInterface';
+import ApplicationInterface from './Contracts/ApplicationInterface';
+import Server from './Server';
+import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
+/**
+ * 视频号应用
+ */
+declare class Application implements ApplicationInterface {
+    constructor(config: ConfigInterface | ChannelConfig);
+    protected account: AccountInterface;
+    protected encryptor: Encryptor;
+    protected server: Server;
+    protected accessToken: AccessTokenInterface;
+    getAccount(): AccountInterface;
+    /**
+     * 设置当前账户实例
+     * @param account
+     * @returns
+     */
+    setAccount(account: AccountInterface): this;
+    getEncryptor(): Encryptor;
+    /**
+     * 设置加密机实例
+     * @param encryptor
+     * @returns
+     */
+    setEncryptor(encryptor: Encryptor): this;
+    getServer(): Server;
+    /**
+     * 设置服务端实例
+     * @param server
+     * @returns
+     */
+    setServer(server: Server): this;
+    getAccessToken(): AccessTokenInterface;
+    /**
+     * 设置AccessToken实例
+     * @param accessToken
+     * @returns
+     */
+    setAccessToken(accessToken: AccessTokenInterface): this;
+    createClient(): AccessTokenAwareClient;
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    protected getHttpClientDefaultOptions(): Record<string, any>;
+}
+interface Application extends ConfigMixin, CacheMixin, ClientMixin, ServerRequestMixin, HttpClientMixin {
+}
+export = Application;

package/dist/Channel/Application.js

@@ -0,0 +1,125 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const merge_1 = __importDefault(require("merge"));
+const ConfigInterface_1 = __importDefault(require("../Core/Contracts/ConfigInterface"));
+const Encryptor_1 = __importDefault(require("../Core/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 Server_1 = __importDefault(require("./Server"));
+const Config_1 = __importDefault(require("../OfficialAccount/Config"));
+/**
+ * 视频号应用
+ */
+class Application {
+    constructor(config) {
+        this.account = null;
+        this.encryptor = null;
+        this.server = null;
+        this.accessToken = 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('app_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().getAppId(), token, aesKey, this.getAccount().getAppId());
+        }
+        return this.encryptor;
+    }
+    /**
+     * 设置加密机实例
+     * @param encryptor
+     * @returns
+     */
+    setEncryptor(encryptor) {
+        this.encryptor = encryptor;
+        return this;
+    }
+    getServer() {
+        if (!this.server) {
+            let token = this.getAccount().getToken();
+            let aesKey = this.getAccount().getAesKey();
+            if (!token || !aesKey) {
+                throw new Error('token or aes_key cannot be empty.');
+            }
+            this.server = new Server_1.default(this.getRequest(), this.getAccount().getAesKey() ? this.getEncryptor() : null);
+        }
+        else {
+            this.server.setRequest(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().getAppId(), this.getAccount().getSecret(), null, this.getCache(), this.getHttpClient(), this.config.get('use_stable_access_token', false));
+        }
+        return this.accessToken;
+    }
+    /**
+     * 设置AccessToken实例
+     * @param accessToken
+     * @returns
+     */
+    setAccessToken(accessToken) {
+        this.accessToken = accessToken;
+        return 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) || (response.toObject()['error'] !== null && response.toObject()['error'] !== undefined); }, this.getConfig().get('http.throw', true)))
+            .setPresets(this.getConfig().all());
+    }
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    getHttpClientDefaultOptions() {
+        return (0, merge_1.default)(true, {
+            baseURL: 'https://api.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/Channel/Contracts/AccountInterface.d.ts

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

package/dist/Channel/Contracts/AccountInterface.js

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

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

@@ -0,0 +1,62 @@
+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 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;
+}
+export = ApplicationInterface;

package/dist/Channel/Contracts/ApplicationInterface.js

@@ -0,0 +1,55 @@
+'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; }
+}
+;
+module.exports = ApplicationInterface;