node-easywechat 3.0.0-beta.3 → 3.0.0

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;

package/dist/Pay/Message.js

@@ -0,0 +1,24 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const Message_1 = __importDefault(require("../Core/Message"));
+class Message extends Message_1.default {
+    getOriginalAttributes() {
+        let attributes = {};
+        try {
+            attributes = JSON.parse(this.originContent);
+        }
+        catch (e) { }
+        return attributes;
+    }
+    getEventType() {
+        let eventType = this.getOriginalAttributes()['event_type'];
+        if (typeof eventType !== 'string') {
+            throw new Error('Invalid event type.');
+        }
+        return eventType;
+    }
+}
+;
+module.exports = Message;

package/dist/Pay/Server.d.ts

@@ -0,0 +1,41 @@
+import ServerInterface from '../Core/Contracts/ServerInterface';
+import Response from '../Core/Http/Response';
+import ServerRequestInterface from '../Core/Http/Contracts/ServerRequestInterface';
+import MerchantInterface from './Contracts/MerchantInterface';
+import Message from './Message';
+import { ServerHandlerClosure } from '../Types/global';
+declare class Server extends ServerInterface {
+    protected merchant: MerchantInterface;
+    protected request: ServerRequestInterface;
+    constructor(merchant?: MerchantInterface, request?: ServerRequestInterface);
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve(): Promise<Response>;
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request?: ServerRequestInterface): Promise<Message>;
+    /**
+     * 获取解密后的消息
+     * @param request
+     * @returns
+     */
+    getDecryptedMessage(request?: ServerRequestInterface): Promise<Message>;
+    /**
+     * 处理付款回调
+     * @param handler 消息处理器，需要接受两个参数，参数1是消息，参数2是下一个消息处理器
+     * @returns
+     */
+    handlePaid(handler: ServerHandlerClosure): this;
+    /**
+     * 处理退款回调
+     * @param handler 消息处理器，需要接受两个参数，参数1是消息，参数2是下一个消息处理器
+     * @returns
+     */
+    handleRefunded(handler: ServerHandlerClosure): this;
+}
+export = Server;

package/dist/Pay/Server.js

@@ -0,0 +1,122 @@
+'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 ServerInterface_1 = __importDefault(require("../Core/Contracts/ServerInterface"));
+const Response_1 = __importDefault(require("../Core/Http/Response"));
+const Message_1 = __importDefault(require("./Message"));
+const AES_1 = require("../Core/Support/AES");
+class Server extends ServerInterface_1.default {
+    constructor(merchant = null, request = null) {
+        super();
+        this.merchant = merchant;
+        this.request = request;
+    }
+    /**
+     * 服务端消息处理
+     * @returns
+     */
+    serve() {
+        return __awaiter(this, void 0, void 0, function* () {
+            let message = yield this.getRequestMessage();
+            try {
+                let defaultResponse = new Response_1.default(200, {}, JSON.stringify({
+                    code: 'SUCCESS', message: '成功',
+                }));
+                let response = yield this.handle(defaultResponse, message);
+                if (!(response instanceof Response_1.default)) {
+                    response = defaultResponse;
+                }
+                return response;
+            }
+            catch (e) {
+                return new Response_1.default(200, {}, JSON.stringify({
+                    code: 'ERROR', message: e.message,
+                }));
+            }
+        });
+    }
+    /**
+     * 获取来自微信服务器的推送消息
+     * @param request 未设置该参数时，则从当前服务端收到的请求中获取
+     * @returns
+     */
+    getRequestMessage(request = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!request) {
+                request = this.request;
+            }
+            let originContent = '';
+            let body = request.getBody();
+            if (body) {
+                originContent = body.toString();
+            }
+            let attributes = {};
+            try {
+                attributes = JSON.parse(originContent);
+            }
+            catch (e) { }
+            if (Object.keys(attributes).length === 0) {
+                throw new Error('Invalid request body.');
+            }
+            if (!attributes['resource']['ciphertext']) {
+                throw new Error('Invalid request.');
+            }
+            try {
+                let decryptMessage = AES_1.AES_GCM.decrypt(attributes['resource']['ciphertext'], this.merchant.getSecretKey(), attributes['resource']['nonce'], attributes['resource']['associated_data']);
+                attributes = JSON.parse(decryptMessage.toString());
+            }
+            catch (e) {
+                throw new Error('Failed to decrypt request message.');
+            }
+            return new Message_1.default(attributes, originContent);
+        });
+    }
+    /**
+     * 获取解密后的消息
+     * @param request
+     * @returns
+     */
+    getDecryptedMessage(request = null) {
+        return this.getRequestMessage(request);
+    }
+    /**
+     * 处理付款回调
+     * @param handler 消息处理器，需要接受两个参数，参数1是消息，参数2是下一个消息处理器
+     * @returns
+     */
+    handlePaid(handler) {
+        this.with((message, next) => __awaiter(this, void 0, void 0, function* () {
+            return message.getEventType() === 'TRANSACTION.SUCCESS' && message.trade_state === 'SUCCESS'
+                ? handler(message, next) : next(message);
+        }));
+        return this;
+    }
+    /**
+     * 处理退款回调
+     * @param handler 消息处理器，需要接受两个参数，参数1是消息，参数2是下一个消息处理器
+     * @returns
+     */
+    handleRefunded(handler) {
+        this.with((message, next) => __awaiter(this, void 0, void 0, function* () {
+            let eventType = message.getEventType();
+            return [
+                'REFUND.SUCCESS',
+                'REFUND.ABNORMAL',
+                'REFUND.CLOSED',
+            ].findIndex(o => o === eventType) > -1 ? handler(message, next) : next(message);
+        }));
+        return this;
+    }
+}
+;
+module.exports = Server;

