node-easywechat 2.9.1 → 3.0.0-alpha.1

package/dist/Core/Contracts/CacheInterface.js

@@ -8,28 +8,41 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-Object.defineProperty(exports, "__esModule", { value: true });
 class CacheInterface {
-    get(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return null;
-        });
+    /**
+     * 获取缓存
+     * @param key 缓存名
+     * @returns
+     */
+    get(key) {
+        return __awaiter(this, void 0, void 0, function* () { return null; });
     }
-    has(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return false;
-        });
+    /**
+     * 设置缓存
+     * @param key 缓存名
+     * @returns
+     */
+    has(key) {
+        return __awaiter(this, void 0, void 0, function* () { return false; });
     }
-    set(id, data = null, lifeTime = 0) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return false;
-        });
+    /**
+     * 设置缓存
+     * @param key 缓存名
+     * @param data 数据
+     * @param lifetime 过期时间，单位：秒
+     * @returns
+     */
+    set(key, data = null, lifetime = 0) {
+        return __awaiter(this, void 0, void 0, function* () { return false; });
     }
-    delete(id) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return false;
-        });
+    /**
+     * 删除缓存
+     * @param key 缓存名
+     * @returns
+     */
+    delete(key) {
+        return __awaiter(this, void 0, void 0, function* () { return false; });
     }
 }
-exports.default = CacheInterface;
 ;
+module.exports = CacheInterface;

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

@@ -0,0 +1,29 @@
+import ObjectAccessInterface from "./ObjectAccessInterface";
+declare abstract class ConfigInterface extends ObjectAccessInterface {
+    /**
+     * 获取全部配置项
+     * @returns
+     */
+    all(): object;
+    /**
+     * 判断配置项是否存在
+     * @param key 键名
+     * @returns
+     */
+    has(key: string): boolean;
+    /**
+     * 设置配置项
+     * @param key 键名
+     * @param value 键值
+     * @returns
+     */
+    set(key: string, value: any): void;
+    /**
+     * 获取配置项
+     * @param key 键名
+     * @param defaultValue 配置项不存在时返回的默认值
+     * @returns
+     */
+    get(key: string | string[], defaultValue?: any): any;
+}
+export = ConfigInterface;

package/dist/Core/Contracts/ConfigInterface.js

@@ -0,0 +1,34 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const ObjectAccessInterface_1 = __importDefault(require("./ObjectAccessInterface"));
+class ConfigInterface extends ObjectAccessInterface_1.default {
+    /**
+     * 获取全部配置项
+     * @returns
+     */
+    all() { return null; }
+    /**
+     * 判断配置项是否存在
+     * @param key 键名
+     * @returns
+     */
+    has(key) { return false; }
+    /**
+     * 设置配置项
+     * @param key 键名
+     * @param value 键值
+     * @returns
+     */
+    set(key, value) { }
+    /**
+     * 获取配置项
+     * @param key 键名
+     * @param defaultValue 配置项不存在时返回的默认值
+     * @returns
+     */
+    get(key, defaultValue = null) { return null; }
+}
+;
+module.exports = ConfigInterface;

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

@@ -0,0 +1,31 @@
+/**
+ * 兼容php的ArrayAccess接口
+ */
+declare abstract class ObjectAccessInterface {
+    /**
+     * 判断键是否存在
+     * @param key 键名
+     * @returns
+     */
+    offsetExists(key: any): boolean;
+    /**
+     * 获取键值
+     * @param key 键名
+     * @returns
+     */
+    offsetGet(key: any): any;
+    /**
+     * 设置键值
+     * @param key 键名
+     * @param value 键值
+     * @returns
+     */
+    offsetSet(key: any, value: any): void;
+    /**
+     * 删除键值
+     * @param key 键名
+     * @returns
+     */
+    offsetUnset(key: any): void;
+}
+export = ObjectAccessInterface;

package/dist/Core/Contracts/ObjectAccessInterface.js

@@ -0,0 +1,33 @@
+'use strict';
+/**
+ * 兼容php的ArrayAccess接口
+ */
+class ObjectAccessInterface {
+    /**
+     * 判断键是否存在
+     * @param key 键名
+     * @returns
+     */
+    offsetExists(key) { return false; }
+    /**
+     * 获取键值
+     * @param key 键名
+     * @returns
+     */
+    offsetGet(key) { return null; }
+    /**
+     * 设置键值
+     * @param key 键名
+     * @param value 键值
+     * @returns
+     */
+    offsetSet(key, value) { }
+    /**
+     * 删除键值
+     * @param key 键名
+     * @returns
+     */
+    offsetUnset(key) { }
+}
+;
+module.exports = ObjectAccessInterface;

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

