sculp-js 0.0.2 → 0.1.1

package/lib/es/random.js

@@ -0,0 +1,67 @@
+/*!
+ * sculp-js v0.1.0
+ * (c) 2023-2023 chandq
+ * Released under the MIT License.
+ */
+
+import { STRING_ARABIC_NUMERALS, STRING_UPPERCASE_ALPHA, STRING_LOWERCASE_ALPHA } from './string.js';
+import { isString, isNumber } from './type.js';
+
+/**
+ * 随机整数
+ * @param {number} min
+ * @param {number} max
+ * @returns {number}
+ */
+const randomNumber = (min, max) => Math.floor(Math.random() * (max - min + 1) + min);
+const STRING_POOL = `${STRING_ARABIC_NUMERALS}${STRING_UPPERCASE_ALPHA}${STRING_LOWERCASE_ALPHA}`;
+/**
+ * 随机字符串
+ * @param {number | string} length
+ * @param {string} pool
+ * @returns {string}
+ */
+const randomString = (length, pool) => {
+    let _length = 0;
+    let _pool = STRING_POOL;
+    if (isString(pool)) {
+        _length = length;
+        _pool = pool;
+    }
+    else if (isNumber(length)) {
+        _length = length;
+    }
+    else if (isString(length)) {
+        _pool = length;
+    }
+    let times = Math.max(_length, 1);
+    let result = '';
+    const min = 0;
+    const max = _pool.length - 1;
+    if (max < 2)
+        throw new Error('字符串池长度不能少于 2');
+    while (times--) {
+        const index = randomNumber(min, max);
+        result += _pool[index];
+    }
+    return result;
+};
+/**
+ * 优先浏览器原生能力获取 UUID v4
+ * @returns {string}
+ */
+function randomUuid() {
+    if (typeof URL === 'undefined' || !URL.createObjectURL || typeof Blob === 'undefined') {
+        const hex = '0123456789abcdef';
+        const model = 'xxxxxxxx-xxxx-4xxx-xxxx-xxxxxxxxxxxx';
+        let str = '';
+        for (let i = 0; i < model.length; i++) {
+            const rnd = randomNumber(0, 15);
+            str += model[i] == '-' || model[i] == '4' ? model[i] : hex[rnd];
+        }
+        return str;
+    }
+    return /[^/]+$/.exec(URL.createObjectURL(new Blob()).slice())[0];
+}
+
+export { STRING_POOL, randomNumber, randomString, randomUuid };

package/lib/es/string.js

@@ -1,9 +1,11 @@
 /*!
- * sculp-js v0.0.1
+ * sculp-js v0.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
 
+import { isString } from './type.js';
+
 /**
  * 将字符串转换为驼峰格式
  * @param {string} string
@@ -120,5 +122,35 @@ const stringEscapeHtml = (html) => {
  * @returns {string}
  */
 const stringFill = (length, value = ' ') => new Array(length).fill(value).join('');
+/**
+ * 字符串的像素宽度
+ * @param {string} str 目标字符串
+ * @param {number} fontSize 字符串字体大小
+ * @param {boolean} isRemoveDom 计算后是否移除中间dom元素
+ * @return {*}
+ */
+function getStrWidthPx(str, fontSize = 14, isRemoveDom = false) {
+    let strWidth = 0;
+    console.assert(isString(str), `${str} 不是有效的字符串`);
+    if (isString(str) && str.length > 0) {
+        let getEle = document.querySelector('#getStrWidth1494304949567');
+        if (!getEle) {
+            const _ele = document.createElement('span');
+            _ele.id = 'getStrWidth1494304949567';
+            _ele.style.fontSize = fontSize + 'px';
+            _ele.style.whiteSpace = 'nowrap';
+            _ele.style.visibility = 'hidden';
+            _ele.textContent = str;
+            document.body.appendChild(_ele);
+            getEle = _ele;
+        }
+        getEle.textContent = str;
+        strWidth = getEle.offsetWidth;
+        if (isRemoveDom) {
+            document.body.appendChild(getEle);
+        }
+    }
+    return strWidth;
+}
 
-export { STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_UPPERCASE_ALPHA, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase };
+export { STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_UPPERCASE_ALPHA, getStrWidthPx, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase };

