@fairys/taro-tools-react 0.0.4 → 0.0.6

package/esm/utils/request.d.ts

@@ -1,5 +1,5 @@
 import Taro from '@tarojs/taro';
-export interface RequestInstanceOptions extends Taro.request.Option<any, any> {
+export interface TaroRequestOption {
     /**模块名称*/
     module?: string;
     /**是否忽略token*/
@@ -7,6 +7,16 @@ export interface RequestInstanceOptions extends Taro.request.Option<any, any> {
     /**是否提示错误信息*/
     isShowErrorMessage?: boolean;
 }
+export interface RequestInstanceOptions extends Taro.request.Option<any, any>, TaroRequestOption {
+}
+export interface DownloadFileOptions extends Taro.downloadFile.Option, TaroRequestOption {
+    /**下载进度回调*/
+    onProgress?: Taro.DownloadTask.OnProgressUpdateCallback;
+}
+export interface UploadFileOptions extends Taro.uploadFile.Option, TaroRequestOption {
+    /**上传进度回调*/
+    onProgress?: Taro.UploadTask.OnProgressUpdateCallback;
+}
 export interface RequestInstanceCreateOptions {
     /**
      * 公共请求配置
@@ -58,6 +68,71 @@ export declare class RequestInstance {
     };
     /**格式化地址*/
     formatUrl: (url: string, module?: string) => string;
+    formatRequestOptions: (options: RequestInstanceOptions | DownloadFileOptions | UploadFileOptions) => {
+        url: string;
+        data?: any;
+        timeout?: number;
+        method?: keyof Taro.request.Method;
+        dataType?: keyof Taro.request.DataType | string;
+        responseType?: keyof Taro.request.ResponseType;
+        enableHttp2?: boolean;
+        enableQuic?: boolean;
+        enableCache?: boolean;
+        enableHttpDNS?: boolean;
+        httpDNSServiceId?: string;
+        enableChunked?: boolean;
+        forceCellularNetwork?: boolean;
+        enableCookie?: boolean;
+        referrerStrategy?: keyof Taro.request.ReferrerStrategy;
+        success?: (result: Taro.request.SuccessCallbackResult<any>) => void;
+        fail?: (res: TaroGeneral.CallbackResult) => void;
+        complete?: (res: Partial<Taro.request.SuccessCallbackResult> & TaroGeneral.CallbackResult) => void;
+        jsonp?: boolean | string;
+        jsonpCache?: RequestCache;
+        mode?: keyof Taro.request.CorsMode;
+        credentials?: keyof Taro.request.Credentials;
+        cache?: keyof Taro.request.Cache;
+        retryTimes?: number;
+        backup?: string | string[];
+        signal?: AbortSignal;
+        dataCheck?(): boolean;
+        useStore?: boolean;
+        storeCheckKey?: string;
+        storeSign?: string;
+        storeCheck?(): boolean;
+        header: {
+            [x: string]: any;
+        };
+    } | {
+        url: string;
+        /**下载进度回调*/
+        onProgress?: Taro.DownloadTask.OnProgressUpdateCallback;
+        filePath?: string;
+        timeout?: number;
+        withCredentials?: boolean;
+        complete?: (res: TaroGeneral.CallbackResult) => void;
+        fail?: (res: TaroGeneral.CallbackResult) => void;
+        success?: (result: Taro.downloadFile.FileSuccessCallbackResult) => void;
+        header: {
+            [x: string]: any;
+        };
+    } | {
+        url: string;
+        /**上传进度回调*/
+        onProgress?: Taro.UploadTask.OnProgressUpdateCallback;
+        filePath: string;
+        name: string;
+        formData?: TaroGeneral.IAnyObject;
+        timeout?: number;
+        fileName?: string;
+        withCredentials?: boolean;
+        complete?: (res: TaroGeneral.CallbackResult) => void;
+        fail?: (res: TaroGeneral.CallbackResult) => void;
+        success?: (result: Taro.uploadFile.SuccessCallbackResult) => void;
+        header: {
+            [x: string]: any;
+        };
+    };
     /**发送请求，返回 Taro.RequestTask */
     requestBase: (options: RequestInstanceOptions) => Taro.RequestTask<any>;
     /**发送请求,返回 Promise */
@@ -90,6 +165,14 @@ export declare class RequestInstance {
         data?: any;
         message?: string;
     }>;
+    /**下载文件(返回 Taro.DownloadTask.DownloadTaskPromise ，可显示下载进度)*/
+    downloadFileTask: (options: DownloadFileOptions) => Taro.DownloadTask.DownloadTaskPromise | undefined;
+    /**下载文件*/
+    downloadFile: (options: DownloadFileOptions) => Promise<Taro.downloadFile.FileSuccessCallbackResult>;
+    /**上传文件(返回 Taro.UploadTask.UploadTaskPromise ，可显示上传进度)*/
+    uploadFileTask: (options: UploadFileOptions) => Taro.UploadTask.UploadTaskPromise;
+    /**上传文件*/
+    uploadFile: (options: UploadFileOptions) => Promise<Taro.uploadFile.SuccessCallbackResult>;
 }
 /** 请求*/
 export declare const request: RequestInstance;

package/esm/utils/request.js

@@ -19,15 +19,13 @@ const requestResponseHandle = (result, options)=>{
     try {
         const statusCode = result.statusCode;
         const code = result?.data?.code;
-        if (result?.data) {
-            if (401 === statusCode || 401 === code || code === globalSettingDataInstance.store.tokenExpiredCode) {
-                msg = "\u8BF7\u91CD\u65B0\u767B\u5F55";
-                globalDataInstance.toLoginPage();
-            } else if (![
-                globalSettingDataInstance.store.requestSuccessCode,
-                200
-            ].includes(code)) msg = result?.data?.message || "\u63A5\u53E3\u5F02\u5E38";
-        } else msg = codeMessage[result?.statusCode];
+        if (401 === statusCode || 401 === code || code === globalSettingDataInstance.store.tokenExpiredCode) {
+            msg = "\u8BF7\u91CD\u65B0\u767B\u5F55";
+            globalDataInstance.toLoginPage();
+        } else msg = [
+            globalSettingDataInstance.store.requestSuccessCode,
+            200
+        ].includes(code) ? codeMessage[result?.statusCode] : result?.data?.message || codeMessage[code || result?.statusCode] || "\u63A5\u53E3\u5F02\u5E38";
     } catch (error) {
         msg = codeMessage[result?.statusCode];
         console.log(error);
@@ -103,8 +101,8 @@ class RequestInstance {
         }
         return `${host}/${newUrl}`;
     };
-    requestBase = (options)=>{
-        const { data, header = {}, module, isIgnoreToken, isShowErrorMessage, ...restOptions } = options;
+    formatRequestOptions = (options)=>{
+        const { header = {}, module, isIgnoreToken, isShowErrorMessage, ...restOptions } = options;
         const token = taro.getStorageSync(globalSettingDataInstance.store.tokenFieldName || 'token');
         const newHeader = {
             ...header
@@ -121,6 +119,17 @@ class RequestInstance {
             globalDataInstance.toLoginPage();
             return;
         }
+        return {
+            header: newHeader,
+            ...restOptions,
+            url: this.formatUrl(options.url, module)
+        };
+    };
+    requestBase = (options)=>{
+        const { isShowErrorMessage } = options;
+        const formattedOptions = this.formatRequestOptions(options);
+        if (!formattedOptions) return;
+        const { header: newHeader, ...restOptions } = formattedOptions;
         return taro.request({
             ...this.commonOptions,
             ...restOptions,
@@ -128,7 +137,6 @@ class RequestInstance {
                 ...newHeader,
                 ...options?.header || {}
             },
-            url: this.formatUrl(options.url, module),
             success: (result)=>{
                 requestResponseHandle(result, options);
                 options?.success?.(result);
@@ -203,6 +211,95 @@ class RequestInstance {
             throw error;
         }
     };
+    downloadFileTask = (options)=>{
+        const { isShowErrorMessage } = options;
+        const formattedOptions = this.formatRequestOptions(options);
+        if (!formattedOptions) return;
+        const { header: newHeader, onProgress, ...restOptions } = formattedOptions;
+        const downloadTask = taro.downloadFile({
+            ...this.commonOptions,
+            ...restOptions,
+            header: {
+                ...newHeader,
+                ...options?.header || {}
+            },
+            success: (result)=>{
+                if (200 === result.statusCode) options?.success?.(result);
+                else {
+                    requestResponseHandle(result, options);
+                    options?.fail?.(result);
+                }
+            },
+            fail: (result)=>{
+                if (false !== isShowErrorMessage) globalDataInstance.showMessage({
+                    content: result.errMsg || "\u8BF7\u6C42\u53D1\u751F\u9519\u8BEF",
+                    type: 'error'
+                });
+                options?.fail?.(result);
+            }
+        });
+        if ('function' == typeof onProgress && downloadTask) downloadTask.onProgressUpdate(onProgress);
+        return downloadTask;
+    };
+    downloadFile = (options)=>{
+        try {
+            return new Promise((resolve, reject)=>{
+                this.downloadFileTask({
+                    ...options,
+                    success: (result)=>{
+                        options?.success?.(result);
+                        resolve(result);
+                    },
+                    fail: (result)=>{
+                        options?.fail?.(result);
+                        reject(result);
+                    }
+                });
+            });
+        } catch (error) {
+            throw error;
+        }
+    };
+    uploadFileTask = (options)=>{
+        const { isShowErrorMessage } = options;
+        const formattedOptions = this.formatRequestOptions(options);
+        if (!formattedOptions) return;
+        const { header: newHeader, onProgress, ...restOptions } = formattedOptions;
+        const uploadTask = taro.uploadFile({
+            ...this.commonOptions,
+            ...restOptions,
+            header: {
+                ...newHeader,
+                ...options?.header || {}
+            },
+            success: (result)=>{
+                requestResponseHandle(result, options);
+                options?.success?.(result);
+            },
+            fail: (result)=>{
+                if (false !== isShowErrorMessage) globalDataInstance.showMessage({
+                    content: result.errMsg || "\u8BF7\u6C42\u53D1\u751F\u9519\u8BEF",
+                    type: 'error'
+                });
+                options?.fail?.(result);
+            }
+        });
+        if ('function' == typeof onProgress && uploadTask) uploadTask.onProgressUpdate(onProgress);
+        return uploadTask;
+    };
+    uploadFile = (options)=>new Promise((resolve, reject)=>{
+            this.uploadFileTask({
+                ...options,
+                success: (result)=>{
+                    options?.success?.(result);
+                    resolve(result);
+                },
+                fail: (result)=>{
+                    options?.fail?.(result);
+                    reject(result);
+                }
+            });
+        });
 }
 const request_request = new RequestInstance();
 const utils_request = request_request;

package/package.json

@@ -3,7 +3,7 @@
   "author": "SunLxy <1011771396@qq.com>",
   "description": "框架组件库",
   "homepage": "https://github.com/autumn-fairy-tales/fairys-taro-react",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "main": "lib/index.js",
   "types": "esm/index.d.ts",
   "module": "esm/index.js",

package/src/utils/request.ts

@@ -16,7 +16,7 @@ const codeMessage = {
   504: 'nginx超时',
 } as const;
 
-export interface RequestInstanceOptions extends Taro.request.Option<any, any> {
+export interface TaroRequestOption {
   /**模块名称*/
   module?: string;
   /**是否忽略token*/
@@ -25,22 +25,37 @@ export interface RequestInstanceOptions extends Taro.request.Option<any, any> {
   isShowErrorMessage?: boolean;
 }
 
+export interface RequestInstanceOptions extends Taro.request.Option<any, any>, TaroRequestOption {}
+export interface DownloadFileOptions extends Taro.downloadFile.Option, TaroRequestOption {
+  /**下载进度回调*/
+  onProgress?: Taro.DownloadTask.OnProgressUpdateCallback;
+}
+export interface UploadFileOptions extends Taro.uploadFile.Option, TaroRequestOption {
+  /**上传进度回调*/
+  onProgress?: Taro.UploadTask.OnProgressUpdateCallback;
+}
 /**处理提示信息*/
-const requestResponseHandle = (result: Taro.request.SuccessCallbackResult<any>, options?: RequestInstanceOptions) => {
+const requestResponseHandle = (
+  result:
+    | Taro.request.SuccessCallbackResult<any>
+    | Taro.downloadFile.FileSuccessCallbackResult
+    | Taro.uploadFile.SuccessCallbackResult,
+  options?: RequestInstanceOptions,
+) => {
   let msg = '';
   try {
     const statusCode = result.statusCode;
+    // @ts-ignore
     const code = result?.data?.code;
-    if (result?.data) {
-      if (statusCode === 401 || code === 401 || code === globalSettingDataInstance.store.tokenExpiredCode) {
-        // 权限问题 ，重新登录
-        msg = '请重新登录';
-        /**重新跳转登录页面*/
-        globalDataInstance.toLoginPage();
-      } else if (![globalSettingDataInstance.store.requestSuccessCode, 200].includes(code)) {
-        // 提示内容
-        msg = result?.data?.message || '接口异常';
-      }
+    if (statusCode === 401 || code === 401 || code === globalSettingDataInstance.store.tokenExpiredCode) {
+      // 权限问题 ，重新登录
+      msg = '请重新登录';
+      /**重新跳转登录页面*/
+      globalDataInstance.toLoginPage();
+    } else if (![globalSettingDataInstance.store.requestSuccessCode, 200].includes(code)) {
+      // 提示内容
+      // @ts-ignore
+      msg = result?.data?.message || codeMessage[code || result?.statusCode] || '接口异常';
     } else {
       msg = codeMessage[result?.statusCode];
     }
@@ -175,9 +190,8 @@ export class RequestInstance {
     return `${host}/${newUrl}`;
   };
 
-  /**发送请求，返回 Taro.RequestTask */
-  requestBase = (options: RequestInstanceOptions) => {
-    const { data, header = {}, module, isIgnoreToken, isShowErrorMessage, ...restOptions } = options;
+  formatRequestOptions = (options: RequestInstanceOptions | DownloadFileOptions | UploadFileOptions) => {
+    const { header = {}, module, isIgnoreToken, isShowErrorMessage, ...restOptions } = options;
     const token = Taro.getStorageSync(globalSettingDataInstance.store.tokenFieldName || 'token');
     const newHeader = { ...header };
     if (token) {
@@ -196,6 +210,22 @@ export class RequestInstance {
         return undefined;
       }
     }
+
+    return {
+      header: newHeader,
+      ...restOptions,
+      url: this.formatUrl(options.url, module),
+    };
+  };
+
+  /**发送请求，返回 Taro.RequestTask */
+  requestBase = (options: RequestInstanceOptions) => {
+    const { isShowErrorMessage } = options;
+    const formattedOptions = this.formatRequestOptions(options);
+    if (!formattedOptions) {
+      return undefined;
+    }
+    const { header: newHeader, ...restOptions } = formattedOptions;
     return Taro.request({
       ...this.commonOptions,
       ...restOptions,
@@ -203,7 +233,6 @@ export class RequestInstance {
         ...newHeader,
         ...(options?.header || {}),
       },
-      url: this.formatUrl(options.url, module),
       success: (result) => {
         /**处理提示
          * 使用 global 状态管理
@@ -295,6 +324,119 @@ export class RequestInstance {
       throw error;
     }
   };
+
+  /**下载文件(返回 Taro.DownloadTask.DownloadTaskPromise ，可显示下载进度)*/
+  downloadFileTask = (options: DownloadFileOptions): Taro.DownloadTask.DownloadTaskPromise | undefined => {
+    const { isShowErrorMessage } = options;
+    const formattedOptions = this.formatRequestOptions(options);
+    if (!formattedOptions) {
+      return undefined;
+    }
+    const { header: newHeader, onProgress, ...restOptions } = formattedOptions as DownloadFileOptions;
+    const downloadTask = Taro.downloadFile({
+      ...this.commonOptions,
+      ...restOptions,
+      header: {
+        ...newHeader,
+        ...(options?.header || {}),
+      },
+      success: (result) => {
+        if (result.statusCode === 200) {
+          options?.success?.(result);
+        } else {
+          requestResponseHandle(result, options as any);
+          options?.fail?.(result);
+        }
+      },
+      fail: (result) => {
+        if (isShowErrorMessage !== false) {
+          globalDataInstance.showMessage({
+            content: result.errMsg || '请求发生错误',
+            type: 'error',
+          });
+        }
+        options?.fail?.(result);
+      },
+    });
+    /**监听下载进度*/
+    if (typeof onProgress === 'function' && downloadTask) {
+      downloadTask.onProgressUpdate(onProgress);
+    }
+    return downloadTask;
+  };
+
+  /**下载文件*/
+  downloadFile = (options: DownloadFileOptions): Promise<Taro.downloadFile.FileSuccessCallbackResult> => {
+    try {
+      return new Promise((resolve, reject) => {
+        this.downloadFileTask({
+          ...options,
+          success: (result) => {
+            options?.success?.(result);
+            resolve(result);
+          },
+          fail: (result) => {
+            options?.fail?.(result);
+            reject(result);
+          },
+        });
+      });
+    } catch (error) {
+      throw error;
+    }
+  };
+
+  /**上传文件(返回 Taro.UploadTask.UploadTaskPromise ，可显示上传进度)*/
+  uploadFileTask = (options: UploadFileOptions) => {
+    const { isShowErrorMessage } = options;
+    const formattedOptions = this.formatRequestOptions(options);
+    if (!formattedOptions) {
+      return undefined;
+    }
+    const { header: newHeader, onProgress, ...restOptions } = formattedOptions as UploadFileOptions;
+    const uploadTask = Taro.uploadFile({
+      ...this.commonOptions,
+      ...restOptions,
+      header: {
+        ...newHeader,
+        ...(options?.header || {}),
+      },
+      success: (result) => {
+        requestResponseHandle(result, options);
+        options?.success?.(result);
+      },
+      fail: (result) => {
+        if (isShowErrorMessage !== false) {
+          globalDataInstance.showMessage({
+            content: result.errMsg || '请求发生错误',
+            type: 'error',
+          });
+        }
+        options?.fail?.(result);
+      },
+    });
+    /**监听上传进度*/
+    if (typeof onProgress === 'function' && uploadTask) {
+      uploadTask.onProgressUpdate(onProgress);
+    }
+    return uploadTask;
+  };
+  /**上传文件*/
+  uploadFile = (options: UploadFileOptions): Promise<Taro.uploadFile.SuccessCallbackResult> => {
+    return new Promise((resolve, reject) => {
+      this.uploadFileTask({
+        ...options,
+        success: (result) => {
+          options?.success?.(result);
+          resolve(result);
+        },
+        fail: (result) => {
+          options?.fail?.(result);
+          reject(result);
+        },
+      });
+    });
+  };
 }
 
 /** 请求*/