sculp-js 0.0.1 → 0.1.1

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-present, [chandq](https://github.com/chandq)
+Copyright (c) 2020-present, chandq
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,3 +1,21 @@
+[![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)
+
 # sculp-js
 
-> js 工具库
+> TS + Rollup, 原生实现，不依赖任何第三方库，输出 esm、cjs、umd三种模块方式的产物
+
+js 工具函数库, 包含类型判断模块：type, 数据处理模块：`array`、`object`、`string`、`number`，功能性模块：下载`download`、复制`clipboard`、`cookie`、日期`date`、qs、水印`watermark`, 文件处理模块：`file`，自定义悬浮提示模块： `tooltip`, dom处理模块：`dom`;
+
+- Array
+  - arrayLike 判断类数组
+  - arrayEach 可中断的数组遍历， 支持倒序
+  - arrayEachAsync 异步遍历数组，可中断，支持倒序
+  - arrayInsertBefore 改变数组元素位置
+  - arrayRemove 数组删除指定元素
+  - deepTraversal 深度优先遍历函数, 支持continue、break，可定制id、children
+  - getTreeIds 在树中找到 id 为某个值的节点，并返回上游的所有父级节点

package/lib/cjs/array.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.0.1
+ * sculp-js v0.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -33,14 +33,14 @@ const arrayEach = (array, iterator, reverse = false) => {
     if (reverse) {
         for (let idx = array.length - 1; idx >= 0; idx--) {
             const val = array[idx];
-            if (iterator(val, idx) === false)
+            if (iterator(val, idx, array) === false)
                 break;
         }
     }
     else {
         for (let idx = 0; idx < array.length; idx++) {
             const val = array[idx];
-            if (iterator(val, idx) === false)
+            if (iterator(val, idx, array) === false)
                 break;
         }
     }
@@ -172,46 +172,17 @@ function getTreeIds(tree, nodeId, config) {
         while (child && child.parentId) {
             ids = [child.parentId, ...ids];
             nodes = [child.parent, ...nodes];
-            child = flatArray.find(_ => _[id] === child.parentId);
+            child = flatArray.find(_ => _[id] === child.parentId); // eslint-disable-line
         }
         return [ids, nodes];
     };
     return getIds(toFlatArray(tree));
 }
-/**
- * 异步ForEach函数
- * @param {array} array
- * @param {asyncFuntion} callback
- * // asyncForEach 使用范例如下
-// const start = async () => {
-//   await asyncForEach(result, async (item) => {
-//     await request(item);
-//     count++;
-//   });
-
-//   console.log('发送次数', count);
-// }
-
-// for await...of 使用范例如下
-// const loadImages =  async (images) => {
-//   for await (const item of images) {
-//      await request(item);
-//      count++;
-//    }
-// }
- * @return {*}
- */
-async function asyncForEach(array, callback) {
-    for (let index = 0, len = array.length; index < len; index++) {
-        await callback(array[index], index, array);
-    }
-}
 
 exports.arrayEach = arrayEach;
 exports.arrayEachAsync = arrayEachAsync;
 exports.arrayInsertBefore = arrayInsertBefore;
 exports.arrayLike = arrayLike;
 exports.arrayRemove = arrayRemove;
-exports.asyncForEach = asyncForEach;
 exports.deepTraversal = deepTraversal;
 exports.getTreeIds = getTreeIds;

package/lib/cjs/async.js

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

package/lib/cjs/clipboard.js

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

package/lib/cjs/cookie.js

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

package/lib/cjs/date.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.0.1
+ * sculp-js v0.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -56,16 +56,16 @@ const formatDate = (date = new Date(), format = 'YYYY-MM-DD HH:mm:ss') => {
  */
 function calculateDate(strDate, n, sep = '-') {
     //strDate 为字符串日期 如:'2019-01-01' n为你要传入的参数，当前为0，前一天为-1，后一天为1
-    let dateArr = strDate.split(sep); //这边给定一个特定时间
-    let newDate = new Date(+dateArr[0], +dateArr[1] - 1, +dateArr[2]);
-    let befminuts = newDate.getTime() + 1000 * 60 * 60 * 24 * parseInt(String(n)); //计算前几天用减，计算后几天用加，最后一个就是多少天的数量
-    let beforeDat = new Date();
+    const dateArr = strDate.split(sep); //这边给定一个特定时间
+    const newDate = new Date(+dateArr[0], +dateArr[1] - 1, +dateArr[2]);
+    const befminuts = newDate.getTime() + 1000 * 60 * 60 * 24 * parseInt(String(n)); //计算前几天用减，计算后几天用加，最后一个就是多少天的数量
+    const beforeDat = new Date();
     beforeDat.setTime(befminuts);
-    let befMonth = beforeDat.getMonth() + 1;
-    let mon = befMonth >= 10 ? befMonth : '0' + befMonth;
-    let befDate = beforeDat.getDate();
-    let da = befDate >= 10 ? befDate : '0' + befDate;
-    let finalNewDate = beforeDat.getFullYear() + '-' + mon + '-' + da;
+    const befMonth = beforeDat.getMonth() + 1;
+    const mon = befMonth >= 10 ? befMonth : '0' + befMonth;
+    const befDate = beforeDat.getDate();
+    const da = befDate >= 10 ? befDate : '0' + befDate;
+    const finalNewDate = beforeDat.getFullYear() + '-' + mon + '-' + da;
     return finalNewDate;
 }
 /**
@@ -76,9 +76,9 @@ function calculateDate(strDate, n, sep = '-') {
  * @return {*}
  */
 function calculateDateTime(n, dateSep = '-', timeSep = ':') {
-    let date = new Date();
-    let separator1 = '-';
-    let separator2 = ':';
+    const date = new Date();
+    const separator1 = '-';
+    const separator2 = ':';
     let year = date.getFullYear();
     let month = date.getMonth() + 1;
     let strDate = date.getDate() + n;

package/lib/cjs/dom.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.0.1
+ * sculp-js v0.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -141,8 +141,20 @@ function onDomReady(callback) {
         domReadyCallbacks.push(callback);
     }
 }
+/**
+ * 获取元素样式属性的计算值
+ * @param {HTMLElement} el
+ * @param {string} property
+ * @param {boolean} reNumber
+ * @return {string|number}
+ */
+function getComputedCssVal(el, property, reNumber = true) {
+    const originVal = getComputedStyle(el).getPropertyValue(property) ?? '';
+    return reNumber ? Number(originVal.replace(/([0-9]*)(.*)/g, '$1')) : originVal;
+}
 
 exports.addClass = addClass;
+exports.getComputedCssVal = getComputedCssVal;
 exports.getStyle = getStyle;
 exports.hasClass = hasClass;
 exports.isDomReady = isDomReady;

package/lib/cjs/download.js

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

package/lib/cjs/easing.js

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

package/lib/cjs/file.js

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

package/lib/cjs/func.js

@@ -0,0 +1,160 @@
+/*!
+ * sculp-js v0.1.0
+ * (c) 2023-2023 chandq
+ * Released under the MIT License.
+ */
+
+'use strict';
+
+/**
+ * 防抖函数
+ * 当函数被连续调用时，该函数并不执行，只有当其全部停止调用超过一定时间后才执行1次。
+ * 例如：上电梯的时候，大家陆陆续续进来，电梯的门不会关上，只有当一段时间都没有人上来，电梯才会关门。
+ * @param {F} func
+ * @param {number} wait
+ * @returns {DebounceFunc<F>}
+ */
+const debounce = (func, wait) => {
+    let timeout;
+    let canceled = false;
+    const f = function (...args) {
+        if (canceled)
+            return;
+        clearTimeout(timeout);
+        timeout = setTimeout(() => {
+            func.call(this, ...args);
+        }, wait);
+    };
+    f.cancel = () => {
+        clearTimeout(timeout);
+        canceled = true;
+    };
+    return f;
+};
+/**
+ * 节流函数
+ * 节流就是节约流量，将连续触发的事件稀释成预设评率。 比如每间隔1秒执行一次函数，无论这期间触发多少次事件。
+ * 这有点像公交车，无论在站点等车的人多不多，公交车只会按时来一班，不会来一个人就来一辆公交车。
+ * @param {F} func
+ * @param {number} wait
+ * @param {boolean} immediate
+ * @returns {ThrottleFunc<F>}
+ */
+const throttle = (func, wait, immediate) => {
+    let timeout;
+    let canceled = false;
+    let lastCalledTime = 0;
+    const f = function (...args) {
+        if (canceled)
+            return;
+        const now = Date.now();
+        const call = () => {
+            lastCalledTime = now;
+            func.call(this, ...args);
+        };
+        // 第一次执行
+        if (lastCalledTime === 0) {
+            if (immediate) {
+                return call();
+            }
+            else {
+                lastCalledTime = now;
+                return;
+            }
+        }
+        const remain = lastCalledTime + wait - now;
+        if (remain > 0) {
+            clearTimeout(timeout);
+            timeout = setTimeout(() => call(), wait);
+        }
+        else {
+            call();
+        }
+    };
+    f.cancel = () => {
+        clearTimeout(timeout);
+        canceled = true;
+    };
+    return f;
+};
+/**
+ * 单次函数
+ * @param {AnyFunc} func
+ * @returns {AnyFunc}
+ */
+const once = (func) => {
+    let called = false;
+    let result;
+    return function (...args) {
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        if (called)
+            return result;
+        called = true;
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+        result = func.call(this, ...args);
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+        return result;
+    };
+};
+/**
+ * 设置全局变量
+ * @param {string | number | symbol} key
+ * @param val
+ */
+function setGlobal(key, val) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    if (typeof globalThis !== 'undefined')
+        globalThis[key] = val;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    else if (typeof window !== 'undefined')
+        window[key] = val;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    else if (typeof global !== 'undefined')
+        global[key] = val;
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    else if (typeof self !== 'undefined')
+        self[key] = val;
+    else
+        throw new SyntaxError('当前环境下无法设置全局属性');
+}
+/**
+ * 设置全局变量
+ * @param {string | number | symbol} key
+ * @param val
+ */
+function getGlobal(key) {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    if (typeof globalThis !== 'undefined')
+        return globalThis[key];
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    else if (typeof window !== 'undefined')
+        return window[key];
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    else if (typeof global !== 'undefined')
+        return global[key];
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    else if (typeof self !== 'undefined')
+        return self[key];
+}
+
+exports.debounce = debounce;
+exports.getGlobal = getGlobal;
+exports.once = once;
+exports.setGlobal = setGlobal;
+exports.throttle = throttle;

package/lib/cjs/index.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.0.1
+ * sculp-js v0.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -21,21 +21,103 @@ var url = require('./url.js');
 var async = require('./async.js');
 var file = require('./file.js');
 var watermark = require('./watermark.js');
+var func = require('./func.js');
+var random = require('./random.js');
+var number = require('./number.js');
+var unique = require('./unique.js');
 
 
 
-exports.array = array;
-exports.clipboard = clipboard;
-exports.cookie = cookie;
-exports.date = date;
-exports.dom = dom;
-exports.download = download;
-exports.object = object;
-exports.path = path;
-exports.qs = qs;
-exports.string = string;
-exports.type = type;
-exports.url = url;
-exports.async = async;
-exports.file = file;
+exports.arrayEach = array.arrayEach;
+exports.arrayEachAsync = array.arrayEachAsync;
+exports.arrayInsertBefore = array.arrayInsertBefore;
+exports.arrayLike = array.arrayLike;
+exports.arrayRemove = array.arrayRemove;
+exports.deepTraversal = array.deepTraversal;
+exports.getTreeIds = array.getTreeIds;
+exports.copyText = clipboard.copyText;
+exports.cookieDel = cookie.cookieDel;
+exports.cookieGet = cookie.cookieGet;
+exports.cookieSet = cookie.cookieSet;
+exports.calculateDate = date.calculateDate;
+exports.calculateDateTime = date.calculateDateTime;
+exports.formatDate = date.formatDate;
+exports.addClass = dom.addClass;
+exports.getComputedCssVal = dom.getComputedCssVal;
+exports.getStyle = dom.getStyle;
+exports.hasClass = dom.hasClass;
+exports.isDomReady = dom.isDomReady;
+exports.onDomReady = dom.onDomReady;
+exports.removeClass = dom.removeClass;
+exports.setStyle = dom.setStyle;
+exports.smoothScroll = dom.smoothScroll;
+exports.downloadBlob = download.downloadBlob;
+exports.downloadData = download.downloadData;
+exports.downloadHref = download.downloadHref;
+exports.downloadURL = download.downloadURL;
+exports.cloneDeep = object.cloneDeep;
+exports.isPlainObject = object.isPlainObject;
+exports.objectAssign = object.objectAssign;
+exports.objectEach = object.objectEach;
+exports.objectEachAsync = object.objectEachAsync;
+exports.objectFill = object.objectFill;
+exports.objectGet = object.objectGet;
+exports.objectHas = object.objectHas;
+exports.objectMap = object.objectMap;
+exports.objectMerge = object.objectAssign;
+exports.objectOmit = object.objectOmit;
+exports.objectPick = object.objectPick;
+exports.pathJoin = path.pathJoin;
+exports.pathNormalize = path.pathNormalize;
+exports.qsParse = qs.qsParse;
+exports.qsStringify = qs.qsStringify;
+exports.STRING_ARABIC_NUMERALS = string.STRING_ARABIC_NUMERALS;
+exports.STRING_LOWERCASE_ALPHA = string.STRING_LOWERCASE_ALPHA;
+exports.STRING_UPPERCASE_ALPHA = string.STRING_UPPERCASE_ALPHA;
+exports.getStrWidthPx = string.getStrWidthPx;
+exports.stringAssign = string.stringAssign;
+exports.stringCamelCase = string.stringCamelCase;
+exports.stringEscapeHtml = string.stringEscapeHtml;
+exports.stringFill = string.stringFill;
+exports.stringFormat = string.stringFormat;
+exports.stringKebabCase = string.stringKebabCase;
+exports.isArray = type.isArray;
+exports.isBigInt = type.isBigInt;
+exports.isBoolean = type.isBoolean;
+exports.isDate = type.isDate;
+exports.isError = type.isError;
+exports.isFunction = type.isFunction;
+exports.isNaN = type.isNaN;
+exports.isNull = type.isNull;
+exports.isNumber = type.isNumber;
+exports.isObject = type.isObject;
+exports.isPrimitive = type.isPrimitive;
+exports.isRegExp = type.isRegExp;
+exports.isString = type.isString;
+exports.isSymbol = type.isSymbol;
+exports.isUndefined = type.isUndefined;
+exports.typeIs = type.typeIs;
+exports.urlDelParams = url.urlDelParams;
+exports.urlParse = url.urlParse;
+exports.urlSetParams = url.urlSetParams;
+exports.urlStringify = url.urlStringify;
+exports.asyncMap = async.asyncMap;
+exports.wait = async.wait;
+exports.chooseLocalFile = file.chooseLocalFile;
 exports.genCanvasWM = watermark.genCanvasWM;
+exports.debounce = func.debounce;
+exports.getGlobal = func.getGlobal;
+exports.once = func.once;
+exports.setGlobal = func.setGlobal;
+exports.throttle = func.throttle;
+exports.STRING_POOL = random.STRING_POOL;
+exports.randomNumber = random.randomNumber;
+exports.randomString = random.randomString;
+exports.randomUuid = random.randomUuid;
+exports.HEX_POOL = number.HEX_POOL;
+exports.formatNumber = number.formatNumber;
+exports.numberAbbr = number.numberAbbr;
+exports.numberToHex = number.numberToHex;
+exports.UNIQUE_NUMBER_SAFE_LENGTH = unique.UNIQUE_NUMBER_SAFE_LENGTH;
+exports.uniqueNumber = unique.uniqueNumber;
+exports.uniqueString = unique.uniqueString;

package/lib/cjs/number.js

@@ -0,0 +1,82 @@
+/*!
+ * sculp-js v0.1.0
+ * (c) 2023-2023 chandq
+ * Released under the MIT License.
+ */
+
+'use strict';
+
+var func = require('./func.js');
+var string = require('./string.js');
+
+const HEX_POOL = `${string.STRING_ARABIC_NUMERALS}${string.STRING_UPPERCASE_ALPHA}${string.STRING_LOWERCASE_ALPHA}`;
+const supportBigInt = typeof BigInt !== 'undefined';
+const jsbi = () => func.getGlobal('JSBI');
+const toBigInt = (n) => (supportBigInt ? BigInt(n) : jsbi().BigInt(n));
+const divide = (x, y) => (supportBigInt ? x / y : jsbi().divide(x, y));
+const remainder = (x, y) => (supportBigInt ? x % y : jsbi().remainder(x, y));
+/**
+ * 将十进制转换成任意进制
+ * @param {number | string} decimal 十进制数值或字符串，可以是任意长度，会使用大数进行计算
+ * @param {string} [hexPool] 进制池，默认 62 进制
+ * @returns {string}
+ */
+const numberToHex = (decimal, hexPool = HEX_POOL) => {
+    if (hexPool.length < 2)
+        throw new Error('进制池长度不能少于 2');
+    if (!supportBigInt) {
+        throw new Error('需要安装 jsbi 模块并将 JSBI 设置为全局变量：\nimport JSBI from "jsbi"; window.JSBI = JSBI;');
+    }
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    let bigInt = toBigInt(decimal);
+    const ret = [];
+    const { length } = hexPool;
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+    const bigLength = toBigInt(length);
+    const execute = () => {
+        const y = Number(remainder(bigInt, bigLength));
+        bigInt = divide(bigInt, bigLength);
+        ret.unshift(hexPool[y]);
+        if (bigInt > 0) {
+            execute();
+        }
+    };
+    execute();
+    return ret.join('');
+};
+/**
+ * 缩写
+ * @param {number | string} num
+ * @param {Array<string>} units
+ * @param {number} ratio
+ * @param {number} exponent
+ * @returns {string}
+ */
+const numberAbbr = (num, units, ratio = 1000, exponent) => {
+    const { length } = units;
+    if (length === 0)
+        throw new Error('至少需要一个单位');
+    let num2 = Number(num);
+    let times = 0;
+    while (num2 >= ratio && times < length - 1) {
+        num2 = num2 / ratio;
+        times++;
+    }
+    const value = num2.toFixed(exponent);
+    const unit = units[times];
+    return value.toString() + '' + unit;
+};
+/**
+ * 将数字格式化成千位分隔符显示的字符串
+ * @param {number} val 数字
+ * @param {'int' | 'float'} type 展示分段显示的类型 int:整型 | float:浮点型
+ * @return {string}
+ */
+function formatNumber(val, type = 'int') {
+    return type === 'int' ? parseInt(String(val)).toLocaleString() : Number(val).toLocaleString('en-US');
+}
+
+exports.HEX_POOL = HEX_POOL;
+exports.formatNumber = formatNumber;
+exports.numberAbbr = numberAbbr;
+exports.numberToHex = numberToHex;

package/lib/cjs/object.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.0.1
+ * sculp-js v0.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -109,8 +109,8 @@ function objectOmit(obj, keys) {
 const merge = (map, source, target) => {
     if (type.isUndefined(target))
         return source;
-    const sourceType = type.default(source);
-    const targetType = type.default(target);
+    const sourceType = type.typeIs(source);
+    const targetType = type.typeIs(target);
     if (sourceType !== targetType) {
         if (type.isArray(target))
             return merge(map, [], target);

package/lib/cjs/path.js

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

package/lib/cjs/qs.js

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