node-easywechat 2.9.1 → 3.0.0-alpha.1

package/dist/Core/Support/Obj.js

@@ -0,0 +1,136 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const merge_1 = __importDefault(require("merge"));
+class Obj {
+    /**
+     * 获取属性
+     * @param obj 对象
+     * @param key 属性，支持“.”作为层级分隔符的多层级查询
+     * @param defaultValue 默认值，默认：null
+     * @returns
+     */
+    static get(obj, key, defaultValue = null) {
+        if (key === null) {
+            return obj;
+        }
+        if (Obj.exists(obj, key)) {
+            return obj[key];
+        }
+        let newObj = merge_1.default.recursive(true, obj);
+        key.split('.').forEach((segment) => {
+            if (Obj.exists(newObj, segment)) {
+                newObj = newObj[segment];
+            }
+            else {
+                return defaultValue;
+            }
+        });
+        return newObj;
+    }
+    /**
+     * 判断属性是否存在
+     * @param obj 对象
+     * @param key 属性，不支持多层级查询
+     * @returns
+     */
+    static exists(obj, key) {
+        return typeof obj === 'object' && obj[key] !== undefined;
+    }
+    /**
+     * 设置属性
+     * @param obj 对象
+     * @param key 属性，支持“.”作为层级分隔符的多层级查询
+     * @param value 值
+     * @returns
+     */
+    static set(obj, key, value) {
+        if (-1 === key.indexOf('.')) {
+            return obj[key] = value;
+        }
+        let keys = key.split('.');
+        key = keys.shift();
+        let newObj = {};
+        if (obj[key] && typeof obj[key] === 'object') {
+            newObj = merge_1.default.recursive(true, obj[key]);
+        }
+        obj[key] = Obj.set(newObj, keys.join('.'), value);
+        return obj;
+    }
+    /**
+     * 将所有属性的属性转为以“.”分隔。如：
+     * ```
+     * {
+     *   "aa": {
+     *     "b1": {
+     *       "cc":123
+     *     },
+     *     "b2": "xxx"
+     *   }
+     * }
+     * ```
+     * 转换后：
+     * ```
+     * {
+     *    "aa.b1.cc": 123,
+     *    "aa.b2": "xxx"
+     * }
+     * ```
+     * @param obj 对象
+     * @param prepend 前缀，默认：''
+     * @returns
+     */
+    static dot(obj, prepend = '') {
+        let results = {};
+        obj.map((key, value) => {
+            if (typeof value === 'object') {
+                results = merge_1.default.recursive(results, Obj.dot(value, `${prepend}${key}.`));
+            }
+            else {
+                results[prepend + key] = value;
+            }
+        });
+        return results;
+    }
+    /**
+     * 判断属性是否存在。如：
+     * ```
+     * Obj.has(obj, 'attr');
+     * Obj.has(obj, 'aa.bb.cc');
+     * Obj.has(obj, ['attr', 'aa.bb.cc']);
+     * ```
+     * @param obj 对象
+     * @param keys 属性，支持“.”作为层级分隔符的多层级查询，也支持多个属性
+     * @returns
+     */
+    static has(obj, keys) {
+        if (!obj || Object.keys(obj).length === 0) {
+            return false;
+        }
+        if (keys === null || keys === undefined) {
+            return false;
+        }
+        if (typeof keys === 'string') {
+            keys = [keys];
+        }
+        for (let i = 0; i < keys.length; i++) {
+            let key = keys[i];
+            if (Obj.exists(obj, key))
+                continue;
+            let newObj = merge_1.default.recursive(true, obj);
+            let subKeys = key.split('.');
+            for (let j = 0; j < subKeys.length; i++) {
+                let subKey = subKeys[j];
+                if (Obj.exists(newObj, subKey)) {
+                    newObj = newObj[subKey];
+                }
+                else {
+                    return false;
+                }
+            }
+        }
+        return true;
+    }
+}
+module.exports = Obj;

