sculp-js 1.7.2 → 1.8.1

package/lib/es/tree.js

@@ -1,9 +1,10 @@
 /*!
- * sculp-js v1.7.2
+ * sculp-js v1.8.1
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
 
+import { arrayEach } from './array.js';
 import { objectOmit } from './object.js';
 import { objectHas, isEmpty } from './type.js';
 
@@ -46,7 +47,7 @@ function forEachDeep(tree, iterator, children = 'children', isReverse = false) {
             }
         }
         else {
-            for (let i = 0; i < arr.length; i++) {
+            for (let i = 0, len = arr.length; i < len; i++) {
                 if (isBreak) {
                     break;
                 }
@@ -172,92 +173,7 @@ 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
  * @param {IFieldOptions} options
  * @returns {any[]}
@@ -266,10 +182,10 @@ function formatTree(list, options = defaultFieldOptions) {
     const { keyField, childField, pidField } = options;
     const treeArr = [];
     const sourceMap = {};
-    list.forEach(item => {
+    arrayEach(list, item => {
         sourceMap[item[keyField]] = item;
     });
-    list.forEach(item => {
+    arrayEach(list, item => {
         const parent = sourceMap[item[pidField]];
         if (parent) {
             (parent[childField] || (parent[childField] = [])).push(item);
@@ -288,7 +204,8 @@ function formatTree(list, options = defaultFieldOptions) {
  */
 function flatTree(treeList, options = defaultFieldOptions) {
     const { childField, keyField, pidField } = options;
-    return treeList.reduce((res, node) => {
+    let res = [];
+    arrayEach(treeList, node => {
         const item = {
             ...node,
             [childField]: [] // 清空子级
@@ -302,8 +219,8 @@ function flatTree(treeList, options = defaultFieldOptions) {
             }));
             res = res.concat(flatTree(children, options));
         }
-        return res;
-    }, []);
+    });
+    return res;
 }
 /**
  * 模糊搜索函数，返回包含搜索字符的节点及其祖先节点, 适用于树型组件的字符过滤功能
@@ -325,7 +242,7 @@ function fuzzySearchTree(nodes, filterCondition, options = defaultSearchTreeOpti
         return nodes;
     }
     const result = [];
-    for (const node of nodes) {
+    arrayEach(nodes, node => {
         // 递归检查子节点是否匹配
         const matchedChildren = node[options.childField] && node[options.childField].length > 0
             ? fuzzySearchTree(node[options.childField] || [], filterCondition, options)
@@ -365,8 +282,8 @@ function fuzzySearchTree(nodes, filterCondition, options = defaultSearchTreeOpti
                 });
             }
         }
-    }
+    });
     return result;
 }
 
-export { buildTree, flatTree, forEachDeep, formatTree, fuzzySearchTree, mapDeep, searchTreeById };
+export { flatTree, forEachDeep, formatTree, fuzzySearchTree, mapDeep, searchTreeById };

package/lib/es/type.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.2
+ * sculp-js v1.8.1
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
@@ -30,11 +30,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';
@@ -114,4 +120,4 @@ function isEmpty(value) {
     return !Object.keys(value).length;
 }
 
-export { arrayLike, typeIs as default, isArray, isBigInt, isBoolean, isDate, isEmpty, isError, isFunction, isJsonString, isNaN, isNull, isNullOrUnDef, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, objectHas, typeIs };
+export { arrayLike, typeIs as default, isArray, isBigInt, isBoolean, isDate, isEmpty, isError, isFunction, isJsonString, isNaN, isNull, isNullOrUnDef, isNullOrUnDef as isNullish, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, objectHas, typeIs };

package/lib/es/unique.js

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

package/lib/es/url.js

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

package/lib/es/validator.js

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

package/lib/es/variable.js

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

package/lib/es/watermark.js

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

package/lib/es/we-decode.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.7.2
+ * sculp-js v1.8.1
  * (c) 2023-present chandq
  * Released under the MIT License.
  */
@@ -8,7 +8,7 @@ const b64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
 // eslint-disable-next-line
 const b64re = /^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/;
 /**
- * 字符串编码成Base64 （适用于任何环境，包括小程序）
+ * 字符串编码成Base64, 平替浏览器的btoa, 不包含中文的处理 （适用于任何环境，包括小程序）
  * @param {string} string
  * @returns {string}
  */
