node-easywechat 2.10.1 → 3.0.0-alpha.2

package/dist/Core/BaseAccessToken.d.ts

@@ -1,96 +0,0 @@
-import BaseApplication from './BaseApplication';
-import HttpMixin from './Mixins/HttpMixin';
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-/**
- * 授权后的AccessToken对象
- */
-export declare class AccessToken {
-    /**
-     * 网页授权接口调用凭证
-     */
-    access_token: string;
-    /**
-     * 调用凭证的超时时间，单位（秒）
-     */
-    expires_in: number;
-    /**
-     * 刷新access_token
-     */
-    refresh_token: string;
-    /**
-     * 用户唯一标识，openid
-     */
-    openid: string;
-    /**
-     * 授权的作用域
-     */
-    scope: string;
-    constructor(info?: object, keysMap?: Record<string, string>);
-    /**
-     * 获取access_token
-     */
-    getToken(): string;
-    /**
-     * 获取access_token
-     */
-    getAccessToken(): string;
-    /**
-     * 获取过期时间
-     */
-    getExpires(): number;
-    /**
-     * 获取refresh_token
-     */
-    getRefreshToken(): string;
-    /**
-     * 获取openid
-     */
-    getOpenid(): string;
-    /**
-     * 获取scope
-     */
-    getScope(): string;
-}
-declare abstract class BaseAccessToken implements HttpMixin {
-    protected requestMethod: string;
-    protected token: string;
-    protected queryName: string;
-    protected tokenKey: string;
-    protected endpointToGetToken: string;
-    protected cachePrefix: string;
-    protected app: BaseApplication;
-    constructor(app: BaseApplication);
-    protected getCredentials(): Promise<object>;
-    getEndpoint(): Promise<string>;
-    getCacheKey(): Promise<string>;
-    requestToken(credentials: object): Promise<Record<string, any>>;
-    /**
-     * 获取Token
-     * @param refresh 为true时表示强制刷新
-     */
-    getToken(refresh?: boolean): Promise<AccessToken>;
-    /**
-     * 包装为授权后的 AccessToken 对象
-     * @param token 接口返回的数据
-     * @returns
-     */
-    protected warpAccessToken(token: Record<string, any>): AccessToken;
-    /**
-     * 设置Token
-     * @param access_token Record<string, any>
-     * @param expires_in 有效时间，单位：秒
-     */
-    setToken(token: Record<string, any>, expires_in?: number): Promise<this>;
-    /**
-     * 刷新Token
-     */
-    refresh(): Promise<this>;
-    /**
-     * 获取刷新后的Token
-     */
-    getRefreshedToken(): Promise<AccessToken>;
-    getTokenKey(): string;
-    applyToRequest(payload: AxiosRequestConfig): Promise<object>;
-    doRequest(payload: AxiosRequestConfig): Promise<AxiosResponse<any>>;
-}
-export default BaseAccessToken;

package/dist/Core/BaseAccessToken.js

