node-easywechat 3.0.0-alpha.1 → 3.0.0-beta.2

package/dist/Core/HttpClient/HttpClientResponse.js

@@ -16,9 +16,6 @@ const merge_1 = __importDefault(require("merge"));
 const Utils_1 = require("../Support/Utils");
 class HttpClientResponse {
     constructor(response, failureJudge = null, throwError = true) {
-        this.response = null;
-        this.failureJudge = null;
-        this.throwError = false;
         this.response = response;
         this.failureJudge = failureJudge;
         this.throwError = throwError;
@@ -47,7 +44,7 @@ class HttpClientResponse {
      * @returns
      */
     isFailed() {
-        if (this.failureJudge) {
+        if (this.is('text') && this.failureJudge) {
             return this.failureJudge(this);
         }
         try {
@@ -76,9 +73,10 @@ class HttpClientResponse {
             if (!content) {
                 throw new Error('Response body is empty.');
             }
-            let contentType = this.getHeader('content-type') || '';
-            if (contentType && (contentType.indexOf('text/xml') > -1 || contentType.indexOf('application/xml') > -1 || content.indexOf('<xml>') > -1)) {
-                return (0, Utils_1.parseXml)(content);
+            if (typeof content === 'string') {
+                if (this.is('xml') && content.indexOf('<xml>') > -1) {
+                    return (0, Utils_1.parseXml)(content);
+                }
             }
             return content;
         });
@@ -119,7 +117,42 @@ class HttpClientResponse {
      * @returns
      */
     toDataUrl() {
-        return 'data:' + this.getHeader('content-type') + ';base64,' + this.response.data;
+        return 'data:' + this.getHeader('content-type') + ';base64,' + this.response.data.toString('base64');
+    }
+    /**
+     * 判断 content-type 是否指定类型
+     * @param type
+     * @returns
+     */
+    is(type) {
+        let contentType = this.getHeader('content-type');
+        let res = false;
+        switch (type.toLowerCase()) {
+            case 'json':
+                res = contentType.indexOf('/json') > -1;
+                break;
+            case 'xml':
+                res = contentType.indexOf('/xml') > -1;
+                break;
+            case 'html':
+                res = contentType.indexOf('/html') > -1;
+                break;
+            case 'image':
+                res = contentType.indexOf('image/') > -1;
+                break;
+            case 'audio':
+                res = contentType.indexOf('audio/') > -1;
+                break;
+            case 'video':
+                res = contentType.indexOf('video/') > -1;
+                break;
+            case 'text':
+                res = contentType.indexOf('text/') > -1
+                    || contentType.indexOf('/json') > -1
+                    || contentType.indexOf('/xml') > -1;
+                break;
+        }
+        return res;
     }
     /**
      * 判断header是否存在

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

@@ -0,0 +1,79 @@
+import { AxiosRequestConfig, Method } from "axios";
+declare class PresetMixin {
+    /**
+     * 存储预置参数
+     */
+    protected presets: Record<string, any>;
+    /**
+     * 存储预置headers数据
+     */
+    protected prependHeaders: Record<string, any>;
+    /**
+     * 存储预置数据
+     */
+    protected prependData: Record<string, any>;
+    /**
+     * 设置预置参数
+     * @param presets
+     * @returns
+     */
+    setPresets(presets: Record<string, any>): this;
+    /**
+     * 设置单个预置header
+     * @param key
+     * @param value
+     * @returns
+     */
+    withHeader(key: string, value: any): this;
+    /**
+     * 批量设置预置headers
+     * @param headers
+     * @returns
+     */
+    withHeaders(headers: Record<string, any>): this;
+    /**
+     * 设置预置数据
+     * @param key 参数名
+     * @param value 参数值，不设置则尝试从预置参数中获取
+     * @returns
+     */
+    with(key: string | string[] | Record<string, any>, value?: string): this;
+    /**
+     * 预设置app_id（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
+     * @param new_appid
+     * @returns
+     */
+    withAppId(new_appid?: string): this;
+    /**
+     * 预设置app_id的别名（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
+     * @param new_alias
+     * @returns
+     */
+    withAppIdAs(new_alias: string): this;
+    /**
+     * 预设置secret（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
+     * @param new_secret
+     * @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 payload
+     * @param method
+     * @returns
+     */
+    mergeThenResetPrepends(payload: AxiosRequestConfig, method?: Method): any;
+}
+export = PresetMixin;

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

@@ -0,0 +1,155 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const merge_1 = __importDefault(require("merge"));
+class PresetMixin {
+    constructor() {
+        /**
+         * 存储预置参数
+         */
+        this.presets = {};
+        /**
+         * 存储预置headers数据
+         */
+        this.prependHeaders = {};
+        /**
+         * 存储预置数据
+         */
+        this.prependData = {};
+    }
+    /**
+     * 设置预置参数
+     * @param presets
+     * @returns
+     */
+    setPresets(presets) {
+        this.presets = presets;
+        return this;
+    }
+    /**
+     * 设置单个预置header
+     * @param key
+     * @param value
+     * @returns
+     */
+    withHeader(key, value) {
+        if (typeof this.prependHeaders !== 'object') {
+            this.prependHeaders = {};
+        }
+        this.prependHeaders[key] = value;
+        return this;
+    }
+    /**
+     * 批量设置预置headers
+     * @param headers
+     * @returns
+     */
+    withHeaders(headers) {
+        headers.map((value, key) => {
+            this.withHeader(key, value);
+        });
+        return this;
+    }
+    /**
+     * 设置预置数据
+     * @param key 参数名
+     * @param value 参数值，不设置则尝试从预置参数中获取
+     * @returns
+     */
+    with(key, value = null) {
+        if (Array.isArray(key)) {
+            key.map((k) => {
+                var _a;
+                this.with(k, (_a = this.presets[k]) !== null && _a !== void 0 ? _a : null);
+            });
+            return this;
+        }
+        else if (typeof key === 'object') {
+            key.map((v, k) => {
+                var _a;
+                this.with(k, (_a = v !== null && v !== void 0 ? v : this.presets[k]) !== null && _a !== void 0 ? _a : null);
+            });
+            return this;
+        }
+        if (typeof this.prependData !== 'object') {
+            this.prependData = {};
+        }
+        this.prependData[key] = value || this.presets[key] || null;
+        return this;
+    }
+    /**
+     * 预设置app_id（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
+     * @param new_appid
+     * @returns
+     */
+    withAppId(new_appid = null) {
+        this.with('app_id', new_appid);
+        return this;
+    }
+    /**
+     * 预设置app_id的别名（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
+     * @param new_alias
+     * @returns
+     */
+    withAppIdAs(new_alias) {
+        this.with(new_alias, this.presets['app_id']);
+        return this;
+    }
+    /**
+     * 预设置secret（因nodejs不支持魔术方法，只好预先设置几个常用的方法）
+     * @param new_secret
+     * @returns
+     */
+    withSecret(new_secret = null) {
+        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 payload
+     * @param method
+     * @returns
+     */
+    mergeThenResetPrepends(payload, method = 'get') {
+        var _a, _b, _c, _d;
+        let field = method.toLowerCase() === 'get' ? 'params' : 'data';
+        let options = merge_1.default.recursive(true, payload);
+        if (!options.headers)
+            options.headers = {};
+        if (((_b = (_a = options.headers['Content-Type']) !== null && _a !== void 0 ? _a : options.headers['content-type']) !== null && _b !== void 0 ? _b : null) === 'application/json' || !!options.json) {
+            field = 'json';
+        }
+        if (((_d = (_c = options.headers['Content-Type']) !== null && _c !== void 0 ? _c : options.headers['content-type']) !== null && _d !== void 0 ? _d : null) === 'text/xml' || !!options.xml) {
+            field = 'xml';
+        }
+        if (this.prependData && Object.keys(this.prependData).length > 0) {
+            options[field] = Object.assign(Object.assign({}, this.prependData), options[field]);
+        }
+        if (this.prependHeaders && Object.keys(this.prependHeaders).length > 0) {
+            options.headers = Object.assign(Object.assign({}, this.prependHeaders), options.headers);
+        }
+        this.prependData = {};
+        this.prependHeaders = {};
+        return options;
+    }
+}
+module.exports = PresetMixin;

package/dist/Core/Message.d.ts

@@ -1,6 +1,12 @@
 import ServerRequestInterface from "./Http/Contracts/ServerRequestInterface";
 import HasAttributesMixin from "./Mixins/HasAttributesMixin";
+/**
+ * 消息对象
+ */
 declare class Message {
+    /**
+     * 原始消息内容
+     */
     protected originContent: string;
     constructor(attributes: Record<string, any>, originContent?: string);
     /**
@@ -9,7 +15,15 @@ declare class Message {
      * @returns
      */
     static createFromRequest(request: ServerRequestInterface): Promise<Message>;
+    /**
+     * 获取原始消息内容
+     * @returns
+     */
     getOriginalContents(): string;
+    /**
+     * 转为字符串
+     * @returns
+     */
     toString(): string;
 }
 interface Message extends HasAttributesMixin {

package/dist/Core/Message.js

@@ -13,8 +13,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const HasAttributesMixin_1 = __importDefault(require("./Mixins/HasAttributesMixin"));
 const Utils_1 = require("./Support/Utils");
+/**
+ * 消息对象
+ */
 class Message {
     constructor(attributes, originContent = '') {
+        /**
+         * 原始消息内容
+         */
         this.originContent = '';
         this.attributes = attributes;
         this.originContent = originContent;
@@ -61,9 +67,17 @@ class Message {
             return new Message(attributes, originContent);
         });
     }
+    /**
+     * 获取原始消息内容
+     * @returns
+     */
     getOriginalContents() {
         return this.originContent;
     }
+    /**
+     * 转为字符串
+     * @returns
+     */
     toString() {
         return this.toJson();
     }

package/dist/Core/Mixins/ClientMixin.d.ts

@@ -1,6 +1,11 @@
 import AccessTokenAwareClient from "../HttpClient/AccessTokenAwareClient";
-declare class ClientMixin {
+declare abstract class ClientMixin {
     protected client: AccessTokenAwareClient;
+    /**
+     * 创建客户端实例
+     * @returns
+     */
+    abstract createClient(): AccessTokenAwareClient;
     /**
      * 获取客户端实例
      * @returns

package/dist/Core/Mixins/ClientMixin.js

@@ -5,6 +5,9 @@ class ClientMixin {
      * @returns
      */
     getClient() {
+        if (!this.client) {
+            this.client = this.createClient();
+        }
         return this.client;
     }
     /**

package/dist/Core/Mixins/ServerRequestMixin.js

@@ -5,6 +5,9 @@ class ServerRequestMixin {
      * @returns
      */
     getRequest() {
+        if (!this.request) {
+            throw new Error('Please set request instance before use.');
+        }
         return this.request;
     }
     /**

package/dist/Core/Support/Utils.d.ts

@@ -68,6 +68,12 @@ export declare const strStudly: (value: string) => string;
  * @returns
  */
 export declare const strCamel: (value: string) => string;
+/**
+ * 蛇形（下划线分隔，全小写），'helloWorld' => 'hello_world'
+ * @param value
+ * @returns
+ */
+export declare const strSnake: (value: string) => string;
 /**
  * 如果只有一个同名、同级节点，则不当作数组
  * @param obj

package/dist/Core/Support/Utils.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildXml = exports.parseXml = exports.singleItem = exports.strCamel = exports.strStudly = exports.strLcwords = exports.strUcwords = exports.rtrim = exports.ltrim = exports.trim = exports.applyMixins = exports.inArray = exports.isIp = exports.isIpv6 = exports.isIpv4 = exports.isFunction = exports.isObject = exports.isNumber = exports.isArray = exports.isString = exports.makeSignature = exports.randomString = exports.parseQueryString = exports.buildQueryString = exports.getTimestamp = exports.md5File = exports.createHmac = exports.createHash = void 0;
+exports.buildXml = exports.parseXml = exports.singleItem = exports.strSnake = exports.strCamel = exports.strStudly = exports.strLcwords = exports.strUcwords = exports.rtrim = exports.ltrim = exports.trim = exports.applyMixins = exports.inArray = exports.isIp = exports.isIpv6 = exports.isIpv4 = exports.isFunction = exports.isObject = exports.isNumber = exports.isArray = exports.isString = exports.makeSignature = exports.randomString = exports.parseQueryString = exports.buildQueryString = exports.getTimestamp = exports.md5File = exports.createHmac = exports.createHash = void 0;
 const crypto_1 = __importDefault(require("crypto"));
 const qs_1 = __importDefault(require("qs"));
 const xml2js_1 = __importDefault(require("xml2js"));
@@ -252,6 +252,15 @@ const strCamel = function (value) {
     return (0, exports.strLcwords)((0, exports.strStudly)(value));
 };
 exports.strCamel = strCamel;
+/**
+ * 蛇形（下划线分隔，全小写），'helloWorld' => 'hello_world'
+ * @param value
+ * @returns
+ */
+const strSnake = function (value) {
+    return value.replace(/([A-Z])/g, "_$1").toLowerCase().substring(1);
+};
+exports.strSnake = strSnake;
 /**
  * 如果只有一个同名、同级节点，则不当作数组
  * @param obj

package/dist/MiniApp/AccessToken.d.ts

@@ -0,0 +1,9 @@
+import BaseAccessToken from "../OfficialAccount/AccessToken";
+declare class AccessToken extends BaseAccessToken {
+    /**
+     * 获取access_token的缓存名称
+     * @returns
+     */
+    getKey(): string;
+}
+export = AccessToken;

package/dist/MiniApp/AccessToken.js

@@ -0,0 +1,18 @@
+'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 {
+    /**
+     * 获取access_token的缓存名称
+     * @returns
+     */
+    getKey() {
+        if (!this.key) {
+            this.key = `mini_app.access_token.${this.appId}`;
+        }
+        return this.key;
+    }
+}
+module.exports = AccessToken;

package/dist/MiniApp/Account.d.ts

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

package/dist/MiniApp/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/MiniApp/Application.d.ts

@@ -0,0 +1,62 @@
+import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
+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 { MiniAppConfig } from '../Types/global';
+import AccountInterface from './Contracts/AccountInterface';
+import ApplicationInterface from './Contracts/ApplicationInterface';
+import Utils from './Utils';
+/**
+ * 小程序应用
+ */
+declare class Application implements ApplicationInterface {
+    constructor(config: ConfigInterface | MiniAppConfig);
+    protected account: AccountInterface;
+    protected encryptor: Encryptor;
+    protected server: ServerInterface;
+    protected accessToken: AccessTokenInterface;
+    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;
+    getUtils(): Utils;
+    createClient(): AccessTokenAwareClient;
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    protected getHttpClientDefaultOptions(): Record<string, any>;
+}
+interface Application extends ConfigMixin, CacheMixin, ClientMixin, ServerRequestMixin, HttpClientMixin {
+}
+export = Application;

package/dist/MiniApp/Application.js

@@ -0,0 +1,126 @@
+'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 Utils_2 = __importDefault(require("./Utils"));
+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);
+        }
+        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;
+    }
+    getUtils() {
+        return new Utils_2.default(this);
+    }
+    createClient() {
+        return (new AccessTokenAwareClient_1.default(this.getHttpClient(), this.getAccessToken()))
+            .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;