util-helpers 4.15.2 → 4.15.3

package/esm/filterTree.js

@@ -7,7 +7,7 @@ import { isObject } from "./utils/type";
  * 过滤/筛选树节点。<br/><br/>如果某节点被过滤掉，它的子节点也一并抛弃
  * 
  * @static
- * @alias module:Processor.filterTree
+ * @alias module:Tree.filterTree
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/esm/findTreeNode.js

@@ -8,7 +8,7 @@ import { isObject } from "./utils/type";
  * 查找树结构数据节点
  * 
  * @static
- * @alias module:Other.findTreeNode
+ * @alias module:Tree.findTreeNode
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/esm/findTreeNodes.js

@@ -8,7 +8,7 @@ import { isObject } from "./utils/type";
  * 查找树结构数据多个节点
  * 
  * @static
- * @alias module:Other.findTreeNodes
+ * @alias module:Tree.findTreeNodes
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/esm/findTreeSelect.js

@@ -54,7 +54,7 @@ function internalFindTreeSelect(tree, predicate, childrenField) {
  * 查找包含当前节点的所有父级节点
  * 
  * @static
- * @alias module:Other.findTreeSelect
+ * @alias module:Tree.findTreeSelect
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/esm/index.js

@@ -46,10 +46,6 @@ export { default as normalizeString } from './normalizeString';
 export { default as safeDate } from './safeDate';
 export { default as formatMobile } from './formatMobile';
 export { default as padZero } from './padZero';
-export { default as transformFieldNames } from './transformFieldNames';
-export { default as listToTree } from './listToTree';
-export { default as treeToList } from './treeToList';
-export { default as filterTree } from './filterTree';
 
 /**
  * 数学计算，修正浮点数计算问题
@@ -106,6 +102,17 @@ export { default as waitTime } from './waitTime';
 export { default as calculateCursorPosition } from './calculateCursorPosition';
 export { default as randomString } from './randomString';
 export { default as strlen } from './strlen';
+
+/**
+ * 树结构数据查询、过滤、转换等处理方法
+ *
+ * @module Tree
+ * @since 4.14.0
+ */
+export { default as transformFieldNames } from './transformFieldNames';
+export { default as listToTree } from './listToTree';
+export { default as treeToList } from './treeToList';
+export { default as filterTree } from './filterTree';
 export { default as findTreeNode } from './findTreeNode';
 export { default as findTreeNodes } from './findTreeNodes';
 export { default as findTreeSelect } from './findTreeSelect';

package/esm/listToTree.js

@@ -40,7 +40,7 @@ function processEmptyChildren(arr, options) {
  * 列表数据转树结构
  * 
  * @static
- * @alias module:Processor.listToTree
+ * @alias module:Tree.listToTree
  * @since 4.14.0
  * @template {Record<string,any>} [T=Record<string,any>]
  * @template {*} [R=T&Record<string,any>]

package/esm/replaceChar.js

@@ -16,20 +16,24 @@ import normalizeString from './normalizeString';
  * @returns {string} 处理后的字符
  * @example
  *
- * // 手机号
+ * // 手机号 前3后4
  * replaceChar('13000000000'); // 130****0000
  *
- * // 身份证
- * replaceChar('130701199310302288'); // 130***********2288
+ * // 身份证 前6后4
+ * replaceChar('130701199310302288', { start: 6, end: -4 }); // 130701********2288
  *
- * // 邮箱
+ * // 邮箱 @前两位
  * const email = '12345@qq.com'
+ * const emailAtIndex = email.indexOf('@');
+ * replaceChar(email, { start: emailAtIndex - 2, end: emailAtIndex }); // 123**@qq.com
+ * // 邮箱 前2和@后面内容，固定替换字符4位
  * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4}); // 12****@qq.com
  *
- * // 银行卡号
+ * // 银行卡号 只展示后4位，固定替换字符4位
  * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4}); // ****0018
- *
- * // 带格式的银行卡号，忽略空字符串
+ * // 银行卡号 前6后4
+ * replaceChar('6228480402564890018', { start: 6, end: -4 }); // 622848*********0018
+ * // 银行卡号 前4后3 忽略格式的空格
  * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '}); // 6228 **** **** **** 018
  *
  * // 用户名

