sculp-js 0.1.1 → 1.0.0

package/lib/cjs/object.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -29,20 +29,22 @@ const isPlainObject = (obj) => {
  * @param {string} key
  * @returns {boolean}
  */
-const objectHas = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key);
+function objectHas(obj, key) {
+    return Object.prototype.hasOwnProperty.call(obj, key);
+}
 /**
  * 遍历对象，返回 false 中断遍历
  * @param {O} obj
  * @param {(val: O[keyof O], key: keyof O) => (boolean | void)} iterator
  */
-const objectEach = (obj, iterator) => {
+function objectEach(obj, iterator) {
     for (const key in obj) {
         if (!objectHas(obj, key))
             continue;
         if (iterator(obj[key], key) === false)
             break;
     }
-};
+}
 /**
  * 异步遍历对象，返回 false 中断遍历
  * @param {O} obj
@@ -148,7 +150,7 @@ const merge = (map, source, target) => {
  * @param {ObjectAssignItem | undefined} targets
  * @returns {R}
  */
-const objectAssign = (source, ...targets) => {
+function objectAssign(source, ...targets) {
     const map = new Map();
     for (let i = 0; i < targets.length; i++) {
         const target = targets[i];
@@ -158,7 +160,7 @@ const objectAssign = (source, ...targets) => {
     }
     map.clear();
     return source;
-};
+}
 /**
  * 对象填充
  * @param {Partial<R>} source
@@ -166,7 +168,7 @@ const objectAssign = (source, ...targets) => {
  * @param {(s: Partial<R>, t: Partial<R>, key: keyof R) => boolean} fillable
  * @returns {R}
  */
-const objectFill = (source, target, fillable) => {
+function objectFill(source, target, fillable) {
     const _fillable = fillable || ((source, target, key) => source[key] === undefined);
     objectEach(target, (val, key) => {
         if (_fillable(source, target, key)) {
@@ -174,7 +176,7 @@ const objectFill = (source, target, fillable) => {
         }
     });
     return source;
-};
+}
 function objectGet(obj, path, strict = false) {
     path = path.replace(/\[(\w+)\]/g, '.$1');
     path = path.replace(/^\./, '');
@@ -207,7 +209,7 @@ function objectGet(obj, path, strict = false) {
  * 深拷贝堪称完全体 即：任何类型的数据都会被深拷贝
  * @param {AnyObject | AnyArray} obj
  * @param {WeakMap} map
- * @return {AnyObject | AnyArray}
+ * @returns {AnyObject | AnyArray}
  */
 function cloneDeep(obj, map = new WeakMap()) {
     if (obj instanceof Date)

package/lib/cjs/path.js

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

package/lib/cjs/qs.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -14,7 +14,7 @@ var type = require('./type.js');
  * @param {string} queryString
  * @returns {Params}
  */
-const qsParse = (queryString) => {
+function qsParse(queryString) {
     const params = new URLSearchParams(queryString);
     const result = {};
     for (const [key, val] of params.entries()) {
@@ -28,7 +28,7 @@ const qsParse = (queryString) => {
         result[key] = params.getAll(key);
     }
     return result;
-};
+}
 const defaultReplacer = (val) => {
     if (type.isString(val))
         return val;
@@ -46,7 +46,7 @@ const defaultReplacer = (val) => {
  * @param {Replacer} replacer
  * @returns {string}
  */
-const qsStringify = (query, replacer = defaultReplacer) => {
+function qsStringify(query, replacer = defaultReplacer) {
     const params = new URLSearchParams();
     object.objectEach(query, (val, key) => {
         if (type.isArray(val)) {
@@ -65,7 +65,7 @@ const qsStringify = (query, replacer = defaultReplacer) => {
         }
     });
     return params.toString();
-};
+}
 
 exports.qsParse = qsParse;
 exports.qsStringify = qsStringify;

package/lib/cjs/random.js

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

package/lib/cjs/string.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -14,24 +14,24 @@ var type = require('./type.js');
  * @param {boolean} [bigger] 是否大写第一个字母
  * @returns {string}
  */
-const stringCamelCase = (string, bigger) => {
+function stringCamelCase(string, bigger) {
     let string2 = string;
     if (bigger) {
         string2 = string.replace(/^./, origin => origin.toUpperCase());
     }
     const HUMP_RE = /[\s_-](.)/g;
     return string2.replace(HUMP_RE, (orign, char) => char.toUpperCase());
-};
+}
 /**
  * 将字符串转换为连字格式
  * @param {string} string
  * @param {string} [separator] 分隔符，默认是"-"（短横线）
  * @returns {string}
  */
-const stringKebabCase = (string, separator = '-') => {
+function stringKebabCase(string, separator = '-') {
     const string2 = string.replace(/^./, origin => origin.toLowerCase());
     return string2.replace(/[A-Z]/g, origin => `${separator}${origin.toLowerCase()}`);
-};
+}
 const STRING_ARABIC_NUMERALS = '0123456789';
 const STRING_LOWERCASE_ALPHA = 'abcdefghijklmnopqrstuvwxyz';
 const STRING_UPPERCASE_ALPHA = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';
@@ -47,7 +47,7 @@ const placeholderRE = /%[%sdo]/g;
  * @param args
  * @returns {string}
  */
-const stringFormat = (string, ...args) => {
+function stringFormat(string, ...args) {
     let index = 0;
     const result = string.replace(placeholderRE, (origin) => {
         const arg = args[index++];
@@ -65,7 +65,7 @@ const stringFormat = (string, ...args) => {
         }
     });
     return [result, ...args.splice(index).map(String)].join(' ');
-};
+}
 const ev = (expression, data) => {
     try {
         // eslint-disable-next-line @typescript-eslint/no-implied-eval,@typescript-eslint/no-unsafe-return
@@ -129,7 +129,7 @@ const stringFill = (length, value = ' ') => new Array(length).fill(value).join('
  * @param {string} str 目标字符串
  * @param {number} fontSize 字符串字体大小
  * @param {boolean} isRemoveDom 计算后是否移除中间dom元素
- * @return {*}
+ * @returns {*}
  */
 function getStrWidthPx(str, fontSize = 14, isRemoveDom = false) {
     let strWidth = 0;

package/lib/cjs/type.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -8,6 +8,11 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+/**
+ * 判断任意值的数据类型
+ * @param {unknown} any
+ * @returns {string}
+ */
 const typeIs = (any) => Object.prototype.toString.call(any).slice(8, -1);
 // 基本数据类型判断
 const isString = (any) => typeof any === 'string';
@@ -21,7 +26,11 @@ const isPrimitive = (any) => any === null || typeof any !== 'object';
 // 复合数据类型判断
 const isObject = (any) => typeIs(any) === 'Object';
 const isArray = (any) => Array.isArray(any);
-// eslint-disable-next-line @typescript-eslint/ban-types
+/**
+ * 判断是否为函数
+ * @param {unknown} any
+ * @returns {boolean}
+ */
 const isFunction = (any) => typeof any === 'function';
 // 对象类型判断
 const isNaN = (any) => Number.isNaN(any);

package/lib/cjs/unique.js

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

package/lib/cjs/url.js

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

package/lib/cjs/watermark.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -13,17 +13,18 @@
  * @desc 网页加水印的工具类
  */
 /**
- * canvas 实现 watermark
+ * canvas 实现 水印, 具备防删除功能
  * @param {ICanvasWM} canvasWM
+ * @example genCanvasWM({ content: 'QQMusicFE' })
  */
-const genCanvasWM = (canvasWM) => {
+function genCanvasWM(canvasWM) {
     const { container = document.body, width = '300px', height = '200px', textAlign = 'center', textBaseline = 'middle', font = '20px PingFangSC-Medium,PingFang SC', 
     // fontWeight = 500,
     fillStyle = 'rgba(189, 177, 167, .3)', content = '请勿外传', rotate = 30, zIndex = 2147483647 } = canvasWM;
     // 仅限主页面添加水印
-    if (!location.pathname.includes('/home')) {
-        return;
-    }
+    // if (!location.pathname.includes('/home')) {
+    //   return;
+    // }
     const args = canvasWM;
     const canvas = document.createElement('canvas');
     canvas.setAttribute('width', width);
@@ -84,8 +85,6 @@ const genCanvasWM = (canvasWM) => {
         });
         mo.observe(container, { attributes: true, subtree: true, childList: true });
     }
-};
-// 调用
-// __canvasWM({ content: 'QQMusicFE' })
+}
 
 exports.genCanvasWM = genCanvasWM;

package/lib/es/array.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -9,10 +9,11 @@ import { isArray, isString, isObject } from './type.js';
 
 /**
  * 判断一个对象是否为类数组
+ *
  * @param any
  * @returns {boolean}
  */
-const arrayLike = (any) => {
+function arrayLike(any) {
     if (isArray(any))
         return true;
     if (isString(any))
@@ -20,14 +21,16 @@ const arrayLike = (any) => {
     if (!isObject(any))
         return false;
     return objectHas(any, 'length');
-};
+}
 /**
  * 遍历数组，返回 false 中断遍历
+ *
  * @param {ArrayLike<V>} array
  * @param {(val: V, idx: number) => any} iterator
  * @param reverse {boolean} 是否倒序
+ * @returns {*}
  */
-const arrayEach = (array, iterator, reverse = false) => {
+function arrayEach(array, iterator, reverse = false) {
     if (reverse) {
         for (let idx = array.length - 1; idx >= 0; idx--) {
             const val = array[idx];
@@ -42,12 +45,12 @@ const arrayEach = (array, iterator, reverse = false) => {
                 break;
         }
     }
-};
+}
 /**
  * 异步遍历数组，返回 false 中断遍历
- * @param {ArrayLike<V>} array
- * @param {(val: V, idx: number) => Promise<any>} iterator
- * @param {boolean} reverse
+ * @param {ArrayLike<V>} array 数组
+ * @param {(val: V, idx: number) => Promise<any>} iterator  支持Promise类型的回调函数
+ * @param {boolean} reverse  是否反向遍历
  */
 async function arrayEachAsync(array, iterator, reverse = false) {
     if (reverse) {
@@ -70,15 +73,16 @@ async function arrayEachAsync(array, iterator, reverse = false) {
  * @param {AnyArray} array
  * @param {number} start
  * @param {number} to
+ * @returns {*}
  */
-const arrayInsertBefore = (array, start, to) => {
+function arrayInsertBefore(array, start, to) {
     if (start === to || start + 1 === to)
         return;
     // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const [source] = array.splice(start, 1);
     const insertIndex = to < start ? to : to - 1;
     array.splice(insertIndex, 0, source);
-};
+}
 /**
  * 数组删除指定项目
  * @param {V[]} array
@@ -99,17 +103,18 @@ function arrayRemove(array, expect) {
 }
 /**
  * 自定义深度优先遍历函数(支持continue和break操作)
- * @param {array} deepList
- * @param {function} iterator
- * @param {array} children
- * @param {boolean} isReverse 是否反向遍历
+ * @param {ArrayLike<V>} tree  树形数据
+ * @param {Function} iterator  迭代函数
+ * @param {string} children 定制子元素的key
+ * @param {boolean} isReverse  是否反向遍历
+ * @returns {*}
  */
-const deepTraversal = (deepList, iterator, children = 'children', isReverse = false) => {
+function deepTraversal(tree, iterator, children = 'children', isReverse = false) {
     let level = 0;
     const walk = (arr, parent) => {
         if (isReverse) {
             for (let i = arr.length - 1; i >= 0; i--) {
-                const re = iterator(arr[i], i, deepList, parent, level);
+                const re = iterator(arr[i], i, tree, parent, level);
                 if (re === 'break') {
                     break;
                 }
@@ -126,7 +131,7 @@ const deepTraversal = (deepList, iterator, children = 'children', isReverse = fa
         }
         else {
             for (let i = 0; i < arr.length; i++) {
-                const re = iterator(arr[i], i, deepList, parent, level);
+                const re = iterator(arr[i], i, tree, parent, level);
                 if (re === 'break') {
                     break;
                 }
@@ -142,14 +147,15 @@ const deepTraversal = (deepList, iterator, children = 'children', isReverse = fa
             }
         }
     };
-    walk(deepList, null);
-};
+    walk(tree, null);
+}
 /**
  * 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
- * @param {ArrayLike<T>} tree
- * @param {IdLike} nodeId
- * @param {ITreeConf} config
- * @return {[IdLike[], ITreeItem<V>[]]}
+ *
+ * @param {ArrayLike<T>} tree - 树形数据
+ * @param {IdLike} nodeId - 元素ID
+ * @param {ITreeConf} config - 迭代配置项
+ * @returns {[IdLike[], ITreeItem<V>[]]} - 由parentId...childId, parentObject-childObject组成的二维数组
  */
 function getTreeIds(tree, nodeId, config) {
     const { children = 'children', id = 'id' } = config || {};

package/lib/es/async.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -9,7 +9,7 @@
  * @param {number} timeout 等待时间，单位毫秒
  * @returns {Promise<void>}
  */
-async function wait(timeout = 1) {
+function wait(timeout = 1) {
     return new Promise(resolve => setTimeout(resolve, timeout));
 }
 /**
@@ -21,7 +21,7 @@ async function wait(timeout = 1) {
  * @param {number} concurrency 并发数量，默认无限
  * @returns {Promise<R[]>}
  */
-async function asyncMap(list, mapper, concurrency = Infinity) {
+function asyncMap(list, mapper, concurrency = Infinity) {
     return new Promise((resolve, reject) => {
         const iterator = list[Symbol.iterator]();
         const limit = Math.min(list.length, concurrency);

package/lib/es/clipboard.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -18,7 +18,7 @@ document.body.appendChild(textEl);
  * 复制文本
  * @param {string} text
  */
-const copyText = (text) => {
+function copyText(text) {
     textEl.value = text;
     textEl.focus({ preventScroll: true });
     textEl.select();
@@ -29,6 +29,6 @@ const copyText = (text) => {
     catch (err) {
         // ignore
     }
-};
+}
 
 export { copyText };

package/lib/es/cookie.js

@@ -1,5 +1,5 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
@@ -11,7 +11,7 @@ import { isNumber, isDate } from './type.js';
  * @param {string} name
  * @returns {string}
  */
-const cookieGet = (name) => {
+function cookieGet(name) {
     const { cookie } = document;
     if (!cookie)
         return '';
@@ -23,14 +23,14 @@ const cookieGet = (name) => {
             return decodeURIComponent(val);
     }
     return '';
-};
+}
 /**
  * 设置 cookie
  * @param {string} name
  * @param {string} value
  * @param {number | Date} [maxAge]
  */
-const cookieSet = (name, value, maxAge) => {
+function cookieSet(name, value, maxAge) {
     const metas = [];
     const EXPIRES = 'expires';
     metas.push([name, encodeURIComponent(value)]);
@@ -49,7 +49,7 @@ const cookieSet = (name, value, maxAge) => {
         return `${key}=${val}`;
     })
         .join(';');
-};
+}
 /**
  * 删除单个 cookie
  * @param name cookie 名称

package/lib/es/date.js

@@ -1,9 +1,64 @@
 /*!
- * sculp-js v0.1.0
+ * sculp-js v1.0.0
  * (c) 2023-2023 chandq
  * Released under the MIT License.
  */
 
+import { isDate, isNaN, isString } from './type.js';
+
+const isValidDate = (any) => isDate(any) && !isNaN(any.getTime());
+/* istanbul ignore next */
+const guessDateSeparator = (value) => {
+    if (!isString(value))
+        return;
+    const value2 = value.replace(/-/g, '/');
+    return new Date(value2);
+};
+/* istanbul ignore next */
+const guessDateTimezone = (value) => {
+    if (!isString(value))
+        return;
+    const re = /([+-])(\d\d)(\d\d)$/;
+    const matches = re.exec(value);
+    if (!matches)
+        return;
+    const value2 = value.replace(re, 'Z');
+    const d = new Date(value2);
+    if (!isValidDate(d))
+        return;
+    const [, flag, hours, minutes] = matches;
+    const hours2 = parseInt(hours, 10);
+    const minutes2 = parseInt(minutes, 10);
+    const offset = (a, b) => (flag === '+' ? a - b : a + b);
+    d.setHours(offset(d.getHours(), hours2));
+    d.setMinutes(offset(d.getMinutes(), minutes2));
+    return d;
+};
+/**
+ * 解析为Date对象
+ * @param {DateValue} value - 可以是数值、字符串或 Date 对象
+ * @returns {Date} - 转换后的目标Date
+ */
+function dateParse(value) {
+    const d1 = new Date(value);
+    if (isValidDate(d1))
+        return d1;
+    // safari 浏览器的日期解析有问题
+    // new Date('2020-06-26 18:06:15') 返回值是一个非法日期对象
+    /* istanbul ignore next */
+    const d2 = guessDateSeparator(value);
+    /* istanbul ignore next */
+    if (isValidDate(d2))
+        return d2;
+    // safari 浏览器的日期解析有问题
+    // new Date('2020-06-26T18:06:15.000+0800') 返回值是一个非法日期对象
+    /* istanbul ignore next */
+    const d3 = guessDateTimezone(value);
+    /* istanbul ignore next */
+    if (isValidDate(d3))
+        return d3;
+    throw new SyntaxError(`${value.toString()} 不是一个合法的日期描述`);
+}
 /**
  * 格式化为日期对象(带自定义格式化模板)
  * @param {DateValue} value 可以是数值、字符串或 Date 对象
@@ -18,10 +73,69 @@
  * - mm：分
  * - ss：秒
  * - SSS：毫秒
- * - ww: 周
  * @returns {string}
  */
-const formatDate = (date = new Date(), format = 'YYYY-MM-DD HH:mm:ss') => {
+// export const dateStringify = (value: DateValue, format = 'YYYY-MM-DD HH:mm:ss'): string => {
+//   const date = dateParse(value);
+//   let fmt = format;
+//   let ret;
+//   const opt: DateObj = {
+//     'Y+': `${date.getFullYear()}`, // 年
+//     'y+': `${date.getFullYear()}`, // 年
+//     'M+': `${date.getMonth() + 1}`, // 月
+//     'D+': `${date.getDate()}`, // 日
+//     'd+': `${date.getDate()}`, // 日
+//     'H+': `${date.getHours()}`, // 时
+//     'm+': `${date.getMinutes()}`, // 分
+//     's+': `${date.getSeconds()}`, // 秒
+//     'S+': `${date.getMilliseconds()}` // 豪秒
+//   };
+//   for (const k in opt) {
+//     ret = new RegExp(`(${k})`).exec(fmt);
+//     if (ret) {
+//       fmt = fmt.replace(ret[1], ret[1].length === 1 ? opt[k] : opt[k].padStart(ret[1].length, '0'));
+//     }
+//   }
+//   return fmt;
+// };
+/**
+ * 将日期转换为一天的开始时间，即0点0分0秒0毫秒
+ * @param {DateValue} value
+ * @returns {Date}
+ */
+function dateToStart(value) {
+    const d = dateParse(value);
+    return new Date(d.getFullYear(), d.getMonth(), d.getDate(), 0, 0, 0, 0);
+}
+/**
+ * 将日期转换为一天的结束时间，即23点59分59秒999毫秒
+ * @param {DateValue} value
+ * @returns {Date}
+ */
+function dateToEnd(value) {
+    const d = dateToStart(value);
+    d.setDate(d.getDate() + 1);
+    return dateParse(d.getTime() - 1);
+}
+/**
+ * 格式化为日期对象(带自定义格式化模板)
+ * @param {Date} value - 可以是数值、字符串或 Date 对象
+ * @param {string} [format] - 模板，默认是 YYYY-MM-DD HH:mm:ss，模板字符：
+ * - YYYY：年
+ * - yyyy: 年
+ * - MM：月
+ * - DD：日
+ * - dd: 日
+ * - HH：时（24 小时制）
+ * - hh：时（12 小时制）
+ * - mm：分
+ * - ss：秒
+ * - SSS：毫秒
+ * - ww: 周
+ * @returns {string}  格式化后的日期字符串
+ */
+function formatDate(value, format = 'YYYY-MM-DD HH:mm:ss') {
+    const date = dateParse(value);
     let fmt = format;
     let ret;
     const opt = {
@@ -44,13 +158,13 @@ const formatDate = (date = new Date(), format = 'YYYY-MM-DD HH:mm:ss') => {
         }
     }
     return fmt;
-};
+}
 /**
  * 计算向前或向后N天的具体日期
- * @param {string} strDate 参考日期
- * @param {number} n 正数：向后推算；负数：向前推算
- * @param {string} sep 日期格式的分隔符
- * @return {*} 目标日期
+ * @param {string} strDate - 参考日期
+ * @param {number} n - 正数：向后推算；负数：向前推算
+ * @param {string} sep - 日期格式的分隔符
+ * @returns {string} 计算后的目标日期
  */
 function calculateDate(strDate, n, sep = '-') {
     //strDate 为字符串日期 如:'2019-01-01' n为你要传入的参数，当前为0，前一天为-1，后一天为1
@@ -68,10 +182,10 @@ function calculateDate(strDate, n, sep = '-') {
 }
 /**
  * 计算向前或向后N天的具体时间日期
- * @param {number} n 正数：向后推算；负数：向前推算
- * @param {string} dateSep 日期分隔符
- * @param {string} timeSep 时间分隔符
- * @return {*}
+ * @param {number} n - 正数：向后推算；负数：向前推算
+ * @param {string} dateSep - 日期分隔符
+ * @param {string} timeSep - 时间分隔符
+ * @returns {string} 转换后的目标日期时间
  */
 function calculateDateTime(n, dateSep = '-', timeSep = ':') {
     const date = new Date();
@@ -107,4 +221,4 @@ function calculateDateTime(n, dateSep = '-', timeSep = ':') {
         date.getSeconds());
 }
 
-export { calculateDate, calculateDateTime, formatDate };
+export { calculateDate, calculateDateTime, dateParse, dateToEnd, dateToStart, formatDate, isValidDate };