node-easywechat 3.0.0-beta.3 → 3.0.0-beta.4

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # CHANGELOG
 
 
+## v3.0.0-beta.4 (2022-06-24)
+
+- Feat: 请求接口数据增加 FormData 实例的支持
+
 ## v3.0.0-beta.3 (2022-06-22)
 
 - Fix: 修复获取js ticket时无法自动获取access_token的问题

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

@@ -2,6 +2,7 @@ import { AxiosInstance, AxiosRequestConfig, Method } from 'axios';
 import HttpClientInterface from './Contracts/HttpClientInterface';
 import HttpClientResponse from './HttpClientResponse';
 import { HttpClientFailureJudgeClosure, LogHandler } from '../../Types/global';
+import FormData from 'form-data';
 declare class HttpClient implements HttpClientInterface {
     protected axios: AxiosInstance;
     protected failureJudge: HttpClientFailureJudgeClosure;
@@ -19,6 +20,12 @@ declare class HttpClient implements HttpClientInterface {
     request(method: Method, url: string, payload?: AxiosRequestConfig<any>): Promise<HttpClientResponse>;
     getInstance(): AxiosInstance;
     setInstance(instance: AxiosInstance): this;
+    /**
+     * 获取 FormData 对象的 headers
+     * @param formData
+     * @returns
+     */
+    protected getFormDataHeaders(formData: FormData): Promise<Record<string, string | number>>;
     /**
      * 创建http客户端
      * @param config

package/dist/Core/HttpClient/HttpClient.js

@@ -11,10 +11,10 @@ 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 merge_1 = __importDefault(require("merge"));
 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"));
 class HttpClient {
     constructor(axios, failureJudge = null, throwError = false) {
         this.axios = axios;
@@ -35,7 +35,9 @@ class HttpClient {
     }
     request(method, url, payload = {}) {
         return __awaiter(this, void 0, void 0, function* () {
-            let options = merge_1.default.recursive(true, payload);
+            let options = Object.assign({}, payload);
+            if (!options.headers)
+                options.headers = {};
             options.method = method;
             options.url = url;
             if (options['xml'] !== undefined) {
@@ -49,8 +51,6 @@ class HttpClient {
                 else {
                     throw new Error('The type of `xml` must be string or object.');
                 }
-                if (!options.headers)
-                    options.headers = {};
                 if (!options.headers['Content-Type'] && !options.headers['content-type']) {
                     options.headers['content-type'] = 'text/xml';
                 }
@@ -69,8 +69,6 @@ class HttpClient {
                 else {
                     throw new Error('The type of `json` must be string or object.');
                 }
-                if (!options.headers)
-                    options.headers = {};
                 if (!options.headers['Content-Type'] && !options.headers['content-type']) {
                     options.headers['content-type'] = 'application/json';
                 }
@@ -78,6 +76,23 @@ class HttpClient {
                 options['json'] = undefined;
                 delete options['json'];
             }
+            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.data)
+                    for (let key in options.data) {
+                        formData.append(key, options.data[key]);
+                    }
+                options.data = formData;
+                options['formData'] = undefined;
+                delete options['formData'];
+            }
+            // 如果 data 是 FormData 对象，则从中提取 headers
+            if (options.data && options.data instanceof form_data_1.default) {
+                options.headers = Object.assign(Object.assign({}, (yield this.getFormDataHeaders(options.data))), options.headers);
+            }
             let starttime = Date.now();
             if (typeof this.logger === 'function') {
                 yield this.logger('before', options);
@@ -97,6 +112,25 @@ class HttpClient {
         this.axios = instance;
         return this;
     }
+    /**
+     * 获取 FormData 对象的 headers
+     * @param formData
+     * @returns
+     */
+    getFormDataHeaders(formData) {
+        return new Promise((resolve, reject) => {
+            let headers = formData.getHeaders();
+            formData.getLength(function (err, length) {
+                if (err) {
+                    headers['content-length'] = 0;
+                }
+                else {
+                    headers['content-length'] = length;
+                }
+                resolve(headers);
+            });
+        });
+    }
     /**
      * 创建http客户端
      * @param config

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

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import { AxiosRequestConfig, Method } from "axios";
+import fs from "fs";
 declare class PresetMixin {
     /**
      * 存储预置参数
@@ -12,6 +14,10 @@ declare class PresetMixin {
      * 存储预置数据
      */
     protected prependData: Record<string, any>;
+    /**
+     * 存储预置文件数据
+     */
+    protected prependFiles: Record<string, fs.ReadStream>;
     /**
      * 设置预置参数
      * @param presets
@@ -68,12 +74,25 @@ declare class PresetMixin {
      * @returns
      */
     withMchIdAs(new_alias?: string): this;
+    /**
+     * 预设置文件
+     * @param file  文件路径或可读文件流
+     * @param key 参数名，默认：'file'
+     * @returns
+     */
+    withFile(file: string | fs.ReadStream, key?: string): this;
+    /**
+     * 预设置多个文件
+     * @param files  键名：文件名，键值：文件路径或可读文件流
+     * @returns
+     */
+    withFiles(files: Record<string, string | fs.ReadStream>): this;
     /**
      * 合并预置参数并清空预置数据
      * @param payload
      * @param method
      * @returns
      */
-    mergeThenResetPrepends(payload: AxiosRequestConfig, method?: Method): any;
+    mergeThenResetPrepends(payload: AxiosRequestConfig, method?: Method): AxiosRequestConfig<any>;
 }
 export = PresetMixin;

package/dist/Core/HttpClient/Mixins/PresetMixin.js

@@ -2,7 +2,7 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-const merge_1 = __importDefault(require("merge"));
+const fs_1 = __importDefault(require("fs"));
 class PresetMixin {
     constructor() {
         /**
@@ -17,6 +17,10 @@ class PresetMixin {
          * 存储预置数据
          */
         this.prependData = {};
+        /**
+         * 存储预置文件数据
+         */
+        this.prependFiles = {};
     }
     /**
      * 设置预置参数
@@ -123,6 +127,35 @@ class PresetMixin {
         this.with(new_alias, this.presets['mch_id']);
         return this;
     }
+    /**
+     * 预设置文件
+     * @param file  文件路径或可读文件流
+     * @param key 参数名，默认：'file'
+     * @returns
+     */
+    withFile(file, key = 'file') {
+        if (typeof this.prependFiles !== 'object') {
+            this.prependFiles = {};
+        }
+        if (file instanceof fs_1.default.ReadStream) {
+            this.prependFiles[key] = file;
+        }
+        else if (typeof file === 'string') {
+            this.prependFiles[key] = fs_1.default.createReadStream(file);
+        }
+        return this;
+    }
+    /**
+     * 预设置多个文件
+     * @param files  键名：文件名，键值：文件路径或可读文件流
+     * @returns
+     */
+    withFiles(files) {
+        for (const key in files) {
+            this.withFile(files[key], key);
+        }
+        return this;
+    }
     /**
      * 合并预置参数并清空预置数据
      * @param payload
@@ -132,9 +165,11 @@ class PresetMixin {
     mergeThenResetPrepends(payload, method = 'get') {
         var _a, _b, _c, _d;
         let field = method.toLowerCase() === 'get' ? 'params' : 'data';
-        let options = merge_1.default.recursive(true, payload);
+        let options = Object.assign({}, payload);
         if (!options.headers)
             options.headers = {};
+        if (!options.formData)
+            options.formData = {};
         if (((_b = (_a = options.headers['Content-Type']) !== null && _a !== void 0 ? _a : options.headers['content-type']) !== null && _b !== void 0 ? _b : null) === 'application/json' || !!options.json) {
             field = 'json';
         }
@@ -147,8 +182,12 @@ class PresetMixin {
         if (this.prependHeaders && Object.keys(this.prependHeaders).length > 0) {
             options.headers = Object.assign(Object.assign({}, this.prependHeaders), options.headers);
         }
+        if (this.prependFiles && Object.keys(this.prependFiles).length > 0) {
+            options.formData = Object.assign(Object.assign({}, this.prependFiles), options.formData);
+        }
         this.prependData = {};
         this.prependHeaders = {};
+        this.prependFiles = {};
         return options;
     }
 }

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/Types/global.d.ts

@@ -14,6 +14,10 @@ declare module 'axios' {
      * 要发送的json数据，会自动解析并赋值到data属性，同时设置content-type=application/json
      */
     json?: string | Record<string, any>;
+    /**
+     * 要发送的FormData数据，会自动解析并赋值到data属性，同时设置根据内容提取headers
+     */
+    formData?: Record<string, any>;
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-easywechat",
-  "version": "3.0.0-beta.3",
+  "version": "3.0.0-beta.4",
   "description": "EasyWechat SDK for Node.js (NOT OFFICIAL)",
   "main": "dist/index.js",
   "scripts": {
@@ -20,7 +20,7 @@
   "license": "MIT",
   "devDependencies": {
     "@types/node": "^17.0.23",
-    "axios-mock-adapter": "^1.20.0",
+    "axios-mock-adapter": "^1.21.1",
     "mocha": "^9.2.2",
     "package-release": "^1.0.2",
     "typescript": "^4.6.3"