node-easywechat 3.0.0-beta.3 → 3.0.0

package/dist/Core/Message.d.ts

@@ -27,132 +27,5 @@ declare class Message {
     toString(): string;
 }
 interface Message extends HasAttributesMixin {
-    /**
-     * 消息密文，兼容模式、安全模式才有
-     */
-    Encrypt?: string;
-    /**
-     * 开发者微信号
-     */
-    ToUserName?: string;
-    /**
-     * 发送方帐号 OpenId
-     */
-    FromUserName?: string;
-    /**
-     * 消息创建时间
-     */
-    CreateTime?: number;
-    /**
-     * 消息类型，'event'：事件，'text'：文本，'image'：图片，'voice'：语音，'video'：视频，'shortvideo'：小视频，'location'：地理位置，'link'：链接
-     */
-    MsgType?: string;
-    /**
-     * 消息id，64位整型
-     * @scope MsgType='text' | 'image' | 'voice' | 'video' | 'shortvideo' | 'location'
-     */
-    MsgId?: string;
-    /**
-     * 文本消息内容
-     * @scope MsgType='text'
-     */
-    Content?: string;
-    /**
-     * 图片链接
-     * @scope MsgType='image'
-     */
-    PicUrl?: string;
-    /**
-     * 媒体id，可以调用获取临时素材接口拉取数据
-     * @scope MsgType='image' | 'voice'
-     */
-    MediaId?: string;
-    /**
-     * 语音格式，如amr，speex等
-     * @scope MsgType='voice'
-     */
-    Format?: string;
-    /**
-     * 语音识别结果，UTF8编码
-     * @scope MsgType='voice'
-     */
-    Recognition?: string;
-    /**
-     * 缩略图的媒体id
-     * @scope MsgType='video' | 'shortvideo'
-     */
-    ThumbMediaId?: string;
-    /**
-     * 纬度
-     * @scope MsgType='location'
-     */
-    Location_X?: number;
-    /**
-     * 经度
-     * @scope MsgType='location'
-     */
-    Location_Y?: number;
-    /**
-     * 地图缩放大小
-     * @scope MsgType='location'
-     */
-    Scale?: number;
-    /**
-     * 地理位置信息
-     * @scope MsgType='location'
-     */
-    Label?: number;
-    /**
-     * 消息标题
-     * @scope MsgType='link'
-     */
-    Title?: string;
-    /**
-     * 消息描述
-     * @scope MsgType='link'
-     */
-    Description?: string;
-    /**
-     * 消息链接
-     * @scope MsgType='link'
-     */
-    Url?: string;
-    /**
-     * 事件类型，subscribe：关注，unsubscribe：取消关注，SCAN：扫描（用户已关注），LOCATION：地理位置；CLICK：自定义菜单事件，VIEW：点击菜单跳转链接
-     * @scope MsgType='event'
-     */
-    Event?: string;
-    /**
-     * 事件KEY值
-     *
-     * Event='subscribe' | 'SCAN'时：qrscene_为前缀，后面为二维码的参数值
-     *
-     * Event='CLICK'时：自定义菜单接口中KEY值对应
-     *
-     * Event='VIEW'时：设置的跳转URL
-     *
-     * @scope MsgType='event' && Event='subscribe' | 'SCAN' | 'CLICK' | 'VIEW'
-     */
-    EventKey?: string;
-    /**
-     * 二维码的ticket，可用来换取二维码图片
-     * @scope MsgType='event' && Event='subscribe' | 'SCAN'
-     */
-    Ticket?: string;
-    /**
-     * 纬度
-     * @scope MsgType='event' && Event='LOCATION'
-     */
-    Latitude?: number;
-    /**
-     * 经度
-     * @scope MsgType='event' && Event='LOCATION'
-     */
-    Longitude?: number;
-    /**
-     * 位置精度
-     * @scope MsgType='event' && Event='LOCATION'
-     */
-    Precision?: number;
 }
 export = Message;

package/dist/Core/Message.js

