@hzab/data-model 1.2.1 → 1.3.1

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+# @hzab/data-model@1.3.0
+
+- fix: useStatusText: true 问题修复
+
+# @hzab/data-model@1.3.0
+
+- feat: 网络情况判断
+- feat: 新增参数 isResponseData 是否返回完整的接口数据（response.data）； isResponse 是否直接返回 response
+
 # @hzab/data-model@1.2.1
 
 - fix: setAxTimeout default timeout 0

package/README.md

@@ -16,6 +16,8 @@ import DataModel, {
   getToken,
   // 设置默认兜底的错误信息
   setDefaultErrMsg,
+  // 设置默认网络异常的错误信息
+  setNetworkErrMsg,
   // 设置 DataModel 中默认的 axios
   setDefaultAxios,
 } from "@hzab/data-model";
@@ -85,6 +87,10 @@ const listDM = new DataModel({
   multipleDeleteReqMap,
   // 批量删除接口 delete 出参枚举函数
   multipleDeleteResMap,
+  // 是否返回完整的接口数据（response.data）
+  isResponseData,
+  // 是否直接返回 response
+  isResponse,
 });
 
 // useDataModel，解决 hooks 写法 model 重复实例化导致 query 丢失的问题
@@ -145,6 +151,8 @@ function Demo({ orgId }) {
 | deleteResMap            | Function | 否   | -      | 删除接口 get 出参枚举函数                   |
 | multipleDeleteReqMap    | Function | 否   | -      | 批量删除接口 get 入参枚举函数               |
 | multipleDeleteResMap    | Function | 否   | -      | 批量删除接口 get 出参枚举函数               |
+| isResponseData    | boolean | 否   | -      | 是否返回完整的接口数据（response.data）               |
+| response    | boolean | 否   | -      | 是否直接返回 response               |
 
 ## useDataModel
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hzab/data-model",
-  "version": "1.2.1",
+  "version": "1.3.1",
   "description": "data model",
   "main": "src",
   "scripts": {

package/src/data-model.js

@@ -2,8 +2,11 @@ import _ from "lodash";
 import axios from "axios";
 
 const DEFAULT_MSG = "未知错误";
+const NETWORK_MSG = "网络异常，请检查网络是否开启";
+
 const _$Temp = {
-  defaultMsg: DEFAULT_MSG,
+  defaultErrMsg: DEFAULT_MSG,
+  networkErrMsg: NETWORK_MSG,
 };
 
 class DataModel {
@@ -24,8 +27,15 @@ class DataModel {
       multipleDeleteApi,
       axios: as,
       axiosConf,
+      // 是否返回完整的接口数据（response.data）
+      isResponseData,
+      // 是否直接返回 response
+      isResponse,
     } = params;
 
+    this.isResponseData = isResponseData;
+    this.isResponse = isResponse;
+
     this.ctx = ctx || {};
     this.query = query || {};
     this.axios = as || _$Temp.axios || axios;
@@ -324,6 +334,14 @@ class DataModel {
   }
 
   handleRes(response, resolve, reject) {
+    if (this.isResponse) {
+      resolve(response);
+      return;
+    }
+    if (this.isResponseData) {
+      resolve(response?.data ?? response);
+      return;
+    }
     if (typeof response !== "object") {
       reject(new Error("response not object"));
       return;
@@ -333,34 +351,38 @@ class DataModel {
     if (_res.data && _res.headers && _res.request && typeof _res.data?.code === "number") {
       _res = _res.data;
     }
-    const { code, message, data, msg } = _res;
+    const { code, data } = _res;
+    const message = this.handleMsg(response);
     if (code === 200) {
       let _data = data ?? {};
-      if (_.isObject(_data) && _data.message === undefined) {
+      if (_.isObject(_data)) {
         // 前缀 _ 避免与 data 里已有的 message 冲突
-        _data._msg = message || msg;
-        _data._message = _data._msg;
+        _data._msg = message;
+        _data._message = message;
       }
       resolve(_data);
     } else {
-      const _msg = message || msg || _$Temp.defaultMsg;
-      const error = new Error(_msg);
+      const error = new Error(message);
       error.code = code;
       error.response = response;
-      error._msg = _msg;
-      error._message = _msg;
+      error._msg = message;
+      error._message = message;
       reject(error);
     }
   }
 
   errorHandler(err, reject) {
+    if (this.isResponse) {
+      reject(err);
+      return;
+    }
+    if (this.isResponseData) {
+      reject(err?.data ?? err);
+      return;
+    }
     const response = err.response || err;
     if (response) {
-      const message =
-        (response.data && (response.data.message || response.data.msg)) ||
-        response.msg ||
-        response.statusText ||
-        _$Temp.defaultMsg;
+      const message = this.handleMsg(response, { useStatusText: true });
       const error = new Error(message);
       error.code = response.status;
       error.response = response;
@@ -371,8 +393,49 @@ class DataModel {
       }
       return reject(error);
     }
-    return reject(err || { _msg: _$Temp.defaultMsg });
+    return reject(err || { _msg: _$Temp.defaultErrMsg });
+  }
+
+  handleMsg(response, { useStatusText }) {
+    let message =
+      (response.data && (response.data.message || response.data.msg)) ||
+      response.msg ||
+      this.getNetworkErrMsg(response);
+
+    if (useStatusText) {
+      message = response.statusText;
+    }
+
+    return message || _$Temp.defaultErrMsg;
+  }
+
+  getNetworkErrMsg(httpCode) {
+    const { networkErrMsg } = _$Temp;
+    if (httpCode === "ERR_NETWORK") {
+      return networkErrMsg;
+    }
+    return checkNetwork() ? "" : networkErrMsg;
+  }
+}
+
+/**
+ * 检测网络状态
+ * @param {*} errMsg 网络异常消息
+ * @returns
+ */
+export function checkNetwork() {
+  if (!navigator) {
+    return true;
+  }
+  if (navigator.onLine === false) {
+    return false;
   }
+  const connection = navigator.connection || navigator.mozConnection || navigator.webkitConnection;
+  if (!connection) {
+    return true;
+  }
+  const noNetwork = connection?.type === "none" || connection.downlink === 0 || connection.effectiveType === null;
+  return !noNetwork;
 }
 
 function setDefaultAxios(ax) {
@@ -383,7 +446,13 @@ function setDefaultAxios(ax) {
 
 export function setDefaultErrMsg(msg) {
   if (msg) {
-    _$Temp.defaultMsg = msg;
+    _$Temp.defaultErrMsg = msg;
+  }
+}
+
+export function setNetworkErrMsg(msg) {
+  if (msg) {
+    _$Temp.networkErrMsg = msg;
   }
 }