@whitesev/utils 2.6.7 → 2.6.9

package/dist/types/src/CommonUtil.d.ts

@@ -0,0 +1,109 @@
+declare class CommonUtil {
+    /**
+     * JSON数据从源端替换到目标端中，如果目标端存在该数据则替换，不添加，返回结果为目标端替换完毕的结果
+     * @param target 目标数据
+     * @param source 源数据
+     * @param isAdd 是否可以追加键，默认false
+     * @example
+     * Utils.assign({"1":1,"2":{"3":3}}, {"2":{"3":4}});
+     * >
+     * {
+            "1": 1,
+            "2": {
+                "3": 4
+            }
+        }
+     */
+    assign<T1, T2 extends object, T3 extends boolean>(target: T1, source: T2, isAdd?: T3): T3 extends true ? T1 & T2 : T1;
+    /**
+     * 判断对象或数据是否为空
+     * + `String`判空的值，如 ""、"null"、"undefined"、"   "
+     * + `Number`判空的值，如 0
+     * + `Object`判空的值，如 {}、null、undefined
+     * + `Array`(存在属性Symbol.iterator)判空的值，如 []
+     * + `Boolean`判空的值，如false
+     * + `Function`判空的值，如()=>{}、(xxx="")=>{}、function(){}、function(xxx=""){}
+     * @returns
+     * + true 为空
+     * + false 不为空
+     * @example
+      Utils.isNull({});
+      > true
+     * @example
+      Utils.isNull([]);
+      > true
+     * @example
+      Utils.isNull(" ");
+      > true
+     * @example
+      Utils.isNull(function(){});
+      > true
+     * @example
+      Utils.isNull(()=>{}));
+      > true
+     * @example
+      Utils.isNull("undefined");
+      > true
+     * @example
+      Utils.isNull("null");
+      > true
+     * @example
+      Utils.isNull(" ", false);
+      > true
+     * @example
+      Utils.isNull([1],[]);
+      > false
+     * @example
+      Utils.isNull([],[1]);
+      > false
+     * @example
+      Utils.isNull(false,[123]);
+      > false
+     **/
+    isNull<T>(value: T | undefined | null): value is null | undefined;
+    isNull(...args: any[]): boolean;
+    /**
+     * 判断对象是否是元素
+     * @param target
+     * @returns
+     * + true 是元素
+     * + false 不是元素
+     * @example
+     * Utils.isDOM(document.querySelector("a"))
+     * > true
+     */
+    isDOM(target: any): boolean;
+    /**
+     * 判断对象是否不为空
+     * @returns {boolean}
+     * + true 不为空
+     * + false 为空
+     * @example
+     * Utils.isNotNull("123");
+     * > true
+     */
+    isNotNull<T>(value: T | null | undefined): value is T;
+    isNotNull(...args: any[]): boolean;
+    /**
+     * 深拷贝
+     * @param obj 对象
+     */
+    deepClone<T extends object | undefined | null>(obj?: T): T;
+    /**
+     * 覆盖对象中的函数this指向
+     * @param target 需要覆盖的对象
+     * @param [objectThis] 覆盖的this指向，如果为传入，则默认为对象本身
+     */
+    coverObjectFunctionThis(target: any, objectThis?: any): void;
+    /**
+     * 字符串转Object对象，类似'{"test":""}' => {"test":""}
+     * @param data
+     * @param errorCallBack （可选）错误回调
+     * @example
+     * Utils.toJSON("{123:123}")
+     * > {123:123}
+     */
+    toJSON<T = any>(data: string | null, errorCallBack?: (error: Error) => void): T;
+}
+declare let commonUtil: CommonUtil;
+export { commonUtil as CommonUtil };

package/dist/types/src/DOMUtils.d.ts