package/lib/es/type.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.0.1
+ * sculp-js v0.1.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -25,4 +25,4 @@ const isDate = (any) => typeIs(any) === 'Date';
 const isError = (any) => typeIs(any) === 'Error';
 const isRegExp = (any) => typeIs(any) === 'RegExp';
 
-export { typeIs as default, isArray, isBigInt, isBoolean, isDate, isError, isFunction, isNaN, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined };
+export { typeIs as default, isArray, isBigInt, isBoolean, isDate, isError, isFunction, isNaN, isNull, isNumber, isObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, typeIs };

package/lib/es/unique.js

@@ -0,0 +1,79 @@
+/*!
+ * sculp-js v0.1.0
+ * (c) 2023-2023 chandq
+ * Released under the MIT License.
+ */
+
+import { numberToHex, HEX_POOL } from './number.js';
+import { randomNumber } from './random.js';
+import { isString, isNumber } from './type.js';
+
+const padStartWithZero = (str, maxLength = 2) => String(str).padStart(maxLength, '0');
+let safeNo = 0;
+let lastTimestamp = 0;
+// 安全后缀长度，按 1 毫秒运算 99999 次 JS 代码来进行估算
+// 那么，补足长度为 5
+// 时间戳模式长度为 13
+// 取最长 5 + 13 = 18
+const UNIQUE_NUMBER_SAFE_LENGTH = 18;
+const FIX_SAFE_LENGTH = 5;
+const TIMESTAMP_LENGTH = 13;
+/**
+ * 生成唯一不重复数值
+ * @param {number} length
+ * @returns {string}
+ */
+const uniqueNumber = (length = UNIQUE_NUMBER_SAFE_LENGTH) => {
+    const now = Date.now();
+    length = Math.max(length, UNIQUE_NUMBER_SAFE_LENGTH);
+    if (now !== lastTimestamp) {
+        lastTimestamp = now;
+        safeNo = 0;
+    }
+    const timestamp = `${now}`;
+    let random = '';
+    const rndLength = length - FIX_SAFE_LENGTH - TIMESTAMP_LENGTH;
+    if (rndLength > 0) {
+        const rndMin = 10 ** (rndLength - 1);
+        const rndMax = 10 ** rndLength - 1;
+        const rnd = randomNumber(rndMin, rndMax);
+        random = `${rnd}`;
+    }
+    const safe = padStartWithZero(safeNo, FIX_SAFE_LENGTH);
+    safeNo++;
+    return `${timestamp}${random}${safe}`;
+};
+const randomFromPool = (pool) => {
+    const poolIndex = randomNumber(0, pool.length - 1);
+    return pool[poolIndex];
+};
+/**
+ * 生成唯一不重复字符串
+ * @param {number | string} length
+ * @param {string} pool
+ * @returns {string}
+ */
+const uniqueString = (length, pool) => {
+    let _length = 0;
+    let _pool = HEX_POOL;
+    if (isString(pool)) {
+        _length = length;
+        _pool = pool;
+    }
+    else if (isNumber(length)) {
+        _length = length;
+    }
+    else if (isString(length)) {
+        _pool = length;
+    }
+    let uniqueString = numberToHex(uniqueNumber(), _pool);
+    let insertLength = _length - uniqueString.length;
+    if (insertLength <= 0)
+        return uniqueString;
+    while (insertLength--) {
+        uniqueString += randomFromPool(_pool);
+    }
+    return uniqueString;
+};
+
+export { UNIQUE_NUMBER_SAFE_LENGTH, uniqueNumber, uniqueString };

package/lib/es/url.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/es/watermark.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/index.d.ts

@@ -5,6 +5,7 @@ type AnyObject = Record<string | number, any>;
 type PartialDeep<T> = {
     [P in keyof T]?: PartialDeep<T[P]>;
 };
+declare const typeIs: (any: unknown) => 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;
@@ -33,7 +34,7 @@ declare const arrayLike: (any: unknown) => boolean;
  * @param {(val: V, idx: number) => any} iterator
  * @param reverse {boolean} 是否倒序
  */
