@hzab/data-model 1.7.0 → 1.7.2

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+# @hzab/data-model@1.7.2
+
+feat: axios.js getCancelTokenSource 获取 axios.CancelToken.source， 用于取消请求
+
+# @hzab/data-model@1.7.1
+
+feat: sortKey/orderByColumn 支持对象格式，支持定义数据类型、自定义数据处理函数；自定义数据对比函数
+
 # @hzab/data-model@1.7.0
 
 feat: 本地数据支持排序查询列表数据

package/README.md

@@ -188,10 +188,21 @@ function Demo({ orgId }) {
 
 ### query 配置
 
-| 参数                  | 类型                 | 必填 | 默认值 | 说明                                                      |
-| --------------------- | -------------------- | ---- | ------ | --------------------------------------------------------- |
-| sortKey/orderByColumn | string/Array[string] | 否   | -      | 排序字段，支持多维度排序，按照传入的顺序排优先级          |
-| sortType/isAsc        | string/Object        | 否   | -      | 排序规则，支持对象配置各字段排序规则 正序: asc 倒序: desc |
+| 参数                  | 类型                                      | 必填 | 默认值 | 说明                                                      |
+| --------------------- | ----------------------------------------- | ---- | ------ | --------------------------------------------------------- |
+| sortKey/orderByColumn | string/Object/Array[string]/Array[Object] | 否   | -      | 排序字段，支持多维度排序，按照传入的顺序排优先级          |
+| sortType/isAsc        | string/Object                             | 否   | -      | 排序规则，支持对象配置各字段排序规则 正序: asc 倒序: desc |
+
+### sortKey/orderByColumn Object 配置
+
+| 参数          | 类型     | 必填 | 默认值 | 说明                                                                                                                       |
+| ------------- | -------- | ---- | ------ | -------------------------------------------------------------------------------------------------------------------------- |
+| path          | string   | 否   | -      | path 取值路径字符串                                                                                                        |
+| type          | string   | 否   | -      | 值类型 用于进行内部相关转换 date                                                                                           |
+| customFormat  | Function | 否   | -      | 自定义数据处理函数                                                                                                         |
+| customCompare | Function | 否   | -      | 自定义数据对比函数 (a, b)=>number，如果 a 小于 b，返回值为负数，如果 a 大于 b，返回值为正数，如果两个元素相等，返回值为 0。NaN 被视为 0。 |
+
+- type 目前支持的类型: date
 
 # 组件开发流程
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hzab/data-model",
-  "version": "1.7.0",
+  "version": "1.7.2",
   "description": "data model",
   "main": "src",
   "scripts": {
@@ -43,6 +43,7 @@
     "js-cookie": ">=3.0.5"
   },
   "dependencies": {
+    "dayjs": "^1.11.7",
     "axios": ">=1.6.2",
     "js-cookie": ">=3.0.5",
     "nanoid": "^3.3.7"

package/src/ArrayUtils.js

@@ -1,5 +1,6 @@
 import { nanoid } from "nanoid";
 import _ from "lodash";
+import dayjs from "dayjs";
 
 export const STATE_CODE = {
   SUC: 200,
@@ -91,39 +92,49 @@ export class ArrayUtils {
     if (!sortKey && !sortType) {
       return _list;
     }
-    const keys = Array.isArray(sortKey) ? sortKey : [sortKey];
+    const paths = Array.isArray(sortKey) ? sortKey : [sortKey];
     _list.sort((a, b) => {
-      return this.compareData(a, b, { keys, sortType });
+      return this.compareData(a, b, { paths, sortType });
     });
     return _list;
   }
 
   /**
-   * 根据传入的 keys 比较对象目标数据先后顺序
+   * 根据传入的 paths 比较对象目标数据先后顺序
    * @param dataA
    * @param dataB
    * @param opt
-   * @param opt.keys 数据 key 数组
-   * @param opt.keyIdx 当前数据下标
+   * @param opt.paths 数据 path 数组
+   * @param opt.pathIdx 当前数据下标
    * @param opt.sortType 排序规则
    * @returns
    */
-  compareData(dataA, dataB, opt = { keys, keyIdx: 0, sortType: "desc" }) {
-    const { keys, keyIdx = 0, sortType = "desc" } = opt;
-    const key = keys[keyIdx];
+  compareData(dataA, dataB, opt = { paths, pathIdx: 0, sortType: "desc" }) {
+    const { paths, pathIdx = 0, sortType = "desc" } = opt;
+    const path = paths[pathIdx];
+    let _path = path;
 
+    if (path && typeof path === "object") {
+      // 外部自定义比较函数
+      if (typeof path.customCompare === "function") {
+        return direction * path.customCompare(dataA, dataB, opt);
+      }
+      _path = path.path;
+    }
+
+    /** 排序规则 */
     let direction = 1;
     // 兼容 string 及 object 类型
     let _sortType = sortType;
     if (typeof _sortType === "object") {
-      _sortType = _sortType[key];
+      _sortType = _sortType[_path];
     }
     if (_sortType === "asc") {
       direction = -1;
     }
 
-    const valueA = _.get(dataA, key);
-    const valueB = _.get(dataB, key);
+    let valueA = this.handleValByKey(dataA, path);
+    let valueB = this.handleValByKey(dataB, path);
     if (valueA < valueB) {
       return -1 * direction;
     }
@@ -131,13 +142,42 @@ export class ArrayUtils {
       return 1 * direction;
     }
 
-    if (keyIdx + 1 >= keys.length) {
+    if (pathIdx + 1 >= paths.length) {
       return 0;
     }
 
     if (valueA == valueB) {
       // 继续使用次选排序规则排序
-      return this.compareData(dataA, dataB, { ...opt, keyIdx: keyIdx + 1 });
+      return this.compareData(dataA, dataB, { ...opt, pathIdx: pathIdx + 1 });
+    }
+  }
+
+  /**
+   * 根据 path 配置对数据进行处理
+   * @param {Object} data 数据
+   * @param {string/Object} path 取值路径字符串 或 取值配置
+   * @param {string} path.path 取值路径字符串
+   * @param {string} path.type 值类型 用于进行相关转换
+   * @param {Function} path.customFormat 自定义数据处理函数
+   */
+  handleValByKey(data, path) {
+    if (typeof path === "string") {
+      return _.get(data, path);
+    }
+    if (path === null || path === undefined) {
+      return;
+    }
+    if (typeof path === "object") {
+      let val = _.get(data, path.path);
+      // 日期格式转为时间戳进行比较
+      if (path?.type === "date") {
+        val = dayjs(val).valueOf();
+      }
+      // 外部自定义数据格式函数,便于排序比较
+      if (typeof path?.customFormat === "function") {
+        val = customFormat(val);
+      }
+      return val;
     }
   }
 

package/src/axios.js

@@ -113,8 +113,20 @@ export function setAxAuthorization(token) {
   setAxHeaders("Authorization", token);
 }
 
+/**
+ * 设置 baseUrl
+ * @param {*} url
+ */
 export function setAxBaseUrl(url) {
   setAxDefaults("baseURL", url);
 }
 
+/**
+ * 获取 axios.CancelToken.source， 用于取消请求
+ * @returns
+ */
+export function getCancelTokenSource() {
+  return axios.CancelToken.source();
+}
+
 export default axios;