package/dist/Pay/Signature.d.ts

@@ -0,0 +1,15 @@
+import MerchantInterface from "./Contracts/MerchantInterface";
+import { AxiosRequestConfig } from "axios";
+declare class Signature {
+    protected merchant: MerchantInterface;
+    constructor(merchant: MerchantInterface);
+    /**
+     * V3版本的签名计算
+     * @param method 请求方式
+     * @param url 请求地址
+     * @param payload 请求载荷
+     * @returns
+     */
+    createHeader(method: string, url: string, payload: AxiosRequestConfig<any>): string;
+}
+export = Signature;

package/dist/Pay/Signature.js

@@ -0,0 +1,44 @@
+'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"));
+const url_1 = __importDefault(require("url"));
+const RSA_1 = __importDefault(require("../Core/Support/RSA"));
+class Signature {
+    constructor(merchant) {
+        this.merchant = merchant;
+    }
+    /**
+     * V3版本的签名计算
+     * @param method 请求方式
+     * @param url 请求地址
+     * @param payload 请求载荷
+     * @returns
+     */
+    createHeader(method, url, payload) {
+        let uri = url_1.default.parse(url);
+        let query = (0, Utils_1.parseQueryString)(uri.query);
+        uri.query = (0, Utils_1.buildQueryString)((0, merge_1.default)(true, query, payload.params));
+        let nonce = (0, Utils_1.randomString)();
+        let timestamp = (0, Utils_1.getTimestamp)();
+        let path = uri.pathname + (uri.query ? '?' + uri.query : '');
+        let body = '';
+        if (payload.data) {
+            if (typeof payload.data === 'object') {
+                body = JSON.stringify(payload.data);
+            }
+            else {
+                body = payload.data;
+            }
+        }
+        let signString = `${method.toUpperCase()}\n${path}\n${timestamp}\n${nonce}\n${body}`;
+        let rsa = new RSA_1.default;
+        rsa.setPublicKey(this.merchant.getCertificate().toString());
+        rsa.setPrivateKey(this.merchant.getPrivateKey().toString());
+        let sign = rsa.sign(signString);
+        return `WECHATPAY2-SHA256-RSA2048 mchid="${this.merchant.getMerchantId()}",nonce_str="${nonce}",timestamp="${timestamp}",serial_no="${this.merchant.getCertificate().getSerialNo()}",signature="${sign}"`;
+    }
+}
+module.exports = Signature;

package/dist/Pay/Utils.d.ts

@@ -0,0 +1,54 @@
+import { PayAppConfig, PayBridgeConfig, PaySdkConfig } from '../Types/global';
+import MerchantInterface from './Contracts/MerchantInterface';
+declare class Utils {
+    protected merchant: MerchantInterface;
+    constructor(merchant: MerchantInterface);
+    /**
+     * 创建签名（V3），并返回签名字符串
+     * @param params 参数集合
+     * @returns
+     */
+    protected createSignature(message: string): string;
+    /**
+     * 创建签名（V2），并返回签名字符串
+     * @param params 参数集合
+     * @returns
+     */
+    createV2Signature(params: Record<string, string | number>): string;
+    /**
+     * 构建JSBridge支付参数
+     * @see [v3文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_1_4.shtml)
+     * @see [v2文档](https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=7_7&index=6)
+     * @param prepayId 下单接口返回的prepay_id
+     * @param appId 应用id
+     * @param signType v3仅支持RSA，V2支持MD5、HMAC-SHA256
+     * @returns
+     */
+    buildBridgeConfig(prepayId: string, appId: string, signType?: string): PayBridgeConfig;
+    /**
+     * 构建JS-SDK支付参数
+     * @see https://developers.weixin.qq.com/doc/offiaccount/OA_Web_Apps/JS-SDK.html#58
+     * @param prepayId 下单接口返回的prepay_id
+     * @param appId 应用id
+     * @param signType v3仅支持RSA，V2支持MD5、HMAC-SHA256
+     */
+    buildSdkConfig(prepayId: string, appId: string, signType?: string): PaySdkConfig;
+    /**
+     * 构建小程序支付参数
+     * @see https://developers.weixin.qq.com/miniprogram/dev/api/payment/wx.requestPayment.html
+     * @param prepayId 下单接口返回的prepay_id
+     * @param appId 应用id
+     * @param signType v3仅支持RSA，V2支持MD5、HMAC-SHA256
+     * @returns
+     */
+    buildMiniAppConfig(prepayId: string, appId: string, signType?: string): PayBridgeConfig;
+    /**
+     * 构建App支付参数
+     * @see https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter4_2_4.shtml
+     * @param prepayId 下单接口返回的prepay_id
+     * @param appId 应用id
+     * @returns
+     */
+    buildAppConfig(prepayId: string, appId: string): PayAppConfig;
+}
+export = Utils;