@@ -0,0 +1,9 @@
+import AccessTokenInterface from "./AccessTokenInterface";
+declare abstract class RefreshableAccessToken extends AccessTokenInterface {
+    /**
+     * 刷新token
+     * @returns
+     */
+    refresh(): Promise<string>;
+}
+export = RefreshableAccessToken;

package/dist/{OfficialAccount/Server/Guard.js → Core/Contracts/RefreshableAccessTokenInterface.js}

@@ -11,14 +11,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-const ServerGuard_1 = __importDefault(require("../../Core/ServerGuard"));
-class Guard extends ServerGuard_1.default {
-    shouldReturnRawResponse() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return !((yield this.app.request.get('echostr')) == null);
-        });
+const AccessTokenInterface_1 = __importDefault(require("./AccessTokenInterface"));
+class RefreshableAccessToken extends AccessTokenInterface_1.default {
+    /**
+     * 刷新token
+     * @returns
+     */
+    refresh() {
+        return __awaiter(this, void 0, void 0, function* () { return null; });
     }
 }
-exports.default = Guard;
 ;
+module.exports = RefreshableAccessToken;

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

@@ -0,0 +1,8 @@
+import ResponseInterface from "../Http/Contracts/ResponseInterface";
+declare abstract class ServerInterface {
+    /**
+     * 处理消息
+     */
+    serve(): Promise<ResponseInterface>;
+}
+export = ServerInterface;

package/dist/Core/Contracts/ServerInterface.js

@@ -0,0 +1,20 @@
+'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());
+    });
+};
+class ServerInterface {
+    /**
+     * 处理消息
+     */
+    serve() {
+        return __awaiter(this, void 0, void 0, function* () { return null; });
+    }
+}
+;
+module.exports = ServerInterface;

package/dist/Core/Encryptor.d.ts

@@ -1,12 +1,38 @@
 /// <reference types="node" />