@@ -0,0 +1,95 @@
+import type { WindowApiOption } from "./types/WindowApi";
+declare class DOMUtils {
+    private windowApi;
+    constructor(option?: WindowApiOption);
+    /**
+     * 选择器，可使用以下的额外语法
+     *
+     * + :contains([text]) 作用: 找到包含指定文本内容的指定元素
+     * + :empty 作用:找到既没有文本内容也没有子元素的指定元素
+     * + :regexp([text]) 作用: 找到符合正则表达式的内容的指定元素
+     * @param selector 选择器
+     * @param parent 指定父元素
+     * @example
+     * DOMUtils.selector("div:contains('测试')")
+     * > div.xxx
+     * @example
+     * DOMUtils.selector("div:empty")
+     * > div.xxx
+     * @example
+     * DOMUtils.selector("div:regexp('^xxxx$')")
+     * > div.xxx
+     */
+    selector<K extends keyof HTMLElementTagNameMap>(selector: K, parent?: Element | Document | DocumentFragment | ShadowRoot): HTMLElementTagNameMap[K] | undefined;
+    selector<E extends Element = Element>(selector: string, parent?: Element | Document | DocumentFragment | ShadowRoot): E | undefined;
+    /**
+     * 选择器，可使用以下的额外语法
+     *
+     * + :contains([text]) 作用: 找到包含指定文本内容的指定元素
+     * + :empty 作用:找到既没有文本内容也没有子元素的指定元素
+     * + :regexp([text]) 作用: 找到符合正则表达式的内容的指定元素
+     * @param selector 选择器
+     * @param parent 指定父元素
+     * @example
+     * DOMUtils.selectorAll("div:contains('测试')")
+     * > [div.xxx]
+     * @example
+     * DOMUtils.selectorAll("div:empty")
+     * > [div.xxx]
+     * @example
+     * DOMUtils.selectorAll("div:regexp('^xxxx$')")
+     * > [div.xxx]
+     * @example
+     * DOMUtils.selectorAll("div:regexp(/^xxx/ig)")
+     * > [div.xxx]
+     */
+    selectorAll<K extends keyof HTMLElementTagNameMap>(selector: K, parent?: Element | Document | DocumentFragment | ShadowRoot): HTMLElementTagNameMap[K][];
+    selectorAll<E extends Element = Element>(selector: string, parent?: Element | Document | DocumentFragment | ShadowRoot): E[];
+    /**
+     * 匹配元素，可使用以下的额外语法
+     *
+     * + :contains([text]) 作用: 找到包含指定文本内容的指定元素
+     * + :empty 作用:找到既没有文本内容也没有子元素的指定元素
+     * + :regexp([text]) 作用: 找到符合正则表达式的内容的指定元素
+     * @param $el 元素
+     * @param selector 选择器
+     * @example
+     * DOMUtils.matches("div:contains('测试')")
+     * > true
+     * @example
+     * DOMUtils.matches("div:empty")
+     * > true
+     * @example
+     * DOMUtils.matches("div:regexp('^xxxx$')")
+     * > true
+     * @example
+     * DOMUtils.matches("div:regexp(/^xxx/ig)")
+     * > false
+     */
+    matches($el: HTMLElement | Element | null | undefined, selector: string): boolean;
+    /**
+     * 根据选择器获取上层元素，可使用以下的额外语法
+     *
+     * + :contains([text]) 作用: 找到包含指定文本内容的指定元素
+     * + :empty 作用:找到既没有文本内容也没有子元素的指定元素
+     * + :regexp([text]) 作用: 找到符合正则表达式的内容的指定元素
+     * @param $el 元素
+     * @param selector 选择器
+     * @example
+     * DOMUtils.closest("div:contains('测试')")
+     * > div.xxx
+     * @example
+     * DOMUtils.closest("div:empty")
+     * > div.xxx
+     * @example
+     * DOMUtils.closest("div:regexp('^xxxx$')")
+     * > div.xxxx
+     * @example
+     * DOMUtils.closest("div:regexp(/^xxx/ig)")
+     * > null
+     */
+    closest<K extends keyof HTMLElementTagNameMap>($el: HTMLElement | Element, selector: string): HTMLElementTagNameMap[K] | null;
+    closest<E extends Element = Element>($el: HTMLElement | Element, selector: string): E | null;
+}
+declare let domUtils: DOMUtils;
+export { domUtils };

package/dist/types/src/Utils.d.ts

@@ -44,7 +44,7 @@ declare class Utils {
             }
         }
      */
