uniapp-request-sdk 1.3.9 → 1.4.1

package/dist/index.d.ts

@@ -11,6 +11,8 @@ interface IParams {
     maxRetryCount?: number;
     /** 请求超时时间默认10s，ms为单位 */
     timeout?: number;
+    /** 上传文件的请求超时时间，ms为单位 */
+    uploadTimeout?: number;
     /** 请求尝试延迟时间默认3s，ms为单位 */
     retryDelay?: number;
     /** token，APP初始化给到小程序的token */
@@ -24,6 +26,9 @@ interface IParams {
     /** 自定义得到token的函数，默认使用从客户端获取token的方式 */
     getTokenFun?: () => Promise<string>;
 }
+declare function requestPromise(options?: RequestOptions & {
+    timeout: number;
+}): Promise<RequestSuccessCallbackResult>;
 declare class UniRequest {
     /** 基准路径 */
     private baseUrl;
@@ -34,6 +39,8 @@ declare class UniRequest {
     private maxRetryCount;
     /** 超时时间 */
     private timeout;
+    /** 上传文件的超时时间 */
+    private uploadTimeout;
     private retryDelay;
     private token?;
     private tokenEventName;
@@ -51,7 +58,9 @@ declare class UniRequest {
         method: RequestOptions['method'];
         data?: RequestOptions['data'];
         header?: RequestOptions['header'];
-    } & RequestOptions): Promise<T>;
+        /** 超时时间 */
+        timeout?: number;
+    } & RequestOptions & UploadFileOption, callbackPromise?: typeof requestPromise): Promise<T>;
     /**
      * post请求
      * @param url
@@ -63,6 +72,16 @@ declare class UniRequest {
     get<T>(url: string, data?: {}, header?: Record<string, string>): Promise<T>;
     delete<T>(url: string, data?: {}, header?: Record<string, string>): Promise<T>;
     put<T>(url: string, data?: {}, header?: Record<string, string>): Promise<T>;
+    /**
+     * 文件上传
+     * @param url 上传的url
+     * @param filePath 文件路径
+     * @param formData HTTP 请求中其他额外的 form data
+     * @param name 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容,默认key为file
+     * @param header
+     * @returns
+     */
+    uploadFile<T>(url: string, filePath: string, formData?: Record<string, any>, name?: string, header?: Record<string, string>): Promise<T>;
 }
 
 export { IParams, UniRequest as default };

package/dist/index.esm.js

@@ -35,6 +35,10 @@ function _toPropertyKey(arg) {
   return typeof key === "symbol" ? key : String(key);
 }
 
