sculp-js 1.7.1 → 1.8.0

package/lib/cjs/tree.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
@@ -7,12 +7,14 @@
 'use strict';
 
 var object = require('./object.js');
+var type = require('./type.js');
 
 const defaultFieldOptions = { keyField: 'key', childField: 'children', pidField: 'pid' };
 const defaultSearchTreeOptions = {
     childField: 'children',
     nameField: 'name',
-    ignoreEmptyChild: false
+    removeEmptyChild: false,
+    ignoreCase: true
 };
 /**
  * 深度优先遍历函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
@@ -69,7 +71,9 @@ function forEachDeep(tree, iterator, children = 'children', isReverse = false) {
     walk(tree, null);
 }
 /**
- * 深度优先遍历的Map函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
+ * 创建一个新数组, 深度优先遍历的Map函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
+ *
+ * 可遍历任何带有 length 属性和数字键的类数组对象
  * @param {ArrayLike<V>} tree  树形数据
  * @param {Function} iterator  迭代函数, 返回值为true时continue, 返回值为false时break
  * @param {string} children 定制子元素的key
@@ -169,91 +173,6 @@ function searchTreeById(tree, nodeId, config) {
     };
     return getIds(toFlatArray(tree));
 }
-/**
- * 使用迭代函数转换数组
- * @param {T} array
- * @param {Function} callback 迭代函数
- * @returns {Array}
- */
-function flatMap(array, callback) {
-    const result = [];
-    array.forEach((value, index) => {
-        result.push(...callback(value, index, array));
-    });
-    return result;
-}
-/**
- * 根据 idProp 与 parentIdProp 从对象数组中构建对应的树
- * 当 A[parentIdProp] === B[idProp] 时，对象A会被移动到对象B的children。
- * 当一个对象的 parentIdProp 不与其他对象的 idProp 字段相等时，该对象被作为树的顶层节点
- * @param {string} idProp 元素ID
- * @param {string} parentIdProp 父元素ID
- * @param {object[]} items 一维数组
- * @returns {WithChildren<T>[]} 树
- * @example
- * const array = [
- *   { id: 'node-1', parent: 'root' },
- *   { id: 'node-2', parent: 'root' },
- *   { id: 'node-3', parent: 'node-2' },
- *   { id: 'node-4', parent: 'node-2' },
- *   { id: 'node-5', parent: 'node-4' },
- * ]
- * const tree = buildTree('id', 'parent', array)
- * expect(tree).toEqual([
- *   { id: 'node-1', parent: 'root' },
- *   {
- *     id: 'node-2',
- *     parent: 'root',
- *     children: [
- *       { id: 'node-3', parent: 'node-2' },
- *       {
- *         id: 'node-4',
- *         parent: 'node-2',
- *         children: [{ id: 'node-5', parent: 'node-4' }],
- *       },
- *     ],
- *   },
- * ])
- */
-function buildTree(idProp, parentIdProp, items) {
-    const wrapperMap = new Map();
-    const ensure = (id) => {
-        if (wrapperMap.has(id)) {
-            return wrapperMap.get(id);
-        }
-        //@ts-ignore
-        const wrapper = { id, parent: null, item: null, children: [] };
-        wrapperMap.set(id, wrapper);
-        return wrapper;
-    };
-    for (const item of items) {
-        const parentWrapper = ensure(item[parentIdProp]);
-        const itemWrapper = ensure(item[idProp]);
-        //@ts-ignore
-        itemWrapper.parent = parentWrapper;
-        //@ts-ignore
-        parentWrapper.children.push(itemWrapper);
-        //@ts-ignore
-        itemWrapper.item = item;
-    }
-    const topLevelWrappers = flatMap(Array.from(wrapperMap.values()).filter(wrapper => wrapper.parent === null), wrapper => wrapper.children);
-    return unwrapRecursively(topLevelWrappers);
-    function unwrapRecursively(wrapperArray) {
-        const result = [];
-        for (const wrapper of wrapperArray) {
-            if (wrapper.children.length === 0) {
-                result.push(wrapper.item);
-            }
-            else {
-                result.push({
-                    ...wrapper.item,
-                    children: unwrapRecursively(wrapper.children)
-                });
-            }
-        }
-        return result;
-    }
-}
 /**
  * 扁平化数组转换成树(效率高于buildTree)
  * @param {any[]} list
@@ -305,20 +224,36 @@ function flatTree(treeList, options = defaultFieldOptions) {
 }
 /**
  * 模糊搜索函数，返回包含搜索字符的节点及其祖先节点, 适用于树型组件的字符过滤功能
- * @param {any[]} nodes
- * @param {string} query
+ * 以下搜索条件二选一，按先后优先级处理：
+ * 1. 过滤函数filter, 返回true/false
+ * 2. 匹配关键词，支持是否启用忽略大小写来判断
+ *
+ * 有以下特性：
+ * 1. 可配置removeEmptyChild字段，来决定是否移除搜索结果中的空children字段
+ * 2. 若无任何过滤条件或keyword模式匹配且keyword为空串，返回原对象；其他情况返回新数组
+ * @param {V[]} nodes
+ * @param {IFilterCondition} filterCondition
  * @param {ISearchTreeOpts} options
- * @returns {any[]}
+ * @returns {V[]}
  */
