node-easywechat 2.9.3 → 3.0.0-alpha.1

package/dist/OfficialAccount/Application.d.ts

@@ -1,68 +1,72 @@
-import BaseApplication from '../Core/BaseApplication';
-import AccessToken from './Auth/AccessToken';
+import ProviderInterface from 'node-socialite/dist/Core/ProviderInterface';
+import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
+import ConfigInterface from '../Core/Contracts/ConfigInterface';
+import ServerInterface from '../Core/Contracts/ServerInterface';
 import Encryptor from '../Core/Encryptor';
-import Guard from './Server/Guard';
-import UserClient from './User/UserClient';
-import TagClient from './User/TagClient';
-import MenuClient from './Menu/MenuClient';
-import TemplateMessageClient from './TemplateMessage/TemplateMessageClient';
-import SubscribeMessageClient from './SubscribeMessage/SubscribeMessageClient';
-import MaterialClient from './Material/MaterialClient';
-import CustomerServiceClient from './CustomerService/CustomerServiceClient';
-import CustomerServiceSession from './CustomerService/CustomerServiceSession';
-import SemanticClient from './Semantic/SemanticClient';
-import DataCubeClient from './DataCube/DataCubeClient';
-import POIClient from './POI/POIClient';
-import AutoReplyClient from './AutoReply/AutoReplyClient';
-import BroadcastingClient from './Broadcasting/BroadcastingClient';
-import Card from './Card/Card';
-import DeviceClient from './Device/DeviceClient';
-import ShakeAround from './ShakeAround/ShakeAround';
-import StoreClient from './Store/StoreClient';
-import CommentClient from './Comment/CommentClient';
-import OfficialAccountBase from './Base/OfficialAccountBase';
-import OCRClient from './OCR/OCRClient';
-import GoodsClient from './Goods/GoodsClient';
-import JssdkClient from '../BaseService/Jssdk/JssdkClient';
-import MediaClient from '../BaseService/Media/MediaClient';
-import QrcodeClient from '../BaseService/Qrcode/QrcodeClient';
-import UrlClient from '../BaseService/Url/UrlClient';
-import { EasyWechatConfig } from '../Core/Types';
-import WeChat from 'node-socialite/dist/Providers/WeChat';
-export default class OfficialAccount extends BaseApplication {
-    protected defaultConfig: EasyWechatConfig;
-    access_token: AccessToken;
-    encryptor: Encryptor;
-    server: Guard;
-    user: UserClient;
-    user_tag: TagClient;
-    oauth: WeChat;
-    menu: MenuClient;
-    template_message: TemplateMessageClient;
-    subscribe_message: SubscribeMessageClient;
-    material: MaterialClient;
-    customer_service: CustomerServiceClient;
-    customer_service_session: CustomerServiceSession;
-    semantic: SemanticClient;
-    data_cube: DataCubeClient;
-    poi: POIClient;
-    auto_reply: AutoReplyClient;
-    broadcasting: BroadcastingClient;
-    card: Card;
-    device: DeviceClient;
-    shake_around: ShakeAround;
-    store: StoreClient;
-    comment: CommentClient;
-    base: OfficialAccountBase;
-    ocr: OCRClient;
-    goods: GoodsClient;
-    jssdk: JssdkClient;
-    media: MediaClient;
-    qrcode: QrcodeClient;
-    url: UrlClient;
-    constructor(config?: EasyWechatConfig, prepends?: Object, id?: String);
-    registerProviders(): void;
-    clearQuota(): Promise<any>;
-    getValidIps(): Promise<any>;
-    checkCallbackUrl(): Promise<any>;
+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 { OfficialAccountConfig, OfficialAccountOAuthFactory } from '../Types/global';
+import AccountInterface from './Contracts/AccountInterface';
+import ApplicationInterface from './Contracts/ApplicationInterface';
+import JsApiTicket from './JsApiTicket';
+import Utils from './Utils';
+declare class Application implements ApplicationInterface {
+    constructor(config: ConfigInterface | OfficialAccountConfig);
+    protected account: AccountInterface;
+    protected encryptor: Encryptor;
+    protected server: ServerInterface;
+    protected accessToken: AccessTokenInterface;
+    protected oauthFactory: OfficialAccountOAuthFactory;
+    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: OfficialAccountOAuthFactory): this;
+    getOAuth(): 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/OfficialAccount/Application.js

@@ -1,239 +1,163 @@
 '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 };
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-const BaseApplication_1 = __importDefault(require("../Core/BaseApplication"));
-const AccessToken_1 = __importDefault(require("./Auth/AccessToken"));
+const merge_1 = __importDefault(require("merge"));
+const ProviderInterface_1 = __importDefault(require("node-socialite/dist/Core/ProviderInterface"));
+const WeChat_1 = __importDefault(require("node-socialite/dist/Providers/WeChat"));
+const Config_1 = __importDefault(require("./Config"));
+const ConfigInterface_1 = __importDefault(require("../Core/Contracts/ConfigInterface"));
 const Encryptor_1 = __importDefault(require("../Core/Encryptor"));
-const Guard_1 = __importDefault(require("./Server/Guard"));
-const FinallResult_1 = __importDefault(require("../Core/Decorators/FinallResult"));
-const UserClient_1 = __importDefault(require("./User/UserClient"));
-const TagClient_1 = __importDefault(require("./User/TagClient"));
-const MenuClient_1 = __importDefault(require("./Menu/MenuClient"));
-const TemplateMessageClient_1 = __importDefault(require("./TemplateMessage/TemplateMessageClient"));
-const SubscribeMessageClient_1 = __importDefault(require("./SubscribeMessage/SubscribeMessageClient"));
-const MaterialClient_1 = __importDefault(require("./Material/MaterialClient"));
-const CustomerServiceClient_1 = __importDefault(require("./CustomerService/CustomerServiceClient"));
-const CustomerServiceSession_1 = __importDefault(require("./CustomerService/CustomerServiceSession"));
-const SemanticClient_1 = __importDefault(require("./Semantic/SemanticClient"));
-const DataCubeClient_1 = __importDefault(require("./DataCube/DataCubeClient"));
-const POIClient_1 = __importDefault(require("./POI/POIClient"));
-const AutoReplyClient_1 = __importDefault(require("./AutoReply/AutoReplyClient"));
-const BroadcastingClient_1 = __importDefault(require("./Broadcasting/BroadcastingClient"));
-const Card_1 = __importDefault(require("./Card/Card"));
-const DeviceClient_1 = __importDefault(require("./Device/DeviceClient"));
-const ShakeAround_1 = __importDefault(require("./ShakeAround/ShakeAround"));
-const StoreClient_1 = __importDefault(require("./Store/StoreClient"));
-const CommentClient_1 = __importDefault(require("./Comment/CommentClient"));
-const OfficialAccountBase_1 = __importDefault(require("./Base/OfficialAccountBase"));
-const OCRClient_1 = __importDefault(require("./OCR/OCRClient"));
-const GoodsClient_1 = __importDefault(require("./Goods/GoodsClient"));
-const JssdkClient_1 = __importDefault(require("../BaseService/Jssdk/JssdkClient"));
-const MediaClient_1 = __importDefault(require("../BaseService/Media/MediaClient"));
-const QrcodeClient_1 = __importDefault(require("../BaseService/Qrcode/QrcodeClient"));
-const UrlClient_1 = __importDefault(require("../BaseService/Url/UrlClient"));
-const node_socialite_1 = require("node-socialite");
-class OfficialAccount extends BaseApplication_1.default {
-    constructor(config = {}, prepends = {}, id = null) {
-        super(config, prepends, id);
-        this.defaultConfig = {
-            app_id: '',
-            secret: '',
-            oauth: {
-                scope: 'snsapi_userinfo',
-                callback: '',
-            },
-        };
-        this.access_token = null;
+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.user = null;
-        this.user_tag = null;
-        this.oauth = null;
-        this.menu = null;
-        this.template_message = null;
-        this.subscribe_message = null;
-        this.material = null;
-        this.customer_service = null;
-        this.customer_service_session = null;
-        this.semantic = null;
-        this.data_cube = null;
-        this.poi = null;
-        this.auto_reply = null;
-        this.broadcasting = null;
-        this.card = null;
-        this.device = null;
-        this.shake_around = null;
-        this.store = null;
-        this.comment = null;
-        this.base = null;
-        this.ocr = null;
-        this.goods = null;
-        this.jssdk = null;
-        this.media = null;
-        this.qrcode = null;
-        this.url = null;
-        this.registerProviders();
-    }
-    registerProviders() {
-        super.registerCommonProviders();
-        if (!this.access_token) {
-            this.offsetSet('access_token', function (app) {
-                return new AccessToken_1.default(app);
-            });
+        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('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) {
-            this.offsetSet('encryptor', function (app) {
-                return new Encryptor_1.default(app.config['app_id'], app.config['token'], app.config['aes_key']);
-            });
+            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) {
-            this.offsetSet('server', function (app) {
-                let guard = new Guard_1.default(app);
-                guard.push(function (payload) {
-                    return __awaiter(this, void 0, void 0, function* () {
-                        let str = yield this.app.request.get('echostr');
-                        if (str) {
-                            return new FinallResult_1.default(str);
-                        }
-                    });
-                });
-                return guard;
-            });
+            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);
         }
-        this.offsetSet('user', function (app) {
-            return new UserClient_1.default(app);
-        });
-        this.offsetSet('user_tag', function (app) {
-            return new TagClient_1.default(app);
-        });
-        if (!this.oauth) {
-            this.offsetSet('oauth', function (app) {
-                let socialiteConfig = {
-                    wechat: {
-                        client_id: app['config']['app_id'],
-                        client_secret: app['config']['secret'],
-                        redirect_url: '',
-                    }
-                };
-                if (app['config']['oauth'] && typeof app['config']['oauth']['callback'] != 'undefined') {
-                    socialiteConfig.wechat.redirect_url = app['config']['oauth']['callback'];
-                }
-                if (app['config']['component_app_id'] && app['config']['component_app_token']) {
-                    socialiteConfig.wechat['component'] = {
-                        id: app['config']['component_app_id'],
-                        token: app['config']['component_app_token'],
-                    };
-                }
-                let socialite = new node_socialite_1.SocialiteManager(socialiteConfig).create('wechat');
-                let scopes = 'snsapi_userinfo';
-                if (app['config']['oauth'] && typeof app['config']['oauth']['scopes'] != 'undefined') {
-                    scopes = app['config']['oauth']['scopes'] || 'snsapi_userinfo';
-                }
-                socialite.scopes(scopes);
-                socialite['state'] = function () {
-                    throw new Error('Please use withState() instead.');
-                };
-                socialite['getToken'] = function () {
-                    throw new Error('Please use tokenFromCode() instead.');
-                };
-                socialite['user'] = function () {
-                    throw new Error('Please use userFromCode() instead.');
-                };
-                return socialite;
+        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());
+        }
+        return this.accessToken;
+    }
+    /**
+     * 设置AccessToken实例
+     * @param accessToken
+     * @returns
+     */
+    setAccessToken(accessToken) {
+        this.accessToken = accessToken;
+        return this;
+    }
+    setOAuthFactory(oauthFactory) {
+        this.oauthFactory = oauthFactory;
+        return this;
+    }
+    getOAuth() {
+        if (!this.oauthFactory) {
+            this.oauthFactory = ((app) => {
+                return (new WeChat_1.default({
+                    client_id: app.getAccount().getAppId(),
+                    client_secret: app.getAccount().getSecret(),
+                    redirect: app.getConfig().get('oauth.redirect_url'),
+                })).scopes(this.getConfig().get('oauth.scopes', 'snsapi_userinfo'));
             });
         }
-        this.offsetSet('menu', function (app) {
-            return new MenuClient_1.default(app);
-        });
-        this.offsetSet('template_message', function (app) {
-            return new TemplateMessageClient_1.default(app);
-        });
-        this.offsetSet('subscribe_message', function (app) {
-            return new SubscribeMessageClient_1.default(app);
-        });
-        this.offsetSet('material', function (app) {
-            return new MaterialClient_1.default(app);
-        });
-        this.offsetSet('customer_service', function (app) {
-            return new CustomerServiceClient_1.default(app);
-        });
-        this.offsetSet('customer_service_session', function (app) {
-            return new CustomerServiceSession_1.default(app);
-        });
-        this.offsetSet('semantic', function (app) {
-            return new SemanticClient_1.default(app);
-        });
-        this.offsetSet('data_cube', function (app) {
-            return new DataCubeClient_1.default(app);
-        });
-        this.offsetSet('poi', function (app) {
-            return new POIClient_1.default(app);
-        });
-        this.offsetSet('auto_reply', function (app) {
-            return new AutoReplyClient_1.default(app);
-        });
-        this.offsetSet('broadcasting', function (app) {
-            return new BroadcastingClient_1.default(app);
-        });
-        this.offsetSet('card', function (app) {
-            return new Card_1.default(app);
-        });
-        this.offsetSet('device', function (app) {
-            return new DeviceClient_1.default(app);
-        });
-        this.offsetSet('shake_around', function (app) {
-            return new ShakeAround_1.default(app);
-        });
-        this.offsetSet('store', function (app) {
-            return new StoreClient_1.default(app);
-        });
-        this.offsetSet('comment', function (app) {
-            return new CommentClient_1.default(app);
-        });
-        this.offsetSet('base', function (app) {
-            return new OfficialAccountBase_1.default(app);
-        });
-        this.offsetSet('ocr', function (app) {
-            return new OCRClient_1.default(app);
-        });
-        this.offsetSet('goods', function (app) {
-            return new GoodsClient_1.default(app);
-        });
-        // BaseService
-        this.offsetSet('jssdk', function (app) {
-            return new JssdkClient_1.default(app);
-        });
-        this.offsetSet('media', function (app) {
-            return new MediaClient_1.default(app);
-        });
-        this.offsetSet('qrcode', function (app) {
-            return new QrcodeClient_1.default(app);
-        });
-        this.offsetSet('url', function (app) {
-            return new UrlClient_1.default(app);
-        });
-    }
-    // map to `base` module
-    clearQuota() {
-        return this.base.clearQuota.apply(this.base, arguments);
-    }
-    getValidIps() {
-        return this.base.getValidIps.apply(this.base, arguments);
-    }
-    checkCallbackUrl() {
-        return this.base.checkCallbackUrl.apply(this.base, arguments);
+        let provider = this.oauthFactory.call(null, this);
+        if (!(provider instanceof ProviderInterface_1.default)) {
+            throw new Error(`The factory must return a \`ProviderInterface\` instance.`);
+        }
+        return provider;
+    }
+    getTicket() {
+        if (!this.ticket) {
+            this.ticket = new JsApiTicket_1.default(this.getAccount().getAppId(), this.getAccount().getSecret(), null, this.getCache(), this.getHttpClient());
+        }
+        return this.ticket;
+    }
+    /**
+     * 设置JsApiTicket实例
+     * @param ticket
+     * @returns
+     */
+    setTicket(ticket) {
+        this.ticket = ticket;
+        return this;
+    }
+    getUtils() {
+        return new Utils_2.default(this);
+    }
+    createClient() {
+        let httpClient = this.getHttpClient();
+        return new AccessTokenAwareClient_1.default(httpClient, this.getAccessToken());
+    }
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    getHttpClientDefaultOptions() {
+        return (0, merge_1.default)(true, {
+            baseURL: 'https://api.weixin.qq.com/',
+        }, this.getConfig().get('http'));
     }
 }
-exports.default = OfficialAccount;
 ;
+;
+(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/OfficialAccount/Config.d.ts

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

package/dist/OfficialAccount/Config.js

@@ -0,0 +1,14 @@
+'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 = [
+            'app_id',
+        ];
+    }
+}
+module.exports = Config;

package/dist/OfficialAccount/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/OfficialAccount/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;