@zcrkey/js-utils 0.0.3 → 0.0.5

package/dist/storage.js

@@ -11,10 +11,10 @@ var CrStorage = /*#__PURE__*/function () {
   _createClass(CrStorage, null, [{
     key: "setLocalItem",
     value:
-    /**
-     * 设置本地存储
-     * @param key
-     * @param data
+    /**
+     * 设置本地存储
+     * @param key
+     * @param data
      */
     function setLocalItem(key, data) {
       try {
@@ -24,10 +24,10 @@ var CrStorage = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * 获取本地存储
-     * @param key
-     * @returns
+    /**
+     * 获取本地存储
+     * @param key
+     * @returns
      */
   }, {
     key: "getLocalItem",
@@ -48,9 +48,9 @@ var CrStorage = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * 清除某个本地存储
-     * @param key
+    /**
+     * 清除某个本地存储
+     * @param key
      */
   }, {
     key: "removeLocalItem",
@@ -58,8 +58,8 @@ var CrStorage = /*#__PURE__*/function () {
       localStorage.removeItem(key);
     }
 
-    /**
-     * 清除所有本地存储
+    /**
+     * 清除所有本地存储
      */
   }, {
     key: "clearLocal",
@@ -67,10 +67,10 @@ var CrStorage = /*#__PURE__*/function () {
       localStorage.clear();
     }
 
-    /**
-     * 设置会话存储
-     * @param key
-     * @param data
+    /**
+     * 设置会话存储
+     * @param key
+     * @param data
      */
   }, {
     key: "setSessionItem",
@@ -82,10 +82,10 @@ var CrStorage = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * 获取会话存储
-     * @param key
-     * @returns
+    /**
+     * 获取会话存储
+     * @param key
+     * @returns
      */
   }, {
     key: "getSessionItem",
@@ -106,9 +106,9 @@ var CrStorage = /*#__PURE__*/function () {
       }
     }
 
-    /**
-     * 清除某个会话存储
-     * @param key
+    /**
+     * 清除某个会话存储
+     * @param key
      */
   }, {
     key: "removeSessionItem",
@@ -116,8 +116,8 @@ var CrStorage = /*#__PURE__*/function () {
       sessionStorage.removeItem(key);
     }
 
-    /**
-     * 清除所有会话存储
+    /**
+     * 清除所有会话存储
      */
   }, {
     key: "clearSession",

package/dist/treeUtil.d.ts

@@ -0,0 +1,48 @@
+export default class CrTreeUtil {
+    /**
+     * 列表数据转树形数据
+     * @param list
+     * @param options
+     * @param options.idField 默认值 id
+     * @param options.parentIdField 默认值 parentId
+     * @param options.childrenField 默认值 children
+     * @param options.isCloneDeep 是否需要深拷贝, 默认值为 true
+     * @param options.getData 处理数据
+     * @returns
+     */
+    static listToTree<T extends Record<string, any>>(list: T[], options?: {
+        idField?: string;
+        parentIdField?: string;
+        childrenField?: string;
+        isCloneDeep?: boolean;
+        getData?: (item: T) => any;
+    }): any[];
+    /**
+     * 树形数据转列表数据
+     * @param tree
+     * @param options
+     * @param options.childrenField 默认值 children
+     * @param options.isCloneDeep 是否需要深拷贝, 默认值为 true
+     * @returns
+     */
+    static treeToList<T extends Record<string, any>>(tree: T[], options?: {
+        childrenField?: string;
+        isCloneDeep?: boolean;
+    }): T[];
+    /**
+     * 获取扁平化父数据(包含自身)
+     * @param listData
+     * @param value
+     * @param settings
+     * @param settings.valueField 默认值 value
+     * @param settings.idField 默认值 id
+     * @param settings.parentIdField 默认值 parentId
+     * @param settings.getData 过滤数据
+     */
+    static getFlatParentDatas<T = any, R extends Record<string, any> = any>(listData: R[], value: number | string, settings?: {
+        valueField?: string;
+        idField?: string;
+        parentIdField?: string;
+        getData?: (item: R) => T;
+    }): T[];
+}

package/dist/treeUtil.js

@@ -0,0 +1,185 @@
+function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it.return != null) it.return(); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+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 _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : String(i); }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+import { cloneDeep as _cloneDeep, find as _find, get as _get, keyBy as _keyBy } from 'lodash';
+var CrTreeUtil = /*#__PURE__*/function () {
+  function CrTreeUtil() {
+    _classCallCheck(this, CrTreeUtil);
+  }
+  _createClass(CrTreeUtil, null, [{
+    key: "listToTree",
+    value:
+    /**
+     * 列表数据转树形数据
+     * @param list
+     * @param options
+     * @param options.idField 默认值 id
+     * @param options.parentIdField 默认值 parentId
+     * @param options.childrenField 默认值 children
+     * @param options.isCloneDeep 是否需要深拷贝, 默认值为 true
+     * @param options.getData 处理数据
+     * @returns
+     */
+    function listToTree(list, options) {
+      var _ref = options || {},
+        _ref$idField = _ref.idField,
+        idField = _ref$idField === void 0 ? 'id' : _ref$idField,
+        _ref$parentIdField = _ref.parentIdField,
+        parentIdField = _ref$parentIdField === void 0 ? 'parentId' : _ref$parentIdField,
+        _ref$childrenField = _ref.childrenField,
+        childrenField = _ref$childrenField === void 0 ? 'children' : _ref$childrenField,
+        _ref$isCloneDeep = _ref.isCloneDeep,
+        isCloneDeep = _ref$isCloneDeep === void 0 ? true : _ref$isCloneDeep,
+        _ref$getData = _ref.getData,
+        getData = _ref$getData === void 0 ? function (item) {
+          return item;
+        } : _ref$getData;
+      var listData = isCloneDeep ? _cloneDeep(list) : list;
+      var treeData = [];
+      var nodeMap = new Map();
+      var _iterator = _createForOfIteratorHelper(listData),
+        _step;
+      try {
+        for (_iterator.s(); !(_step = _iterator.n()).done;) {
+          var _item = _step.value;
+          var id = _item[idField];
+          var node = _objectSpread(_objectSpread({}, getData(_item)), {}, {
+            __origin_id: id,
+            __origin_pid: _item[parentIdField]
+          });
+          nodeMap.set(id, node);
+        }
+      } catch (err) {
+        _iterator.e(err);
+      } finally {
+        _iterator.f();
+      }
+      var _iterator2 = _createForOfIteratorHelper(nodeMap.values()),
+        _step2;
+      try {
+        for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
+          var _node = _step2.value;
+          var parentId = _node.__origin_pid;
+          if (parentId === undefined || parentId === null || parentId === 0 || !nodeMap.has(parentId)) {
+            treeData.push(_node);
+          } else {
+            var parentNode = nodeMap.get(parentId);
+            if (!parentNode[childrenField]) {
+              parentNode[childrenField] = [];
+            }
+            parentNode[childrenField].push(_node);
+          }
+        }
+      } catch (err) {
+        _iterator2.e(err);
+      } finally {
+        _iterator2.f();
+      }
+      var clean = function clean(nodes) {
+        var _iterator3 = _createForOfIteratorHelper(nodes),
+          _step3;
+        try {
+          for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
+            var node = _step3.value;
+            delete node.__origin_id;
+            delete node.__origin_pid;
+            if (node[childrenField]) {
+              clean(node[childrenField]);
+            }
+          }
+        } catch (err) {
+          _iterator3.e(err);
+        } finally {
+          _iterator3.f();
+        }
+      };
+      clean(treeData);
+      return treeData;
+    }
+
+    /**
+     * 树形数据转列表数据
+     * @param tree
+     * @param options
+     * @param options.childrenField 默认值 children
+     * @param options.isCloneDeep 是否需要深拷贝, 默认值为 true
+     * @returns
+     */
+  }, {
+    key: "treeToList",
+    value: function treeToList(tree, options) {
+      var _ref2 = options || {},
+        _ref2$childrenField = _ref2.childrenField,
+        childrenField = _ref2$childrenField === void 0 ? 'children' : _ref2$childrenField,
+        _ref2$isCloneDeep = _ref2.isCloneDeep,
+        isCloneDeep = _ref2$isCloneDeep === void 0 ? true : _ref2$isCloneDeep;
+      var result = [];
+      var queue = _toConsumableArray(tree);
+      while (queue.length) {
+        var node = queue.shift();
+        var children = node[childrenField];
+        var _ = node[childrenField],
+          rest = _objectWithoutProperties(node, [childrenField].map(_toPropertyKey));
+        result.push(rest);
+        if (children && children.length) {
+          queue.push.apply(queue, _toConsumableArray(children));
+        }
+      }
+      return isCloneDeep ? _cloneDeep(result) : result;
+    }
+
+    /**
+     * 获取扁平化父数据(包含自身)
+     * @param listData
+     * @param value
+     * @param settings
+     * @param settings.valueField 默认值 value
+     * @param settings.idField 默认值 id
+     * @param settings.parentIdField 默认值 parentId
+     * @param settings.getData 过滤数据
+     */
+  }, {
+    key: "getFlatParentDatas",
+    value: function getFlatParentDatas(listData, value, settings) {
+      if (!Array.isArray(listData) || listData.length === 0 || value == null) {
+        return [];
+      }
+      var options = Object.assign({
+        valueField: 'value',
+        idField: 'id',
+        parentIdField: 'parentId',
+        getData: function getData(item) {
+          return item;
+        }
+      }, settings);
+      var nodeMap = _keyBy(listData, options.valueField);
+      var result = [];
+      var visited = new Set();
+      var current = nodeMap[value];
+      while (current && !visited.has(_get(current, options.idField))) {
+        visited.add(_get(current, options.idField));
+        result.unshift(options.getData(current));
+        var parentId = _get(current, options.parentIdField);
+        current = _find(listData, [options.valueField, parentId]);
+      }
+      return result;
+    }
+  }]);
+  return CrTreeUtil;
+}();
+export { CrTreeUtil as default };

package/dist/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;
@@ -75,6 +88,10 @@ export default class CrUtil {
      * 列表数据转树型数据
      * @param listData
      * @param settings
+     * @param settings.idField 默认值 id
+     * @param settings.pidField 默认值 parentId
+     * @param settings.childrenField 默认值 children
+     * @deprecated 即将移除，使用 {@link CrObjUtil.listToTree} 替代
      * @returns
      */
     static listToTreeData(listData: any[], settings?: {
@@ -88,6 +105,10 @@ export default class CrUtil {
      * 树型数据转列表数据
      * @param treeData
      * @param settings
+     * @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?: {
@@ -101,6 +122,10 @@ export default class CrUtil {
      * @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<T, R extends Record<string, any>>(listData: R[], value: number | string, settings?: {
@@ -126,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
@@ -162,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;
 }