@zcrkey/js-utils 0.0.4 → 0.0.6

package/README.md

@@ -1,56 +1,69 @@
-# @zcrkey/js-utils
-
-一个 javascript 实用函数库
-
-## 安装和使用
-
-### 通过 import 方式安装
-
-在开始之前，你可能需要安装 [yarn](https://github.com/yarnpkg/yarn/) 或者 [pnpm](https://pnpm.io/zh/)。
-
-从 yarn 或 npm 或 pnpm 安装并引入
-
-```sh
-$ yarn add @zcrkey/js-utils
-# or
-$ npm install @zcrkey/js-utils --save
-# or
-$ pnpm install @zcrkey/js-utils --save
-
-```
-
-修改 `src/App.js`，引入 @zcrkey/js-utils 。
-
-```jsx
-import React from 'react';
-import { CrUtil } from '@zcrkey/js-utils';
-
-const App = () => (
-
-  useEffect(() => {
-    console.log(CrUtil.trim(' @zcrkey/js-utils '))
-  });
-
-  <div className="App">
-  </div>
-);
-
-export default App;
-```
-
-### 通过独立版本安装
-
-- 下载 @zcrkey/js-utils 的独立版本文件（如 index.umd.js）
-- 在 HTML 文件的 \<head\> 或 \<body\> 部分添加 \<script\> 标签，并指向下载的 @zcrkey/js-utils 文件
-- 在 HTML 文件中使用 @zcrkey/js-utils
-
-```
-<script src="./index.umd.js"></script>
-<script>
-  console.log(CrUtil.trim(' @zcrkey/js-utils '))
-</script>
-```
-
-## LICENSE
-
-MIT
+# @zcrkey/js-utils
+
+一个 javascript 实用函数库
+
+## 安装和使用
+
+### 通过 import 方式安装
+
+在开始之前，你可能需要安装 [yarn](https://github.com/yarnpkg/yarn/) 或者 [pnpm](https://pnpm.io/zh/)。
+
+从 yarn 或 npm 或 pnpm 安装并引入
+
+```sh
+$ yarn add @zcrkey/js-utils
+# or
+$ npm install @zcrkey/js-utils --save
+# or
+$ pnpm install @zcrkey/js-utils --save
+
+```
+
+修改 `src/App.js`，引入 @zcrkey/js-utils 。
+
+```jsx
+import React from 'react';
+import { CrUtil } from '@zcrkey/js-utils';
+
+const App = () => (
+
+  useEffect(() => {
+    console.log(CrUtil.trim(' @zcrkey/js-utils '))
+  });
+
+  <div className="App">
+  </div>
+);
+
+export default App;
+```
+
+### NODE 环境下使用
+
+```
+const { CrUtil } = require('@zcrkey/js-utils');
+
+console.log(CrUtil.trim(' @zcrkey/js-utils '))
+
+```
+
+### 通过独立版本安装
+
+- 下载 @zcrkey/js-utils 的独立版本文件（如 index.umd.js）
+- 在 HTML 文件的 \<head\> 或 \<body\> 部分添加 \<script\> 标签，并指向下载的 @zcrkey/js-utils 文件
+- 在 HTML 文件中使用 @zcrkey/js-utils
+
+```
+<script src="./index.umd.js"></script>
+<script>
+  console.log(CrUtil.trim(' @zcrkey/js-utils '))
+</script>
+```
+
+## 更新日志
+
+请查看 [CHANGELOG.md](https://cnb.cool/cnbkey/zcrkey/js-utils/-/blob/master/CHANGELOG.md) 获取版本更新详情。
+
+## LICENSE
+
+MIT

package/dist/cjs/eventCenter.js

@@ -0,0 +1,120 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/eventCenter.ts
+var eventCenter_exports = {};
+__export(eventCenter_exports, {
+  default: () => CrEventCenter
+});
+module.exports = __toCommonJS(eventCenter_exports);
+var CrEventCenter = class {
+  /**
+   * 新增订阅
+   *
+   * @param {*} key 名称
+   * @param {*} listener 执行函数
+   * @returns 订阅信息
+   * @example
+     this.subscription = CrEventCenter.on('名称', (参数) => {});
+   */
+  static on(key, listener) {
+    const subscriber = this.subscribers.find((item) => item.key == key);
+    if (subscriber) {
+      subscriber.listeners.push(listener);
+    } else {
+      this.subscribers.push({
+        key,
+        listeners: [listener]
+      });
+    }
+    let subscription = {
+      key,
+      listener,
+      remove: () => {
+        this.off(subscription);
+      }
+    };
+    return subscription;
+  }
+  /**
+   * 移除订阅
+   *
+   * @param {*} subscription 
+   * @param {*} type 'all'  
+   * @example
+     CrEventCenter.off(this.subscription);
+   */
+  static off(subscription, type) {
+    const index = this.subscribers.findIndex(
+      (item) => item.key == subscription.key
+    );
+    if (index > -1) {
+      if (type == "all") {
+        this.subscribers.splice(index, 1);
+      } else {
+        const subscriber = this.subscribers[index];
+        const _index = subscriber.listeners.findIndex(
+          (item) => item == subscription.listener
+        );
+        if (_index > -1) {
+          subscriber.listeners.splice(_index, 1);
+        }
+      }
+    }
+  }
+  /**
+   * 派发事件
+   *
+   * @param {*} key 名称
+   * @param {*} args 其余参数
+   * @example
+     CrEventCenter.emit('名称', 参数数据);
+   */
+  static emit(key, ...args) {
+    const subscriber = this.subscribers.find((item) => item.key == key);
+    if (subscriber && subscriber.listeners && subscriber.listeners.length > 0) {
+      subscriber.listeners.forEach((listener) => {
+        listener(...args);
+      });
+    }
+  }
+  /**
+   * 查找事件
+   *
+   * @param {*} key 名称
+   * @example
+    let subscriber = CrEventCenter.find('名称');
+   */
+  static find(key) {
+    return this.subscribers.find((item) => item.key == key);
+  }
+  /**
+   * 清理所有事件
+   *
+   * @memberof CrEventCenter
+   * @example
+     CrEventCenter.clear();
+   */
+  static clear() {
+    this.subscribers.length = 0;
+  }
+};
+/**
+ * 储存订阅者
+ */
+CrEventCenter.subscribers = [];

package/dist/cjs/index.d.ts

@@ -0,0 +1,8 @@
+export type * from './eventCenter';
+export { default as CrEventCenter } from './eventCenter';
+export type * from './objUtil';
+export { default as CrObjUtil } from './objUtil';
+export { default as CrStorage } from './storage';
+export type * from './treeUtil';
+export { default as CrTreeUtil } from './treeUtil';
+export { default as CrUtil } from './util';

package/dist/cjs/index.js

@@ -0,0 +1,51 @@
+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/index.ts
+var src_exports = {};
+__export(src_exports, {
+  CrEventCenter: () => import_eventCenter.default,
+  CrObjUtil: () => import_objUtil.default,
+  CrStorage: () => import_storage.default,
+  CrTreeUtil: () => import_treeUtil.default,
+  CrUtil: () => import_util.default
+});
+module.exports = __toCommonJS(src_exports);
+var import_eventCenter = __toESM(require("./eventCenter"));
+var import_objUtil = __toESM(require("./objUtil"));
+var import_storage = __toESM(require("./storage"));
+var import_treeUtil = __toESM(require("./treeUtil"));
+var import_util = __toESM(require("./util"));
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CrEventCenter,
+  CrObjUtil,
+  CrStorage,
+  CrTreeUtil,
+  CrUtil
+});

package/dist/cjs/objUtil.d.ts

@@ -0,0 +1,12 @@
+import { PropertyPath } from 'lodash';
+export type { PropertyPath };
+export default class CrObjUtil {
+    /**
+     * 根据字段路径获取对象值
+     * @param obj { 'a': [{ 'b': { 'c': 3 } }] }
+     * @param path 'a[0].b.c' | ['a', '0', 'b', 'c']
+     * @param defaultValue 找不到时返回的默认值
+     * @returns
+     */
+    static getValueByPath(obj: Record<string | number | symbol, any>, propertyPath: PropertyPath, defaultValue?: any): any;
+}

package/dist/cjs/objUtil.js

@@ -0,0 +1,37 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/objUtil.ts
+var objUtil_exports = {};
+__export(objUtil_exports, {
+  default: () => CrObjUtil
+});
+module.exports = __toCommonJS(objUtil_exports);
+var import_lodash = require("lodash");
+var CrObjUtil = class {
+  /**
+   * 根据字段路径获取对象值
+   * @param obj { 'a': [{ 'b': { 'c': 3 } }] }
+   * @param path 'a[0].b.c' | ['a', '0', 'b', 'c']
+   * @param defaultValue 找不到时返回的默认值
+   * @returns
+   */
+  static getValueByPath(obj, propertyPath, defaultValue) {
+    return (0, import_lodash.get)(obj, propertyPath, defaultValue);
+  }
+};

package/dist/cjs/storage.js

@@ -0,0 +1,118 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/storage.ts
+var storage_exports = {};
+__export(storage_exports, {
+  default: () => CrStorage
+});
+module.exports = __toCommonJS(storage_exports);
+var CrStorage = class {
+  /**
+   * 设置本地存储
+   * @param key
+   * @param data
+   */
+  static setLocalItem(key, data) {
+    try {
+      localStorage.setItem(key, JSON.stringify(data));
+    } catch (error) {
+      console.warn(`setLocalItem:${key}:${error}`);
+    }
+  }
+  /**
+   * 获取本地存储
+   * @param key
+   * @returns
+   */
+  static getLocalItem(key) {
+    const str = localStorage.getItem(key);
+    if (str) {
+      if (str === "undefined") {
+        return null;
+      }
+      try {
+        return JSON.parse(str);
+      } catch (error) {
+        console.warn(`getLocalItem:${key}:${error}`);
+        return null;
+      }
+    } else {
+      return null;
+    }
+  }
+  /**
+   * 清除某个本地存储
+   * @param key
+   */
+  static removeLocalItem(key) {
+    localStorage.removeItem(key);
+  }
+  /**
+   * 清除所有本地存储
+   */
+  static clearLocal() {
+    localStorage.clear();
+  }
+  /**
+   * 设置会话存储
+   * @param key
+   * @param data
+   */
+  static setSessionItem(key, data) {
+    try {
+      sessionStorage.setItem(key, JSON.stringify(data));
+    } catch (error) {
+      console.warn(`setSessionItem:${key}:${error}`);
+    }
+  }
+  /**
+   * 获取会话存储
+   * @param key
+   * @returns
+   */
+  static getSessionItem(key) {
+    const str = sessionStorage.getItem(key);
+    if (str) {
+      if (str === "undefined") {
+        return null;
+      }
+      try {
+        return JSON.parse(str);
+      } catch (error) {
+        console.warn(`getSessionItem:${key}:${error}`);
+        return null;
+      }
+    } else {
+      return null;
+    }
+  }
+  /**
+   * 清除某个会话存储
+   * @param key
+   */
+  static removeSessionItem(key) {
+    sessionStorage.removeItem(key);
+  }
+  /**
+   * 清除所有会话存储
+   */
+  static clearSession() {
+    sessionStorage.clear();
+  }
+};

package/dist/cjs/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/cjs/treeUtil.js

@@ -0,0 +1,145 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+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 __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/treeUtil.ts
+var treeUtil_exports = {};
+__export(treeUtil_exports, {
+  default: () => CrTreeUtil
+});
+module.exports = __toCommonJS(treeUtil_exports);
+var import_lodash = require("lodash");
+var CrTreeUtil = class {
+  /**
+   * 列表数据转树形数据
+   * @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(list, options) {
+    const {
+      idField = "id",
+      parentIdField = "parentId",
+      childrenField = "children",
+      isCloneDeep = true,
+      getData = (item) => item
+    } = options || {};
+    const listData = isCloneDeep ? (0, import_lodash.cloneDeep)(list) : list;
+    const treeData = [];
+    const nodeMap = /* @__PURE__ */ new Map();
+    for (const item of listData) {
+      const id = item[idField];
+      const node = {
+        ...getData(item),
+        __origin_id: id,
+        __origin_pid: item[parentIdField]
+      };
+      nodeMap.set(id, node);
+    }
+    for (const node of nodeMap.values()) {
+      const parentId = node.__origin_pid;
+      if (parentId === void 0 || parentId === null || parentId === 0 || !nodeMap.has(parentId)) {
+        treeData.push(node);
+      } else {
+        const parentNode = nodeMap.get(parentId);
+        if (!parentNode[childrenField]) {
+          parentNode[childrenField] = [];
+        }
+        parentNode[childrenField].push(node);
+      }
+    }
+    const clean = (nodes) => {
+      for (const node of nodes) {
+        delete node.__origin_id;
+        delete node.__origin_pid;
+        if (node[childrenField]) {
+          clean(node[childrenField]);
+        }
+      }
+    };
+    clean(treeData);
+    return treeData;
+  }
+  /**
+   * 树形数据转列表数据
+   * @param tree
+   * @param options
+   * @param options.childrenField 默认值 children
+   * @param options.isCloneDeep 是否需要深拷贝, 默认值为 true
+   * @returns
+   */
+  static treeToList(tree, options) {
+    const { childrenField = "children", isCloneDeep = true } = options || {};
+    const result = [];
+    const queue = [...tree];
+    while (queue.length) {
+      const node = queue.shift();
+      const children = node[childrenField];
+      const { [childrenField]: _, ...rest } = node;
+      result.push(rest);
+      if (children && children.length) {
+        queue.push(...children);
+      }
+    }
+    return isCloneDeep ? (0, import_lodash.cloneDeep)(result) : result;
+  }
+  /**
+   * 获取扁平化父数据(包含自身)
+   * @param listData
+   * @param value
+   * @param settings
+   * @param settings.valueField 默认值 value
+   * @param settings.idField 默认值 id
+   * @param settings.parentIdField 默认值 parentId
+   * @param settings.getData 过滤数据
+   */
+  static getFlatParentDatas(listData, value, settings) {
+    if (!Array.isArray(listData) || listData.length === 0 || value == null) {
+      return [];
+    }
+    const options = Object.assign(
+      {
+        valueField: "value",
+        idField: "id",
+        parentIdField: "parentId",
+        getData: (item) => {
+          return item;
+        }
+      },
+      settings
+    );
+    const nodeMap = (0, import_lodash.keyBy)(listData, options.valueField);
+    const result = [];
+    const visited = /* @__PURE__ */ new Set();
+    let current = nodeMap[value];
+    while (current && !visited.has((0, import_lodash.get)(current, options.idField))) {
+      visited.add((0, import_lodash.get)(current, options.idField));
+      result.unshift(options.getData(current));
+      const parentId = (0, import_lodash.get)(
+        current,
+        options.parentIdField
+      );
+      current = (0, import_lodash.find)(listData, [options.valueField, parentId]);
+    }
+    return result;
+  }
+};