package/esm/transformFieldNames.doc.js

@@ -5,7 +5,7 @@
  * 转换字段名，返回一个转换字段后的值，不改变原值。
  * 
  * @static
- * @alias module:Processor.transformFieldNames
+ * @alias module:Tree.transformFieldNames
  * @since 4.14.0
  * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
  * @param {object} fieldNames 字段名映射

package/esm/transformFieldNames.type.js

@@ -1,5 +1,3 @@
-// @ts-nocheck
-
 // 交换字段名
 /**
  * @template {*} D
@@ -8,10 +6,10 @@
  */
 
 // 交换字段名，支持嵌套
-// 先排除子级字段名，再交换字段名，然后加上子级字段名，再替换一次。这里的 F 有类型问题，因为排除了子级字段名，暂时没有比较好的方案处理。
+// 先排除子级字段名，再交换字段名，然后加上子级字段名，再替换一次。
 /**
  * @template {*} D
- * @template {Record<string, keyof D>} F
+ * @template {Record<string, any>} F
  * @template {string} C
  * @typedef {(C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[]} TransformFieldNames
  */

package/esm/treeToList.js

@@ -7,7 +7,7 @@ import { isObject } from "./utils/type";
  * 树结构转列表数据
  * 
  * @static
- * @alias module:Processor.treeToList
+ * @alias module:Tree.treeToList
  * @since 4.14.0
  * @template {Record<string,any>} T
  * @template {keyof T} K

package/esm/utils/config.js

@@ -15,5 +15,5 @@ function setDisableWarning(bool) {
 }
 
 // eslint-disable-next-line no-undef
-var version = "4.15.2";
+var version = "4.15.3";
 export { config, setDisableWarning, version };

package/lib/filterTree.js

@@ -15,7 +15,7 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
  * 过滤/筛选树节点。<br/><br/>如果某节点被过滤掉，它的子节点也一并抛弃
  * 
  * @static
- * @alias module:Processor.filterTree
+ * @alias module:Tree.filterTree
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/lib/findTreeNode.js

@@ -16,7 +16,7 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  * 查找树结构数据节点
  * 
  * @static
- * @alias module:Other.findTreeNode
+ * @alias module:Tree.findTreeNode
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/lib/findTreeNodes.js

@@ -16,7 +16,7 @@ function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len
  * 查找树结构数据多个节点
  * 
  * @static
- * @alias module:Other.findTreeNodes
+ * @alias module:Tree.findTreeNodes
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/lib/findTreeSelect.js

@@ -59,7 +59,7 @@ function internalFindTreeSelect(tree, predicate, childrenField) {
  * 查找包含当前节点的所有父级节点
  * 
  * @static
- * @alias module:Other.findTreeSelect
+ * @alias module:Tree.findTreeSelect
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/lib/index.js

@@ -356,10 +356,6 @@ var _normalizeString = _interopRequireDefault(require("./normalizeString"));
 var _safeDate = _interopRequireDefault(require("./safeDate"));
 var _formatMobile = _interopRequireDefault(require("./formatMobile"));
 var _padZero = _interopRequireDefault(require("./padZero"));
-var _transformFieldNames = _interopRequireDefault(require("./transformFieldNames"));
-var _listToTree = _interopRequireDefault(require("./listToTree"));
-var _treeToList = _interopRequireDefault(require("./treeToList"));
-var _filterTree = _interopRequireDefault(require("./filterTree"));
 var _plus = _interopRequireDefault(require("./plus"));
 var _minus = _interopRequireDefault(require("./minus"));
 var _times = _interopRequireDefault(require("./times"));
@@ -369,6 +365,10 @@ var _waitTime = _interopRequireDefault(require("./waitTime"));
 var _calculateCursorPosition = _interopRequireDefault(require("./calculateCursorPosition"));
 var _randomString = _interopRequireDefault(require("./randomString"));
 var _strlen = _interopRequireDefault(require("./strlen"));
+var _transformFieldNames = _interopRequireDefault(require("./transformFieldNames"));
+var _listToTree = _interopRequireDefault(require("./listToTree"));
+var _treeToList = _interopRequireDefault(require("./treeToList"));
+var _filterTree = _interopRequireDefault(require("./filterTree"));
 var _findTreeNode = _interopRequireDefault(require("./findTreeNode"));
 var _findTreeNodes = _interopRequireDefault(require("./findTreeNodes"));
 var _findTreeSelect = _interopRequireDefault(require("./findTreeSelect"));

package/lib/listToTree.js

@@ -48,7 +48,7 @@ function processEmptyChildren(arr, options) {
  * 列表数据转树结构
  * 
  * @static
- * @alias module:Processor.listToTree
+ * @alias module:Tree.listToTree
  * @since 4.14.0
  * @template {Record<string,any>} [T=Record<string,any>]
  * @template {*} [R=T&Record<string,any>]

package/lib/replaceChar.js

@@ -22,20 +22,24 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "d
  * @returns {string} 处理后的字符
  * @example
  *
- * // 手机号
+ * // 手机号 前3后4
  * replaceChar('13000000000'); // 130****0000
  *
- * // 身份证
- * replaceChar('130701199310302288'); // 130***********2288
+ * // 身份证 前6后4
+ * replaceChar('130701199310302288', { start: 6, end: -4 }); // 130701********2288
  *
- * // 邮箱
+ * // 邮箱 @前两位
  * const email = '12345@qq.com'
+ * const emailAtIndex = email.indexOf('@');
+ * replaceChar(email, { start: emailAtIndex - 2, end: emailAtIndex }); // 123**@qq.com
+ * // 邮箱 前2和@后面内容，固定替换字符4位
  * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4}); // 12****@qq.com
  *