-export default class Encryptor {
+declare class Encryptor {
     protected appId: string;
     protected token: string;
     protected aesKey: Buffer;
     protected blockSize: number;
-    constructor(appId: string, token: string, aesKey: string);
+    protected receiveId: string;
+    constructor(appId: string, token: string, aesKey: string, receiveId?: string);
+    /**
+     * 获取配置的token
+     * @returns
+     */
     getToken(): string;
-    signature(...args: any[]): string;
+    /**
+     * 计算消息签名
+     * @param args
+     * @returns
+     */
+    createSignature(...args: any[]): string;
+    /**
+     * 加密
+     * @param text
+     * @param nonce
+     * @param timestamp
+     * @returns
+     */
     encrypt(text: string, nonce?: string, timestamp?: number): string;
+    /**
+     * 解密
+     * @param text
+     * @param msgSignature
+     * @param nonce
+     * @param timestamp
+     * @returns
+     */
     decrypt(text: string, msgSignature: string, nonce: string, timestamp: number): string;
 }
+export = Encryptor;

package/dist/Core/Encryptor.js

@@ -2,28 +2,45 @@
 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"));
-const Utils_1 = require("./Utils");
-const AES_1 = require("./AES");
-const PKCS_1 = require("./PKCS");
+const Utils_1 = require("./Support/Utils");
+const AES_1 = require("./Support/AES");
+const PKCS_1 = __importDefault(require("./Support/PKCS"));
 class Encryptor {
-    constructor(appId, token, aesKey) {
+    constructor(appId, token, aesKey, receiveId = null) {
         this.appId = null;
         this.token = null;
         this.aesKey = null;
         this.blockSize = 32;
+        this.receiveId = null;
         this.appId = appId;
         this.token = token;
+        this.receiveId = receiveId;
         this.aesKey = Buffer.from(aesKey + '=', 'base64');
     }
+    /**
+     * 获取配置的token
+     * @returns
+     */
     getToken() {
         return this.token;
     }
-    signature(...args) {
+    /**
+     * 计算消息签名
+     * @param args
+     * @returns
+     */
+    createSignature(...args) {
         args.sort();
         return (0, Utils_1.createHash)(args.join(''), 'sha1');
     }
+    /**
+     * 加密
+     * @param text
+     * @param nonce
+     * @param timestamp
+     * @returns
+     */
     encrypt(text, nonce = null, timestamp = null) {
         let encrypted = '';
         try {
@@ -32,7 +49,7 @@ class Encryptor {
             let msg = Buffer.from(text);
             let msgLength = Buffer.alloc(4);
             msgLength.writeUInt32BE(msg.length, 0);
-            let encoded = PKCS_1.PKCS7.pad(Buffer.concat([randomString, msgLength, msg, Buffer.from(this.appId)]), this.blockSize);
+            let encoded = PKCS_1.default.pad(Buffer.concat([randomString, msgLength, msg, Buffer.from(this.appId)]), this.blockSize);
             encrypted = AES_1.AES.encrypt(encoded, this.aesKey, this.aesKey.slice(0, 16), false, 'aes-256-cbc').toString('base64');
         }
         catch (e) {
@@ -44,26 +61,34 @@ class Encryptor {
             timestamp = (0, Utils_1.getTimestamp)();
         let response = {
             Encrypt: encrypted,
-            MsgSignature: this.signature(this.token, timestamp, nonce, encrypted),
+            MsgSignature: this.createSignature(this.token, timestamp, nonce, encrypted),
             TimeStamp: timestamp,
             Nonce: nonce,
         };
         return (0, Utils_1.buildXml)(response);
     }
+    /**
+     * 解密
+     * @param text
+     * @param msgSignature
+     * @param nonce
+     * @param timestamp
+     * @returns
+     */
     decrypt(text, msgSignature, nonce, timestamp) {
-        let signature = this.signature(this.token, nonce, timestamp, text);
+        let signature = this.createSignature(this.token, nonce, timestamp, text);
         if (signature !== msgSignature) {
             throw new Error('Invalid Signature.');
         }
         let deciphered = AES_1.AES.decrypt(Buffer.from(text, 'base64'), this.aesKey, this.aesKey.slice(0, 16), false, 'aes-256-cbc');
-        deciphered = PKCS_1.PKCS7.unpad(deciphered, this.blockSize);
+        deciphered = PKCS_1.default.unpad(deciphered, this.blockSize);
         let content = deciphered.slice(16);
         let length = content.slice(0, 4).readUInt32BE(0);
-        if (content.slice(length + 4).toString() !== this.appId) {
+        if (this.receiveId && content.slice(length + 4).toString() !== this.receiveId) {
             throw new Error('Invalid appId.');
         }
         return content.slice(4, length + 4).toString();
     }
 }
-exports.default = Encryptor;
 ;
+module.exports = Encryptor;

package/dist/Core/Http/Contracts/MessageInterface.d.ts

@@ -0,0 +1,69 @@
+/// <reference types="node" />
+declare abstract class MessageInterface {
+    /**
+     * 获取 HTTP 协议版本，如：'1.1', '1.0'
+     * @returns
+     */
+    getProtocolVersion(): string;
+    /**
+     * 设置 HTTP 协议版本
+     * @param version
+     * @returns
+     */
+    withProtocolVersion(version: string): this;
+    /**
+     * 获取所有headers
+     * @returns
+     */
+    getHeaders(): Record<string, any>;
+    /**
+     * 判断header是否存在
+     * @param name
+     * @returns
+     */
+    hasHeader(name: string): boolean;
+    /**
+     * 获取header
+     * @param name
+     * @returns
+     */
+    getHeader(name: string): any;
+    /**
+     * 获取header，逗号分隔同名header
+     * @param name
+     * @returns
+     */
+    getHeaderLine(name: string): string;
+    /**
+     * 设置header值
+     * @param name
+     * @param value
+     * @returns
+     */
+    withHeader(name: string, value: string | string[]): this;
+    /**
+     * 附加header值
+     * @param name
+     * @param value
+     * @returns
+     */
+    withAddedHeader(name: string, value: string | string[]): this;
+    /**
+     * 删除header
+     * @param name
+     * @returns
+     */
+    withoutHeader(name: string): this;
+    /**
+     * 获取body内容
+     * @returns
+     */
+    getBody(): Buffer;
+    /**
+     * 设置body内容
+     * @param body
+     * @returns
+     */
+    withBody(body: any): this;
+}
+export = MessageInterface;

package/dist/Core/Http/Contracts/MessageInterface.js

@@ -0,0 +1,70 @@
+'use strict';
+class MessageInterface {
+    /**
+     * 获取 HTTP 协议版本，如：'1.1', '1.0'
+     * @returns
+     */
+    getProtocolVersion() { return null; }
+    /**
+     * 设置 HTTP 协议版本
+     * @param version
+     * @returns
+     */
+    withProtocolVersion(version) { return this; }
+    /**
+     * 获取所有headers
+     * @returns
+     */
+    getHeaders() { return null; }
+    /**
+     * 判断header是否存在
+     * @param name
+     * @returns
+     */
+    hasHeader(name) { return false; }
+    /**
+     * 获取header
+     * @param name
+     * @returns
+     */
+    getHeader(name) { return null; }
+    /**
+     * 获取header，逗号分隔同名header
+     * @param name
+     * @returns
+     */
+    getHeaderLine(name) { return null; }
+    /**
+     * 设置header值
+     * @param name
+     * @param value
+     * @returns
+     */
+    withHeader(name, value) { return this; }
+    /**
+     * 附加header值
+     * @param name
+     * @param value
+     * @returns
+     */
+    withAddedHeader(name, value) { return this; }
+    /**
+     * 删除header
+     * @param name
+     * @returns
+     */
+    withoutHeader(name) { return this; }
+    /**
+     * 获取body内容
+     * @returns
+     */
+    getBody() { return null; }
+    /**
+     * 设置body内容
+     * @param body
+     * @returns
+     */
+    withBody(body) { return this; }
+}
+;
+module.exports = MessageInterface;

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

@@ -0,0 +1,37 @@
+import MessageInterface from "./MessageInterface";
+declare abstract class RequestInterface extends MessageInterface {
+    /**
+     * 获取请求路径，默认返回：'/'
+     * @returns
+     */
+    getRequestTarget(): string;
+    /**
+     * 设置请求路径
+     * @param requestTarget
+     * @returns
+     */
+    withRequestTarget(requestTarget: string): this;
+    /**
+     * 获取请求方式
+     * @returns
+     */
+    getMethod(): string;
+    /**
+     * 设置请求方式
+     * @param method
+     * @returns
+     */
+    withMethod(method: string): this;
+    /**
+     * 获取请求地址
+     * @returns
+     */
+    getUri(): string;
+    /**
+     * 设置请求地址
+     * @param uri
+     * @returns
+     */
+    withUri(uri: string): this;
+}
+export = RequestInterface;

package/dist/Core/Http/Contracts/RequestInterface.js

@@ -0,0 +1,42 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const MessageInterface_1 = __importDefault(require("./MessageInterface"));
+class RequestInterface extends MessageInterface_1.default {
+    /**
+     * 获取请求路径，默认返回：'/'
+     * @returns
+     */
+    getRequestTarget() { return null; }
+    /**
+     * 设置请求路径
+     * @param requestTarget
+     * @returns
+     */
+    withRequestTarget(requestTarget) { return this; }
+    /**
+     * 获取请求方式
+     * @returns
+     */
+    getMethod() { return null; }
+    /**
+     * 设置请求方式
+     * @param method
+     * @returns
+     */
+    withMethod(method) { return this; }
+    /**
+     * 获取请求地址
+     * @returns
+     */
+    getUri() { return null; }
+    /**
+     * 设置请求地址
+     * @param uri
+     * @returns
+     */
+    withUri(uri) { return this; }
+}
+;
+module.exports = RequestInterface;

package/dist/Core/Http/Contracts/ResponseInterface.d.ts

@@ -0,0 +1,21 @@
+import MessageInterface from "./MessageInterface";
+declare abstract class ResponseInterface extends MessageInterface {
+    /**
+     * 获取响应状态码
+     * @returns
+     */
+    getStatusCode(): number;
+    /**
+     * 设置响应状态
+     * @param code 状态码
+     * @param reasonPhrase 状态码描述
+     * @returns
+     */
+    withStatus(code: number, reasonPhrase?: string): this;
+    /**
+     * 获取状态码描述
+     * @returns
+     */
+    getReasonPhrase(): string;
+}
+export = ResponseInterface;

package/dist/Core/Http/Contracts/ResponseInterface.js

@@ -0,0 +1,26 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const MessageInterface_1 = __importDefault(require("./MessageInterface"));
+class ResponseInterface extends MessageInterface_1.default {
+    /**
+     * 获取响应状态码
+     * @returns
+     */
+    getStatusCode() { return null; }
+    /**
+     * 设置响应状态
+     * @param code 状态码
+     * @param reasonPhrase 状态码描述
+     * @returns
+     */
+    withStatus(code, reasonPhrase = '') { return this; }
+    /**
+     * 获取状态码描述
+     * @returns
+     */
+    getReasonPhrase() { return null; }
+}
+;
+module.exports = ResponseInterface;