@zcrkey/js-utils 0.0.4 → 0.0.6

package/dist/{util.d.ts → cjs/util.d.ts}

@@ -10,7 +10,7 @@ export default class CrUtil {
      * @param value
      * @returns boolean
      */
-    static isObject<T = any>(value: T): value is T extends Array<any> ? never : T;
+    static isObject<T = any>(value: T): value is T extends object ? (T extends any[] ? never : T) : never;
     /**
      * 判断是否为空对象
      * @param value
@@ -28,31 +28,37 @@ export default class CrUtil {
      * @param value
      * @returns boolean
      */
-    static isDate(value: any): boolean;
+    static isDate(value: unknown): boolean;
     /**
      * 判断是否为字符串
      * @param value
      * @returns boolean
      */
-    static isString(value: any): value is string;
+    static isString(value: unknown): value is string;
     /**
      * 判断是否为数字
      * @param value
      * @returns boolean
      */
-    static isNumber(value: any): value is number;
+    static isNumber(value: unknown): value is number;
     /**
      * 判断是否为文件 File
      * @param value
      * @returns boolean
      */
-    static isFile(value: any): value is File;
+    static isFile(value: unknown): value is File;
     /**
      * 判断是否为 Boolean
      * @param value
      * @returns boolean
      */
-    static isBoolean(value: any): value is boolean;
+    static isBoolean(value: unknown): value is boolean;
+    /**
+     * 判断是否为 Function
+     * @param value
+     * @returns boolean
+     */
+    static isFunction(value: unknown): value is (...args: any[]) => any;
     /**
      * 去掉字符串前后所有空格
      * @param str
@@ -65,9 +71,16 @@ export default class CrUtil {
      * @returns number
      */
     static getArrayDimension(arr: any[]): number;
+    /**
+     * 深拷贝
+     * @param value
+     * @returns
+     */
+    static cloneDeep<T>(value: T): T;
     /**
      * 深拷贝
      * @param target
+     * @deprecated 即将移除，使用 {@link CrUtil.cloneDeep} 替代
      * @returns
      */
     static deepCopy<T = any>(target: T): T;
@@ -78,6 +91,7 @@ export default class CrUtil {
      * @param settings.idField 默认值 id
      * @param settings.pidField 默认值 parentId
      * @param settings.childrenField 默认值 children
+     * @deprecated 即将移除，使用 {@link CrObjUtil.listToTree} 替代
      * @returns
      */
     static listToTreeData(listData: any[], settings?: {
@@ -94,6 +108,7 @@ export default class CrUtil {
      * @param settings.idField 默认值 id
      * @param settings.pidField 默认值 parentId
      * @param settings.childrenField 默认值 children
+     * @deprecated 即将移除，使用 {@link CrObjUtil.treeToList} 替代
      * @returns
      */
     static treeDataToListData(treeData: any[], pid?: string | number, settings?: {
@@ -110,6 +125,7 @@ export default class CrUtil {
      * @param settings.valueField 默认值 value
      * @param settings.idField 默认值 id
      * @param settings.pidField 默认值 parentId
+     * @deprecated 即将移除，使用 {@link CrObjUtil.getFlatParentDatas} 替代
      * @returns
      */
     static getParentNodes<T, R extends Record<string, any>>(listData: R[], value: number | string, settings?: {
@@ -135,6 +151,19 @@ export default class CrUtil {
     static paramsParse(str: string, settings?: {
         ignoreQueryPrefix: boolean;
     }): {};
+    /**
+     * 获取 URL 参数
+     * @param {*} url
+     * @returns
+     * @example
+     * "https://example.com?foo=bar&baz=qux" => {"query":{"foo":"bar","baz":"qux"},"hash":{},"all":{"foo":"bar","baz":"qux"}}
+     * "https://example.com/page?foo=1#/?a=1&b=2" => {"query":{"foo":"1"},"hash":{"/":"","a":"1","b":"2"},"all":{"foo":"1","/":"","a":"1","b":"2"}},
+     */
+    static getQueryParams(url: string): {
+        query: Record<string, any>;
+        hash: Record<string, any>;
+        all: Record<string, any>;
+    };
     /**
      * 版本号比较
      * @param v1
@@ -171,4 +200,10 @@ export default class CrUtil {
      * @returns
      */
     static compareDataDiff(data1: any, data2: any): Record<string, "added" | "removed" | "modified">;
+    /**
+     * 格式化为千分位
+     * @param value
+     * @returns 12345.6789 => 12,345.6789
+     */
+    static fmtThousands(value: number | string | undefined): string;
 }

package/dist/cjs/util.js

@@ -0,0 +1,572 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/util.ts
+var util_exports = {};
+__export(util_exports, {
+  default: () => CrUtil
+});
+module.exports = __toCommonJS(util_exports);
+var import_lodash = require("lodash");
+var import_qs = __toESM(require("qs"));
+var CrUtil = class {
+  /**
+   * 判断是否为数组
+   * @param value
+   * @returns boolean
+   */
+  static isArray(value) {
+    return Array.isArray(value);
+  }
+  /**
+   * 判断是否为对象
+   * @param value
+   * @returns boolean
+   */
+  static isObject(value) {
+    return typeof value === "object" && value !== null && !CrUtil.isArray(value);
+  }
+  /**
+   * 判断是否为空对象
+   * @param value
+   * @returns boolean
+   */
+  static isEmptyObject(value) {
+    return Object.keys(value).length === 0 && value.constructor === Object;
+  }
+  /**
+   * 判断是否对象的属性是否全部为空
+   * @param value
+   * @returns boolean
+   */
+  static isObjectPropertiesAllEmpty(value) {
+    return Object.keys(value).every((key) => {
+      const _value = value[key];
+      return _value === void 0 || _value === null || _value === "" || _value === 0 && typeof _value === "number" || isNaN(_value);
+    });
+  }
+  /**
+   * 判断是否为日期
+   * @param value
+   * @returns boolean
+   */
+  static isDate(value) {
+    return Object.prototype.toString.call(value) === "[object Date]";
+  }
+  /**
+   * 判断是否为字符串
+   * @param value
+   * @returns boolean
+   */
+  static isString(value) {
+    return Object.prototype.toString.call(value) === "[object String]";
+  }
+  /**
+   * 判断是否为数字
+   * @param value
+   * @returns boolean
+   */
+  static isNumber(value) {
+    return typeof value === "number" && !isNaN(value);
+  }
+  /**
+   * 判断是否为文件 File
+   * @param value
+   * @returns boolean
+   */
+  static isFile(value) {
+    return Object.prototype.toString.call(value) === "[object File]";
+  }
+  /**
+   * 判断是否为 Boolean
+   * @param value
+   * @returns boolean
+   */
+  static isBoolean(value) {
+    return Object.prototype.toString.call(value) === "[object Boolean]";
+  }
+  /**
+   * 判断是否为 Function
+   * @param value
+   * @returns boolean
+   */
+  static isFunction(value) {
+    return typeof value === "function";
+  }
+  /**
+   * 去掉字符串前后所有空格
+   * @param str
+   * @returns string
+   */
+  static trim(str) {
+    return (str + "").replace(/(^[\s\n\t]+|[\s\n\t]+$)/g, "");
+  }
+  /**
+   * 获取数组为几维数组
+   * @param arr
+   * @returns number
+   */
+  static getArrayDimension(arr) {
+    if (!CrUtil.isArray(arr))
+      return 0;
+    let maxDimension = 0;
+    for (let i = 0; i < arr.length; i++) {
+      const dimension = CrUtil.getArrayDimension(arr[i]);
+      maxDimension = Math.max(maxDimension, dimension);
+    }
+    return maxDimension + 1;
+  }
+  /**
+   * 深拷贝
+   * @param value
+   * @returns
+   */
+  static cloneDeep(value) {
+    return (0, import_lodash.cloneDeep)(value);
+  }
+  /**
+   * 深拷贝
+   * @param target
+   * @deprecated 即将移除，使用 {@link CrUtil.cloneDeep} 替代
+   * @returns
+   */
+  static deepCopy(target) {
+    let _target;
+    if (CrUtil.isArray(target)) {
+      _target = [];
+      for (let i = 0, len = target.length; i < len; i++) {
+        if (CrUtil.isArray(target[i]) || CrUtil.isObject(target[i])) {
+          _target.push(CrUtil.deepCopy(target[i]));
+        } else {
+          _target.push(target[i]);
+        }
+      }
+    } else if (CrUtil.isObject(target)) {
+      _target = {};
+      for (let i in target) {
+        if (CrUtil.isArray(target[i]) || CrUtil.isObject(target[i])) {
+          _target[i] = CrUtil.deepCopy(target[i]);
+        } else {
+          _target[i] = target[i];
+        }
+      }
+    } else {
+      _target = target;
+    }
+    return _target;
+  }
+  /**
+   * 列表数据转树型数据
+   * @param listData
+   * @param settings
+   * @param settings.idField 默认值 id
+   * @param settings.pidField 默认值 parentId
+   * @param settings.childrenField 默认值 children
+   * @deprecated 即将移除，使用 {@link CrObjUtil.listToTree} 替代
+   * @returns
+   */
+  static listToTreeData(listData, settings) {
+    const options = Object.assign(
+      {
+        idField: "id",
+        pidField: "parentId",
+        childrenField: "children",
+        isDeepCopy: false,
+        getData: (item) => {
+          return item;
+        }
+      },
+      settings
+    );
+    const { idField, pidField, childrenField, isDeepCopy, getData } = options;
+    if (isDeepCopy) {
+      listData = CrUtil.deepCopy(listData);
+    }
+    const pidMap = /* @__PURE__ */ new Map();
+    const idMap = /* @__PURE__ */ new Map();
+    for (const item of listData) {
+      const pid = item[pidField];
+      const id = item[idField];
+      if (!pidMap.has(pid)) {
+        pidMap.set(pid, []);
+      }
+      pidMap.get(pid).push(item);
+      idMap.set(id, item);
+    }
+    const buildTree = (pid) => {
+      const children = pidMap.get(pid) || [];
+      return children.map((item) => {
+        const rawChildren = buildTree(item[idField]);
+        const node = {
+          ...getData(item)
+        };
+        if (rawChildren.length > 0) {
+          node[childrenField] = rawChildren;
+        }
+        return node;
+      });
+    };
+    const rootPids = /* @__PURE__ */ new Set();
+    for (const pid of pidMap.keys()) {
+      if (pid === void 0 || pid === null || pid === 0 || !idMap.has(pid)) {
+        rootPids.add(pid);
+      }
+    }
+    const tree = [];
+    for (const pid of rootPids) {
+      tree.push(...buildTree(pid));
+    }
+    return tree;
+  }
+  /**
+   * 树型数据转列表数据
+   * @param treeData
+   * @param settings
+   * @param settings.idField 默认值 id
+   * @param settings.pidField 默认值 parentId
+   * @param settings.childrenField 默认值 children
+   * @deprecated 即将移除，使用 {@link CrObjUtil.treeToList} 替代
+   * @returns
+   */
+  static treeDataToListData(treeData, pid = 0, settings) {
+    let options = Object.assign(
+      {
+        idField: "id",
+        pidField: "parentId",
+        childrenField: "children",
+        isDeepCopy: false
+      },
+      settings
+    );
+    let listData = [];
+    for (let i = 0; i < treeData.length; i++) {
+      const node = treeData[i];
+      const item = { ...node };
+      item[options.pidField] = pid;
+      delete item[options.childrenField];
+      listData.push(item);
+      if (node[options.childrenField]) {
+        const childrenList = this.treeDataToListData(
+          node[options.childrenField],
+          item[options.idField],
+          settings
+        );
+        listData.push(...childrenList);
+      }
+    }
+    if (options.isDeepCopy) {
+      listData = CrUtil.deepCopy(listData);
+    }
+    return listData;
+  }
+  /**
+   * 获取所有父级数据（包含自身）
+   * @param listData
+   * @param value
+   * @param settings
+   * @param settings.valueField 默认值 value
+   * @param settings.idField 默认值 id
+   * @param settings.pidField 默认值 parentId
+   * @deprecated 即将移除，使用 {@link CrObjUtil.getFlatParentDatas} 替代
+   * @returns
+   */
+  static getParentNodes(listData, value, settings) {
+    const options = Object.assign(
+      {
+        valueField: "value",
+        idField: "id",
+        pidField: "parentId",
+        getData: (item) => {
+          return item;
+        }
+      },
+      settings
+    );
+    if (!(listData && listData.length > 0) || !value) {
+      return [];
+    }
+    const idField = options.idField;
+    const pidField = options.pidField;
+    const valueField = options.valueField;
+    const nodes = [];
+    let node = listData.find(
+      (item) => item[valueField] == value
+    );
+    if (node) {
+      nodes.push(options.getData(node));
+      while (node && node[pidField]) {
+        const parentOption = listData.find(
+          // eslint-disable-next-line @typescript-eslint/no-loop-func
+          (item) => item[idField] == node[pidField]
+        );
+        if (parentOption) {
+          nodes.push(options.getData(parentOption));
+        }
+        node = parentOption;
+      }
+    }
+    nodes.reverse();
+    return nodes;
+  }
+  /**
+   * 参数序列化
+   * @param params {a:'1',b:{},c:[]}
+   * @returns
+   */
+  static paramsSerializer(params, settings) {
+    const options = Object.assign(
+      {
+        isFilterNonNull: false
+      },
+      settings
+    );
+    if (options.isFilterNonNull) {
+      Object.keys(params).forEach((key) => {
+        if (params[key] === null || params[key] === void 0 || params[key] === "") {
+          delete params[key];
+        }
+      });
+    }
+    return import_qs.default.stringify(params);
+  }
+  /**
+   * 参数解析
+   * @param {*} str
+   * @param {*} settings
+   * @returns
+   */
+  static paramsParse(str, settings) {
+    let obj = {};
+    let option = Object.assign(
+      {
+        ignoreQueryPrefix: true
+      },
+      settings
+    );
+    if (str) {
+      obj = import_qs.default.parse(str, option);
+    }
+    return obj;
+  }
+  /**
+   * 获取 URL 参数
+   * @param {*} url
+   * @returns
+   * @example
+   * "https://example.com?foo=bar&baz=qux" => {"query":{"foo":"bar","baz":"qux"},"hash":{},"all":{"foo":"bar","baz":"qux"}}
+   * "https://example.com/page?foo=1#/?a=1&b=2" => {"query":{"foo":"1"},"hash":{"/":"","a":"1","b":"2"},"all":{"foo":"1","/":"","a":"1","b":"2"}},
+   */
+  static getQueryParams(url) {
+    const query = {};
+    const hash = {};
+    const all = {};
+    const parse = (queryString) => {
+      if (!queryString) {
+        return {};
+      }
+      try {
+        return import_qs.default.parse(queryString);
+      } catch {
+        const result = {};
+        if (!queryString)
+          return result;
+        queryString.split("&").forEach((pair) => {
+          if (!pair)
+            return;
+          const [key, val] = pair.split("=");
+          if (key)
+            result[decodeURIComponent(key)] = decodeURIComponent(val || "");
+        });
+        return result;
+      }
+    };
+    try {
+      const [base, hashPart] = url.split("#");
+      const queryPart = base.split("?")[1];
+      Object.assign(query, parse(queryPart));
+      if (hashPart) {
+        for (const part of hashPart.split("?")) {
+          Object.assign(hash, parse(part));
+        }
+      }
+      Object.assign(all, query, hash);
+    } catch (error) {
+      console.error("getQueryParams:", error);
+    }
+    return { query, hash, all };
+  }
+  /**
+   * 版本号比较
+   * @param v1
+   * @param v2
+   * @returns number
+   * @description v1大于v2(1)、v1小于v2(-1)、v1等于v2(0)
+   */
+  static compareVersion(v1, v2) {
+    let v1Arr = CrUtil.trim(v1).split(".");
+    let v2Arr = CrUtil.trim(v2).split(".");
+    const len = Math.max(v1.length, v2.length);
+    while (v1Arr.length < len) {
+      v1Arr.push("0");
+    }
+    while (v2Arr.length < len) {
+      v2Arr.push("0");
+    }
+    for (let i = 0; i < len; i++) {
+      const num1 = parseInt(v1Arr[i]);
+      const num2 = parseInt(v2Arr[i]);
+      if (num1 > num2) {
+        return 1;
+      } else if (num1 < num2) {
+        return -1;
+      }
+    }
+    return 0;
+  }
+  /**
+   * 根据 ids 获取相对应的数据名称
+   * @param data
+   * @param ids
+   * @param settings
+   * @returns string
+   */
+  static getDataNameByIds(data, ids, settings) {
+    const options = Object.assign(
+      {
+        sep: "、",
+        idField: "id",
+        nameField: "name"
+      },
+      settings
+    );
+    let str = "";
+    if (ids && ids.length > 0) {
+      str = ids.map((id) => {
+        let item = data.find((item2) => item2[options.idField] == id);
+        if (item) {
+          return item[options.nameField];
+        } else {
+          return "";
+        }
+      }).join(options.sep);
+    }
+    return str;
+  }
+  /**
+   * 追加html标签属性值
+   * @param htmlStr
+   * @param tagName
+   * @param attrName
+   * @param newAttrValue
+   * @returns string
+   */
+  static appendHtmlTagAttr(htmlStr, tagName, attrName, newAttrValue) {
+    let regex = new RegExp(`(<${tagName}\\s+)([^>]*?)([^>]*>)`, "g");
+    let replacedHtml = htmlStr.replace(regex, function(match, p1, p2, p3) {
+      let _regex = new RegExp(`${attrName}="(.*?)"`, "g");
+      if (_regex.exec(match)) {
+        let __regex = new RegExp(
+          `(<${tagName}\\s+)([^>]*?)${attrName}="(.*)"([^>]*>)`,
+          "g"
+        );
+        return match.replace(__regex, function(_match, _p1, _p2, _p3, _p4) {
+          return _p1 + _p2 + `${attrName}="${_p3} ${newAttrValue}"` + _p4;
+        });
+      } else {
+        return p1 + `${attrName}="${newAttrValue}" ` + p3;
+      }
+    });
+    replacedHtml = replacedHtml.replace(
+      new RegExp(`<${tagName}>`, "g"),
+      `<${tagName} ${attrName}="${newAttrValue}">`
+    );
+    return replacedHtml;
+  }
+  /**
+   * 比较数据差异
+   * @param data1
+   * @param data2
+   * @returns
+   */
+  static compareDataDiff(data1, data2) {
+    const diffFieldSet = {};
+    const compare = (path, o1, o2) => {
+      if (CrUtil.isArray(o1) && CrUtil.isArray(o2)) {
+        const lengthDiff = o1.length - o2.length;
+        if (lengthDiff !== 0) {
+          diffFieldSet[path] = "modified";
+          if (lengthDiff > 0) {
+            for (let i = o2.length; i < o1.length; i++) {
+              diffFieldSet[`${path}[${i}]`] = "removed";
+            }
+          } else {
+            for (let i = o1.length; i < o2.length; i++) {
+              diffFieldSet[`${path}[${i}]`] = "added";
+            }
+          }
+        } else {
+          for (let i = 0; i < o1.length; i++) {
+            compare(`${path}[${i}]`, o1[i], o2[i]);
+          }
+        }
+      } else if (CrUtil.isObject(o1) && CrUtil.isObject(o2)) {
+        for (let key in o1) {
+          const _path = path ? `${path}.${key}` : key;
+          if (Object.prototype.hasOwnProperty.call(o1, key) && !(key in o2)) {
+            diffFieldSet[_path] = "removed";
+          } else if (Object.prototype.hasOwnProperty.call(o2, key)) {
+            compare(_path, o1[key], o2[key]);
+          }
+        }
+        for (let key in o2) {
+          const _path = path ? `${path}.${key}` : key;
+          if (Object.prototype.hasOwnProperty.call(o2, key) && !(key in o1)) {
+            diffFieldSet[_path] = "added";
+          }
+        }
+      } else if (o1 !== o2) {
+        diffFieldSet[path] = "modified";
+      }
+    };
+    compare("", data1, data2);
+    return diffFieldSet;
+  }
+  /**
+   * 格式化为千分位
+   * @param value
+   * @returns 12345.6789 => 12,345.6789
+   */
+  static fmtThousands(value) {
+    if (value == void 0 || value == null || isNaN(Number(value))) {
+      return String(value);
+    }
+    const [intPart, decimalPart] = String(value).split(".");
+    const formattedInt = intPart.replace(/\B(?=(\d{3})+(?!\d))/g, ",");
+    return decimalPart ? `${formattedInt}.${decimalPart}` : formattedInt;
+  }
+};