- * // 银行卡号
+ * // 银行卡号 只展示后4位，固定替换字符4位
  * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4}); // ****0018
- *
- * // 带格式的银行卡号，忽略空字符串
+ * // 银行卡号 前6后4
+ * replaceChar('6228480402564890018', { start: 6, end: -4 }); // 622848*********0018
+ * // 银行卡号 前4后3 忽略格式的空格
  * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '}); // 6228 **** **** **** 018
  *
  * // 用户名

package/lib/transformFieldNames.doc.js

@@ -11,7 +11,7 @@ exports["default"] = void 0;
  * 转换字段名，返回一个转换字段后的值，不改变原值。
  * 
  * @static
- * @alias module:Processor.transformFieldNames
+ * @alias module:Tree.transformFieldNames
  * @since 4.14.0
  * @param {object[]} data 对象数组。如果是树结构数据，需要指定第三个参数 childrenField
  * @param {object} fieldNames 字段名映射

package/lib/treeToList.js

@@ -15,7 +15,7 @@ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input ==
  * 树结构转列表数据
  * 
  * @static
- * @alias module:Processor.treeToList
+ * @alias module:Tree.treeToList
  * @since 4.14.0
  * @template {Record<string,any>} T
  * @template {keyof T} K

package/lib/utils/config.js

@@ -24,5 +24,5 @@ function setDisableWarning(bool) {
 }
 
 // eslint-disable-next-line no-undef
-var version = "4.15.2";
+var version = "4.15.3";
 exports.version = version;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.15.2",
+  "version": "4.15.3",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",

package/types/filterTree.d.ts

@@ -3,7 +3,7 @@ export default filterTree;
  * 过滤/筛选树节点。<br/><br/>如果某节点被过滤掉，它的子节点也一并抛弃
  *
  * @static
- * @alias module:Processor.filterTree
+ * @alias module:Tree.filterTree
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/findTreeNode.d.ts

@@ -3,7 +3,7 @@ export default findTreeNode;
  * 查找树结构数据节点
  *
  * @static
- * @alias module:Other.findTreeNode
+ * @alias module:Tree.findTreeNode
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/findTreeNodes.d.ts

@@ -3,7 +3,7 @@ export default findTreeNodes;
  * 查找树结构数据多个节点
  *
  * @static
- * @alias module:Other.findTreeNodes
+ * @alias module:Tree.findTreeNodes
  * @since 4.15.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/findTreeSelect.d.ts

@@ -3,7 +3,7 @@ export default findTreeSelect;
  * 查找包含当前节点的所有父级节点
  *
  * @static
- * @alias module:Other.findTreeSelect
+ * @alias module:Tree.findTreeSelect
  * @since 4.14.0
  * @template {any} T
  * @template {(item: T) => boolean} F