@@ -1,222 +0,0 @@
-'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 });
-exports.AccessToken = void 0;
-const HttpMixin_1 = __importDefault(require("./Mixins/HttpMixin"));
-const Utils_1 = require("./Utils");
-/**
- * 授权后的AccessToken对象
- */
-class AccessToken {
-    constructor(info = null, keysMap = {}) {
-        /**
-         * 网页授权接口调用凭证
-         */
-        this.access_token = '';
-        /**
-         * 调用凭证的超时时间，单位（秒）
-         */
-        this.expires_in = 0;
-        /**
-         * 刷新access_token
-         */
-        this.refresh_token = '';
-        /**
-         * 用户唯一标识，openid
-         */
-        this.openid = '';
-        /**
-         * 授权的作用域
-         */
-        this.scope = null;
-        if (info) {
-            Object.keys(info).map(key => {
-                this[key] = info[key] || info[(0, Utils_1.strCamel)(key)] || '';
-            });
-            if (keysMap) {
-                Object.keys(keysMap).map(key => {
-                    let mapKey = keysMap[key];
-                    this[key] = info[mapKey] || info[(0, Utils_1.strCamel)(mapKey)] || '';
-                });
-            }
-        }
-    }
-    /**
-     * 获取access_token
-     */
-    getToken() {
-        return this.access_token;
-    }
-    /**
-     * 获取access_token
-     */
-    getAccessToken() {
-        return this.access_token;
-    }
-    /**
-     * 获取过期时间
-     */
-    getExpires() {
-        return this.expires_in;
-    }
-    /**
-     * 获取refresh_token
-     */
-    getRefreshToken() {
-        return this.refresh_token;
-    }
-    /**
-     * 获取openid
-     */
-    getOpenid() {
-        return this.openid;
-    }
-    /**
-     * 获取scope
-     */
-    getScope() {
-        return this.scope;
-    }
-}
-exports.AccessToken = AccessToken;
-;
-class BaseAccessToken {
-    constructor(app) {
-        this.requestMethod = 'GET';
-        this.token = '';
-        this.queryName = '';
-        this.tokenKey = 'access_token';
-        this.endpointToGetToken = '';
-        this.cachePrefix = 'easywechat.kernel.access_token.';
-        this.app = null;
-        this.app = app;
-    }
-    getCredentials() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return {};
-        });
-    }
-    getEndpoint() {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (!this.endpointToGetToken) {
-                throw new Error('Unset the endpoint of AccessToken');
-            }
-            return this.endpointToGetToken;
-        });
-    }
-    getCacheKey() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.cachePrefix + (0, Utils_1.createHash)(JSON.stringify(yield this.getCredentials()), 'md5');
-        });
-    }
-    requestToken(credentials) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let payload = {
-                url: yield this.getEndpoint(),
-                method: this.requestMethod,
-            };
-            if (this.requestMethod == 'POST') {
-                payload.data = credentials;
-            }
-            else {
-                payload.params = credentials;
-            }
-            let response = yield this.doRequest(payload);
-            return response.data;
-        });
-    }
-    ;
-    /**
-     * 获取Token
-     * @param refresh 为true时表示强制刷新
-     */
-    getToken(refresh = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let cacheKey = yield this.getCacheKey();
-            let cache = this.app.getCache();
-            if (!refresh && (yield cache.has(cacheKey))) {
-                let token = yield cache.get(cacheKey);
-                if (token)
-                    return this.warpAccessToken(token);
-            }
-            let res = yield this.requestToken(yield this.getCredentials());
-            if (res.errcode) {
-                throw new Error(res.errmsg);
-            }
-            yield this.setToken(res, res.expires_in || 7200);
-            return this.warpAccessToken(res);
-        });
-    }
-    /**
-     * 包装为授权后的 AccessToken 对象
-     * @param token 接口返回的数据
-     * @returns
-     */
-    warpAccessToken(token) {
-        return new AccessToken(token);
-    }
-    /**
-     * 设置Token
-     * @param access_token Record<string, any>
-     * @param expires_in 有效时间，单位：秒
-     */
-    setToken(token, expires_in = 7200) {
-        return __awaiter(this, void 0, void 0, function* () {
-            let cacheKey = yield this.getCacheKey();
-            let cache = this.app.getCache();
-            yield cache.set(cacheKey, token, expires_in);
-            if (!cache.has(cacheKey)) {
-                throw new Error('Failed to cache access token.');
-            }
-            return this;
-        });
-    }
-    ;
-    /**
-     * 刷新Token
-     */
-    refresh() {
-        return __awaiter(this, void 0, void 0, function* () {
-            yield this.getToken(true);
-            return this;
-        });
-    }
-    /**
-     * 获取刷新后的Token
-     */
-    getRefreshedToken() {
-        return this.getToken(true);
-    }
-    getTokenKey() {
-        return this.tokenKey;
-    }
-    applyToRequest(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            payload.params = payload.params || {};
-            if (!payload.params[this.queryName || this.tokenKey]) {
-                payload.params[this.queryName || this.tokenKey] = (yield this.getToken())[this.tokenKey];
-            }
-            return payload;
-        });
-    }
-    // Rewrite by HttpMixin
-    doRequest(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return null;
-        });
-    }
-}
-;
-(0, Utils_1.applyMixins)(BaseAccessToken, [HttpMixin_1.default]);
-exports.default = BaseAccessToken;

package/dist/Core/BaseApplication.d.ts

@@ -1,72 +0,0 @@
-import CacheInterface from './Contracts/CacheInterface';
-import FileCache from './Cache/FileCache';
-import Request from './Http/Request';
-import { EasyWechatConfig } from './Types';
-import BaseAccessToken from './BaseAccessToken';
-export default abstract class BaseApplicatioin {
-    protected defaultConfig: EasyWechatConfig;
-    protected userConfig: EasyWechatConfig;
-    protected id: String;
-    /**
-     * 缓存实例
-     */
-    cache: CacheInterface;
-    /**
-     * 配置项
-     */
-    config: EasyWechatConfig;
-    /**
-     * 日志方法
-     */
-    log: Function;
-    /**
-     * 请求实例
-     */
-    request: Request;
-    /**
-     * 请求token
-     */
-    access_token: BaseAccessToken;
-    constructor(config: EasyWechatConfig, prepends?: Object, id?: String);
-    getId(): String;
-    /**
-     * 获取合并后的配置
-     */
-    getConfig(): EasyWechatConfig;
-    /**
-     * 注册通用模块
-     */
-    registerCommonProviders(): void;
-    /**
-     * 扩展服务模块
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param func 传入一个闭包，闭包会接收一个指向id模块的实例参数
-     */
-    extend(id: string, func: Function): void;
-    /**
-     * 自定义服务模块（重新绑定）
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param value 自定义服务模块的实例，可以传入一个闭包，闭包会接收一个指向Application的参数
-     */
-    rebind(id: string, value: any): void;
-    /**
-     * 解绑自定义服务模块
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param value 自定义服务模块的实例
-     */
-    offsetUnset(id: string): void;
-    /**
-     * 绑定自定义服务模块
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param value 自定义服务模块的实例，可以传入一个闭包，闭包会接收一个指向Application的参数
-     */
-    offsetSet(id: string, value: any): void;
-    /**
-     * 获取cache实例
-     */
-    getCache(): CacheInterface;
-    /**
-     * 生成默认的缓存实例（文件缓存）
-     */
-    createDefaultCache(): FileCache;
-}

