node-easywechat 3.0.0 → 3.1.0

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # CHANGELOG
 
 
+## v3.1.0 (2022-11-09)
+
+- Feat: 新增开放平台模块
+
+- Fix: 修复获取配置项异常的问题
+- Fix: 修复配置项类型判断异常的问题
+- Fix: 修复请求客户端无法设置请求是否错误判断逻辑的方法
+
+- Perf: 优化url路径解析方法
+
+## v3.0.1 (2022-08-26)
+
+- Fix: 修复with方法无效的问题
+
 ## v3.0.0 (2022-07-28)
 
 - Feat: 请求后自动解析响应结果，简化获取数据的方式
@@ -17,6 +31,7 @@
 - Fix: 调整默认Message提示的作用域为公众号和小程序
 - Fix: 修复AccessToken对象声明错误的问题
 
+- Docs: 更新client调用方法说明
 - Docs: 增加微信支付相关说明文档
 
 ## v3.0.0-beta.5 (2022-06-29)

package/README.md

@@ -44,6 +44,13 @@ let app = new Pay({
   // 配置项
 });
 
+// 开放平台
+const { OpenPlatform } = require('node-easywechat');
+// 实例化应用
+let app = new OpenPlatform({
+  // 配置项
+});
+
 // ----- 以下为通用的 api 调用方法 -----
 
 // 获取 api 调用客户端