@@ -49,7 +49,11 @@ class Message {
      */
     static createFromRequest(request) {
         return __awaiter(this, void 0, void 0, function* () {
-            let originContent = request.getBody().toString();
+            let originContent = '';
+            let body = request.getBody();
+            if (body) {
+                originContent = body.toString();
+            }
             let attributes = {};
             if ('<' === originContent.substring(0, 1)) {
                 attributes = yield (0, Utils_1.parseXml)(originContent);

package/dist/Core/Mixins/DecryptXmlMessageMixin.js

@@ -16,7 +16,7 @@ class DecryptXmlMessageMixin {
      */
     decryptMessage(message, encryptor, signature, timestamp, nonce) {
         return __awaiter(this, void 0, void 0, function* () {
-            let ciphertext = message.Encrypt;
+            let ciphertext = message['Encrypt'];
             this.validateSignature(encryptor.getToken(), ciphertext, signature, timestamp, nonce);
             let attributes = yield (0, Utils_1.parseXml)(encryptor.decrypt(ciphertext, signature, nonce, timestamp));
             message.merge(attributes);

package/dist/Core/Mixins/ResponseXmlMessageMixin.js

@@ -25,8 +25,8 @@ class ResponseXmlMessageMixin {
                 return new Response_1.default(200, {}, 'success');
             }
             let attributes = merge_1.default.recursive({
-                ToUserName: message.FromUserName,
-                FromUserName: message.ToUserName,
+                ToUserName: message['FromUserName'],
+                FromUserName: message['ToUserName'],
                 CreateTime: (0, Utils_1.getTimestamp)(),
             }, yield this.normalizeResponse(response));
             return this.createXmlResponse(attributes, encryptor);

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

@@ -0,0 +1,20 @@
+export declare class PrivateKey {
+    protected key: string;
+    protected passphrase?: string;
+    constructor(key: string, passphrase?: string);
+    /**
+     * 获取私钥
+     * @returns
+     */
+    getKey(): string;
+    /**
+     * 获取密码
+     * @returns
+     */
+    getPassphrase(): string;
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString(): string;
+}

package/dist/Core/Support/PrivateKey.js

@@ -0,0 +1,38 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrivateKey = void 0;
+const fs_1 = __importDefault(require("fs"));
+class PrivateKey {
+    constructor(key, passphrase) {
+        this.key = key;
+        this.passphrase = passphrase;
+        if (fs_1.default.existsSync(key)) {
+            this.key = fs_1.default.readFileSync(key, 'utf8') || '';
+        }
+    }
+    /**
+     * 获取私钥
+     * @returns
+     */
+    getKey() {
+        return this.key;
+    }
+    /**
+     * 获取密码
+     * @returns
+     */
+    getPassphrase() {
+        return this.passphrase;
+    }
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString() {
+        return this.getKey();
+    }
+}
+exports.PrivateKey = PrivateKey;

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

@@ -0,0 +1,14 @@
+export declare class PublicKey {
+    certificate: string;
+    constructor(certificate: string);
+    /**
+     * 获取公钥的序列号
+     * @returns
+     */
+    getSerialNo(): string;
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString(): string;
+}

package/dist/Core/Support/PublicKey.js

@@ -0,0 +1,36 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PublicKey = void 0;
+const fs_1 = __importDefault(require("fs"));
+const crypto_1 = require("crypto");
+class PublicKey {
+    constructor(certificate) {
+        this.certificate = certificate;
+        if (fs_1.default.existsSync(certificate)) {
+            this.certificate = fs_1.default.readFileSync(certificate, 'utf8') || '';
+        }
+    }
+    /**
+     * 获取公钥的序列号
+     * @returns
+     */
+    getSerialNo() {
+        try {
+            return new crypto_1.X509Certificate(this.certificate).serialNumber;
+        }
+        catch (e) {
+            throw new Error('Read the $certificate failed, please check it whether or nor correct');
+        }
+    }
+    /**
+     * 转为字符串
+     * @returns
+     */
+    toString() {
+        return this.certificate;
+    }
+}
+exports.PublicKey = PublicKey;

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

@@ -23,7 +23,7 @@ declare class RSA {
      * 加密
      * @param plaintext 待加密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */
@@ -32,7 +32,7 @@ declare class RSA {
      * 解密
      * @param ciphertext 待解密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */

package/dist/Core/Support/RSA.js

@@ -34,11 +34,11 @@ class RSA {
      * 加密
      * @param plaintext 待加密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */
-    encrypt(plaintext, encoding = 'base64', hashType = 'sha1', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
+    encrypt(plaintext, encoding = 'base64', hashType = 'sha256', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
         let encryptedData = crypto_1.default.publicEncrypt({
             key: this.publicKey,
             padding,
@@ -50,11 +50,11 @@ class RSA {
      * 解密
      * @param ciphertext 待解密文本
      * @param encoding 编码，默认：'base64'
-     * @param hashType 哈希方式，默认：'sha1'
+     * @param hashType 哈希方式，默认：'sha256'
      * @param padding 补位方式，默认：crypto.constants.RSA_PKCS1_OAEP_PADDING
      * @returns
      */
-    decrypt(ciphertext, encoding = 'base64', hashType = 'sha1', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
+    decrypt(ciphertext, encoding = 'base64', hashType = 'sha256', padding = crypto_1.default.constants.RSA_PKCS1_OAEP_PADDING) {
         let decryptedData = crypto_1.default.privateDecrypt({
             key: this.privateKey,
             padding,

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

@@ -93,3 +93,9 @@ export declare const parseXml: (xml: string) => Promise<Record<string, any>>;
  * @returns
  */
 export declare const buildXml: (data: Record<string, any>, rootName?: string) => string;
+/**
+ * 创建UserAgent
+ * @param appends 可选，附加的字符串列表
+ * @returns
+ */
+export declare const createUserAgent: (appends?: string[]) => string;

package/dist/Core/Support/Utils.js

@@ -12,12 +12,13 @@ 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.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;
+exports.createUserAgent = 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"));
 const stream_1 = __importDefault(require("stream"));
 const fs_1 = __importDefault(require("fs"));
+const axios_1 = __importDefault(require("axios"));
 const createHash = function (str, type = 'sha1') {
     return crypto_1.default.createHash(type).update(str).digest('hex');
 };
@@ -321,3 +322,16 @@ const buildXml = function (data, rootName = 'xml') {
     return XmlBuilder.buildObject(data).replace('<?xml version="1.0"?>', '');
 };
 exports.buildXml = buildXml;
+/**
+ * 创建UserAgent
+ * @param appends 可选，附加的字符串列表
+ * @returns
+ */
+const createUserAgent = function (appends = []) {
+    let values = [];
+    values.push(`node-easywechat/${require('../../../package.json').version}`);
+    values.push(`axios/${axios_1.default.VERSION}`);
+    values = values.concat(appends);
+    return values.join(' ');
+};
+exports.createUserAgent = createUserAgent;

package/dist/MiniApp/Application.d.ts

@@ -1,4 +1,3 @@
-import AccessTokenInterface from '../Core/Contracts/AccessTokenInterface';
 import ConfigInterface from '../Core/Contracts/ConfigInterface';
 import ServerInterface from '../Core/Contracts/ServerInterface';
 import Encryptor from '../Core/Encryptor';
@@ -12,6 +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';
 /**
  * 小程序应用
  */
@@ -20,7 +20,7 @@ declare class Application implements ApplicationInterface {
     protected account: AccountInterface;
     protected encryptor: Encryptor;
     protected server: ServerInterface;
-    protected accessToken: AccessTokenInterface;
+    protected accessToken: RefreshableAccessTokenInterface;
     getAccount(): AccountInterface;
     /**
      * 设置当前账户实例
@@ -42,13 +42,13 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     setServer(server: ServerInterface): this;
-    getAccessToken(): AccessTokenInterface;
+    getAccessToken(): RefreshableAccessTokenInterface;
     /**
      * 设置AccessToken实例
      * @param accessToken
      * @returns
      */
-    setAccessToken(accessToken: AccessTokenInterface): this;
+    setAccessToken(accessToken: RefreshableAccessTokenInterface): this;
     getUtils(): Utils;
     createClient(): AccessTokenAwareClient;
     /**

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

@@ -1,4 +1,3 @@
-import AccessTokenInterface from "../../Core/Contracts/AccessTokenInterface";
 import CacheInterface from "../../Core/Contracts/CacheInterface";
 import ConfigInterface from "../../Core/Contracts/ConfigInterface";
 import AccessTokenAwareClient from "../../Core/HttpClient/AccessTokenAwareClient";
@@ -8,6 +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";
 declare abstract class ApplicationInterface {
     /**
      * 获取当前账户实例
@@ -53,7 +53,7 @@ declare abstract class ApplicationInterface {
      * 获取AccessToken实例
      * @returns
      */
-    getAccessToken(): AccessTokenInterface;
+    getAccessToken(): RefreshableAccessTokenInterface;
     /**
      * 获取缓存实例
      * @returns

package/dist/OfficialAccount/AccessToken.d.ts

@@ -1,7 +1,7 @@
 import CacheInterface from "../Core/Contracts/CacheInterface";
 import HttpClientInterface from "../Core/HttpClient/Contracts/HttpClientInterface";
-import RefreshableAccessToken from "../Core/Contracts/RefreshableAccessTokenInterface";
-declare class AccessToken implements RefreshableAccessToken {
+import RefreshableAccessTokenInterface from "../Core/Contracts/RefreshableAccessTokenInterface";
+declare class AccessToken implements RefreshableAccessTokenInterface {
     protected appId: string;
     protected secret: string;
     protected key: string;

package/dist/OfficialAccount/AccessToken.js

@@ -66,13 +66,13 @@ class AccessToken {
     }
     refresh() {
         return __awaiter(this, void 0, void 0, function* () {
-            let response = yield (yield this.httpClient.request('get', 'cgi-bin/token', {
+            let response = (yield this.httpClient.request('get', 'cgi-bin/token', {
                 params: {
                     grant_type: 'client_credential',
                     appid: this.appId,
                     secret: this.secret,
                 }
-            })).toObject(false);
+            })).toObject();
             if (!response['access_token']) {
                 throw new Error('Failed to get access_token: ' + JSON.stringify(response));
             }

package/dist/OfficialAccount/Application.d.ts

@@ -1,5 +1,4 @@
 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';
@@ -14,6 +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';
 /**
  * 公众号应用
  */
@@ -22,7 +22,7 @@ declare class Application implements ApplicationInterface {
     protected account: AccountInterface;
     protected encryptor: Encryptor;
     protected server: ServerInterface;
-    protected accessToken: AccessTokenInterface;
+    protected accessToken: RefreshableAccessTokenInterface;
     protected oauthFactory: OfficialAccountOAuthFactory;
     protected ticket: JsApiTicket;
     getAccount(): AccountInterface;
@@ -46,13 +46,13 @@ declare class Application implements ApplicationInterface {
      * @returns
      */
     setServer(server: ServerInterface): this;
-    getAccessToken(): AccessTokenInterface;
+    getAccessToken(): RefreshableAccessTokenInterface;
     /**
      * 设置AccessToken实例
      * @param accessToken
      * @returns
      */
-    setAccessToken(accessToken: AccessTokenInterface): this;
+    setAccessToken(accessToken: RefreshableAccessTokenInterface): this;
     setOAuthFactory(oauthFactory: OfficialAccountOAuthFactory): this;
     getOAuth(): ProviderInterface;
     getTicket(): JsApiTicket;

package/dist/OfficialAccount/Application.js

@@ -75,11 +75,6 @@ class Application {
     }
     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;

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

@@ -1,5 +1,4 @@
 import ProviderInterface from "node-socialite/dist/Core/ProviderInterface";
-import AccessTokenInterface from "../../Core/Contracts/AccessTokenInterface";
 import CacheInterface from "../../Core/Contracts/CacheInterface";
 import ConfigInterface from "../../Core/Contracts/ConfigInterface";
 import AccessTokenAwareClient from "../../Core/HttpClient/AccessTokenAwareClient";
@@ -11,6 +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";
 declare abstract class ApplicationInterface {
     /**
      * 获取当前账户实例
@@ -56,7 +56,7 @@ declare abstract class ApplicationInterface {
      * 获取AccessToken实例
      * @returns
      */
-    getAccessToken(): AccessTokenInterface;
+    getAccessToken(): RefreshableAccessTokenInterface;
     /**
      * 获取缓存实例
      * @returns

package/dist/OfficialAccount/JsApiTicket.js

@@ -35,11 +35,11 @@ class JsApiTicket extends AccessToken_1.default {
             if (!!ticket && typeof ticket === 'string') {
                 return ticket;
             }
-            let response = yield (yield this.httpClient.request('get', '/cgi-bin/ticket/getticket', {
+            let response = (yield this.httpClient.request('get', '/cgi-bin/ticket/getticket', {
                 params: {
                     type: 'jsapi',
                 }
-            })).toObject(false);
+            })).toObject();
             if (!response['ticket']) {
                 throw new Error('Failed to get jssdk_ticket: ' + JSON.stringify(response));
             }