package/dist/Core/BaseApplication.js

@@ -1,138 +0,0 @@
-'use strict';
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const FileCache_1 = __importDefault(require("./Cache/FileCache"));
-const Utils_1 = require("./Utils");
-const Request_1 = __importDefault(require("./Http/Request"));
-class BaseApplicatioin {
-    constructor(config, prepends = {}, id = null) {
-        this.defaultConfig = {};
-        this.userConfig = {};
-        this.id = null;
-        /**
-         * 缓存实例
-         */
-        this.cache = null;
-        /**
-         * 配置项
-         */
-        this.config = {};
-        /**
-         * 日志方法
-         */
-        this.log = null;
-        /**
-         * 请求实例
-         */
-        this.request = null;
-        /**
-         * 请求token
-         */
-        this.access_token = null;
-        if (new.target === BaseApplicatioin) {
-            throw new Error('Can not create instance via BaseApplicatioin.');
-        }
-        if ((0, Utils_1.isObject)(prepends)) {
-            for (let key in prepends) {
-                this.offsetSet(key, prepends[key]);
-            }
-        }
-        this.userConfig = config || {};
-        this.id = id || null;
-    }
-    getId() {
-        if (!this.id) {
-            this.id = (0, Utils_1.createHash)(JSON.stringify(this.userConfig), 'md5');
-        }
-        return this.id;
-    }
-    /**
-     * 获取合并后的配置
-     */
-    getConfig() {
-        let base = {
-            // https://www.npmjs.com/package/request#requestoptions-callback
-            http: {
-                timeout: 30000,
-                baseURL: 'https://api.weixin.qq.com/',
-            },
-        };
-        return (0, Utils_1.merge)((0, Utils_1.merge)(base, this.defaultConfig), this.userConfig);
-    }
-    /**
-     * 注册通用模块
-     */
-    registerCommonProviders() {
-        this.offsetSet('config', function (app) {
-            return app.getConfig();
-        });
-        this.offsetSet('log', function (app) {
-            return function () {
-                if (!app['config']['debug'])
-                    return true;
-                let args = arguments;
-                args[0] = 'NodeEasywechat2: ' + args[0];
-                return console.log.apply(null, arguments);
-            };
-        });
-        if (!this.request) {
-            this.request = new Request_1.default;
-        }
-    }
-    /**
-     * 扩展服务模块
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param func 传入一个闭包，闭包会接收一个指向id模块的实例参数
-     */
-    extend(id, func) {
-        let client = this[id];
-        func(client);
-    }
-    /**
-     * 自定义服务模块（重新绑定）
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param value 自定义服务模块的实例，可以传入一个闭包，闭包会接收一个指向Application的参数
-     */
-    rebind(id, value) {
-        this.offsetUnset(id);
-        this.offsetSet(id, value);
-    }
-    /**
-     * 解绑自定义服务模块
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param value 自定义服务模块的实例
-     */
-    offsetUnset(id) {
-        delete this[id];
-    }
-    /**
-     * 绑定自定义服务模块
-     * @param id 服务模块的id，如：cache、request、access_token
-     * @param value 自定义服务模块的实例，可以传入一个闭包，闭包会接收一个指向Application的参数
-     */
-    offsetSet(id, value) {
-        if ((0, Utils_1.isFunction)(value)) {
-            value = value(this);
-        }
-        this[id] = value;
-    }
-    /**
-     * 获取cache实例
-     */
-    getCache() {
-        if (this.cache) {
-            return this.cache;
-        }
-        return this.cache = this.createDefaultCache();
-    }
-    /**
-     * 生成默认的缓存实例（文件缓存）
-     */
-    createDefaultCache() {
-        return new FileCache_1.default(this.config.file_cache || null);
-    }
-}
-exports.default = BaseApplicatioin;
-;

package/dist/Core/BaseClient.d.ts

