node-easywechat 3.0.0-beta.4 → 3.0.1

package/dist/Pay/Client.js

@@ -0,0 +1,146 @@
+'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.prependData && Object.keys(this.prependData).length > 0) {
+                payload.data = Object.assign(Object.assign({}, this.prependData), payload.data);
+            }
+            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);
+    }
+    /**
+     * 预设置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;
+    }
+}
+;
+(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;

package/dist/Pay/LegacySignature.d.ts

@@ -0,0 +1,12 @@
+import MerchantInterface from "./Contracts/MerchantInterface";
+declare class LegacySignature {
+    protected merchant: MerchantInterface;
+    constructor(merchant: MerchantInterface);
+    /**
+     * V2版本的签名计算，并返回带签名字段的参数集合
+     * @param params 参数集合
+     * @returns
+     */
+    sign(params: Record<string, string | number>): Record<string, string | number>;
+}
+export = LegacySignature;

package/dist/Pay/LegacySignature.js

@@ -0,0 +1,59 @@
+'use strict';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Utils_1 = require("../Core/Support/Utils");
+const merge_1 = __importDefault(require("merge"));
+class LegacySignature {
+    constructor(merchant) {
+        this.merchant = merchant;
+    }
+    /**
+     * V2版本的签名计算，并返回带签名字段的参数集合
+     * @param params 参数集合
+     * @returns
+     */
+    sign(params) {
+        var _a, _b;
+        let nonce = (0, Utils_1.randomString)();
+        let attributes = (0, merge_1.default)(true, {
+            nonce_str: nonce,
+            sub_mch_id: (_a = params['sub_mch_id']) !== null && _a !== void 0 ? _a : null,
+            sub_appid: (_b = params['sub_appid']) !== null && _b !== void 0 ? _b : null,
+        }, params);
+        let signString = '';
+        let sparator = '';
+        let keys = Object.keys(attributes);
+        keys = keys.sort();
+        for (let i = 0; i < keys.length; i++) {
+            if (keys[i] == 'sign' || typeof attributes[keys[i]] === undefined || attributes[keys[i]] === null)
+                continue;
+            signString += sparator + keys[i] + '=' + attributes[keys[i]];
+            sparator = '&';
+        }
+        let key = this.merchant.getV2SecretKey();
+        if (!key) {
+            throw new Error('Missing V2 API key.');
+        }
+        signString += '&key=' + key;
+        let sign = '';
+        let type = params['sign_type'] ? (params['sign_type'] + '').toLowerCase() : 'md5';
+        switch (type) {
+            case 'sha1':
+            case 'md5':
+                sign = (0, Utils_1.createHash)(signString, type);
+                break;
+            case 'hmac-sha256':
+            case 'hmac_sha256':
+                type = type.replace(/^hmac[\-|_]/i, '');
+                sign = (0, Utils_1.createHmac)(signString, key, type);
+                break;
+        }
+        if (!sign) {
+            throw new Error('Failed to sign the request.');
+        }
+        params.sign = (sign + '').toUpperCase();
+        return params;
+    }
+}
+module.exports = LegacySignature;

package/dist/Pay/Merchant.d.ts

@@ -0,0 +1,25 @@
+import { PrivateKey } from "../Core/Support/PrivateKey";
+import { PublicKey } from "../Core/Support/PublicKey";
+import MerchantInterface from "./Contracts/MerchantInterface";
+declare class Merchant implements MerchantInterface {
+    protected mchId: string;
+    protected privateKey: PrivateKey;
+    protected certificate: PublicKey;
+    protected secretKey: string;
+    protected v2SecretKey: string;
+    protected platformCerts: Record<string, PublicKey>;
+    constructor(mchId: string, privateKey: PrivateKey, certificate: PublicKey, secretKey: string, v2SecretKey?: string, platformCerts?: Record<string, string | PublicKey> | string[] | PublicKey[]);
+    /**
+     * 统一规范化平台证书
+     * @param platformCerts 平台证书列表
+     * @returns
+     */
+    protected normalizePlatformCerts(platformCerts: Record<string, string | PublicKey> | string[] | PublicKey[]): Record<string, PublicKey>;
+    getMerchantId(): string;
+    getPrivateKey(): PrivateKey;
+    getSecretKey(): string;
+    getV2SecretKey(): string;
+    getCertificate(): PublicKey;
+    getPlatformCert(serial: string): PublicKey;
+}
+export = Merchant;

package/dist/Pay/Merchant.js