-    assign<T1, T2 extends object, T3 extends boolean>(target: T1, source: T2, isAdd?: T3): T3 extends true ? T1 & T2 : T1;
+    assign: <T1, T2 extends object, T3 extends boolean>(target: T1, source: T2, isAdd?: T3 | undefined) => T3 extends true ? T1 & T2 : T1;
     /**
      * 异步替换字符串
      * @param string 需要被替换的目标字符串
@@ -121,7 +121,7 @@ declare class Utils {
      * 深拷贝
      * @param obj 对象
      */
-    deepClone<T extends object | undefined | null>(obj?: T): T;
+    deepClone: <T extends object | undefined | null>(obj?: T | undefined) => T;
     /**
      * 防抖函数
      * @param fn 需要触发的回调
@@ -811,7 +811,7 @@ declare class Utils {
      * Utils.isDOM(document.querySelector("a"))
      * > true
      */
-    isDOM(target: any): boolean;
+    isDOM: (target: any) => boolean;
     /**
      * 判断浏览器是否支持全屏
      */
@@ -853,8 +853,10 @@ declare class Utils {
      * Utils.isNotNull("123");
      * > true
      */
-    isNotNull<T>(value: T | null | undefined): value is T;
-    isNotNull(...args: any[]): boolean;
+    isNotNull: {
+        <T>(value: T | null | undefined): value is T;
+        (...args: any[]): boolean;
+    };
     /**
      * 判断对象或数据是否为空
      * + `String`判空的值，如 ""、"null"、"undefined"、"   "
@@ -900,8 +902,10 @@ declare class Utils {
       Utils.isNull(false,[123]);
       > false
      **/
-    isNull<T>(value: T | undefined | null): value is null | undefined;
-    isNull(...args: any[]): boolean;
+    isNull: {
+        <T>(value: T | undefined | null): value is null | undefined;
+        (...args: any[]): boolean;
+    };
     /**
      * 判断浏览器主题是否是暗黑|深色模式
      */
@@ -1348,7 +1352,7 @@ declare class Utils {
      * Utils.toJSON("{123:123}")
      * > {123:123}
      */
-    toJSON<T = any>(data: string | null, errorCallBack?: (error: Error) => void): T;
+    toJSON: <T = any>(data: string | null, errorCallBack?: (error: Error) => void) => T;
     /**
      * 对象转为UrlSearchParams格式的字符串
      * @param obj 目标对象，可以是对象组成的数组
@@ -1804,7 +1808,7 @@ declare class Utils {
      * @param target 需要覆盖的对象
      * @param [objectThis] 覆盖的this指向，如果为传入，则默认为对象本身
      */
-    coverObjectFunctionThis(target: any, objectThis?: any): void;
+    coverObjectFunctionThis: (target: any, objectThis?: any) => void;
     /**
      * 生成uuid
      * @example
@@ -1847,6 +1851,19 @@ declare class Utils {
      * @param timeId setInterval 返回的`id`
      */
     workerClearInterval(timeId: number | undefined): void;
+    /**
+     * 获取剪贴板信息
+     */
+    getClipboardInfo(): Promise<{
+        /**
+         * 错误信息，如果为null，则表示读取成功
+         */
+        error: Error | null;
+        /**
+         * 剪贴板内容
+         */
+        content: string;
+    }>;
 }
 declare let utils: Utils;
 export { utils as Utils };

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@whitesev/utils",
-  "version": "2.6.7",
+  "version": "2.6.9",
   "description": "一个常用的工具库",
+  "$schema": "https://json.schemastore.org/package.json",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/types/index.d.ts",

package/src/CommonUtil.ts

@@ -0,0 +1,302 @@
+import { TryCatch } from "./TryCatch";
+
+class CommonUtil {
+	/** 
+     * JSON数据从源端替换到目标端中，如果目标端存在该数据则替换，不添加，返回结果为目标端替换完毕的结果
+     * @param target 目标数据
+     * @param source 源数据
+     * @param isAdd 是否可以追加键，默认false
+     * @example
+     * Utils.assign({"1":1,"2":{"3":3}}, {"2":{"3":4}});
+     * > 
+     * {
+            "1": 1,
+            "2": {
+                "3": 4
+            }
+        }
+     */
+	assign<T1, T2 extends object, T3 extends boolean>(
+		target: T1,
+		source: T2,
+		isAdd?: T3
+	): T3 extends true ? T1 & T2 : T1;
+	assign(target = {}, source = {}, isAdd = false) {
+		let UtilsContext = this;
+		if (Array.isArray(source)) {
+			let canTraverse = source.filter((item) => {
+				return typeof item === "object";
+			});
+			if (!canTraverse.length) {
+				return source;
+			}
+		}
+		if (source == null) {
+			return target;
+		}
+		if (target == null) {
+			target = {};
+		}
+		if (isAdd) {
+			for (const sourceKeyName in source) {
+				const targetKeyName = sourceKeyName;
+				let targetValue = (target as any)[targetKeyName];
+				let sourceValue = (source as any)[sourceKeyName];
+				if (
+					typeof sourceValue === "object" &&
+					sourceValue != null &&
+					sourceKeyName in target &&
+					!UtilsContext.isDOM(sourceValue)
+				) {
+					/* 源端的值是object类型，且不是元素节点 */
+					(target as any)[sourceKeyName] = UtilsContext.assign(
+						targetValue,
+						sourceValue,
+						isAdd
+					);
+					continue;
+				}
+				(target as any)[sourceKeyName] = sourceValue;
+			}
+		} else {
+			for (const targetKeyName in target) {
+				if (targetKeyName in source) {
+					let targetValue = (target as any)[targetKeyName];
+					let sourceValue = (source as any)[targetKeyName];
+					if (
+						typeof sourceValue === "object" &&
+						sourceValue != null &&
+						!UtilsContext.isDOM(sourceValue) &&
+						Object.keys(sourceValue).length
+					) {
+						/* 源端的值是object类型，且不是元素节点 */
+						(target as any)[targetKeyName] = UtilsContext.assign(
+							targetValue,
+							sourceValue,
+							isAdd
+						);
+						continue;
+					}
+					/* 直接赋值 */
+					(target as any)[targetKeyName] = sourceValue;
+				}
+			}
+		}
+
+		return target;
+	}
+	/**
+     * 判断对象或数据是否为空
+     * + `String`判空的值，如 ""、"null"、"undefined"、"   "
+     * + `Number`判空的值，如 0
+     * + `Object`判空的值，如 {}、null、undefined
+     * + `Array`(存在属性Symbol.iterator)判空的值，如 []
+     * + `Boolean`判空的值，如false
+     * + `Function`判空的值，如()=>{}、(xxx="")=>{}、function(){}、function(xxx=""){}
+     * @returns
+     * + true 为空
+     * + false 不为空
+     * @example
+      Utils.isNull({});
+      > true
+     * @example
+      Utils.isNull([]);
+      > true
+     * @example
+      Utils.isNull(" ");
+      > true
+     * @example
+      Utils.isNull(function(){});
+      > true
+     * @example
+      Utils.isNull(()=>{}));
+      > true
+     * @example
+      Utils.isNull("undefined");
+      > true
+     * @example
+      Utils.isNull("null");
+      > true
+     * @example
+      Utils.isNull(" ", false);
+      > true
+     * @example
+      Utils.isNull([1],[]);
+      > false
+     * @example
+      Utils.isNull([],[1]);
+      > false
+     * @example
+      Utils.isNull(false,[123]);
+      > false
+     **/
+	isNull<T>(value: T | undefined | null): value is null | undefined;
+	isNull(...args: any[]): boolean;
+	isNull(...args: any[]): boolean {
+		let result = true;
+		let checkList = [...args];
+		for (const objItem of checkList) {
+			let itemResult = false;
+			if (objItem === null || objItem === undefined) {
+				itemResult = true;
+			} else {
+				switch (typeof objItem) {
+					case "object":
+						if (typeof objItem[Symbol.iterator] === "function") {
+							/* 可迭代 */
+							itemResult = objItem.length === 0;
+						} else {
+							itemResult = Object.keys(objItem).length === 0;
+						}
+						break;
+					case "number":
+						itemResult = objItem === 0;
+						break;
+					case "string":
+						itemResult =
+							objItem.trim() === "" ||
+							objItem === "null" ||
+							objItem === "undefined";
+						break;
+					case "boolean":
+						itemResult = !objItem;
+						break;
+					case "function":
+						let funcStr = objItem.toString().replace(/\s/g, "");
+						/* 排除()=>{}、(xxx="")=>{}、function(){}、function(xxx=""){} */
+						itemResult = Boolean(
+							funcStr.match(/^\(.*?\)=>\{\}$|^function.*?\(.*?\)\{\}$/)
+						);
+						break;
+				}
+			}
+			result = result && itemResult;
+		}
+
+		return result;
+	}
+	/**
+	 * 判断对象是否是元素
+	 * @param target
+	 * @returns
+	 * + true 是元素
+	 * + false 不是元素
+	 * @example
+	 * Utils.isDOM(document.querySelector("a"))
+	 * > true
+	 */
+	isDOM(target: any): boolean {
+		return target instanceof Node;
+	}
+	/**
+	 * 判断对象是否不为空
+	 * @returns {boolean}
+	 * + true 不为空
+	 * + false 为空
+	 * @example
+	 * Utils.isNotNull("123");
+	 * > true
+	 */
+	isNotNull<T>(value: T | null | undefined): value is T;
+	isNotNull(...args: any[]): boolean;
+	isNotNull(...args: any[]): boolean {
+		let UtilsContext = this;
+		return !UtilsContext.isNull.apply(this, args);
+	}
+	/**
+	 * 深拷贝
+	 * @param obj 对象
+	 */
+	deepClone<T extends object | undefined | null>(obj?: T): T;
+	deepClone<T extends object | undefined | null>(obj?: T) {
+		let UtilsContext = this;
+		if (obj === void 0) return void 0;
+		if (obj === null) return null;
+		let clone = obj instanceof Array ? [] : {};
+		for (const [key, value] of Object.entries(obj)) {
+			(clone as any)[key] =
+				typeof value === "object" ? UtilsContext.deepClone(value) : value;
+		}
+		return clone;
+	}
+	/**
+	 * 覆盖对象中的函数this指向
+	 * @param target 需要覆盖的对象
+	 * @param [objectThis] 覆盖的this指向，如果为传入，则默认为对象本身
+	 */
+	coverObjectFunctionThis(target: any, objectThis?: any) {
+		if (typeof target !== "object" || target === null) {
+			throw new Error("target must be object");
+		}
+		objectThis = objectThis || target;
+		Object.keys(target).forEach((key) => {
+			if (typeof target[key] === "function") {
+				target[key] = target[key].bind(objectThis);
+			}
+		});
+	}
+	/**
+	 * 字符串转Object对象，类似'{"test":""}' => {"test":""}
+	 * @param data
+	 * @param errorCallBack （可选）错误回调
+	 * @example
+	 * Utils.toJSON("{123:123}")
+	 * > {123:123}
+	 */
+	toJSON<T = any>(
+		data: string | null,
+		errorCallBack?: (error: Error) => void
+	): T;
+	toJSON<T = any>(
+		data: string | null,
+		errorCallBack?: (error: Error) => void
+	): T {
+		let result: any = {};
+		if (typeof data === "object") {
+			return data as any;
+		}
+		TryCatch()
+			.config({ log: false })
+			.error((error: Error) => {
+				TryCatch()
+					.error(() => {
+						try {
+							result = new Function("return " + data)();
+						} catch (error2: any) {
+							if (typeof errorCallBack === "function") {
+								errorCallBack(error2);
+							}
+						}
+					})
+					.run(() => {
+						if (
+							data &&
+							/^[\],:{}\s]*$/.test(
+								data
+									.replace(/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g, "@")
+									.replace(
+										/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,
+										"]"
+									)
+									.replace(/(?:^|:|,)(?:\s*\[)+/g, "")
+							)
+						) {
+							result = new Function("return " + data)();
+						} else {
+							if (typeof errorCallBack === "function") {
+								errorCallBack(new Error("target is not a JSON"));
+							}
+						}
+					});
+			})
+			.run(() => {
+				data = (data as string).trim();
+				result = JSON.parse(data);
+			});
+		return result as any;
+	}
+}
+
+let commonUtil = new CommonUtil();
+
+export { commonUtil as CommonUtil };