@@ -1,20 +0,0 @@
-import BaseAccessToken from './BaseAccessToken';
-import BaseApplication from './BaseApplication';
-import HttpMixin from './Mixins/HttpMixin';
-import Response from './Http/Response';
-import { AxiosRequestConfig, AxiosResponse } from 'axios';
-declare abstract class BaseClient implements HttpMixin {
-    protected accessToken: BaseAccessToken;
-    protected app: BaseApplication;
-    constructor(app: BaseApplication, accessToken?: BaseAccessToken);
-    setAccessToken(accessToken: BaseAccessToken): this;
-    getAccessToken(): BaseAccessToken;
-    request(payload: AxiosRequestConfig, returnResponse?: Boolean): Promise<AxiosResponse<any>>;
-    httpUpload(url: string, files?: object, form?: object, query?: object): Promise<any>;
-    httpGet(url: string, query?: object): Promise<any>;
-    httpPost(url: string, formData?: object): Promise<any>;
-    httpPostJson(url: string, data?: object, query?: object): Promise<any>;
-    requestRaw(payload: AxiosRequestConfig): Promise<Response>;
-    doRequest(payload: AxiosRequestConfig): Promise<AxiosResponse<any>>;
-}
-export default BaseClient;

package/dist/Core/BaseClient.js

@@ -1,109 +0,0 @@
-'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 HttpMixin_1 = __importDefault(require("./Mixins/HttpMixin"));
-const Utils_1 = require("./Utils");
-const fs_1 = __importDefault(require("fs"));
-const Response_1 = __importDefault(require("./Http/Response"));
-const form_data_1 = __importDefault(require("form-data"));
-class BaseClient {
-    constructor(app, accessToken = null) {
-        this.accessToken = null;
-        this.app = null;
-        this.app = app;
-        this.accessToken = accessToken || this.app.access_token;
-    }
-    setAccessToken(accessToken) {
-        this.accessToken = accessToken;
-        return this;
-    }
-    getAccessToken() {
-        return this.accessToken;
-    }
-    request(payload, returnResponse = false) {
-        return __awaiter(this, void 0, void 0, function* () {
-            payload = payload || {};
-            if (!payload.method) {
-                payload.method = 'POST';
-            }
-            if (!payload.params) {
-                payload.params = {};
-            }
-            if (this.accessToken) {
-                payload = yield this.accessToken.applyToRequest(payload);
-            }
-            let response = yield this.doRequest(payload);
-            return returnResponse ? response : response.data;
-        });
-    }
-    httpUpload(url, files = {}, form = {}, query = {}) {
-        let formData = new form_data_1.default;
-        for (let name in files) {
-            if ((0, Utils_1.isString)(files[name])) {
-                formData.append(name, fs_1.default.createReadStream(files[name]));
-            }
-            else {
-                formData.append(name, files[name]);
-            }
-        }
-        for (let name in form) {
-            formData.append(name, form[name]);
-        }
-        return this.request({
-            url,
-            data: formData,
-            method: 'POST',
-            params: query,
-        });
-    }
-    httpGet(url, query = {}) {
-        return this.request({
-            url,
-            method: 'GET',
-            params: query,
-        });
-    }
-    httpPost(url, formData = {}) {
-        return this.request({
-            url,
-            method: 'POST',
-            data: formData,
-        });
-    }
-    httpPostJson(url, data = {}, query = {}) {
-        return this.request({
-            url,
-            method: 'POST',
-            data: data,
-            params: query,
-        });
-    }
-    requestRaw(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            payload = payload || {};
-            payload.responseType = 'arraybuffer';
-            let res = yield this.request(payload, true);
-            return new Response_1.default(res.data, res.status, res.headers);
-        });
-    }
-    // Rewrite by HttpMixin
-    doRequest(payload) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return null;
-        });
-    }
-}
-;
-(0, Utils_1.applyMixins)(BaseClient, [HttpMixin_1.default]);
-exports.default = BaseClient;

package/dist/Core/Contracts/RequestInterface.d.ts

@@ -1,10 +0,0 @@
-export default abstract class RequestInterface {
-    getMethod(): string;
-    get(key: string): Promise<any>;
-    post(key: string): Promise<any>;
-    getContent(): Promise<any>;
-    getUri(): string;
-    getContentType(): string;
-    getHeaders(): object;
-    getClientIp(): string;
-}

package/dist/Core/Contracts/RequestInterface.js

@@ -1,30 +0,0 @@
-'use strict';
-Object.defineProperty(exports, "__esModule", { value: true });
-class RequestInterface {
-    getMethod() {
-        return '';
-    }
-    get(key) {
-        return null;
-    }
-    post(key) {
-        return null;
-    }
-    getContent() {
-        return null;
-    }
-    getUri() {
-        return '';
-    }
-    getContentType() {
-        return '';
-    }
-    getHeaders() {
-        return null;
-    }
-    getClientIp() {
-        return '';
-    }
-}
-exports.default = RequestInterface;
-;