package/dist/Core/{PKCS.d.ts → Support/PKCS.d.ts}

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-export declare class PKCS7 {
+declare class PKCS7 {
     /**
      * 对需要加密的明文进行填充补位
      * @param text 需要进行填充补位操作的明文
@@ -13,3 +13,4 @@ export declare class PKCS7 {
      */
     static unpad(text: string | Buffer, blockSize?: number): Buffer;
 }
+export = PKCS7;

package/dist/Core/{PKCS.js → Support/PKCS.js}

@@ -1,6 +1,4 @@
 'use strict';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PKCS7 = void 0;
 class PKCS7 {
     /**
      * 对需要加密的明文进行填充补位
@@ -41,4 +39,4 @@ class PKCS7 {
         return buf.slice(0, buf.length - pad);
     }
 }
-exports.PKCS7 = PKCS7;
+module.exports = PKCS7;

package/dist/Core/{RSA.d.ts → Support/RSA.d.ts}

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import crypto from 'crypto';
-export default class RSA {
+declare class RSA {
     protected publicKey: crypto.KeyObject;
     /**
      * 设置公钥
@@ -57,3 +57,4 @@ export default class RSA {
      */
     verify(signature: string, data: string, hashType: string, encoding?: BufferEncoding, padding?: number): boolean;
 }
+export = RSA;

package/dist/Core/{RSA.js → Support/RSA.js}

@@ -2,7 +2,6 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-Object.defineProperty(exports, "__esModule", { value: true });
 const crypto_1 = __importDefault(require("crypto"));
 class RSA {
     constructor() {
@@ -95,5 +94,5 @@ class RSA {
         return !!isVerified;
     }
 }
-exports.default = RSA;
 ;
+module.exports = RSA;

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

@@ -0,0 +1,89 @@
+import Stream from 'stream';
+export declare const createHash: (str: string, type?: string) => any;
+export declare const createHmac: (str: string, key: string, type?: string) => any;
+/**
+ * 计算文件的 md5 值
+ * @param path 文件路径或文件可读流
+ */
+export declare const md5File: (path: string | Stream.Readable) => Promise<string>;
+export declare const getTimestamp: (datetime?: string) => number;
+export declare const buildQueryString: (data: Record<string, any>, options?: Record<string, any>) => string;
+export declare const parseQueryString: (data: string, options?: Record<string, any>) => Record<string, any>;
+export declare const randomString: (len?: number) => string;
+export declare const makeSignature: (params: object, key?: string, type?: string) => string;
+export declare const isString: (data: any) => boolean;
+export declare const isArray: (data: any) => boolean;
+export declare const isNumber: (data: any) => boolean;
+export declare const isObject: (data: any) => boolean;
+export declare const isFunction: (data: any) => boolean;
+export declare const isIpv4: (ip: string) => boolean;
+export declare const isIpv6: (ip: string) => boolean;
+export declare const isIp: (ip: string) => boolean;
+export declare const inArray: (data: any, arr: any, strict?: boolean) => boolean;
+/**
+ * 类应用混入方法
+ * @param derivedCtor 目标类
+ * @param constructors 混入类列表
+ */
+export declare const applyMixins: (derivedCtor: any, constructors: any[]) => void;
+/**
+ * 去除字符串左右的符号
+ * @param str 原字符串
+ * @param chars 要去除的符号，正则字符串，默认空白符
+ */
+export declare const trim: (str: string, chars?: string) => string;
+/**
+ * 去除字符串左边的符号
+ * @param str 原字符串
+ * @param chars 要去除的符号，正则字符串，默认空白符
+ */
+export declare const ltrim: (str: string, chars?: string) => string;
+/**
+ * 去除字符串右边的符号
+ * @param str 原字符串
+ * @param chars 要去除的符号，正则字符串，默认空白符
+ */
+export declare const rtrim: (str: string, chars?: string) => string;
+/**
+ * 将单词首字母转成大写，'hello word' => 'Hello World'
+ * @param str
+ * @returns
+ */
+export declare const strUcwords: (str: string) => string;
+/**
+ * 将单词首字母转成小写，'Hello World' => 'hello word'
+ * @param str
+ * @returns
+ */
+export declare const strLcwords: (str: string) => string;
+/**
+ * 驼峰（首字母大写），'hello word' => 'HelloWorld'
+ * @param value
+ * @returns
+ */
+export declare const strStudly: (value: string) => string;
+/**
+ * 驼峰（首字母小写），'hello word' => 'helloWorld'
+ * @param value
+ * @returns
+ */
+export declare const strCamel: (value: string) => string;
+/**
+ * 如果只有一个同名、同级节点，则不当作数组
+ * @param obj
+ * @returns
+ */
+export declare const singleItem: (obj: any) => any;
+/**
+ * 解析xml
+ * @param xml
+ * @returns
+ */
+export declare const parseXml: (xml: string) => Promise<Record<string, any>>;
+/**
+ * 构建xml
+ * @param data 对象
+ * @param rootName 根节点名，默认：'xml'
+ * @returns
+ */
+export declare const buildXml: (data: Record<string, any>, rootName?: string) => string;

package/dist/Core/{Utils.js → Support/Utils.js}

@@ -12,41 +12,12 @@ 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.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 = exports.merge = void 0;
+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;
 const crypto_1 = __importDefault(require("crypto"));
 const qs_1 = __importDefault(require("qs"));
 const xml2js_1 = __importDefault(require("xml2js"));
 const stream_1 = __importDefault(require("stream"));
 const fs_1 = __importDefault(require("fs"));
-const merge = (target, source) => {
-    if ((0, exports.isObject)(source)) {
-        if (source.constructor !== Object) {
-            target = source;
-        }
-        else {
-            if (!target || !(0, exports.isObject)(target)) {
-                target = {};
-            }
-            Object.keys(source).map((k) => {
-                if (!target[k]) {
-                    target[k] = null;
-                }
-                target[k] = (0, exports.merge)(target[k], source[k]);
-            });
-        }
-    }
-    else if ((0, exports.isArray)(source)) {
-        if (!target || !(0, exports.isArray)(target)) {
-            target = [];
-        }
-        target = target.concat(target, source);
-    }
-    else {
-        target = source;
-    }
-    return target;
-};
-exports.merge = merge;
 const createHash = function (str, type = 'sha1') {
     return crypto_1.default.createHash(type).update(str).digest('hex');
 };
@@ -192,39 +163,100 @@ const inArray = function (data, arr, strict = false) {
     }
 };
 exports.inArray = inArray;
-const applyMixins = function (derivedCtor, baseCtors) {
-    baseCtors.forEach(baseCtor => {
-        Object.getOwnPropertyNames(baseCtor.prototype).forEach(name => {
-            derivedCtor.prototype[name] = baseCtor.prototype[name];
+/**
+ * 类应用混入方法
+ * @param derivedCtor 目标类
+ * @param constructors 混入类列表
+ */
+const applyMixins = function (derivedCtor, constructors) {
+    constructors.forEach((baseCtor) => {
+        Object.getOwnPropertyNames(baseCtor.prototype).forEach((name) => {
+            // 构造函数或目标类已有的方法，则以目标类的为准
+            if (name === 'constructor' || typeof derivedCtor.prototype[name] !== 'undefined')
+                return;
+            Object.defineProperty(derivedCtor.prototype, name, Object.getOwnPropertyDescriptor(baseCtor.prototype, name) || Object.create(null));
         });
     });
 };
 exports.applyMixins = applyMixins;
-// 将单词首字母转成大写，'hello word' => 'Hello World'
+/**
+ * 去除字符串左右的符号
+ * @param str 原字符串
+ * @param chars 要去除的符号，正则字符串，默认空白符
+ */
+const trim = (str, chars = '\\s+') => {
+    if (!str || !(0, exports.isString)(str))
+        return '';
+    return str.replace(new RegExp('^' + chars + '|' + chars + '$', 'gm'), '');
+};
+exports.trim = trim;
+/**
+ * 去除字符串左边的符号
+ * @param str 原字符串
+ * @param chars 要去除的符号，正则字符串，默认空白符
+ */
+const ltrim = (str, chars = '\\s+') => {
+    if (!str || !(0, exports.isString)(str))
+        return '';
+    return str.replace(new RegExp('^' + chars, 'gm'), '');
+};
+exports.ltrim = ltrim;
+/**
+ * 去除字符串右边的符号
+ * @param str 原字符串
+ * @param chars 要去除的符号，正则字符串，默认空白符
+ */
+const rtrim = (str, chars = '\\s+') => {
+    if (!str || !(0, exports.isString)(str))
+        return '';
+    return str.replace(new RegExp(chars + '$', 'gm'), '');
+};
+exports.rtrim = rtrim;
+/**
+ * 将单词首字母转成大写，'hello word' => 'Hello World'
+ * @param str
+ * @returns
+ */
 const strUcwords = function (str) {
     return str.replace(/\b[a-z]/gi, function (letter) {
         return letter.toUpperCase();
     });
 };
 exports.strUcwords = strUcwords;
-// 将单词首字母转成小写，'Hello World' => 'hello word'
+/**
+ * 将单词首字母转成小写，'Hello World' => 'hello word'
+ * @param str
+ * @returns
+ */
 const strLcwords = function (str) {
     return str.replace(/\b[a-z]/gi, function (letter) {
         return letter.toLowerCase();
     });
 };
 exports.strLcwords = strLcwords;
-// 驼峰（首字母大写），'hello word' => 'HelloWorld'
+/**
+ * 驼峰（首字母大写），'hello word' => 'HelloWorld'
+ * @param value
+ * @returns
+ */
 const strStudly = function (value) {
     return (0, exports.strUcwords)(value.replace(/[\-|\_]/gi, ' ')).replace(/\s/gi, '');
 };
 exports.strStudly = strStudly;
-// 驼峰（首字母小写），'hello word' => 'helloWorld'
+/**
+ * 驼峰（首字母小写），'hello word' => 'helloWorld'
+ * @param value
+ * @returns
+ */
 const strCamel = function (value) {
     return (0, exports.strLcwords)((0, exports.strStudly)(value));
 };
 exports.strCamel = strCamel;
-// 如果只有一个同名、同级节点，则不当作数组
+/**
+ * 如果只有一个同名、同级节点，则不当作数组
+ * @param obj
+ * @returns
+ */
 const singleItem = function (obj) {
     if (typeof obj == 'object') {
         if (typeof obj.length != 'undefined') {
@@ -245,6 +277,11 @@ const singleItem = function (obj) {
     return obj;
 };
 exports.singleItem = singleItem;
+/**
+ * 解析xml
+ * @param xml
+ * @returns
+ */
 const parseXml = function (xml) {
     return __awaiter(this, void 0, void 0, function* () {
         let res = yield xml2js_1.default.parseStringPromise(xml);
@@ -255,9 +292,16 @@ const parseXml = function (xml) {
     });
 };
 exports.parseXml = parseXml;
+/**
+ * 构建xml
+ * @param data 对象
+ * @param rootName 根节点名，默认：'xml'
+ * @returns
+ */
 const buildXml = function (data, rootName = 'xml') {
     let XmlBuilder = new xml2js_1.default.Builder({
         cdata: true,
+        xmldec: null,
         rootName,
         renderOpts: {
             pretty: false,
@@ -265,6 +309,6 @@ const buildXml = function (data, rootName = 'xml') {
             newline: '',
         }
     });
-    return XmlBuilder.buildObject(data);
+    return XmlBuilder.buildObject(data).replace('<?xml version="1.0"?>', '');
 };
 exports.buildXml = buildXml;

package/dist/OfficialAccount/AccessToken.d.ts

@@ -0,0 +1,26 @@
+import CacheInterface from "../Core/Contracts/CacheInterface";
+import HttpClientInterface from "../Core/HttpClient/Contracts/HttpClientInterface";
+import RefreshableAccessToken from "../Core/Contracts/RefreshableAccessTokenInterface";
+declare class AccessToken implements RefreshableAccessToken {
+    protected appId: string;
+    protected secret: string;
+    protected key: string;
+    protected cache: CacheInterface;
+    protected httpClient: HttpClientInterface;
+    constructor(appId: string, secret: string, key?: string, cache?: CacheInterface, httpClient?: HttpClientInterface);
+    /**
+     * 获取access_token的缓存名称
+     * @returns
+     */
+    getKey(): string;
+    /**
+     * 设置access_token的缓存名称
+     * @param key
+     * @returns
+     */
+    setKey(key: string): this;
+    getToken(): Promise<string>;
+    toQuery(): Promise<Record<string, any>>;
+    refresh(): Promise<string>;
+}
+export = AccessToken;

package/dist/OfficialAccount/AccessToken.js

@@ -0,0 +1,83 @@
+'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 };
+};
+const HttpClient_1 = __importDefault(require("../Core/HttpClient/HttpClient"));
+const FileCache_1 = __importDefault(require("../Core/Cache/FileCache"));
+class AccessToken {
+    constructor(appId, secret, key = null, cache = null, httpClient = null) {
+        this.appId = null;
+        this.secret = null;
+        this.key = null;
+        this.cache = null;
+        this.httpClient = null;
+        this.appId = appId;
+        this.secret = secret;
+        this.key = key;
+        this.cache = cache || new FileCache_1.default();
+        this.httpClient = httpClient || HttpClient_1.default.create({
+            baseURL: 'https://api.weixin.qq.com/',
+        });
+    }
+    /**
+     * 获取access_token的缓存名称
+     * @returns
+     */
+    getKey() {
+        if (!this.key) {
+            this.key = `official_account.access_token.${this.appId}`;
+        }
+        return this.key;
+    }
+    /**
+     * 设置access_token的缓存名称
+     * @param key
+     * @returns
+     */
+    setKey(key) {
+        this.key = key;
+        return this;
+    }
+    getToken() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let token = yield this.cache.get(this.getKey());
+            if (!!token && typeof token === 'string') {
+                return token;
+            }
+            return this.refresh();
+        });
+    }
+    toQuery() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return {
+                access_token: yield this.getToken(),
+            };
+        });
+    }
+    refresh() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let response = yield (yield this.httpClient.request('get', 'cgi-bin/token', {
+                params: {
+                    grant_type: 'client_credential',
+                    appid: this.appId,
+                    secret: this.secret,
+                }
+            })).toObject(false);
+            if (!response['access_token']) {
+                throw new Error('Failed to get access_token: ' + JSON.stringify(response));
+            }
+            yield this.cache.set(this.getKey(), response['access_token'], parseInt(response['expires_in']));
+            return response['access_token'];
+        });
+    }
+}
+module.exports = AccessToken;

package/dist/OfficialAccount/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/OfficialAccount/Account.js

@@ -0,0 +1,29 @@
+'use strict';
+class Account {
+    constructor(appId, secret, token = null, aesKey = null) {
+        this.appId = null;
+        this.secret = null;
+        this.token = null;
+        this.aesKey = null;
+        this.appId = appId;
+        this.secret = secret;
+        this.token = token;
+        this.aesKey = aesKey;
+    }
+    getAppId() {
+        return this.appId;
+    }
+    getSecret() {
+        if (null === this.secret) {
+            throw new Error("No secret configured.");
+        }
+        return this.secret;
+    }
+    getToken() {
+        return this.token;
+    }
+    getAesKey() {
+        return this.aesKey;
+    }
+}
+module.exports = Account;