-function fuzzySearchTree(nodes, query, options = defaultSearchTreeOptions) {
+function fuzzySearchTree(nodes, filterCondition, options = defaultSearchTreeOptions) {
+    if (!type.objectHas(filterCondition, 'filter') &&
+        (!type.objectHas(filterCondition, 'keyword') || type.isEmpty(filterCondition.keyword))) {
+        return nodes;
+    }
     const result = [];
     for (const node of nodes) {
         // 递归检查子节点是否匹配
         const matchedChildren = node[options.childField] && node[options.childField].length > 0
-            ? fuzzySearchTree(node[options.childField] || [], query, options)
+            ? fuzzySearchTree(node[options.childField] || [], filterCondition, options)
             : [];
         // 检查当前节点是否匹配或者有匹配的子节点
-        if (node[options.nameField].toLowerCase().includes(query.toLowerCase()) || matchedChildren.length > 0) {
+        if ((type.objectHas(filterCondition, 'filter')
+            ? filterCondition.filter(node)
+            : !options.ignoreCase
+                ? node[options.nameField].includes(filterCondition.keyword)
+                : node[options.nameField].toLowerCase().includes(filterCondition.keyword.toLowerCase())) ||
+            matchedChildren.length > 0) {
             // 将当前节点加入结果中
             if (node[options.childField]) {
                 if (matchedChildren.length > 0) {
@@ -327,7 +262,7 @@ function fuzzySearchTree(nodes, query, options = defaultSearchTreeOptions) {
                         [options.childField]: matchedChildren // 包含匹配的子节点
                     });
                 }
-                else if (options.ignoreEmptyChild) {
+                else if (options.removeEmptyChild) {
                     node[options.childField] && delete node[options.childField];
                     result.push({
                         ...node
@@ -351,7 +286,6 @@ function fuzzySearchTree(nodes, query, options = defaultSearchTreeOptions) {
     return result;
 }
 
-exports.buildTree = buildTree;
 exports.flatTree = flatTree;
 exports.forEachDeep = forEachDeep;
 exports.formatTree = formatTree;

package/lib/cjs/type.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
@@ -34,11 +34,17 @@ function arrayLike(any) {
     return objectHas(any, 'length');
 }
 /**
- * 判断任意值的数据类型
+ * 判断任意值的数据类型，检查非对象时不如typeof、instanceof的性能高
+ *
+ * 当检查类对象时是不可靠的，对象可以通过定义 Symbol.toStringTag 属性来更改检查结果
+ *
+ * 详见：https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Object/toString
  * @param {unknown} any
- * @returns {string}
+ * @returns
  */
-const typeIs = (any) => Object.prototype.toString.call(any).slice(8, -1);
+function typeIs(any) {
+    return Object.prototype.toString.call(any).slice(8, -1);
+}
 // 基本数据类型判断
 const isString = (any) => typeof any === 'string';
 const isBoolean = (any) => typeof any === 'boolean';
@@ -131,6 +137,7 @@ exports.isJsonString = isJsonString;
 exports.isNaN = isNaN;
 exports.isNull = isNull;
 exports.isNullOrUnDef = isNullOrUnDef;
+exports.isNullish = isNullOrUnDef;
 exports.isNumber = isNumber;
 exports.isObject = isObject;
 exports.isPrimitive = isPrimitive;

package/lib/cjs/unique.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/cjs/url.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/cjs/validator.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/cjs/variable.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/cjs/watermark.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/cjs/we-decode.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/array.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/async.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/base64.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/clipboard.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/cookie.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/date.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/dom.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
@@ -116,31 +116,6 @@ function smoothScroll(options) {
         render();
     });
 }
-const domReadyCallbacks = [];
-const eventType = 'DOMContentLoaded';
-const listener = () => {
-    domReadyCallbacks.forEach(callback => callback());
-    domReadyCallbacks.length = 0;
-    document.removeEventListener(eventType, listener);
-};
-document.addEventListener(eventType, listener);
-let readied = false;
-function isDomReady() {
-    if (readied)
-        return true;
-    readied = ['complete', 'loaded', 'interactive'].indexOf(document.readyState) !== -1;
-    return readied;
-}
-function onDomReady(callback) {
-    // document readied
-    if (isDomReady()) {
-        setTimeout(callback, 0);
-    }
-    // listen document to ready
-    else {
-        domReadyCallbacks.push(callback);
-    }
-}
 /**
  * 获取元素样式属性的计算值
  * @param {HTMLElement} el
@@ -183,4 +158,4 @@ function getStrWidthPx(str, fontSize = 14, isRemoveDom = false) {
     return strWidth;
 }
 
-export { addClass, getComputedCssVal, getStrWidthPx, getStyle, hasClass, isDomReady, onDomReady, removeClass, setStyle, smoothScroll };
+export { addClass, getComputedCssVal, getStrWidthPx, getStyle, hasClass, removeClass, setStyle, smoothScroll };

package/lib/es/download.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/easing.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/file.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/func.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/index.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
@@ -8,13 +8,13 @@ export { arrayEach, arrayEachAsync, arrayInsertBefore, arrayRemove } from './arr
 export { copyText } from './clipboard.js';
 export { cookieDel, cookieGet, cookieSet } from './cookie.js';
 export { calculateDate, calculateDateTime, dateParse, dateToEnd, dateToStart, formatDate, isValidDate } from './date.js';
-export { addClass, getComputedCssVal, getStrWidthPx, getStyle, hasClass, isDomReady, onDomReady, removeClass, setStyle, smoothScroll } from './dom.js';
+export { addClass, getComputedCssVal, getStrWidthPx, getStyle, hasClass, removeClass, setStyle, smoothScroll } from './dom.js';
 export { crossOriginDownload, downloadBlob, downloadData, downloadHref, downloadURL } from './download.js';
-export { cloneDeep, isPlainObject, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectMap, objectAssign as objectMerge, objectOmit, objectPick } from './object.js';
+export { cloneDeep, isEqual, isPlainObject, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectMap, objectAssign as objectMerge, objectOmit, objectPick } from './object.js';
 export { pathJoin, pathNormalize } from './path.js';
 export { qsParse, qsStringify } from './qs.js';
 export { STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_UPPERCASE_ALPHA, parseQueryParams, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase } from './string.js';
-export { arrayLike, isArray, isBigInt, isBoolean, isDate, isEmpty, isError, isFunction, isJsonString, isNaN, isNull, isNullOrUnDef, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, objectHas, typeIs } from './type.js';
+export { arrayLike, isArray, isBigInt, isBoolean, isDate, isEmpty, isError, isFunction, isJsonString, isNaN, isNull, isNullOrUnDef, isNullOrUnDef as isNullish, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, objectHas, typeIs } from './type.js';
 export { urlDelParams, urlParse, urlSetParams, urlStringify } from './url.js';
 export { asyncMap, wait } from './async.js';
 export { chooseLocalFile, compressImg, supportCanvas } from './file.js';
@@ -24,7 +24,7 @@ export { STRING_POOL, randomNumber, randomString, randomUuid } from './random.js
 export { HEX_POOL, formatNumber, numberAbbr, numberToHex } from './number.js';
 export { UNIQUE_NUMBER_SAFE_LENGTH, uniqueNumber, uniqueString } from './unique.js';
 export { tooltipEvent } from './tooltip.js';
-export { buildTree, flatTree, forEachDeep, formatTree, fuzzySearchTree, mapDeep, searchTreeById } from './tree.js';
+export { flatTree, forEachDeep, formatTree, fuzzySearchTree, mapDeep, searchTreeById } from './tree.js';
 export { add, divide, multiply, strip, subtract } from './math.js';
 export { weAtob, weBtoa } from './we-decode.js';
 export { decodeFromBase64, encodeToBase64 } from './base64.js';

package/lib/es/math.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */

package/lib/es/number.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.0
+ * sculp-js v1.8.0
  * (c) 2023-present chandq
  * Released under the MIT License.
  */