-declare const arrayEach: <V>(array: ArrayLike<V>, iterator: (val: V, idx: number) => any, reverse?: boolean) => void;
+declare const arrayEach: <V>(array: ArrayLike<V>, iterator: (val: V, idx: number, arr: ArrayLike<V>) => any, reverse?: boolean) => void;
 /**
  * 异步遍历数组，返回 false 中断遍历
  * @param {ArrayLike<V>} array
@@ -76,30 +77,6 @@ interface ITreeConf {
  * @return {[IdLike[], ITreeItem<V>[]]}
  */
 declare function getTreeIds<V>(tree: ArrayLike<V>, nodeId: IdLike, config?: ITreeConf): [IdLike[], ArrayLike<V>[]];
-/**
- * 异步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 {*}
- */
-declare function asyncForEach(array: any[], callback: Function): Promise<void>;
 
 /**
  * 复制文本
@@ -214,6 +191,14 @@ declare function smoothScroll(options?: Partial<SmoothScrollOptions>): Promise<v
 type ReadyCallback = () => void;
 declare function isDomReady(): boolean;
 declare function onDomReady(callback: ReadyCallback): void;
+/**
+ * 获取元素样式属性的计算值
+ * @param {HTMLElement} el
+ * @param {string} property
+ * @param {boolean} reNumber
+ * @return {string|number}
+ */
+declare function getComputedCssVal(el: HTMLElement, property: string, reNumber?: boolean): string | number;
 
 interface Params<T = string | number> {
     [key: string]: T | Array<T>;
@@ -414,6 +399,14 @@ declare const stringEscapeHtml: (html: string) => string;
  * @returns {string}
  */
 declare const stringFill: (length: number, value?: string) => string;
+/**
+ * 字符串的像素宽度
+ * @param {string} str 目标字符串
+ * @param {number} fontSize 字符串字体大小
+ * @param {boolean} isRemoveDom 计算后是否移除中间dom元素
+ * @return {*}
+ */
+declare function getStrWidthPx(str: string, fontSize?: number, isRemoveDom?: boolean): number;
 
 interface Url {
     protocol: string;
@@ -502,4 +495,126 @@ interface ICanvasWM {
  */
 declare const genCanvasWM: (canvasWM: ICanvasWM) => void;
 
-export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, type LooseParamValue, type LooseParams, type Params, type PartialDeep, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_UPPERCASE_ALPHA, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncForEach, asyncMap, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, cookieDel, cookieGet, cookieSet, copyText, deepTraversal, downloadBlob, downloadData, downloadHref, downloadURL, formatDate, genCanvasWM, getStyle, getTreeIds, hasClass, isArray, isBigInt, isBoolean, isDate, isDomReady, isError, isFunction, isNaN, isNull, isNumber, isObject, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, onDomReady, pathJoin, pathNormalize, qsParse, qsStringify, removeClass, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, urlDelParams, urlParse, urlSetParams, urlStringify, wait };
+interface DebounceFunc<F extends AnyFunc> {
+    (...args: Parameters<F>): void;
+    cancel: () => void;
+}
+/**
+ * 防抖函数
+ * 当函数被连续调用时，该函数并不执行，只有当其全部停止调用超过一定时间后才执行1次。
+ * 例如：上电梯的时候，大家陆陆续续进来，电梯的门不会关上，只有当一段时间都没有人上来，电梯才会关门。
+ * @param {F} func
+ * @param {number} wait
+ * @returns {DebounceFunc<F>}
+ */
+declare const debounce: <F extends AnyFunc>(func: F, wait?: number) => DebounceFunc<F>;
+interface ThrottleFunc<F extends AnyFunc> {
+    (...args: Parameters<F>): void;
+    cancel: () => void;
+}
+/**
+ * 节流函数
+ * 节流就是节约流量，将连续触发的事件稀释成预设评率。 比如每间隔1秒执行一次函数，无论这期间触发多少次事件。
+ * 这有点像公交车，无论在站点等车的人多不多，公交车只会按时来一班，不会来一个人就来一辆公交车。
+ * @param {F} func
+ * @param {number} wait
+ * @param {boolean} immediate
+ * @returns {ThrottleFunc<F>}
+ */
+declare const throttle: <F extends AnyFunc>(func: F, wait: number, immediate?: boolean) => ThrottleFunc<F>;
+interface OnceFunc<F extends AnyFunc> {
+    (...args: Parameters<F>): ReturnType<F>;
+}
+/**
+ * 单次函数
+ * @param {AnyFunc} func
+ * @returns {AnyFunc}
+ */
+declare const once: <F extends AnyFunc = AnyFunc>(func: F) => OnceFunc<F>;
+/**
+ * 设置全局变量
+ * @param {string | number | symbol} key
+ * @param val
+ */
+declare function setGlobal(key: string | number | symbol, val?: any): void;
+/**
+ * 设置全局变量
+ * @param {string | number | symbol} key
+ * @param val
+ */
+declare function getGlobal<T>(key: string | number | symbol): T | void;
+
+/**
+ * 随机整数
+ * @param {number} min
+ * @param {number} max
+ * @returns {number}
+ */
+declare const randomNumber: (min: number, max: number) => number;
+declare const STRING_POOL = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+interface RandomString {
+    (length: number, pool: string): string;
+    (length: number): string;
+    (pool: string): string;
+    (): string;
+}
+/**
+ * 随机字符串
+ * @param {number | string} length
+ * @param {string} pool
+ * @returns {string}
+ */
+declare const randomString: RandomString;
+/**
+ * 优先浏览器原生能力获取 UUID v4
+ * @returns {string}
+ */
+declare function randomUuid(): string;
+
+declare const HEX_POOL = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+/**
+ * 将十进制转换成任意进制
+ * @param {number | string} decimal 十进制数值或字符串，可以是任意长度，会使用大数进行计算
+ * @param {string} [hexPool] 进制池，默认 62 进制
+ * @returns {string}
+ */
+declare const numberToHex: (decimal: number | string, hexPool?: string) => string;
+/**
+ * 缩写
+ * @param {number | string} num
+ * @param {Array<string>} units
+ * @param {number} ratio
+ * @param {number} exponent
+ * @returns {string}
+ */
+declare const numberAbbr: (num: number | string, units: Array<string>, ratio?: number, exponent?: number) => string;
+/**
+ * 将数字格式化成千位分隔符显示的字符串
+ * @param {number} val 数字
+ * @param {'int' | 'float'} type 展示分段显示的类型 int:整型 | float:浮点型
+ * @return {string}
+ */
+declare function formatNumber(val: number, type?: string): string;
+
+declare const UNIQUE_NUMBER_SAFE_LENGTH = 18;
+/**
+ * 生成唯一不重复数值
+ * @param {number} length
+ * @returns {string}
+ */
+declare const uniqueNumber: (length?: number) => string;
+interface UniqueString {
+    (length: number, pool: string): string;
+    (length: number): string;
+    (pool: string): string;
+    (): string;
+}
+/**
+ * 生成唯一不重复字符串
+ * @param {number | string} length
+ * @param {string} pool
+ * @returns {string}
+ */
+declare const uniqueString: UniqueString;
+
+export { type AnyArray, type AnyFunc, type AnyObject, type ArrayElements, HEX_POOL, type LooseParamValue, type LooseParams, type Params, type PartialDeep, type Replacer, STRING_ARABIC_NUMERALS, STRING_LOWERCASE_ALPHA, STRING_POOL, STRING_UPPERCASE_ALPHA, UNIQUE_NUMBER_SAFE_LENGTH, addClass, arrayEach, arrayEachAsync, arrayInsertBefore, arrayLike, arrayRemove, asyncMap, calculateDate, calculateDateTime, chooseLocalFile, cloneDeep, cookieDel, cookieGet, cookieSet, copyText, debounce, deepTraversal, downloadBlob, downloadData, downloadHref, downloadURL, formatDate, formatNumber, genCanvasWM, getComputedCssVal, getGlobal, getStrWidthPx, getStyle, getTreeIds, hasClass, isArray, isBigInt, isBoolean, isDate, isDomReady, isError, isFunction, isNaN, isNull, isNumber, isObject, isPlainObject, isPrimitive, isRegExp, isString, isSymbol, isUndefined, numberAbbr, numberToHex, objectAssign, objectEach, objectEachAsync, objectFill, objectGet, objectHas, objectMap, objectAssign as objectMerge, objectOmit, objectPick, onDomReady, once, pathJoin, pathNormalize, qsParse, qsStringify, randomNumber, randomString, randomUuid, removeClass, setGlobal, setStyle, smoothScroll, stringAssign, stringCamelCase, stringEscapeHtml, stringFill, stringFormat, stringKebabCase, throttle, typeIs, uniqueNumber, uniqueString, urlDelParams, urlParse, urlSetParams, urlStringify, wait };