+/** 客户端交互内置事件名称 */
+var EVENT_NAME = {
+  LOGOUT: 'logout'
+};
 function requestPromise(options) {
   return new Promise(function (res, rej) {
     uni.request(Object.assign(Object.assign({}, options), {
@@ -43,6 +47,14 @@ function requestPromise(options) {
     }));
   });
 }
+function uploadFilePromise(options) {
+  return new Promise(function (res, rej) {
+    uni.uploadFile(Object.assign(Object.assign({}, options), {
+      success: res,
+      fail: rej
+    }));
+  });
+}
 /** 得到小程序的token */
 function getToken(eventName) {
   return new Promise(function (res, rej) {
@@ -66,6 +78,8 @@ var UniRequest = /*#__PURE__*/function () {
     this.maxRetryCount = 3;
     /** 超时时间 */
     this.timeout = 10000;
+    /** 上传文件的超时时间 */
+    this.uploadTimeout = 5000;
     this.retryDelay = 3000;
     this.tokenEventName = 'getToken';
     /** token的header名称，默认Authorization */
@@ -103,6 +117,7 @@ var UniRequest = /*#__PURE__*/function () {
     key: "request",
     value: function request(params) {
       var _this3 = this;
+      var callbackPromise = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : requestPromise;
       var url = params.url;
       /** 如果是http开头的，则不需要加入baseUrl */
       if (!/^https?:\/\//.test(url)) {
@@ -116,11 +131,19 @@ var UniRequest = /*#__PURE__*/function () {
       return new Promise(function (res, rej) {
         var retryFucntion = function retryFucntion() {
           /** 因为token需要动态获取，因此放入这里 */
+          // #ifndef H5
           header[_this3.tokenHeader] = "".concat(_this3.tokenPrefix).concat(_this3.token);
-          requestPromise(Object.assign(Object.assign({}, params), {
+          // #endif
+          /** 针对h5调试的时候，因为塞入cookie是不安全的，因此无需塞入cookie，使用登录页后，后端塞入的cookie */
+          // #ifdef H5
+          if (!['cookie'].includes(_this3.tokenHeader)) {
+            header[_this3.tokenHeader] = "".concat(_this3.tokenPrefix).concat(_this3.token);
+          }
+          // #endif
+          callbackPromise(Object.assign(Object.assign({}, params), {
             header: header,
             url: url,
-            timeout: _this3.timeout
+            timeout: params.timeout || _this3.timeout
           })).then(function (resData) {
             var statusCode = resData.statusCode,
               data = resData.data;
@@ -130,7 +153,8 @@ var UniRequest = /*#__PURE__*/function () {
               } else {
                 _this3.rejectHandler(rej, resData);
               }
-            } else if (statusCode === 403 && !requestedToken) {
+              /** 针对小网关进行的处理，历史遗留问题，需要兼容 */
+            } else if ('403' === statusCode && !requestedToken) {
               // #ifndef H5
               (_this3.getTokenFun ? _this3.getTokenFun() : getToken(_this3.tokenEventName)).then(function (token) {
                 _this3.token = token;
@@ -148,6 +172,12 @@ var UniRequest = /*#__PURE__*/function () {
               // #ifdef H5
               _this3.rejectHandler(rej, resData);
               // #endif
+              /** 最新无权限处理方案，直接调用客户端logout事件，退出到登录页 */
+            } else if ('401' === statusCode) {
+              _this3.rejectHandler(rej, resData);
+              uni.sendNativeEvent(EVENT_NAME.LOGOUT, {}, function () {
+                console.log('用户无权限，调用logout事件，退出到登录页');
+              });
             } else {
               if (_this3.maxRetryCount > retryCount) {
                 delayRetryFcuntion();
@@ -227,6 +257,30 @@ var UniRequest = /*#__PURE__*/function () {
         method: 'PUT'
       });
     }
+    /**
+     * 文件上传
+     * @param url 上传的url
+     * @param filePath 文件路径
+     * @param formData HTTP 请求中其他额外的 form data
+     * @param name 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容,默认key为file
+     * @param header
+     * @returns
+     */
+  }, {
+    key: "uploadFile",
+    value: function uploadFile(url, filePath, formData) {
+      var name = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'file';
+      var header = arguments.length > 4 ? arguments[4] : undefined;
+      return this.request({
+        url: url,
+        filePath: filePath,
+        formData: formData,
+        name: name,
+        header: header,
+        timeout: this.uploadTimeout,
+        method: 'PUT'
+      }, uploadFilePromise);
+    }
   }]);
   return UniRequest;
 }();

package/dist/index.umd.js

@@ -0,0 +1,298 @@
+(function (global, factory) {
+  typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports) :
+  typeof define === 'function' && define.amd ? define(['exports'], factory) :
+  (global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global.UniappRequestSdk = {}));
+})(this, (function (exports) { 'use strict';
+
+  function _classCallCheck(instance, Constructor) {
+    if (!(instance instanceof Constructor)) {
+      throw new TypeError("Cannot call a class as a function");
+    }
+  }
+  function _defineProperties(target, props) {
+    for (var i = 0; i < props.length; i++) {
+      var descriptor = props[i];
+      descriptor.enumerable = descriptor.enumerable || false;
+      descriptor.configurable = true;
+      if ("value" in descriptor) descriptor.writable = true;
+      Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor);
+    }
+  }
+  function _createClass(Constructor, protoProps, staticProps) {
+    if (protoProps) _defineProperties(Constructor.prototype, protoProps);
+    if (staticProps) _defineProperties(Constructor, staticProps);
+    Object.defineProperty(Constructor, "prototype", {
+      writable: false
+    });
+    return Constructor;
+  }
+  function _toPrimitive(input, hint) {
+    if (typeof input !== "object" || input === null) return input;
+    var prim = input[Symbol.toPrimitive];
+    if (prim !== undefined) {
+      var res = prim.call(input, hint || "default");
+      if (typeof res !== "object") return res;
+      throw new TypeError("@@toPrimitive must return a primitive value.");
+    }
+    return (hint === "string" ? String : Number)(input);
+  }
+  function _toPropertyKey(arg) {
+    var key = _toPrimitive(arg, "string");
+    return typeof key === "symbol" ? key : String(key);
+  }
+
+  /** 客户端交互内置事件名称 */
+  var EVENT_NAME = {
+    LOGOUT: 'logout'
+  };
+  function requestPromise(options) {
+    return new Promise(function (res, rej) {
+      uni.request(Object.assign(Object.assign({}, options), {
+        success: res,
+        fail: rej
+      }));
+    });
+  }
+  function uploadFilePromise(options) {
+    return new Promise(function (res, rej) {
+      uni.uploadFile(Object.assign(Object.assign({}, options), {
+        success: res,
+        fail: rej
+      }));
+    });
+  }
+  /** 得到小程序的token */
+  function getToken(eventName) {
+    return new Promise(function (res, rej) {
+      var timeout = setTimeout(rej, 5000);
+      uni.sendNativeEvent(eventName, {}, function (resData) {
+        clearTimeout(timeout);
+        res(resData);
+      });
+    });
+  }
+  var UniRequest = /*#__PURE__*/function () {
+    function UniRequest(params) {
+      var _this = this;
+      _classCallCheck(this, UniRequest);
+      /** 基准路径 */
+      this.baseUrl = '';
+      /** 错误处理函数 */
+      this.onErrorHandler = function (error) {
+        console.error(error);
+      };
+      this.maxRetryCount = 3;
+      /** 超时时间 */
+      this.timeout = 10000;
+      /** 上传文件的超时时间 */
+      this.uploadTimeout = 5000;
+      this.retryDelay = 3000;
+      this.tokenEventName = 'getToken';
+      /** token的header名称，默认Authorization */
+      this.tokenHeader = 'Authorization';
+      /** 传入的token前缀，默认Bearer ，注意Bearer有个空字符串*/
+      this.tokenPrefix = 'Bearer ';
+      if (params) {
+        Object.keys(params).forEach(function (key) {
+          if (params[key] !== void 0) {
+            _this[key] = params[key];
+          }
+        });
+      }
+    }
+    _createClass(UniRequest, [{
+      key: "rejectHandler",
+      value: function rejectHandler(rej, data) {
+        var _a;
+        rej(data);
+        (_a = this.onErrorHandler) === null || _a === void 0 ? void 0 : _a.call(this, data);
+      }
+    }, {
+      key: "setParams",
+      value: function setParams(params) {
+        var _this2 = this;
+        if (params) {
+          Object.keys(params).forEach(function (key) {
+            if (params[key] !== void 0) {
+              _this2[key] = params[key];
+            }
+          });
+        }
+      }
+    }, {
+      key: "request",
+      value: function request(params) {
+        var _this3 = this;
+        var callbackPromise = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : requestPromise;
+        var url = params.url;
+        /** 如果是http开头的，则不需要加入baseUrl */
+        if (!/^https?:\/\//.test(url)) {
+          url = "".concat(this.baseUrl.replace(/\/$/, ''), "/").concat(params.url.replace(/^\//, ''), "?t=").concat(Date.now());
+        } else {
+          url = "".concat(params.url, "?t=").concat(Date.now());
+        }
+        var header = Object.assign(Object.assign({}, this.header), params.header);
+        var requestedToken = false;
+        var retryCount = 0;
+        return new Promise(function (res, rej) {
+          var retryFucntion = function retryFucntion() {
+            /** 因为token需要动态获取，因此放入这里 */
+            // #ifndef H5
+            header[_this3.tokenHeader] = "".concat(_this3.tokenPrefix).concat(_this3.token);
+            // #endif
+            /** 针对h5调试的时候，因为塞入cookie是不安全的，因此无需塞入cookie，使用登录页后，后端塞入的cookie */
+            // #ifdef H5
+            if (!['cookie'].includes(_this3.tokenHeader)) {
+              header[_this3.tokenHeader] = "".concat(_this3.tokenPrefix).concat(_this3.token);
+            }
+            // #endif
+            callbackPromise(Object.assign(Object.assign({}, params), {
+              header: header,
+              url: url,
+              timeout: params.timeout || _this3.timeout
+            })).then(function (resData) {
+              var statusCode = resData.statusCode,
+                data = resData.data;
+              if (statusCode === 200) {
+                if (!data.errno) {
+                  res(data.data);
+                } else {
+                  _this3.rejectHandler(rej, resData);
+                }
+                /** 针对小网关进行的处理，历史遗留问题，需要兼容 */
+              } else if ('403' === statusCode && !requestedToken) {
+                // #ifndef H5
+                (_this3.getTokenFun ? _this3.getTokenFun() : getToken(_this3.tokenEventName)).then(function (token) {
+                  _this3.token = token;
+                  requestedToken = true;
+                  /** 获取token应该立马请求,不需要延迟 */
+                  retryFucntion();
+                })["catch"](function () {
+                  if (_this3.maxRetryCount > retryCount) {
+                    delayRetryFcuntion();
+                  } else {
+                    _this3.rejectHandler(rej, resData);
+                  }
+                });
+                // #endif
+                // #ifdef H5
+                _this3.rejectHandler(rej, resData);
+                // #endif
+                /** 最新无权限处理方案，直接调用客户端logout事件，退出到登录页 */
+              } else if ('401' === statusCode) {
+                _this3.rejectHandler(rej, resData);
+                uni.sendNativeEvent(EVENT_NAME.LOGOUT, {}, function () {
+                  console.log('用户无权限，调用logout事件，退出到登录页');
+                });
+              } else {
+                if (_this3.maxRetryCount > retryCount) {
+                  delayRetryFcuntion();
+                } else {
+                  _this3.rejectHandler(rej, resData);
+                }
+              }
+            })["catch"](function (rejData) {
+              if (_this3.maxRetryCount > retryCount) {
+                delayRetryFcuntion();
+              } else {
+                _this3.rejectHandler(rej, rejData);
+              }
+            });
+          };
+          var delayRetryFcuntion = function delayRetryFcuntion() {
+            setTimeout(function () {
+              retryCount++;
+              retryFucntion();
+            }, _this3.retryDelay);
+          };
+          retryFucntion();
+        });
+      }
+      /**
+       * post请求
+       * @param url
+       * @param data 可传可不传
+       * @param header
+       * @returns
+       */
+    }, {
+      key: "post",
+      value: function post(url) {
+        var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+        var header = arguments.length > 2 ? arguments[2] : undefined;
+        return this.request({
+          url: url,
+          data: data,
+          header: header,
+          method: 'POST'
+        });
+      }
+    }, {
+      key: "get",
+      value: function get(url) {
+        var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+        var header = arguments.length > 2 ? arguments[2] : undefined;
+        return this.request({
+          url: url,
+          data: data,
+          header: header,
+          method: 'GET'
+        });
+      }
+    }, {
+      key: "delete",
+      value: function _delete(url) {
+        var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+        var header = arguments.length > 2 ? arguments[2] : undefined;
+        return this.request({
+          url: url,
+          data: data,
+          header: header,
+          method: 'DELETE'
+        });
+      }
+    }, {
+      key: "put",
+      value: function put(url) {
+        var data = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+        var header = arguments.length > 2 ? arguments[2] : undefined;
+        return this.request({
+          url: url,
+          data: data,
+          header: header,
+          method: 'PUT'
+        });
+      }
+      /**
+       * 文件上传
+       * @param url 上传的url
+       * @param filePath 文件路径
+       * @param formData HTTP 请求中其他额外的 form data
+       * @param name 文件对应的 key , 开发者在服务器端通过这个 key 可以获取到文件二进制内容,默认key为file
+       * @param header
+       * @returns
+       */
+    }, {
+      key: "uploadFile",
+      value: function uploadFile(url, filePath, formData) {
+        var name = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : 'file';
+        var header = arguments.length > 4 ? arguments[4] : undefined;
+        return this.request({
+          url: url,
+          filePath: filePath,
+          formData: formData,
+          name: name,
+          header: header,
+          timeout: this.uploadTimeout,
+          method: 'PUT'
+        }, uploadFilePromise);
+      }
+    }]);
+    return UniRequest;
+  }();
+
+  exports["default"] = UniRequest;
+
+  Object.defineProperty(exports, '__esModule', { value: true });
+
+}));

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "uniapp-request-sdk",
-  "version": "1.3.9",
+  "version": "1.4.1",
   "description": "用于uniapp小程序的请求库的sdk",
-  "main": "dist/index.esm.js",
+  "main": "dist/index.umd.js",
+  "module": " dist/index.esm.js",
   "typings": "dist/index.d.ts",
   "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.umd.js",
+      "import": "./dist/index.esm.js"
+    }
+  },
   "files": [
     "dist"
   ],
@@ -50,5 +57,12 @@
     "rollup-plugin-terser": "^7.0.2",
     "rollup-plugin-typescript2": "^0.27.2",
     "typescript": "^4.0.2"
+  },
+  "buildOptions": {
+    "name": "UniappRequestSdk",
+    "formats": [
+      "umd",
+      "esm"
+    ]
   }
 }