@@ -16,8 +16,9 @@ function weBtoa(string) {
     // 同window.btoa: 字符串编码成Base64
     string = String(string);
     let bitmap, a, b, c, result = '', i = 0;
-    const rest = string.length % 3;
-    for (; i < string.length;) {
+    const strLen = string.length;
+    const rest = strLen % 3;
+    for (; i < strLen;) {
         if ((a = string.charCodeAt(i++)) > 255 || (b = string.charCodeAt(i++)) > 255 || (c = string.charCodeAt(i++)) > 255)
             throw new TypeError("Failed to execute 'btoa' on 'Window': The string to be encoded contains characters outside of the Latin1 range.");
         bitmap = (a << 16) | (b << 8) | c;
@@ -30,7 +31,7 @@ function weBtoa(string) {
     return rest ? result.slice(0, rest - 3) + '==='.substring(rest) : result;
 }
 /**
- * Base64解码为原始字符串（适用于任何环境，包括小程序）
+ * Base64解码为原始字符串，平替浏览器的atob, 不包含中文的处理（适用于任何环境，包括小程序）
  * @param {string} string
  * @returns {string}
  */
@@ -41,7 +42,7 @@ function weAtob(string) {
         throw new TypeError("Failed to execute 'atob' on 'Window': The string to be decoded is not correctly encoded.");
     string += '=='.slice(2 - (string.length & 3));
     let bitmap, result = '', r1, r2, i = 0;
-    for (; i < string.length;) {
+    for (const strLen = string.length; i < strLen;) {
         bitmap =
             (b64.indexOf(string.charAt(i++)) << 18) |
                 (b64.indexOf(string.charAt(i++)) << 12) |

package/lib/index.d.ts

@@ -24,11 +24,15 @@ declare function objectHas<T extends AnyObject>(obj: T, key: keyof T): boolean;
  */
 declare function arrayLike(any: unknown): boolean;
 /**
- * 判断任意值的数据类型
+ * 判断任意值的数据类型，检查非对象时不如typeof、instanceof的性能高
+ *
+ * 当检查类对象时是不可靠的，对象可以通过定义 Symbol.toStringTag 属性来更改检查结果
+ *
+ * 详见：https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Object/toString
  * @param {unknown} any
- * @returns {string}
+ * @returns
  */
-declare const typeIs: (any: unknown) => string;
+declare function typeIs(any: unknown): 'Null' | 'Undefined' | 'Symbol' | 'Boolean' | 'Number' | 'String' | 'Function' | 'Date' | 'RegExp' | 'Map' | 'Set' | 'ArrayBuffer' | 'Object' | 'Array' | 'Error' | 'BigInt' | 'Promise' | 'AsyncFunction' | string;
 declare const isString: (any: unknown) => any is string;
 declare const isBoolean: (any: unknown) => any is boolean;
 declare const isSymbol: (any: unknown) => any is symbol;
@@ -38,6 +42,7 @@ declare const isUndefined: (any: unknown) => any is undefined;
 declare const isNull: (any: unknown) => any is null;
 declare const isPrimitive: (any: unknown) => boolean;
 declare function isNullOrUnDef(val: unknown): val is null | undefined;
+
 declare const isObject: (any: unknown) => any is Record<string, unknown>;
 declare const isArray: (any: unknown) => any is unknown[];
 /**
@@ -268,9 +273,6 @@ interface SmoothScrollOptions {
     easing: EasingName;
 }
 declare function smoothScroll(options?: Partial<SmoothScrollOptions>): Promise<void>;
-type ReadyCallback = () => void;
-declare function isDomReady(): boolean;
-declare function onDomReady(callback: ReadyCallback): void;
 /**
  * 获取元素样式属性的计算值
  * @param {HTMLElement} el
@@ -403,6 +405,13 @@ declare function objectAssign<R = AnyObject | AnyArray>(source: ObjectAssignItem
  * @returns {R}
  */
 declare function objectFill<R extends AnyObject = AnyObject>(source: Partial<R>, target: Partial<R>, fillable?: (s: typeof source, t: typeof target, key: keyof R) => boolean): R;
+/**
+ * 获取对象指定层级下的属性值（现在可用ES6+的可选链?.来替代）
+ * @param {AnyObject} obj
+ * @param {string} path
+ * @param {boolean} strict
+ * @returns
+ */
 declare function objectGet(obj: AnyObject, path: string, strict?: boolean): {
     p: any | undefined;
     k: string | undefined;
@@ -419,6 +428,14 @@ declare function objectGet(obj: AnyObject, path: string, strict?: boolean): {
  * @returns {T}
  */
 declare function cloneDeep<T>(source: T, map?: WeakMap<any, any>): T;
+type Comparable = null | undefined | boolean | number | string | Date | RegExp | Map<any, any> | Set<any> | ArrayBuffer | object | Array<any>;
+/**
+ * 比较两值是否相等，适用所有数据类型
+ * @param {Comparable} a
+ * @param {Comparable} b
+ * @returns {boolean}
+ */
+declare function isEqual(a: Comparable, b: Comparable): boolean;
 
 /**
  * 标准化路径
@@ -809,47 +826,8 @@ interface ITreeConf {
  * @returns {[IdLike[], ITreeItem<V>[]]} - 由parentId...childId, parentObject-childObject组成的二维数组
  */
 declare function searchTreeById<V>(tree: ArrayLike<V>, nodeId: IdLike, config?: ITreeConf): [IdLike[], ArrayLike<V>[]];
-type WithChildren<T> = T & {
-    children?: WithChildren<T>[];
-};
 /**
- * 根据 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' }],
- *       },
- *     ],
- *   },
- * ])
- */
-declare function buildTree<ID extends string, PID extends string, T extends {
-    [key in ID | PID]: string;
-}>(idProp: ID, parentIdProp: PID, items: T[]): WithChildren<T>[];
-/**
- * 扁平化数组转换成树(效率高于buildTree)
+ * 扁平化数组转换成树
  * @param {any[]} list
  * @param {IFieldOptions} options
  * @returns {any[]}
@@ -914,13 +892,13 @@ type NumberType = number | string;
 declare function strip(num: NumberType, precision?: number): number;
 
 /**
- * 字符串编码成Base64 （适用于任何环境，包括小程序）
+ * 字符串编码成Base64, 平替浏览器的btoa, 不包含中文的处理 （适用于任何环境，包括小程序）
  * @param {string} string
  * @returns {string}
  */
 declare function weBtoa(string: string): string;
 /**
- * Base64解码为原始字符串（适用于任何环境，包括小程序）
+ * Base64解码为原始字符串，平替浏览器的atob, 不包含中文的处理（适用于任何环境，包括小程序）
  * @param {string} string
  * @returns {string}
  */
@@ -1077,4 +1055,4 @@ declare function replaceVarFromString(sourceStr: string, targetObj: Record<strin
  */
 declare function executeInScope(code: string, scope?: Record<string, any>): any;
 
-export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type DateObj, type DateValue, type DebounceFunc, EMAIL_REGEX, type FileType, HEX_POOL, HTTP_URL_REGEX, type ICanvasWM, type ICompressOptions, type IFieldOptions, type IFilterCondition, IPV4_REGEX, IPV6_REGEX, type ISearchTreeOpts, type ITreeConf, type IdLike, type LooseParamValue, type LooseParams, type ObjectAssignItem, type OnceFunc, PHONE_REGEX, type Params, type PartialDeep, type RandomString, type ReadyCallback, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, type SetStyle, type SmoothScrollOptions, type Style, type ThrottleFunc, UNIQUE_NUMBER_SAFE_LENGTH, URL_REGEX, type UniqueString, type Url, type WithChildren, add, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, buildTree, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, compressImg, cookieDel, cookieGet, cookieSet, copyText, crossOriginDownload, dateParse, dateToEnd, dateToStart, debounce, decodeFromBase64, divide, downloadBlob, downloadData, downloadHref, downloadURL, encodeToBase64, escapeRegExp, executeInScope, flatTree, forEachDeep, formatDate, formatNumber, formatTree, fuzzySearchTree, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, hasClass, isArray, isBigInt, isBoolean, isDate, isDigit, isDomReady, isEmail, isEmpty, isError, isFloat, isFunction, isIdNo, isInteger, isIpV4, isIpV6, isJsonString, isNaN, isNull, isNullOrUnDef, isNumber, isNumerical, isObject, isPhone, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, isUrl, isValidDate, mapDeep, multiply, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, onDomReady, once, parseQueryParams, parseVarFromString, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, replaceVarFromString, searchTreeById, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, strip, subtract, supportCanvas, throttle, tooltipEvent, typeIs, uniqueNumber, uniqueString, uniqueSymbol, urlDelParams, urlParse, urlSetParams, urlStringify, wait, weAtob, weBtoa };
+export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type Comparable, type DateObj, type DateValue, type DebounceFunc, EMAIL_REGEX, type FileType, HEX_POOL, HTTP_URL_REGEX, type ICanvasWM, type ICompressOptions, type IFieldOptions, type IFilterCondition, IPV4_REGEX, IPV6_REGEX, type ISearchTreeOpts, type ITreeConf, type IdLike, type LooseParamValue, type LooseParams, type ObjectAssignItem, type OnceFunc, PHONE_REGEX, type Params, type PartialDeep, type RandomString, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, type SetStyle, type SmoothScrollOptions, type Style, type ThrottleFunc, UNIQUE_NUMBER_SAFE_LENGTH, URL_REGEX, type UniqueString, type Url, add, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, compressImg, cookieDel, cookieGet, cookieSet, copyText, crossOriginDownload, dateParse, dateToEnd, dateToStart, debounce, decodeFromBase64, divide, downloadBlob, downloadData, downloadHref, downloadURL, encodeToBase64, escapeRegExp, executeInScope, flatTree, forEachDeep, formatDate, formatNumber, formatTree, fuzzySearchTree, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, hasClass, isArray, isBigInt, isBoolean, isDate, isDigit, isEmail, isEmpty, isEqual, isError, isFloat, isFunction, isIdNo, isInteger, isIpV4, isIpV6, isJsonString, isNaN, isNull, isNullOrUnDef, isNullOrUnDef as isNullish, isNumber, isNumerical, isObject, isPhone, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, isUrl, isValidDate, mapDeep, multiply, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, once, parseQueryParams, parseVarFromString, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, replaceVarFromString, searchTreeById, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, strip, subtract, supportCanvas, throttle, tooltipEvent, typeIs, uniqueNumber, uniqueString, uniqueSymbol, urlDelParams, urlParse, urlSetParams, urlStringify, wait, weAtob, weBtoa };