node-easywechat 3.1.0 → 3.1.2

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # CHANGELOG
 
 
+## v3.1.2 (2022-12-06)
+
+- Feat: 新作微信支付模块的文件上传方法
+
+- Fix: nodejs版本不能低于15.6.0
+- Fix: 更新依赖的nodejs版本
+- Fix: 修复RSA证书使用格式不正确导致的签名异常问题
+
+## v3.1.1 (2022-11-15)
+
+- Feat: 增加请求失败时的重试机制，具体见配置项http.retry
+
 ## v3.1.0 (2022-11-09)
 
 - Feat: 新增开放平台模块
@@ -9,6 +21,8 @@
 - Fix: 修复配置项类型判断异常的问题
 - Fix: 修复请求客户端无法设置请求是否错误判断逻辑的方法
 
+- Docs: 增加开放平台的说明
+
 - Perf: 优化url路径解析方法
 
 ## v3.0.1 (2022-08-26)

package/README.md

@@ -16,6 +16,8 @@
 
 `npm install -S node-easywechat@next`
 
+**注：3.x 版本需要 Node.js 15.6.0 及以上版本**
+
 ### 使用说明
 
 绝大部分API都可以根据 [EasyWechat 的文档](https://www.easywechat.com/5.x/) 来使用。小部分（如获取请求相关数据、返回响应数据、支付证书等）的操作，由于语言环境的不同，会有不同处理。具体可以查看 [node-easywechat-demo](https://github.com/hpyer/node-easywechat-demo/) 以及下方的[自定义模块说明](#自定义模块模块替换使用方法) 。如果仍有疑问，请提issue，谢谢～
@@ -78,7 +80,11 @@ let data = response.toObject();
 {
   // axios 请求参数
   // 详见：https://github.com/axios/axios#request-config
-  http: {},
+  http: {
+    // 请求失败时，自动重试。默认不重试
+    // 详见：https://github.com/softonic/axios-retry#options
+    retry: {}
+  },
 
   // 缓存以文件(默认设置)存储时，需要的配置项
   file_cache: {

package/dist/Core/HttpClient/HttpClient.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
 import HttpClientInterface from './Contracts/HttpClientInterface';
 import HttpClientResponse from './HttpClientResponse';
-import { HttpClientFailureJudgeClosure, LogHandler } from '../../Types/global';
+import { HttpClientFailureJudgeClosure, HttpConfig, LogHandler } from '../../Types/global';
 import FormData from 'form-data';
 declare class HttpClient implements HttpClientInterface {
     protected axios: AxiosInstance;
@@ -28,6 +28,6 @@ declare class HttpClient implements HttpClientInterface {
      * @param config
      * @returns
      */
-    static create(config?: AxiosRequestConfig, failureJudge?: HttpClientFailureJudgeClosure, throwError?: boolean): HttpClient;
+    static create(config?: HttpConfig, failureJudge?: HttpClientFailureJudgeClosure, throwError?: boolean): HttpClient;
 }
 export = HttpClient;

package/dist/Core/HttpClient/HttpClient.js

@@ -15,6 +15,7 @@ const axios_1 = __importDefault(require("axios"));
 const HttpClientResponse_1 = __importDefault(require("./HttpClientResponse"));
 const Utils_1 = require("../Support/Utils");
 const form_data_1 = __importDefault(require("form-data"));
+const axios_retry_1 = __importDefault(require("axios-retry"));
 class HttpClient {
     constructor(axios, failureJudge = null, throwError = false) {
         this.axios = axios;
@@ -78,8 +79,13 @@ class HttpClient {
             }
             if (options['formData'] && Object.keys(options['formData']).length > 0) {
                 let formData = new form_data_1.default();
-                for (let key in options['formData']) {
-                    formData.append(key, options['formData'][key]);
+                if (options['formData'] instanceof form_data_1.default) {
+                    formData = options['formData'];
+                }
+                else {
+                    for (let key in options['formData']) {
+                        formData.append(key, options['formData'][key]);
+                    }
                 }
                 if (options.data)
                     for (let key in options.data) {
@@ -139,7 +145,11 @@ class HttpClient {
      * @returns
      */
     static create(config = null, failureJudge = null, throwError = false) {
-        return new HttpClient(axios_1.default.create(config), failureJudge, throwError);
+        let axios = axios_1.default.create(config);
+        if (config && config.retry) {
+            (0, axios_retry_1.default)(axios, config.retry);
+        }
+        return new HttpClient(axios, failureJudge, throwError);
     }
 }
 module.exports = HttpClient;

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

@@ -1,12 +1,13 @@
+/// <reference types="node" />
 export declare class PrivateKey {
-    protected key: string;
     protected passphrase?: string;
+    protected key: Buffer;
     constructor(key: string, passphrase?: string);
     /**
-     * 获取私钥
+     * 获取私钥内容
      * @returns
      */
-    getKey(): string;
+    getKey(): Buffer;
     /**
      * 获取密码
      * @returns
@@ -16,5 +17,5 @@ export declare class PrivateKey {
      * 转为字符串
      * @returns
      */
-    toString(): string;
+    toString(): Buffer;
 }

package/dist/Core/Support/PrivateKey.js

@@ -7,14 +7,13 @@ 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') || '';
+            this.key = fs_1.default.readFileSync(key) || Buffer.from('');
         }
     }
     /**
-     * 获取私钥
+     * 获取私钥内容
      * @returns
      */
     getKey() {

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

@@ -1,11 +1,17 @@
+/// <reference types="node" />
 export declare class PublicKey {
-    certificate: string;
+    protected certificate: Buffer;
     constructor(certificate: string);
     /**
      * 获取公钥的序列号
      * @returns
      */
     getSerialNo(): string;
+    /**
+     * 获取证书内容
+     * @returns
+     */
+    getValue(): Buffer;
     /**
      * 转为字符串
      * @returns

package/dist/Core/Support/PublicKey.js

@@ -8,9 +8,8 @@ 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') || '';
+            this.certificate = fs_1.default.readFileSync(certificate) || Buffer.from('');
         }
     }
     /**
@@ -25,12 +24,19 @@ class PublicKey {
             throw new Error('Read the $certificate failed, please check it whether or nor correct');
         }
     }
+    /**
+     * 获取证书内容
+     * @returns
+     */
+    getValue() {
+        return this.certificate;
+    }
     /**
      * 转为字符串
      * @returns
      */
     toString() {
-        return this.certificate;
+        return this.certificate.toString();
     }
 }
 exports.PublicKey = PublicKey;

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

@@ -1,11 +1,12 @@
+import Crypto from 'crypto';
 import Stream from 'stream';
-export declare const createHash: (str: string, type?: string) => any;
-export declare const createHmac: (str: string, key: string, type?: string) => any;
+export declare const createHash: (str: Crypto.BinaryLike, type?: string, target?: Crypto.BinaryToTextEncoding) => any;
+export declare const createHmac: (str: Crypto.BinaryLike, key: Crypto.BinaryLike, type?: string, target?: Crypto.BinaryToTextEncoding) => any;
 /**
- * 计算文件的 md5 值
+ * 计算文件的哈希值
  * @param path 文件路径或文件可读流
  */
-export declare const md5File: (path: string | Stream.Readable) => Promise<string>;
+export declare const createFileHash: (path: string | Stream.Readable, type?: string, target?: Crypto.BinaryToTextEncoding) => Promise<string>;
 export declare const getTimestamp: (datetime?: string) => number;
 export declare const buildQueryString: (data: Record<string, any>, options?: Record<string, any>) => string;
 export declare const parseQueryString: (data: string, options?: Record<string, any>) => Record<string, any>;

package/dist/Core/Support/Utils.js

@@ -12,26 +12,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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.createFileHash = 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');
+const createHash = function (str, type = 'sha1', target = 'hex') {
+    return crypto_1.default.createHash(type).update(str).digest(target);
 };
 exports.createHash = createHash;
-const createHmac = function (str, key, type = 'sha256') {
-    return crypto_1.default.createHmac(type, key).update(str).digest('hex');
+const createHmac = function (str, key, type = 'sha256', target = 'hex') {
+    return crypto_1.default.createHmac(type, key).update(str).digest(target);
 };
 exports.createHmac = createHmac;
 /**
- * 计算文件的 md5 值
+ * 计算文件的哈希值
  * @param path 文件路径或文件可读流
  */
-const md5File = function (path) {
+const createFileHash = function (path, type = 'sha1', target = 'hex') {
     return new Promise((reslove, reject) => {
         let stream;
         if ((0, exports.isString)(path)) {
@@ -41,17 +41,17 @@ const md5File = function (path) {
             stream = new stream_1.default.PassThrough();
             path.pipe(stream);
         }
-        let md5sum = crypto_1.default.createHash('md5');
+        let md5sum = crypto_1.default.createHash(type);
         stream.on('data', function (chunk) {
             md5sum.update(chunk);
         });
         stream.on('end', function () {
-            let str = md5sum.digest('hex').toUpperCase();
+            let str = md5sum.digest(target).toUpperCase();
             reslove(str);
         });
     });
 };
-exports.md5File = md5File;
+exports.createFileHash = createFileHash;
 const getTimestamp = function (datetime = null) {
     let time;
     try {

package/dist/Pay/Application.js

@@ -13,8 +13,6 @@ 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"));
 /**
  * 微信支付应用
@@ -34,7 +32,7 @@ class Application {
     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 : []);
+            this.merchant = new Merchant_1.default(this.config.get('mch_id'), this.config.get('private_key'), 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;
     }

package/dist/Pay/Client.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="node" />
+import fs from 'fs';
 import { Method, AxiosRequestConfig, AxiosInstance } from "axios";
 import HttpClientInterface from "../Core/HttpClient/Contracts/HttpClientInterface";
 import HttpClientMethodsMixin from '../Core/HttpClient/Mixins/HttpClientMethodsMixin';
@@ -16,6 +18,16 @@ declare class Client implements HttpClientInterface {
     setInstance(instance: AxiosInstance): this;
     setLogger(logger: LogHandler): this;
     request(method: Method, url: string, payload?: AxiosRequestConfig<any>): Promise<HttpClientResponse>;
+    /**
+     * 文件上传
+     * @see https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter2_1_1.shtml
+     * @param uri 接口地址
+     * @param file 文件路径或文件可读流
+     * @param meta 文件元信息，包含 filename 和 sha256 两个字段
+     * @param filename 文件名，必须以 .jpg、.bmp、.png 为后缀
+     * @returns
+     */
+    uploadMedia(uri: string, file: string | fs.ReadStream, meta?: Record<string, any>, filename?: string): Promise<HttpClientResponse>;
     /**
      * 判断是否是V3请求
      * @param url 请求地址

package/dist/Pay/Client.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+const fs_1 = __importDefault(require("fs"));
 const merge_1 = __importDefault(require("merge"));
 const Utils_1 = require("../Core/Support/Utils");
 const HttpClient_1 = __importDefault(require("../Core/HttpClient/HttpClient"));
@@ -18,6 +19,7 @@ const HttpClientMethodsMixin_1 = __importDefault(require("../Core/HttpClient/Mix
 const PresetMixin_1 = __importDefault(require("../Core/HttpClient/Mixins/PresetMixin"));
 const Signature_1 = __importDefault(require("./Signature"));
 const LegacySignature_1 = __importDefault(require("./LegacySignature"));
+const form_data_1 = __importDefault(require("form-data"));
 class Client {
     constructor(merchant, client, defaultOptions = {}) {
         var _a;
@@ -89,6 +91,42 @@ class Client {
             return this.client.request(method, (0, Utils_1.ltrim)(url, '\\/+'), payload);
         });
     }
+    /**
+     * 文件上传
+     * @see https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter2_1_1.shtml
+     * @param uri 接口地址
+     * @param file 文件路径或文件可读流
+     * @param meta 文件元信息，包含 filename 和 sha256 两个字段
+     * @param filename 文件名，必须以 .jpg、.bmp、.png 为后缀
+     * @returns
+     */
+    uploadMedia(uri, file, meta = null, filename = null) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (typeof file === 'string') {
+                file = fs_1.default.createReadStream(file);
+            }
+            if (!meta) {
+                meta = {
+                    filename: filename !== null && filename !== void 0 ? filename : 'file.jpg',
+                    sha256: yield (0, Utils_1.createFileHash)(file, 'sha256'),
+                };
+            }
+            let metaJson = JSON.stringify(meta);
+            let formData = new form_data_1.default();
+            formData.append('file', file);
+            formData.append('meta', metaJson, {
+                contentType: 'application/json',
+            });
+            return this.client.request('POST', (0, Utils_1.ltrim)(uri, '\\/+'), {
+                formData,
+                headers: {
+                    'authorization': this.createSignature('POST', uri, {
+                        data: metaJson,
+                    }),
+                }
+            });
+        });
+    }
     /**
      * 判断是否是V3请求
      * @param url 请求地址

package/dist/Pay/Merchant.d.ts

@@ -3,12 +3,12 @@ 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[]);
+    protected privateKey: PrivateKey;
+    protected certificate: PublicKey;
+    constructor(mchId: string, privateKey: string | PrivateKey, certificate: string | PublicKey, secretKey: string, v2SecretKey?: string, platformCerts?: Record<string, string | PublicKey> | string[] | PublicKey[]);
     /**
      * 统一规范化平台证书
      * @param platformCerts 平台证书列表

package/dist/Pay/Merchant.js

@@ -1,13 +1,24 @@
 'use strict';
+const PrivateKey_1 = require("../Core/Support/PrivateKey");
 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 = {};
+        if (!(privateKey instanceof PrivateKey_1.PrivateKey)) {
+            this.privateKey = new PrivateKey_1.PrivateKey(privateKey);
+        }
+        else {
+            this.privateKey = privateKey;
+        }
+        if (!(certificate instanceof PublicKey_1.PublicKey)) {
+            this.certificate = new PublicKey_1.PublicKey(certificate);
+        }
+        else {
+            this.certificate = certificate;
+        }
         this.platformCerts = this.normalizePlatformCerts(platformCerts);
     }
     /**

package/dist/Pay/Signature.js

@@ -36,8 +36,8 @@ class Signature {
         }
         let signString = `${method.toUpperCase()}\n${pathname}\n${timestamp}\n${nonce}\n${body}`;
         let rsa = new RSA_1.default;
-        rsa.setPublicKey(this.merchant.getCertificate().toString());
-        rsa.setPrivateKey(this.merchant.getPrivateKey().toString());
+        rsa.setPublicKey(this.merchant.getCertificate().getValue());
+        rsa.setPrivateKey(this.merchant.getPrivateKey().getKey());
         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}"`;
     }

package/dist/Types/global.d.ts

@@ -74,6 +74,35 @@ export declare interface CacheFileConfig {
   ext: string
 }
 
+/**
+ * 网络请求配置
+ */
+export declare interface HttpConfig extends AxiosRequestConfig {
+  /**
+   * 是否抛出异常
+   */
+  throw?: boolean;
+  /**
+   * 是否抛出异常
+   * @see https://github.com/softonic/axios-retry#options
+   */
+  retry?: IAxiosRetry.IAxiosRetryConfig;
+  // retry?: {
+  //   /**
+  //    * 仅以下状态码重试
+  //    */
+  //   http_codes: number[];
+  //   /**
+  //    * 最大重试次数
+  //    */
+  //   max_retries: number;
+  //   /**
+  //    * 请求间隔 (毫秒)
+  //    */
+  //   delay: number;
+  // };
+}
+
 /**
  * 基础配置
  */
@@ -81,7 +110,7 @@ export declare interface BaseConfig {
   /**
    * 网络请求相关配置
    */
-  http?: AxiosRequestConfig;
+  http?: HttpConfig;
 
   /**
    * 文件缓存相关配置

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-easywechat",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
@@ -18,15 +18,19 @@
   ],
   "author": "Hpyer",
   "license": "MIT",
+  "engines": {
+    "node": ">=15.6.0"
+  },
   "devDependencies": {
     "@types/node": "^17.0.23",
     "axios-mock-adapter": "^1.21.1",
     "mocha": "^9.2.2",
-    "package-release": "^1.0.2",
+    "package-release": "^1.0.3",
     "typescript": "^4.6.3"
   },
   "dependencies": {
     "axios": "^0.26.1",
+    "axios-retry": "^3.3.1",
     "form-data": "^4.0.0",
     "merge": "^2.1.1",
     "node-socialite": "^1.2.5",