@@ -138,6 +145,20 @@ let data = response.toObject();
 }
 ```
 
+``` js
+// 开放平台配置
+{
+  // 开放平台的 app key
+  app_id: '',
+  // 开放平台的 app secret
+  secret: '',
+  // 开放平台的 token
+  token: '',
+  // EncodingAESKey
+  aes_key: '',
+}
+```
+
 ### 自定义模块（模块替换）使用方法
 
 #### 日志模块
@@ -251,7 +272,7 @@ app.setRequest(request);
 - [x] 公众号模块
 - [x] 微信支付
 - [x] 小程序
-- [ ] 开放平台
+- [x] 开放平台
 - [ ] 企业微信
 - [ ] 企业微信开放平台
 - [ ] 自定义

package/dist/Core/Config.d.ts

@@ -1,6 +1,6 @@
 import { OfficialAccountConfig, MiniAppConfig, PayConfig, OpenPlatformConfig, WorkConfig, OpenWorkConfig } from "../Types/global";
 import ConfigInterface from "./Contracts/ConfigInterface";
-declare class Config implements ConfigInterface {
+declare class Config extends ConfigInterface {
     protected items: OfficialAccountConfig | MiniAppConfig | PayConfig | OpenPlatformConfig | WorkConfig | OpenWorkConfig;
     protected requiredKeys: string[];
     constructor(items?: OfficialAccountConfig | MiniAppConfig | PayConfig | OpenPlatformConfig | WorkConfig | OpenWorkConfig);

package/dist/Core/Config.js

@@ -3,9 +3,11 @@ 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("./Contracts/ConfigInterface"));
 const Obj_1 = __importDefault(require("./Support/Obj"));
-class Config {
+class Config extends ConfigInterface_1.default {
     constructor(items = {}) {
+        super();
         this.items = items;
         this.requiredKeys = [];
         this.items = merge_1.default.recursive(true, items);

package/dist/Core/HttpClient/Contracts/HttpClientInterface.d.ts

@@ -1,5 +1,5 @@
 import { Method, AxiosRequestConfig, AxiosInstance } from 'axios';
-import { LogHandler } from '../../../Types/global';
+import { HttpClientFailureJudgeClosure, LogHandler } from '../../../Types/global';
 import HttpClientResponse from '../HttpClientResponse';
 declare abstract class HttpClientInterface {
     /**
@@ -15,6 +15,12 @@ declare abstract class HttpClientInterface {
      * 设置日志方法
      */
     setLogger(logger: LogHandler): this;
+    /**
+     * 设置错误判断方法
+     * @param closure
+     * @returns
+     */
+    judgeFailureUsing(closure: HttpClientFailureJudgeClosure): this;
     /**
      * 发起http请求
      */

package/dist/Core/HttpClient/Contracts/HttpClientInterface.js

@@ -22,6 +22,12 @@ class HttpClientInterface {
      * 设置日志方法
      */
     setLogger(logger) { return this; }
+    /**
+     * 设置错误判断方法
+     * @param closure
+     * @returns
+     */
+    judgeFailureUsing(closure) { return this; }
     /**
      * 发起http请求
      */

package/dist/Core/HttpClient/HttpClient.d.ts

@@ -12,11 +12,8 @@ declare class HttpClient implements HttpClientInterface {
      */
     protected logger: LogHandler;
     constructor(axios: AxiosInstance, failureJudge?: HttpClientFailureJudgeClosure, throwError?: boolean);
-    /**
-     * 设置日志处理方法
-     * @param logger
-     */
     setLogger(logger: LogHandler): this;
+    judgeFailureUsing(closure: HttpClientFailureJudgeClosure): this;
     request(method: Method, url: string, payload?: AxiosRequestConfig<any>): Promise<HttpClientResponse>;
     getInstance(): AxiosInstance;
     setInstance(instance: AxiosInstance): this;

package/dist/Core/HttpClient/HttpClient.js

@@ -25,14 +25,14 @@ class HttpClient {
          */
         this.logger = null;
     }
-    /**
-     * 设置日志处理方法
-     * @param logger
-     */
     setLogger(logger) {
         this.logger = logger;
         return this;
     }
+    judgeFailureUsing(closure) {
+        this.failureJudge = closure;
+        return this;
+    }
     request(method, url, payload = {}) {
         return __awaiter(this, void 0, void 0, function* () {
             let options = Object.assign({}, payload);

package/dist/Core/HttpClient/Mixins/PresetMixin.d.ts

@@ -62,18 +62,6 @@ declare class PresetMixin {
      * @returns
      */
     withSecret(new_secret?: string): this;
-    /**
-     * 预设置mch_id（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_mch_id
-     * @returns
-     */
-    withMchId(new_mch_id?: string): this;
-    /**
-     * 预设置mch_id别名（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_alias
-     * @returns
-     */
-    withMchIdAs(new_alias?: string): this;
     /**
      * 预设置文件
      * @param file  文件路径或可读文件流

package/dist/Core/HttpClient/Mixins/PresetMixin.js

@@ -109,24 +109,6 @@ class PresetMixin {
         this.with('secret', new_secret);
         return this;
     }
-    /**
-     * 预设置mch_id（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_mch_id
-     * @returns
-     */
-    withMchId(new_mch_id = null) {
-        this.with('mch_id', new_mch_id);
-        return this;
-    }
-    /**
-     * 预设置mch_id别名（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
-     * @param new_alias
-     * @returns
-     */
-    withMchIdAs(new_alias = null) {
-        this.with(new_alias, this.presets['mch_id']);
-        return this;
-    }
     /**
      * 预设置文件
      * @param file  文件路径或可读文件流

package/dist/Core/Support/Obj.js

@@ -19,14 +19,16 @@ class Obj {
             return obj[key];
         }
         let newObj = merge_1.default.recursive(true, obj);
-        key.split('.').forEach((segment) => {
+        let keys = key.split('.');
+        for (let i = 0; i < keys.length; i++) {
+            let segment = keys[i];
             if (Obj.exists(newObj, segment)) {
                 newObj = newObj[segment];
             }
             else {
                 return defaultValue;
             }
-        });
+        }
         return newObj;
     }
     /**

package/dist/MiniApp/Application.d.ts

@@ -11,7 +11,7 @@ import { MiniAppConfig } from '../Types/global';
 import AccountInterface from './Contracts/AccountInterface';
 import ApplicationInterface from './Contracts/ApplicationInterface';
 import Utils from './Utils';
-import RefreshableAccessTokenInterface from '../Core/Contracts/RefreshableAccessTokenInterface';
+import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
 /**
  * 小程序应用
  */
@@ -20,7 +20,7 @@ declare class Application implements ApplicationInterface {
     protected account: AccountInterface;
     protected encryptor: Encryptor;
     protected server: ServerInterface;
-    protected accessToken: RefreshableAccessTokenInterface;
+    protected accessToken: AccessTokenInterface;
     getAccount(): AccountInterface;
     /**
      * 设置当前账户实例
@@ -42,13 +42,13 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     setServer(server: ServerInterface): this;
-    getAccessToken(): RefreshableAccessTokenInterface;
+    getAccessToken(): AccessTokenInterface;
     /**
      * 设置AccessToken实例
      * @param accessToken
      * @returns
      */
-    setAccessToken(accessToken: RefreshableAccessTokenInterface): this;
+    setAccessToken(accessToken: AccessTokenInterface): this;
     getUtils(): Utils;
     createClient(): AccessTokenAwareClient;
     /**

package/dist/MiniApp/Application.js

@@ -107,7 +107,7 @@ class Application {
         return new Utils_2.default(this);
     }
     createClient() {
-        return (new AccessTokenAwareClient_1.default(this.getHttpClient(), this.getAccessToken()))
+        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());
     }
     /**

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

@@ -7,7 +7,7 @@ import ServerRequestInterface from "../../Core/Http/Contracts/ServerRequestInter
 import Encryptor from "../../Core/Encryptor";
 import AccountInterface from "./AccountInterface";
 import Utils from "../Utils";
-import RefreshableAccessTokenInterface from "../../Core/Contracts/RefreshableAccessTokenInterface";
+import AccessTokenInterface from "../../Core/Contracts/AccessTokenInterface";
 declare abstract class ApplicationInterface {
     /**
      * 获取当前账户实例
@@ -53,7 +53,7 @@ declare abstract class ApplicationInterface {
      * 获取AccessToken实例
      * @returns
      */
-    getAccessToken(): RefreshableAccessTokenInterface;
+    getAccessToken(): AccessTokenInterface;
     /**
      * 获取缓存实例
      * @returns

package/dist/OfficialAccount/Application.d.ts

@@ -13,7 +13,7 @@ import AccountInterface from './Contracts/AccountInterface';
 import ApplicationInterface from './Contracts/ApplicationInterface';
 import JsApiTicket from './JsApiTicket';
 import Utils from './Utils';
-import RefreshableAccessTokenInterface from '../Core/Contracts/RefreshableAccessTokenInterface';
+import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
 /**
  * 公众号应用
  */
@@ -22,7 +22,7 @@ declare class Application implements ApplicationInterface {
     protected account: AccountInterface;
     protected encryptor: Encryptor;
     protected server: ServerInterface;
-    protected accessToken: RefreshableAccessTokenInterface;
+    protected accessToken: AccessTokenInterface;
     protected oauthFactory: OfficialAccountOAuthFactory;
     protected ticket: JsApiTicket;
     getAccount(): AccountInterface;
@@ -46,13 +46,13 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     setServer(server: ServerInterface): this;
-    getAccessToken(): RefreshableAccessTokenInterface;
+    getAccessToken(): AccessTokenInterface;
     /**
      * 设置AccessToken实例
      * @param accessToken
      * @returns
      */
-    setAccessToken(accessToken: RefreshableAccessTokenInterface): this;
+    setAccessToken(accessToken: AccessTokenInterface): this;
     setOAuthFactory(oauthFactory: OfficialAccountOAuthFactory): this;
     getOAuth(): ProviderInterface;
     getTicket(): JsApiTicket;

package/dist/OfficialAccount/Application.js

@@ -142,7 +142,7 @@ class Application {
         return new Utils_2.default(this);
     }
     createClient() {
-        return (new AccessTokenAwareClient_1.default(this.getHttpClient(), this.getAccessToken()))
+        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());
     }
     /**

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

@@ -10,7 +10,7 @@ import AccountInterface from "./AccountInterface";
 import { OfficialAccountOAuthFactory } from "../../Types/global";
 import JsApiTicket from "../JsApiTicket";
 import Utils from "../Utils";
-import RefreshableAccessTokenInterface from "../../Core/Contracts/RefreshableAccessTokenInterface";
+import AccessTokenInterface from "../../Core/Contracts/AccessTokenInterface";
 declare abstract class ApplicationInterface {
     /**
      * 获取当前账户实例
@@ -56,7 +56,7 @@ declare abstract class ApplicationInterface {
      * 获取AccessToken实例
      * @returns
      */
-    getAccessToken(): RefreshableAccessTokenInterface;
+    getAccessToken(): AccessTokenInterface;
     /**
      * 获取缓存实例
      * @returns

package/dist/OpenPlatform/Account.d.ts

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

package/dist/OpenPlatform/Account.js

@@ -0,0 +1,22 @@
+'use strict';
+class Account {
+    constructor(appId, secret, token = null, aesKey = null) {
+        this.appId = appId;
+        this.secret = secret;
+        this.token = token;
+        this.aesKey = aesKey;
+    }
+    getAppId() {
+        return this.appId;
+    }
+    getSecret() {
+        return this.secret;
+    }
+    getToken() {
+        return this.token;
+    }
+    getAesKey() {
+        return this.aesKey;
+    }
+}
+module.exports = Account;

package/dist/OpenPlatform/Application.d.ts

@@ -0,0 +1,152 @@
+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';
+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 OfficialAccountApplication from '../OfficialAccount/Application';
+import MiniAppApplication from '../MiniApp/Application';
+import { OfficialAccountConfig, OfficialAccountOAuthFactory, MiniAppConfig } from '../Types/global';
+import AccountInterface from './Contracts/AccountInterface';
+import ApplicationInterface from './Contracts/ApplicationInterface';
+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 componentAccessToken: AccessTokenInterface;
+    protected verifyTicket: VerifyTicketInterface;
+    getAccount(): AccountInterface;
+    /**
+     * 设置当前账户实例
+     * @param account
+     * @returns
+     */
+    setAccount(account: AccountInterface): this;
+    getVerifyTicket(): VerifyTicketInterface;
+    setVerifyTicket(verifyTicket: VerifyTicketInterface): this;
+    getEncryptor(): Encryptor;
+    /**
+     * 设置加密机实例
+     * @param encryptor
+     * @returns
+     */
+    setEncryptor(encryptor: Encryptor): this;
+    getServer(): ServerInterface;
+    /**
+     * 设置服务端实例
+     * @param server
+     * @returns
+     */
+    setServer(server: ServerInterface): this;
+    getAccessToken(): AccessTokenInterface;
+    getComponentAccessToken(): AccessTokenInterface;
+    /**
+     * 设置AccessToken实例
+     * @param accessToken
+     * @returns
+     */
+    setComponentAccessToken(componentAccessToken: AccessTokenInterface): this;
+    /**
+     * 使用授权码获取授权信息
+     * @see https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/authorization_info.html
+     * @param authorizationCode
+     * @returns
+     */
+    getAuthorization(authorizationCode: string): Promise<Authorization>;
+    /**
+     * 获取/刷新接口调用令牌
+     * @see https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/api_authorizer_token.html
+     * @param authorizerAppId
+     * @param authorizerRefreshToken
+     * @returns
+     */
+    refreshAuthorizerToken(authorizerAppId: string, authorizerRefreshToken: string): Promise<import("../Types/global").WeixinResponse>;
+    /**
+     * 获取预授权码
+     * @see https://developers.weixin.qq.com/doc/oplatform/Third-party_Platforms/2.0/api/ThirdParty/token/pre_auth_code.html
+     * @returns
+     */
+    createPreAuthorizationCode(): Promise<import("../Types/global").WeixinResponse>;
+    getOAuth(): ProviderInterface;
+    /**
+     * 根据刷新令牌获取公众号实例
+     * @param appId
+     * @param refreshToken
+     * @param config
+     * @returns
+     */
+    getOfficialAccountWithRefreshToken(appId: string, refreshToken: string, config?: ConfigInterface | OfficialAccountConfig): Promise<OfficialAccountApplication>;
+    /**
+     * 根据访问令牌获取公众号实例
+     * @param appId
+     * @param accessToken
+     * @param config
+     * @returns
+     */
+    getOfficialAccountWithAccessToken(appId: string, accessToken: string, config?: ConfigInterface | OfficialAccountConfig): OfficialAccountApplication;
+    /**
+     * 获取公众号实例
+     * @param authorizerAccessToken
+     * @param config
+     * @returns
+     */
+    getOfficialAccount(authorizerAccessToken: AuthorizerAccessToken, config?: ConfigInterface | OfficialAccountConfig): OfficialAccountApplication;
+    /**
+     * 创建第三方oauth工厂
+     * @param authorizerAppId
+     * @param config
+     * @returns
+     */
+    protected createAuthorizerOAuthFactory(authorizerAppId: string, config: ConfigInterface): OfficialAccountOAuthFactory;
+    /**
+     * 根据刷新令牌获取小程序实例
+     * @param appId
+     * @param refreshToken
+     * @param config
+     * @returns
+     */
+    getMiniAppWithRefreshToken(appId: string, refreshToken: string, config?: ConfigInterface | MiniAppConfig): Promise<MiniAppApplication>;
+    /**
+     * 根据访问令牌获取小程序实例
+     * @param appId
+     * @param accessToken
+     * @param config
+     * @returns
+     */
+    getMiniAppWithAccessToken(appId: string, accessToken: string, config?: ConfigInterface | MiniAppConfig): MiniAppApplication;
+    /**
+     * 获取小程序实例
+     * @param authorizerAccessToken
+     * @param config
+     * @returns
+     */
+    getMiniApp(authorizerAccessToken: AuthorizerAccessToken, config?: ConfigInterface | MiniAppConfig): MiniAppApplication;
+    /**
+     * 获取第三方授权令牌
+     * @param appId
+     * @param refreshToken
+     * @returns
+     */
+    getAuthorizerAccessToken(appId: string, refreshToken: string): Promise<any>;
+    createClient(): AccessTokenAwareClient;
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    protected getHttpClientDefaultOptions(): Record<string, any>;
+}
+interface Application extends ConfigMixin, CacheMixin, ClientMixin, ServerRequestMixin, HttpClientMixin {
+}
+export = Application;