package/types/index.d.ts

@@ -33,10 +33,6 @@ export { default as normalizeString } from "./normalizeString";
 export { default as safeDate } from "./safeDate";
 export { default as formatMobile } from "./formatMobile";
 export { default as padZero } from "./padZero";
-export { default as transformFieldNames } from "./transformFieldNames";
-export { default as listToTree } from "./listToTree";
-export { default as treeToList } from "./treeToList";
-export { default as filterTree } from "./filterTree";
 export { default as plus } from "./plus";
 export { default as minus } from "./minus";
 export { default as times } from "./times";
@@ -46,6 +42,10 @@ export { default as waitTime } from "./waitTime";
 export { default as calculateCursorPosition } from "./calculateCursorPosition";
 export { default as randomString } from "./randomString";
 export { default as strlen } from "./strlen";
+export { default as transformFieldNames } from "./transformFieldNames";
+export { default as listToTree } from "./listToTree";
+export { default as treeToList } from "./treeToList";
+export { default as filterTree } from "./filterTree";
 export { default as findTreeNode } from "./findTreeNode";
 export { default as findTreeNodes } from "./findTreeNodes";
 export { default as findTreeSelect } from "./findTreeSelect";

package/types/listToTree.d.ts

@@ -3,7 +3,7 @@ export default listToTree;
  * 列表数据转树结构
  *
  * @static
- * @alias module:Processor.listToTree
+ * @alias module:Tree.listToTree
  * @since 4.14.0
  * @template {Record<string,any>} [T=Record<string,any>]
  * @template {*} [R=T&Record<string,any>]

package/types/replaceChar.d.ts

@@ -15,20 +15,24 @@ export default replaceChar;
  * @returns {string} 处理后的字符
  * @example
  *
- * // 手机号
+ * // 手机号 前3后4
  * replaceChar('13000000000'); // 130****0000
  *
- * // 身份证
- * replaceChar('130701199310302288'); // 130***********2288
+ * // 身份证 前6后4
+ * replaceChar('130701199310302288', { start: 6, end: -4 }); // 130701********2288
  *
- * // 邮箱
+ * // 邮箱 @前两位
  * const email = '12345@qq.com'
+ * const emailAtIndex = email.indexOf('@');
+ * replaceChar(email, { start: emailAtIndex - 2, end: emailAtIndex }); // 123**@qq.com
+ * // 邮箱 前2和@后面内容，固定替换字符4位
  * replaceChar(email, {start: 2, end: email.indexOf('@'), repeat: 4}); // 12****@qq.com
  *
- * // 银行卡号
+ * // 银行卡号 只展示后4位，固定替换字符4位
  * replaceChar('6228480402564890018', {start: 0, end: -4, repeat: 4}); // ****0018
- *
- * // 带格式的银行卡号，忽略空字符串
+ * // 银行卡号 前6后4
+ * replaceChar('6228480402564890018', { start: 6, end: -4 }); // 622848*********0018
+ * // 银行卡号 前4后3 忽略格式的空格
  * replaceChar('6228 4804 0256 4890 018', {start: 4, end: -4, exclude: ' '}); // 6228 **** **** **** 018
  *
  * // 用户名

package/types/transformFieldNames.type.d.ts

@@ -1,2 +1,2 @@
 export type ExchangeFieldNames<D extends unknown, F extends Record<string, keyof D>> = Omit<D, F[keyof F]> & { [P in keyof F]: D[F[P]]; };
-export type TransformFieldNames<D extends unknown, F extends Record<string, keyof D>, C extends string> = (C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[];
+export type TransformFieldNames<D extends unknown, F extends Record<string, any>, C extends string> = (C extends keyof D ? ExchangeFieldNames<Omit<D, C> & Record<C, TransformFieldNames<D, F, C>>, F> : ExchangeFieldNames<D, F>)[];

package/types/treeToList.d.ts

@@ -3,7 +3,7 @@ export default treeToList;
  * 树结构转列表数据
  *
  * @static
- * @alias module:Processor.treeToList
+ * @alias module:Tree.treeToList
  * @since 4.14.0
  * @template {Record<string,any>} T
  * @template {keyof T} K