@@ -0,0 +1,53 @@
+'use strict';
+const PublicKey_1 = require("../Core/Support/PublicKey");
+class Merchant {
+    constructor(mchId, privateKey, certificate, secretKey, v2SecretKey = null, platformCerts = []) {
+        this.mchId = mchId;
+        this.privateKey = privateKey;
+        this.certificate = certificate;
+        this.secretKey = secretKey;
+        this.v2SecretKey = v2SecretKey;
+        this.platformCerts = {};
+        this.platformCerts = this.normalizePlatformCerts(platformCerts);
+    }
+    /**
+     * 统一规范化平台证书
+     * @param platformCerts 平台证书列表
+     * @returns
+     */
+    normalizePlatformCerts(platformCerts) {
+        let certs = {};
+        let isArray = Array.isArray(platformCerts);
+        for (let key in platformCerts) {
+            let publicKey = platformCerts[key];
+            if (typeof publicKey === 'string') {
+                publicKey = new PublicKey_1.PublicKey(publicKey);
+            }
+            if (!(publicKey instanceof PublicKey_1.PublicKey)) {
+                throw new Error('Invalid platform certficate.');
+            }
+            certs[isArray ? publicKey.getSerialNo() : key] = publicKey;
+        }
+        return certs;
+    }
+    getMerchantId() {
+        return this.mchId;
+    }
+    getPrivateKey() {
+        return this.privateKey;
+    }
+    getSecretKey() {
+        return this.secretKey;
+    }
+    getV2SecretKey() {
+        return this.v2SecretKey;
+    }
+    getCertificate() {
+        return this.certificate;
+    }
+    getPlatformCert(serial) {
+        var _a;
+        return (_a = this.platformCerts[serial]) !== null && _a !== void 0 ? _a : null;
+    }
+}
+module.exports = Merchant;

package/dist/Pay/Message.d.ts

@@ -0,0 +1,175 @@
+import BaseMessage from '../Core/Message';
+declare class Message extends BaseMessage {
+    getOriginalAttributes(): Record<string, any>;
+    getEventType(): string;
+}
+interface Message {
+    /**
+     * 应用ID
+     */
+    appid: string;
+    /**
+     * 商户号
+     */
+    mchid: string;
+    /**
+     * 商户订单号
+     */
+    out_trade_no: string;
+    /**
+     * 微信支付订单号
+     */
+    transaction_id: string;
+    /**
+     * 交易类型
+     * - `JSAPI` 公众号支付
+     * - `NATIVE` 扫码支付
+     * - `APP` APP支付
+     * - `MICROPAY` 付款码支付
+     * - `MWEB` H5支付
+     * - `FACEPAY` 刷脸支付
+     */
+    trade_type: string;
+    /**
+     * 交易状态
+     * - `SUCCESS` 支付成功
+     * - `REFUND` 转入退款
+     * - `NOTPAY` 未支付
+     * - `CLOSED` 已关闭
+     * - `REVOKED` 已撤销（付款码支付）
+     * - `USERPAYING` 用户支付中（付款码支付）
+     * - `PAYERROR` 支付失败(其他原因，如银行返回失败)
+     */
+    trade_state: string;
+    /**
+     * 交易状态描述
+     */
+    trade_state_desc: string;
+    /**
+     * 付款银行
+     * @see [银行对照表](https://pay.weixin.qq.com/wiki/doc/apiv3/terms_definition/chapter1_1_3.shtml#part-6)
+     */
+    bank_type: string;
+    /**
+     * 附加数据
+     */
+    attach?: string;
+    /**
+     * 支付完成时间。格式：yyyy-MM-DDTHH:mm:ss+TIMEZONE，如：2015-05-20T13:29:35+08:00
+     */
+    success_time: string;
+    /**
+     * 支付者
+     */
+    payer: {
+        /**
+         * 用户标识
+         */
+        openid: string;
+    };
+    /**
+     * 订单金额
+     */
+    amount: {
+        /**
+         * 总金额，单位：分
+         */
+        total: number;
+        /**
+         * 用户支付金额	，单位：分
+         */
+        payer_total: number;
+        /**
+         * 货币类型，如：`CNY` 表示人民币，境内商户号仅支持人民币
+         */
+        currency: string;
+        /**
+         * 用户支付币种，如：`CNY` 表示人民币
+         */
+        payer_currency: string;
+    };
+    /**
+     * 场景信息
+     */
+    scene_info?: {
+        /**
+         * 商户端设备号
+         */
+        device_id?: string;
+    };
+    /**
+     * 优惠信息
+     */
+    promotion_detail?: {
+        /**
+         * 券ID
+         */
+        coupon_id: string;
+        /**
+         * 优惠名称
+         */
+        name?: string;
+        /**
+         * 优惠范围
+         * - `GLOBAL` 全场代金券
+         * - `SINGLE` 单品优惠
+         */
+        scope?: string;
+        /**
+         * 优惠类型
+         * - `CASH` 充值型代金券
+         * - `NOCASH` 免充值型代金券
+         */
+        type?: string;
+        /**
+         * 优惠券面额
+         */
+        amount: number;
+        /**
+         * 活动ID
+         */
+        stock_id?: number;
+        /**
+         * 微信出资，单位：分
+         */
+        wechatpay_contribute?: number;
+        /**
+         * 商户出资，单位：分
+         */
+        merchant_contribute?: number;
+        /**
+         * 其他出资，单位：分
+         */
+        other_contribute?: number;
+        /**
+         * 优惠币种，如：`CNY` 表示人民币，境内商户号仅支持人民币
+         */
+        currency?: string;
+        /**
+         * 单品列表
+         */
+        goods_detail?: {
+            /**
+             * 商品编码
+             */
+            goods_id: string;
+            /**
+             * 商品数量
+             */
+            quantity: number;
+            /**
+             * 商品单价，单位：分
+             */
+            unit_price: number;
+            /**
+             * 商品优惠金额
+             */
+            discount_amount: number;
+            /**
+             * 商品备注
+             */
+            goods_remark: string;
+        }[];
+    };
+}
+export = Message;