sculp-js 1.0.1 → 1.2.0

package/README.md

@@ -1,24 +1,120 @@
 [![Node.js CI](https://github.com/chandq/sculp-js/actions/workflows/node.js.yml/badge.svg)](https://github.com/chandq/sculp-js/actions/workflows/node.js.yml)
 [![sculp-js](https://img.shields.io/github/package-json/v/chandq/sculp-js?style=flat-square)](https://github.com/chandq/sculp-js)
-[![node](https://img.shields.io/badge/node-v12.0.0-blue)](https://nodejs.org/download/release/v12.0.0/)
 [![node](https://img.shields.io/badge/language-typescript-orange.svg)](https://nodejs.org/download/release/v12.0.0/)
 [![license:MIT](https://img.shields.io/npm/l/vue.svg?sanitize=true)](https://github.com/chandq/sculp-js/blob/main/LICENSE.md)
 [![Downloads:?](https://img.shields.io/npm/dm/sculp-js.svg?sanitize=true)](https://npmcharts.com/compare/sculp-js?minimal=true)
+[![codecov](https://codecov.io/gh/chandq/sculp-js/graph/badge.svg?token=VZ6TERPGI9)](https://codecov.io/gh/chandq/sculp-js)
 
 # sculp-js
 
-> TS + Rollup, 原生实现，不依赖任何第三方库，输出 esm、cjs、umd三种模块方式的产物
+[API文档](https://chandq.github.io/sculp-js/)
 
-js 工具函数库, 包含类型判断模块：type, 数据处理模块：`array`、`object`、`string`、`number`，功能性模块：下载`download`、复制`clipboard`、`cookie`、日期`date`、qs、水印`watermark`, 文件处理模块：`file`，自定义悬浮提示模块： `tooltip`, dom处理模块：`dom`;
+> TS + Rollup, native implementation, without relying on any third-party libraries, outputs products of three module modes: ESM, CJS, and UMD
+
+## Features
+
+- Type
+
+  - isString
+  - isBoolean
+  - isNumber
+  - isUndefined
+  - isNull
+  - isPrimitive
+  - isObject
+  - typeIs
 
 - Array
 
   - arrayLike 判断类数组
-  - arrayEach 可中断的数组遍历， 支持倒序
   - arrayEachAsync 异步遍历数组，可中断，支持倒序
-  - arrayInsertBefore 改变数组元素位置
-  - arrayRemove 数组删除指定元素
-  - deepTraversal 深度优先遍历函数, 支持continue、break，可定制id、children
-  - getTreeIds 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
+  - forEachDeep 深度优先遍历函数, 支持continue、break，可定制id、children
+  - searchTreeById 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
+  - buildTree 根据 id 与 parentId 从对象数组中构建对应的树
+
+- Object
+
+  - isPlainObject
+  - objectHas
+  - objectAssign 合并
+  - objectEach
+  - objectEachAsync
+  - objectGet
+
+- Number
+
+  - formatNumber
+
+- String
+
+  - stringCamelCase
+  - stringKebabCase
+  - getStrWidthPx
+
+- Unique
+
+  - uniqueString
+  - uniqueNumber
+
+- Date
+
+  - formatDate
+  - dateToStart
+  - dateToEnd
+  - calculateDate
+  - calculateDateTime
+
+- Download
+
+  - downloadURL
+  - downloadHref
+  - downloadBlob
+  - downloadData
+
+- File
+
+  - chooseLocalFile
+
+- Dom
+
+  - hasClass
+  - addClass
+  - removeClass
+  - setStyle
+  - getStyle
+  - getComputedCssVal
+
+- Watermark
+
+  - genCanvasWM
+
+- Clipboard
+  - copyText
+
+## Install
+
+```js
+npm i sculp-js
+```
+
+## Usage
+
+```js
+import { forEachDeep } from 'sculp-js';
+
+const tree = [
+  { id: 1, name: 'row1' },
+  {
+    id: 2,
+    name: 'row2',
+    children: [{ id: 21, name: 'row2-1' }]
+  },
+  { id: 3, name: 'row3' }
+];
 
-## [API文档详情](https://chandq.github.io/sculp-js/)
+const arr = [];
+forEachDeep(tree, ({ id, name }) => {
+  arr.push(name);
+});
+// arr will be: ['row1', 'row2', 'row2-1', 'row3'];
+```

package/lib/cjs/array.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.0.0
+ * sculp-js v1.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -109,100 +109,9 @@ function arrayRemove(array, expect) {
     indexes.forEach((val, idx) => array.splice(val - idx, 1));
     return array;
 }
-/**
- * 自定义深度优先遍历函数(支持continue和break操作)
- * @param {ArrayLike<V>} tree  树形数据
- * @param {Function} iterator  迭代函数, 返回值为true时continue, 返回值为false时break
- * @param {string} children 定制子元素的key
- * @param {boolean} isReverse  是否反向遍历
- * @returns {*}
- */
-function forEachDeep(tree, iterator, children = 'children', isReverse = false) {
-    let level = 0, isBreak = false;
-    const walk = (arr, parent) => {
-        if (isReverse) {
-            for (let i = arr.length - 1; i >= 0; i--) {
-                if (isBreak) {
-                    break;
-                }
-                const re = iterator(arr[i], i, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                // @ts-ignore
-                if (Array.isArray(arr[i][children])) {
-                    ++level;
-                    // @ts-ignore
-                    walk(arr[i][children], arr[i]);
-                }
-            }
-        }
-        else {
-            for (let i = 0; i < arr.length; i++) {
-                if (isBreak) {
-                    break;
-                }
-                const re = iterator(arr[i], i, tree, parent, level);
-                if (re === false) {
-                    isBreak = true;
-                    break;
-                }
-                else if (re === true) {
-                    continue;
-                }
-                // @ts-ignore
-                if (Array.isArray(arr[i][children])) {
-                    ++level;
-                    // @ts-ignore
-                    walk(arr[i][children], arr[i]);
-                }
-            }
-        }
-    };
-    walk(tree, null);
-}
-/**
- * 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
- *
- * @param {ArrayLike<T>} tree - 树形数据
- * @param {IdLike} nodeId - 元素ID
- * @param {ITreeConf} config - 迭代配置项
- * @returns {[IdLike[], ITreeItem<V>[]]} - 由parentId...childId, parentObject-childObject组成的二维数组
- */
-function searchTreeById(tree, nodeId, config) {
-    const { children = 'children', id = 'id' } = config || {};
-    const toFlatArray = (tree, parentId, parent) => {
-        return tree.reduce((t, _) => {
-            const child = _[children];
-            return [
-                ...t,
-                parentId ? { ..._, parentId, parent } : _,
-                ...(child && child.length ? toFlatArray(child, _[id], _) : [])
-            ];
-        }, []);
-    };
-    const getIds = (flatArray) => {
-        let child = flatArray.find(_ => _[id] === nodeId);
-        const { parent, parentId, ...other } = child;
-        let ids = [nodeId], nodes = [other];
-        while (child && child.parentId) {
-            ids = [child.parentId, ...ids];
-            nodes = [child.parent, ...nodes];
-            child = flatArray.find(_ => _[id] === child.parentId); // eslint-disable-line
-        }
-        return [ids, nodes];
-    };
-    return getIds(toFlatArray(tree));
-}
 
 exports.arrayEach = arrayEach;
 exports.arrayEachAsync = arrayEachAsync;
 exports.arrayInsertBefore = arrayInsertBefore;
 exports.arrayLike = arrayLike;
 exports.arrayRemove = arrayRemove;
-exports.forEachDeep = forEachDeep;
-exports.searchTreeById = searchTreeById;

package/lib/cjs/async.js

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

package/lib/cjs/clipboard.js

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

package/lib/cjs/cookie.js

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

package/lib/cjs/date.js

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

package/lib/cjs/dom.js

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

package/lib/cjs/download.js

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

package/lib/cjs/easing.js

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

package/lib/cjs/file.js

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

package/lib/cjs/func.js

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

package/lib/cjs/index.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v1.0.0
+ * sculp-js v1.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -26,6 +26,7 @@ var random = require('./random.js');
 var number = require('./number.js');
 var unique = require('./unique.js');
 var tooltip = require('./tooltip.js');
+var tree = require('./tree.js');
 
 
 
@@ -34,8 +35,6 @@ exports.arrayEachAsync = array.arrayEachAsync;
 exports.arrayInsertBefore = array.arrayInsertBefore;
 exports.arrayLike = array.arrayLike;
 exports.arrayRemove = array.arrayRemove;
-exports.forEachDeep = array.forEachDeep;
-exports.searchTreeById = array.searchTreeById;
 exports.copyText = clipboard.copyText;
 exports.cookieDel = cookie.cookieDel;
 exports.cookieGet = cookie.cookieGet;
@@ -127,3 +126,7 @@ exports.UNIQUE_NUMBER_SAFE_LENGTH = unique.UNIQUE_NUMBER_SAFE_LENGTH;
 exports.uniqueNumber = unique.uniqueNumber;
 exports.uniqueString = unique.uniqueString;
 exports.tooltipEvent = tooltip.tooltipEvent;
+exports.buildTree = tree.buildTree;
+exports.forEachDeep = tree.forEachDeep;
+exports.formatTree = tree.formatTree;
+exports.searchTreeById = tree.searchTreeById;

package/lib/cjs/number.js

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

package/lib/cjs/object.js

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

package/lib/cjs/path.js

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

package/lib/cjs/qs.js

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

package/lib/cjs/random.js

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

package/lib/cjs/string.js

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

package/lib/cjs/tooltip.js

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

package/lib/cjs/tree.js

@@ -0,0 +1,212 @@
+/*!
+ * sculp-js v1.1.0
+ * (c) 2023-2023 chandq
+ * Released under the MIT License.
+ */
+
+'use strict';
+
+const defaultFieldOptions = { keyField: 'key', childField: 'children', pidField: 'pid' };
+/**
+ * 自定义深度优先遍历函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
+ * @param {ArrayLike<V>} tree  树形数据
+ * @param {Function} iterator  迭代函数, 返回值为true时continue, 返回值为false时break
+ * @param {string} children 定制子元素的key
+ * @param {boolean} isReverse  是否反向遍历
+ * @returns {*}
+ */
+function forEachDeep(tree, iterator, children = 'children', isReverse = false) {
+    let level = 0, isBreak = false;
+    const walk = (arr, parent) => {
+        if (isReverse) {
+            for (let i = arr.length - 1; i >= 0; i--) {
+                if (isBreak) {
+                    break;
+                }
+                const re = iterator(arr[i], i, arr, tree, parent, level);
+                if (re === false) {
+                    isBreak = true;
+                    break;
+                }
+                else if (re === true) {
+                    continue;
+                }
+                // @ts-ignore
+                if (arr[i] && Array.isArray(arr[i][children])) {
+                    ++level;
+                    // @ts-ignore
+                    walk(arr[i][children], arr[i]);
+                }
+            }
+        }
+        else {
+            for (let i = 0; i < arr.length; i++) {
+                if (isBreak) {
+                    break;
+                }
+                const re = iterator(arr[i], i, arr, tree, parent, level);
+                if (re === false) {
+                    isBreak = true;
+                    break;
+                }
+                else if (re === true) {
+                    continue;
+                }
+                // @ts-ignore
+                if (arr[i] && Array.isArray(arr[i][children])) {
+                    ++level;
+                    // @ts-ignore
+                    walk(arr[i][children], arr[i]);
+                }
+            }
+        }
+    };
+    walk(tree, null);
+}
+/**
+ * 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
+ *
+ * @param {ArrayLike<T>} tree - 树形数据
+ * @param {IdLike} nodeId - 元素ID
+ * @param {ITreeConf} config - 迭代配置项
+ * @returns {[IdLike[], ITreeItem<V>[]]} - 由parentId...childId, parentObject-childObject组成的二维数组
+ */
+function searchTreeById(tree, nodeId, config) {
+    const { children = 'children', id = 'id' } = config || {};
+    const toFlatArray = (tree, parentId, parent) => {
+        return tree.reduce((t, _) => {
+            const child = _[children];
+            return [
+                ...t,
+                parentId ? { ..._, parentId, parent } : _,
+                ...(child && child.length ? toFlatArray(child, _[id], _) : [])
+            ];
+        }, []);
+    };
+    const getIds = (flatArray) => {
+        let child = flatArray.find(_ => _[id] === nodeId);
+        const { parent, parentId, ...other } = child;
+        let ids = [nodeId], nodes = [other];
+        while (child && child.parentId) {
+            ids = [child.parentId, ...ids];
+            nodes = [child.parent, ...nodes];
+            child = flatArray.find(_ => _[id] === child.parentId); // eslint-disable-line
+        }
+        return [ids, nodes];
+    };
+    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[]}
+ */
+function formatTree(list, options = defaultFieldOptions) {
+    const { keyField, childField, pidField } = options;
+    const treeArr = [];
+    const sourceMap = {};
+    list.forEach(item => {
+        sourceMap[item[keyField]] = item;
+    });
+    list.forEach(item => {
+        const parent = sourceMap[item[pidField]];
+        if (parent) {
+            (parent[childField] || (parent[childField] = [])).push(item);
+        }
+        else {
+            treeArr.push(item);
+        }
+    });
+    return treeArr;
+}
+
+exports.buildTree = buildTree;
+exports.forEachDeep = forEachDeep;
+exports.formatTree = formatTree;
+exports.searchTreeById = searchTreeById;

package/lib/cjs/type.js

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

package/lib/cjs/unique.js

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

package/lib/cjs/url.js

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

package/lib/cjs/watermark.js

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