node-easywechat 3.0.0-beta.3 → 3.0.0

package/dist/OfficialAccount/Message.d.ts

@@ -1,4 +1,143 @@
 import BaseMessage from '../Core/Message';
 declare class Message extends BaseMessage {
 }
+interface Message {
+    /**
+     * 消息密文，兼容模式、安全模式才有
+     */
+    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/OfficialAccount/Message.js

@@ -5,4 +5,5 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 const Message_1 = __importDefault(require("../Core/Message"));
 class Message extends Message_1.default {
 }
+;
 module.exports = Message;

package/dist/OfficialAccount/Server.js

@@ -28,7 +28,7 @@ class Server extends ServerInterface_1.default {
         return __awaiter(this, void 0, void 0, function* () {
             let echostr = this.request.getQueryParams()['echostr'] || '';
             if (!!echostr) {
-                return new Response_1.default(200, {}, echostr);
+                return new Response_1.default(200, { 'Content-Type': 'text/html' }, echostr);
             }
             let message = yield this.getRequestMessage(this.request);
             let query = this.request.getQueryParams();

package/dist/Pay/Application.d.ts

@@ -0,0 +1,52 @@
+import ConfigInterface from '../Core/Contracts/ConfigInterface';
+import ServerInterface from '../Core/Contracts/ServerInterface';
+import Encryptor from '../Core/Encryptor';
+import CacheMixin from '../Core/Mixins/CacheMixin';
+import ConfigMixin from '../Core/Mixins/ConfigMixin';
+import HttpClientMixin from '../Core/Mixins/HttpClientMixin';
+import ServerRequestMixin from '../Core/Mixins/ServerRequestMixin';
+import { PayConfig } from '../Types/global';
+import MerchantInterface from './Contracts/MerchantInterface';
+import ApplicationInterface from './Contracts/ApplicationInterface';
+import Utils from './Utils';
+import HttpClientInterface from '../Core/HttpClient/Contracts/HttpClientInterface';
+/**
+ * 微信支付应用
+ */
+declare class Application implements ApplicationInterface {
+    constructor(config: ConfigInterface | PayConfig);
+    protected merchant: MerchantInterface;
+    protected encryptor: Encryptor;
+    protected server: ServerInterface;
+    protected client: HttpClientInterface;
+    getMerchant(): MerchantInterface;
+    /**
+     * 设置当前账户实例
+     * @param merchant
+     * @returns
+     */
+    setMerchant(merchant: MerchantInterface): this;
+    getServer(): ServerInterface;
+    /**
+     * 设置服务端实例
+     * @param server
+     * @returns
+     */
+    setServer(server: ServerInterface): this;
+    getUtils(): Utils;
+    getClient(): HttpClientInterface;
+    /**
+     * 设置客户端
+     * @param client
+     * @returns
+     */
+    setClient(client: HttpClientInterface): this;
+    /**
+     * 获取请求默认配置
+     * @returns
+     */
+    protected getHttpClientDefaultOptions(): Record<string, any>;
+}
+interface Application extends ConfigMixin, CacheMixin, ServerRequestMixin, HttpClientMixin {
+}
+export = Application;

package/dist/Pay/Application.js

@@ -0,0 +1,96 @@
+'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 CacheMixin_1 = __importDefault(require("../Core/Mixins/CacheMixin"));
+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 Merchant_1 = __importDefault(require("./Merchant"));
+const Server_1 = __importDefault(require("./Server"));
+const Utils_2 = __importDefault(require("./Utils"));
+const Config_1 = __importDefault(require("../OfficialAccount/Config"));
+const PrivateKey_1 = require("../Core/Support/PrivateKey");
+const PublicKey_1 = require("../Core/Support/PublicKey");
+const Client_1 = __importDefault(require("./Client"));
+/**
+ * 微信支付应用
+ */
+class Application {
+    constructor(config) {
+        this.merchant = null;
+        this.encryptor = null;
+        this.server = null;
+        if (config instanceof ConfigInterface_1.default) {
+            this.setConfig(config);
+        }
+        else {
+            this.setConfig(new Config_1.default(config));
+        }
+    }
+    getMerchant() {
+        var _a;
+        if (!this.merchant) {
+            this.merchant = new Merchant_1.default(this.config.get('mch_id'), new PrivateKey_1.PrivateKey(this.config.get('private_key')), new PublicKey_1.PublicKey(this.config.get('certificate')), this.config.get('secret_key'), this.config.get('v2_secret_key'), (_a = this.config.get('platform_certs')) !== null && _a !== void 0 ? _a : []);
+        }
+        return this.merchant;
+    }
+    /**
+     * 设置当前账户实例
+     * @param merchant
+     * @returns
+     */
+    setMerchant(merchant) {
+        this.merchant = merchant;
+        return this;
+    }
+    getServer() {
+        if (!this.server) {
+            this.server = new Server_1.default(this.getMerchant(), this.getRequest());
+        }
+        return this.server;
+    }
+    /**
+     * 设置服务端实例
+     * @param server
+     * @returns
+     */
+    setServer(server) {
+        this.server = server;
+        return this;
+    }
+    getUtils() {
+        return new Utils_2.default(this.getMerchant());
+    }
+    getClient() {
+        if (!this.client) {
+            this.client = (new Client_1.default(this.getMerchant(), this.getHttpClient(), this.config.get('http', {}))).setPresets(this.config.all());
+        }
+        return this.client;
+    }
+    /**
+     * 设置客户端
+     * @param client
+     * @returns
+     */
+    setClient(client) {
+        this.client = client;
+        return this;
+    }
+    /**
+     * 获取请求默认配置
+     * @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, ServerRequestMixin_1.default, HttpClientMixin_1.default]);
+module.exports = Application;

package/dist/Pay/Client.d.ts

@@ -0,0 +1,42 @@
+import { Method, AxiosRequestConfig, AxiosInstance } from "axios";
+import HttpClientInterface from "../Core/HttpClient/Contracts/HttpClientInterface";
+import HttpClientMethodsMixin from '../Core/HttpClient/Mixins/HttpClientMethodsMixin';
+import { LogHandler } from '../Types/global';
+import HttpClientResponse from '../Core/HttpClient/HttpClientResponse';
+import PresetMixin from '../Core/HttpClient/Mixins/PresetMixin';
+import MerchantInterface from './Contracts/MerchantInterface';
+declare class Client implements HttpClientInterface {
+    protected merchant: MerchantInterface;
+    protected throw: boolean;
+    protected client: HttpClientInterface;
+    protected defaultOptions: AxiosRequestConfig<any>;
+    V3_URI_PREFIXES: string[];
+    constructor(merchant: MerchantInterface, client: HttpClientInterface, defaultOptions?: Record<string, any>);
+    getInstance(): AxiosInstance;
+    setInstance(instance: AxiosInstance): this;
+    setLogger(logger: LogHandler): this;
+    request(method: Method, url: string, payload?: AxiosRequestConfig<any>): Promise<HttpClientResponse>;
+    /**
+     * 判断是否是V3请求
+     * @param url 请求地址
+     * @returns
+     */
+    protected isV3Request(url: string): boolean;
+    /**
+     * 创建签名（V3）
+     * @param method 请求方式
+     * @param url 请求地址
+     * @param payload 请求载荷
+     * @returns
+     */
+    protected createSignature(method: string, url: string, payload: AxiosRequestConfig<any>): string;
+    /**
+     * 创建签名（V2）
+     * @param body 请求参数
+     * @returns
+     */
+    protected attachLegacySignature(body: Record<string, any>): Record<string, string | number>;
+}
+interface Client extends HttpClientMethodsMixin, PresetMixin {
+}
+export = Client;

package/dist/Pay/Client.js

@@ -0,0 +1,125 @@
+'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 merge_1 = __importDefault(require("merge"));
+const Utils_1 = require("../Core/Support/Utils");
+const HttpClient_1 = __importDefault(require("../Core/HttpClient/HttpClient"));
+const HttpClientMethodsMixin_1 = __importDefault(require("../Core/HttpClient/Mixins/HttpClientMethodsMixin"));
+const PresetMixin_1 = __importDefault(require("../Core/HttpClient/Mixins/PresetMixin"));
+const url_1 = __importDefault(require("url"));
+const Signature_1 = __importDefault(require("./Signature"));
+const LegacySignature_1 = __importDefault(require("./LegacySignature"));
+class Client {
+    constructor(merchant, client, defaultOptions = {}) {
+        var _a;
+        this.merchant = merchant;
+        this.throw = true;
+        this.client = null;
+        this.defaultOptions = {
+            baseURL: 'https://api.mch.weixin.qq.com',
+            headers: {
+                'Content-Type': 'application/json',
+                'Accept': 'application/json',
+            },
+        };
+        this.V3_URI_PREFIXES = [
+            '/v3/',
+            '/sandbox/v3/',
+            '/hk/v3/',
+            '/global/v3/',
+        ];
+        this.throw = !!((_a = defaultOptions['throw']) !== null && _a !== void 0 ? _a : true);
+        this.defaultOptions = merge_1.default.recursive(true, this.defaultOptions, defaultOptions);
+        this.client = client || HttpClient_1.default.create();
+    }
+    getInstance() {
+        return this.client.getInstance();
+    }
+    setInstance(instance) {
+        this.client.setInstance(instance);
+        return this;
+    }
+    setLogger(logger) {
+        this.client.setLogger(logger);
+        return this;
+    }
+    request(method, url, payload = {}) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!payload.headers)
+                payload.headers = {};
+            if (!payload.headers['user-agent'] && !payload.headers['User-Agent']) {
+                payload.headers['user-agent'] = (0, Utils_1.createUserAgent)();
+            }
+            if (this.isV3Request(url)) {
+                payload.headers['authorization'] = this.createSignature(method, url, payload);
+            }
+            else {
+                if (payload.xml) {
+                    if (Array.isArray(payload.xml)) {
+                        payload.xml = (0, Utils_1.buildXml)(this.attachLegacySignature(payload.xml));
+                    }
+                    if (typeof payload.xml !== 'string') {
+                        throw new Error('The `xml` option must be a string or object.');
+                    }
+                    payload.data = payload.xml;
+                    delete payload.xml;
+                }
+                if (payload.data && typeof payload.data === 'object') {
+                    payload.data = (0, Utils_1.buildXml)(this.attachLegacySignature(payload.data));
+                }
+                if (!payload.headers['content-type'] && !payload.headers['Content-Type']) {
+                    payload.headers['content-type'] = 'text/xml';
+                }
+            }
+            if (this.prependHeaders && Object.keys(this.prependHeaders).length > 0) {
+                payload.headers = Object.assign(Object.assign({}, this.prependHeaders), payload.headers);
+            }
+            return this.client.request(method, (0, Utils_1.ltrim)(url, '\\/+'), payload);
+        });
+    }
+    /**
+     * 判断是否是V3请求
+     * @param url 请求地址
+     * @returns
+     */
+    isV3Request(url) {
+        let urlObj = url_1.default.parse(url);
+        for (let i = 0; i < this.V3_URI_PREFIXES.length; i++) {
+            if (urlObj.pathname.startsWith(this.V3_URI_PREFIXES[i])) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * 创建签名（V3）
+     * @param method 请求方式
+     * @param url 请求地址
+     * @param payload 请求载荷
+     * @returns
+     */
+    createSignature(method, url, payload) {
+        return (new Signature_1.default(this.merchant)).createHeader(method, url, payload);
+    }
+    /**
+     * 创建签名（V2）
+     * @param body 请求参数
+     * @returns
+     */
+    attachLegacySignature(body) {
+        return (new LegacySignature_1.default(this.merchant)).sign(body);
+    }
+}
+;
+(0, Utils_1.applyMixins)(Client, [HttpClientMethodsMixin_1.default, PresetMixin_1.default]);
+module.exports = Client;

package/dist/Pay/Config.d.ts

@@ -0,0 +1,5 @@
+import BaseConfig from '../Core/Config';
+declare class Config extends BaseConfig {
+    protected requiredKeys: string[];
+}
+export = Config;

package/dist/Pay/Config.js

@@ -0,0 +1,17 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Config_1 = __importDefault(require("../Core/Config"));
+class Config extends Config_1.default {
+    constructor() {
+        super(...arguments);
+        this.requiredKeys = [
+            'mch_id',
+            'secret_key',
+            'private_key',
+            'certificate',
+        ];
+    }
+}
+module.exports = Config;

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

@@ -0,0 +1,50 @@
+import CacheInterface from "../../Core/Contracts/CacheInterface";
+import ConfigInterface from "../../Core/Contracts/ConfigInterface";
+import HttpClientInterface from "../../Core/HttpClient/Contracts/HttpClientInterface";
+import ServerInterface from "../../Core/Contracts/ServerInterface";
+import ServerRequestInterface from "../../Core/Http/Contracts/ServerRequestInterface";
+import MerchantInterface from "./MerchantInterface";
+import Utils from "../Utils";
+declare abstract class ApplicationInterface {
+    /**
+     * 获取当前账户实例
+     * @returns
+     */
+    getMerchant(): MerchantInterface;
+    /**
+     * 获取服务端实例
+     * @returns
+     */
+    getServer(): ServerInterface;
+    /**
+     * 获取当前请求实例
+     * @returns
+     */
+    getRequest(): ServerRequestInterface;
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient(): HttpClientInterface;
+    /**
+     * 获取网络请求客户端实例
+     * @returns
+     */
+    getHttpClient(): HttpClientInterface;
+    /**
+     * 获取配置信息实例
+     * @returns
+     */
+    getConfig(): ConfigInterface;
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache(): CacheInterface;
+    /**
+     * 获取工具实例
+     * @returns
+     */
+    getUtils(): Utils;
+}
+export = ApplicationInterface;

package/dist/Pay/Contracts/ApplicationInterface.js

@@ -0,0 +1,45 @@
+'use strict';
+class ApplicationInterface {
+    /**
+     * 获取当前账户实例
+     * @returns
+     */
+    getMerchant() { return null; }
+    /**
+     * 获取服务端实例
+     * @returns
+     */
+    getServer() { return null; }
+    /**
+     * 获取当前请求实例
+     * @returns
+     */
+    getRequest() { return null; }
+    /**
+     * 获取客户端实例
+     * @returns
+     */
+    getClient() { return null; }
+    /**
+     * 获取网络请求客户端实例
+     * @returns
+     */
+    getHttpClient() { return null; }
+    /**
+     * 获取配置信息实例
+     * @returns
+     */
+    getConfig() { return null; }
+    /**
+     * 获取缓存实例
+     * @returns
+     */
+    getCache() { return null; }
+    /**
+     * 获取工具实例
+     * @returns
+     */
+    getUtils() { return null; }
+}
+;
+module.exports = ApplicationInterface;

package/dist/Pay/Contracts/MerchantInterface.d.ts

@@ -0,0 +1,35 @@
+import { PrivateKey } from "../../Core/Support/PrivateKey";
+import { PublicKey } from "../../Core/Support/PublicKey";
+declare abstract class MerchantInterface {
+    /**
+     * 获取merchant_id
+     * @returns
+     */
+    getMerchantId(): string;
+    /**
+     * 获取证书私钥
+     */
+    getPrivateKey(): PrivateKey;
+    /**
+     * 获取secret_key
+     * @returns
+     */
+    getSecretKey(): string;
+    /**
+     * 获取secret_key（V2版本）
+     * @returns
+     */
+    getV2SecretKey(): string;
+    /**
+     * 获取证书
+     * @returns
+     */
+    getCertificate(): PublicKey;
+    /**
+     * 获取平台证书
+     * @param serial
+     * @returns
+     */
+    getPlatformCert(serial: string): PublicKey;
+}
+export = MerchantInterface;

package/dist/Pay/Contracts/MerchantInterface.js

@@ -0,0 +1,35 @@
+'use strict';
+class MerchantInterface {
+    /**
+     * 获取merchant_id
+     * @returns
+     */
+    getMerchantId() { return null; }
+    /**
+     * 获取证书私钥
+     */
+    getPrivateKey() { return null; }
+    /**
+     * 获取secret_key
+     * @returns
+     */
+    getSecretKey() { return null; }
+    /**
+     * 获取secret_key（V2版本）
+     * @returns
+     */
+    getV2SecretKey() { return null; }
+    /**
+     * 获取证书
+     * @returns
+     */
+    getCertificate() { return null; }
+    /**
+     * 获取平台证书
+     * @param serial
+     * @returns
+     */
+    getPlatformCert(serial) { return null; }
+}
+;
+module.exports = MerchantInterface;

package/dist/Pay/Contracts/ResponseValidatorInterface.d.ts

@@ -0,0 +1,9 @@
+import ResponseInterface from "../../Core/Http/Contracts/ResponseInterface";
+declare abstract class ResponseValidatorInterface {
+    /**
+     * 验证响应对象
+     * @returns
+     */
+    validate(response: ResponseInterface): void;
+}
+export = ResponseValidatorInterface;

package/dist/Pay/Contracts/ResponseValidatorInterface.js

@@ -0,0 +1,10 @@
+'use strict';
+class ResponseValidatorInterface {
+    /**
+     * 验证响应对象
+     * @returns
+     */
+    validate(response) { }
+}
+;
+module.exports = ResponseValidatorInterface;