@whitesev/utils 2.3.8 → 2.4.0

package/src/types/Log.d.ts

@@ -0,0 +1,19 @@
+/** Utils.Log的初始化配置 */
+export interface UtilsLogOptions {
+	/** 是否输出Tag，false的话其它的颜色也不输出 @default true */
+	tag: boolean;
+	/** log.success的颜色 @default "#0000FF" */
+	successColor: string;
+	/** log.warn的颜色 @default "0" */
+	warnColor: string;
+	/** log.error的颜色 @default "#FF0000" */
+	errorColor: string;
+	/** log.info的颜色 @default "0" */
+	infoColor: string;
+	/** 是否开启debug模式，true会在控制台每次调用时输出调用函数的所在位置，false不会输出位置 @default false */
+	debug: boolean;
+	/** 当console输出超过logMaxCount数量自动清理控制台 @default false */
+	autoClearConsole: boolean;
+	/** console输出的最高数量，autoClearConsole开启则生效 @default 999 */
+	logMaxCount: number;
+}

package/src/types/Progress.d.ts

@@ -0,0 +1,20 @@
+export interface ProgressParamConfig {
+	/** canvas元素节点 */
+	canvasNode: HTMLCanvasElement;
+	/** 绘制角度，默认：95 */
+	deg: number;
+	/** 进度，默认：0 */
+	progress: number;
+	/** 绘制的线宽度，默认：10 */
+	lineWidth: number;
+	/** 绘制的背景颜色，默认：#1e637c */
+	lineBgColor: string;
+	/** 绘制的线的颜色，默认：#25deff */
+	lineColor: string;
+	/** 绘制的字体颜色，默认：#000000 */
+	textColor: string;
+	/** 绘制的字体大小(px)，默认：22px */
+	fontSize: number;
+	/** 绘制的圆的半径，默认：50 */
+	circleRadius: number;
+}

package/src/types/TryCatch.d.ts

@@ -0,0 +1,9 @@
+export declare interface UtilsTryCatchConfig {
+	log: boolean;
+}
+/** tryCatch */
+export declare interface UtilsTryCatchType {
+	run: UtilsTryCatchType;
+	config: UtilsTryCatchType;
+	error: UtilsTryCatchType;
+}

package/src/types/UtilsGMCookie.d.ts

@@ -0,0 +1,55 @@
+export interface UtilsGMCookieResult {
+	/** 为 window.location.hostname */
+	domain: string;
+	expirationDate: null;
+	hostOnly: true;
+	httpOnly: false;
+	name: string;
+	path: "/";
+	sameSite: "unspecified";
+	secure: true;
+	session: false;
+	value: string;
+}
+
+export interface UtilsGMCookieListOptions {
+	/** 默认为当前的url */
+	url: string;
+	/** 默认为当前的域名(window.location.hostname) */
+	domain: string;
+	/** 需要检索的Cookie的名字 */
+	name: string | RegExp;
+	/** 需要检索的Cookie的路径，默认为"/" */
+	path: string;
+}
+
+export interface UtilsGMCookieSetOptions {
+	/** 默认为当前的url */
+	url?: string;
+	/** 默认为当前的域名(window.location.hostname) */
+	domain?: string;
+	/** 需要检索的Cookie的名字 */
+	name?: string;
+	/** 需要检索的Cookie的路径，默认为"/" */
+	path?: string;
+	/** 值 */
+	value?: string | number;
+	/** 确保Cookie只在通过安全协议（如HTTPS）的情况下传输 */
+	secure?: boolean;
+	/** 是否防止JavaScript代码访问Cookie */
+	httpOnly?: boolean;
+	/**  Cookie过期时间，默认为30天 */
+	expirationDate?: number;
+}
+
+export interface UtilsGMCookieDeleteOptions {
+	/** 默认为当前的url */
+	url: string;
+	/** 需要检索的Cookie的名字 */
+	name: string;
+}
+
+export interface WindowApiOption {
+	window: Window & typeof globalThis;
+	document: Document;
+}

package/src/types/UtilsGMMenu.d.ts

@@ -0,0 +1,77 @@
+export interface UtilsGMMenuClickCallBackData {
+	/** 菜单键名 */
+	key: string;
+	/** 是否启用 */
+	enable: boolean;
+	/** 点击前的enable值 */
+	oldEnable: boolean;
+	/** 触发的事件 */
+	event: MouseEvent | KeyboardEvent;
+	/** 将enable值写入本地的回调，设置参数false就不保存到本地 */
+	storeValue(enable: boolean): void;
+}
+
+export interface UtilsGMMenuOption {
+	/** 菜单的本地键key，不可重复，会覆盖 */
+	key: string;
+	/** 菜单的文本 */
+	text: string;
+	/** （可选）菜单的开启状态，默认为false */
+	enable?: boolean;
+	/** （可选）使用条件：TamperMonkey版本>5.0，如果id和已注册的菜单id相同，可修改当前已注册菜单的options */
+	id?: number;
+	/** （可选）An optional access key. Please see the description below. Either options or accessKey can be specified. */
+	accessKey?: string;
+	/** （可选）自动关闭菜单，可不设置 */
+	autoClose?: boolean;
+	/** 使用条件：TamperMonkey版本>5.0，使用菜单项的鼠标悬浮上的工具提示*/
+	title?: string;
+	/** （可选）点击菜单后自动刷新网页，默认为true */
+	autoReload?: boolean;
+	/** 菜单的显示文本，未设置的话则自动根据enable在前面加上图标 */
+	showText(text: string, enable: boolean): string;
+	/** 点击菜单的回调 */
+	callback(data: UtilsGMMenuClickCallBackData): void;
+	/** 是否允许菜单进行存储值，默认true允许 */
+	isStoreValue?: boolean;
+}
+
+export interface UtilsGMMenuHandledOption extends UtilsGMMenuOption {
+	/**
+	 * 删除该菜单
+	 */
+	deleteMenu(): void;
+}
+
+export interface UtilsGMMenuOptionData {
+	/**
+	 * 菜单id
+	 */
+	id?: number;
+	/**
+	 * 菜单配置
+	 */
+	data: UtilsGMMenuOption;
+	/**
+	 * 处理后的菜单配置
+	 * 对autoReload进行处理，如果未赋值，按默认的true赋值
+	 * 对isStoreValue进行处理，如果未赋值，按默认的true赋值
+	 * 新增一个deleteMenu
+	 */
+	handleData: UtilsGMMenuHandledOption;
+}
+
+export interface UtilsGMMenuConstructorOptions {
+	/** （可选）配置*/
+	data?: UtilsGMMenuOption[];
+	/** （可选）全局菜单点击菜单后自动刷新网页，默认为true */
+	autoReload?: boolean;
+	/**  油猴函数 @grant GM_getValue */
+	GM_getValue: any;
+	/**  油猴函数 @grant GM_setValue */
+	GM_setValue: any;
+	/**  油猴函数 @grant GM_registerMenuCommand */
+	GM_registerMenuCommand: any;
+	/**  油猴函数 @grant GM_unregisterMenuCommand */
+	GM_unregisterMenuCommand: any;
+}

package/src/types/Vue2.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Vue2实例
+ */
+export declare interface Vue2Instance {
+	$attrs: any;
+	$children: Vue2Instance[];
+	$createElement: (...args: any[]) => any;
+	$el: HTMLElement;
+	$listeners: any;
+	$options: any;
+	$parent: Vue2Instance;
+	$refs: any;
+	$root: Vue2Instance;
+	$scopedSlots: any;
+	$slots: any;
+	$store: any;
+	$vnode: any;
+
+	_data: any;
+	_directInactive: boolean;
+	_events: any;
+	_hasHookEvent: boolean;
+	_isBeingDestroyed: boolean;
+	_isDestroyed: boolean;
+	_isMounted: boolean;
+	_isVue: boolean;
+
+	$data: any;
+	$isServer: boolean;
+	$props: any;
+	$route: {
+		fullPath: string;
+		hash: string;
+		matched: any[];
+		meta: any;
+		name: string;
+		params: any;
+		path: string;
+		query: any;
+		[key: string]: any;
+	};
+	$router: {
+		afterHooks: Function[];
+		app: Vue2Instance;
+		apps: Vue2Instance[];
+		beforeHooks: Function[];
+		fallback: boolean;
+		history: {
+			base: string;
+			current: Vue2Instance["$route"];
+			listeners: any[];
+			router: Vue2Instance["$router"];
+			/**
+			 *
+			 * @param delta 访问的距离。如果 delta < 0 则后退相应数量的记录，如果 > 0 则前进。
+			 * @param triggerListeners 是否应该触发连接到该历史的监听器
+			 */
+			go: (delta: number, triggerListeners?: boolean) => void;
+			/**
+			 *
+			 * @param to 要设置的地址
+			 * @param data 可选的 HistoryState 以关联该导航记录
+			 */
+			push: (to: string, data?: any) => void;
+			/**
+			 *
+			 * @param to 要设置的地址
+			 * @param data 可选的 HistoryState 以关联该导航记录
+			 */
+			replace: (to: string, data?: any) => void;
+			[key: string]: any;
+		};
+		matcher: {
+			addRoute: (...args: any[]) => any;
+			addRoutes: (...args: any[]) => any;
+			getRoutes: () => any;
+			match: (...args: any[]) => any;
+			[key: string]: any;
+		};
+		mode: string;
+		options: {
+			mode: string;
+			routes: any[];
+			scrollBehavior: (...args: any[]) => any;
+			[key: string]: any;
+		};
+		resolveHooks: ((...args: any[]) => any)[];
+		currentRoute: Vue2Instance["$route"];
+		beforeEach: (
+			callback:
+				| ((
+						/** 即将要进入的目标 路由对象 */
+						to: Vue2Instance["$route"],
+						/** 当前导航正要离开的路由 */
+						from: Vue2Instance["$route"],
+						/**
+						 *
+						 * + next(): 进行管道中的下一个钩子。如果全部钩子执行完了，则导航的状态就是 confirmed (确认的)。
+						 * + next(false): 中断当前的导航。如果浏览器的 URL 改变了 (可能是用户手动或者浏览器后退按钮)，那么 URL 地址会重置到 from 路由对应的地址。
+						 * + next('/') 或者 next({ path: '/' }): 跳转到一个不同的地址。当前的导航被中断，然后进行一个新的导航。你可以向 next 传递任意位置对象，且允许设置诸如 replace: true、name: 'home' 之类的选项以及任何用在 router-link 的 to prop 或 router.push 中的选项。
+						 * + next(error): (2.4.0+) 如果传入 next 的参数是一个 Error 实例，则导航会被终止且该错误会被传递给 router.onError() 注册过的回调。
+						 */
+						next: Function
+				  ) => void)
+				/** 移除上一个添加的监听 */
+				| (() => void)
+		) => void;
+
+		afterEach: (
+			callback:
+				| ((
+						/** 即将要进入的目标 路由对象 */
+						to: Vue2Instance["$route"],
+						/** 当前导航正要离开的路由 */
+						from: Vue2Instance["$route"]
+				  ) => void)
+				/** 移除上一个添加的监听 */
+				| (() => void)
+		) => void;
+		push: (...args: any[]) => void;
+		back: () => void;
+		go: (...args: any[]) => void;
+		replace: (...args: any[]) => void;
+		addRoute: (...args: any[]) => void;
+		addRoutes: (...args: any[]) => void;
+		[key: string]: any;
+	};
+	$ssrContext: any;
+
+	$watch: (
+		key: string | string[] | (() => any),
+		handler: (this: any, newVal: any, oldVal: any) => void,
+		options?: {
+			immediate?: boolean;
+			deep?: boolean;
+		}
+	) => void;
+
+	[key: string]: any;
+}
+
+/**
+ * 包含vue属性的HTMLElement
+ */
+export declare interface Vue2HTMLElement extends HTMLElement {
+	__vue__: Vue2Instance;
+}
+
+/**
+ * 包含vue属性的HTMLElement
+ */
+export declare interface Vue2HTMLDivElement extends HTMLDivElement {
+	__vue__: Vue2Instance;
+}

package/src/types/WindowApi.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 配置类型
+ */
+export type UtilsWindowApiOption = {
+	document: Document;
+	window: Window & typeof globalThis;
+	globalThis: typeof globalThis | Window;
+	self: Window & typeof globalThis;
+	top: Window;
+};

package/{dist/types/src/AjaxHookerType.d.ts → src/types/ajaxHooker.d.ts}

@@ -1,147 +1,155 @@
-import type { HttpxHeaders, HttpxMethod, HttpxStatus } from "./Httpx";
-/** 请求的response配置 */
-export declare interface UtilsAjaxHookResponseOptions {
-    /**
-     * （重定向后的）Url
-     */
-    finalUrl: string;
-    /**
-     * 响应码
-     */
-    status: HttpxStatus;
-    /**
-     * 响应头
-     */
-    responseHeaders: HttpxHeaders;
-    /**
-     * 响应内容
-     */
-    response?: string | Blob | ArrayBuffer | XMLDocument | FormData;
-    /**
-     * 响应内容文本
-     */
-    responseText?: string;
-}
-/** hook请求的配置 */
-export declare interface UtilsAjaxHookRequestOptions {
-    /**
-     * 只读属性。一个字符串，表明请求类型是xhr还是fetch
-     */
-    type: "xhr";
-    /**
-     * 请求的Url
-     */
-    url: string;
-    /**
-     * 请求的url和method，可以直接修改
-     */
-    method: HttpxMethod;
-    /**
-     * 是否取消请求，设置为true即可取消本次请求
-     */
-    abort: boolean;
-    /**
-     * 请求头，可以直接修改
-     */
-    headers: HttpxHeaders;
-    /**
-     * 请求携带的数据，可以直接修改
-     */
-    data?: any;
-    /**
-     * 响应内容，必须通过一个回调函数进行读取和修改。
-     *
-     * 响应内容为一个对象，包含finalUrl、status、responseHeaders和被读取的响应数据，除响应数据可修改，其他属性是只读的。
-     *
-     * 响应数据是哪个属性取决于哪个属性被读取，xhr可能的属性为response、responseText、responseXML，fetch可能的属性为arrayBuffer、blob、formData、json、text。
-     *
-     * 在控制台输出时，xhr响应将包含所有属性，但只有被读取过的属性具有明确的值。修改对应属性即可影响读取结果，进而实现响应数据的修改。
-     */
-    response?: (res: Required<UtilsAjaxHookResponseOptions>) => void;
-    /**
-     * 只读属性。异步请求为true，同步请求为false，异步特性无法作用于同步请求
-     */
-    async: boolean;
-}
-/** 过滤规则配置 */
-export declare interface UtilsAjaxHookFilterOptions {
-    /**
-     * 应是xhr或fetch
-     */
-    type?: "xhr" | "fetch";
-    /**
-     * 字符串或正则表达式，无需完全匹配
-     */
-    url?: string;
-    /**
-     * 请求方法
-     */
-    method?: HttpxMethod;
-    /**
-     * 是否异步
-     */
-    async?: boolean;
-}
-/** Utils.ajaxHooker */
-export declare interface UtilsAjaxHookResult {
-    /**
-     * 劫持
-     * @example
-        ajaxHooker.hook(request => {
-            if (request.url === 'https://www.example.com/') {
-                request.response = res => {
-                    console.log(res);
-                    res.responseText += 'test';
-                };
-            }
-        });
-      * @example
-        // 异步特性无法作用于同步请求，但同步修改仍然有效
-        // 你可以将以上所有可修改属性赋值为Promise，原请求将被阻塞直至Promise完成（若发生reject，数据将不会被修改）
-        // 此特性可用于异步劫持。以下是一个异步修改响应数据的例子
-        ajaxHooker.hook(request => {
-            request.response = res => {
-                const responseText = res.responseText; // 注意保存原数据
-                res.responseText = new Promise(resolve => {
-                    setTimeout(() => {
-                        resolve(responseText + 'test');
-                    }, 3000);
-                });
-            };
-        });
-
-        // 也可以传入async回调函数以实现异步
-        ajaxHooker.hook(async request => {
-            request.data = await modifyData(request.data);
-            request.response = async res => {
-                res.responseText = await modifyResponse(res.responseText);
-            };
-        });
-     */
-    hook(callback: (request: UtilsAjaxHookRequestOptions) => void | Promise<undefined>): void;
-    /**
-     * 过滤
-     * @example
-        // 应于hook方法之前执行，此方法若尽早执行，有助于提升性能。
-        // 为hook方法设置过滤规则，只有符合规则的请求才会触发hook。过滤规则是一个对象数组，参考下例
-        ajaxHooker.filter([
-            {type: 'xhr', url: 'www.example.com', method: 'GET', async: true},
-            {url: /^http/},
-        ]);
-     */
-    filter(filterOptions: UtilsAjaxHookFilterOptions[]): void;
-    /**
-     * 阻止xhr和fetch被改写
-     * @example
-        // 如果库劫持失败，可能是其他代码对xhr/fetch进行了二次劫持，protect方法会尝试阻止xhr和fetch被改写。应于document-start阶段尽早执行，部分网页下可能引发错误，谨慎使用。
-        ajaxHooker.protect();
-     */
-    protect(): void;
-    /**
-     * 取消劫持
-     * @example
-        // 将xhr和fetch恢复至劫持前的状态，调用此方法后，hook方法不再生效。
-        ajaxHooker.unhook();
-     */
-    unhook(): void;
-}
+import type { HttpxHeaders, HttpxMethod, HttpxStatus } from "./Httpx";
+
+/** 请求的response配置 */
+export declare interface UtilsAjaxHookResponseOptions {
+	/**
+	 * （重定向后的）Url
+	 */
+	finalUrl: string;
+	/**
+	 * 响应码
+	 */
+	status: HttpxStatus;
+	/**
+	 * 响应头
+	 */
+	responseHeaders: HttpxHeaders;
+	/**
+	 * 响应内容
+	 */
+	response?: string | Blob | ArrayBuffer | XMLDocument | FormData;
+	/**
+	 * 响应内容文本
+	 */
+	responseText?: string;
+}
+
+/** hook请求的配置 */
+export declare interface UtilsAjaxHookRequestOptions {
+	/**
+	 * 只读属性。一个字符串，表明请求类型是xhr还是fetch
+	 */
+	type: "xhr";
+	/**
+	 * 请求的Url
+	 */
+	url: string;
+	/**
+	 * 请求的url和method，可以直接修改
+	 */
+	method: HttpxMethod;
+	/**
+	 * 是否取消请求，设置为true即可取消本次请求
+	 */
+	abort: boolean;
+	/**
+	 * 请求头，可以直接修改
+	 */
+	headers: HttpxHeaders;
+	/**
+	 * 请求携带的数据，可以直接修改
+	 */
+	data?: any;
+	/**
+	 * 响应内容，必须通过一个回调函数进行读取和修改。
+	 *
+	 * 响应内容为一个对象，包含finalUrl、status、responseHeaders和被读取的响应数据，除响应数据可修改，其他属性是只读的。
+	 *
+	 * 响应数据是哪个属性取决于哪个属性被读取，xhr可能的属性为response、responseText、responseXML，fetch可能的属性为arrayBuffer、blob、formData、json、text。
+	 *
+	 * 在控制台输出时，xhr响应将包含所有属性，但只有被读取过的属性具有明确的值。修改对应属性即可影响读取结果，进而实现响应数据的修改。
+	 */
+	response?: (res: Required<UtilsAjaxHookResponseOptions>) => void;
+	/**
+	 * 只读属性。异步请求为true，同步请求为false，异步特性无法作用于同步请求
+	 */
+	async: boolean;
+}
+
+/** 过滤规则配置 */
+export declare interface UtilsAjaxHookFilterOptions {
+	/**
+	 * 应是xhr或fetch
+	 */
+	type?: "xhr" | "fetch";
+	/**
+	 * 字符串或正则表达式，无需完全匹配
+	 */
+	url?: string;
+	/**
+	 * 请求方法
+	 */
+	method?: HttpxMethod;
+	/**
+	 * 是否异步
+	 */
+	async?: boolean;
+}
+
+/** Utils.ajaxHooker */
+export declare interface UtilsAjaxHookResult {
+	/**
+     * 劫持
+     * @example
+        ajaxHooker.hook(request => {
+            if (request.url === 'https://www.example.com/') {
+                request.response = res => {
+                    console.log(res);
+                    res.responseText += 'test';
+                };
+            }
+        });
+      * @example
+        // 异步特性无法作用于同步请求，但同步修改仍然有效
+        // 你可以将以上所有可修改属性赋值为Promise，原请求将被阻塞直至Promise完成（若发生reject，数据将不会被修改）
+        // 此特性可用于异步劫持。以下是一个异步修改响应数据的例子
+        ajaxHooker.hook(request => {
+            request.response = res => {
+                const responseText = res.responseText; // 注意保存原数据
+                res.responseText = new Promise(resolve => {
+                    setTimeout(() => {
+                        resolve(responseText + 'test');
+                    }, 3000);
+                });
+            };
+        });
+
+        // 也可以传入async回调函数以实现异步
+        ajaxHooker.hook(async request => {
+            request.data = await modifyData(request.data);
+            request.response = async res => {
+                res.responseText = await modifyResponse(res.responseText);
+            };
+        });
+     */
+	hook(
+		callback: (
+			request: UtilsAjaxHookRequestOptions
+		) => void | Promise<undefined>
+	): void;
+	/**
+     * 过滤
+     * @example
+        // 应于hook方法之前执行，此方法若尽早执行，有助于提升性能。
+        // 为hook方法设置过滤规则，只有符合规则的请求才会触发hook。过滤规则是一个对象数组，参考下例
+        ajaxHooker.filter([
+            {type: 'xhr', url: 'www.example.com', method: 'GET', async: true},
+            {url: /^http/},
+        ]);
+     */
+	filter(filterOptions: UtilsAjaxHookFilterOptions[]): void;
+	/**
+     * 阻止xhr和fetch被改写
+     * @example
+        // 如果库劫持失败，可能是其他代码对xhr/fetch进行了二次劫持，protect方法会尝试阻止xhr和fetch被改写。应于document-start阶段尽早执行，部分网页下可能引发错误，谨慎使用。
+        ajaxHooker.protect();
+     */
+	protect(): void;
+	/**
+     * 取消劫持
+     * @example
+        // 将xhr和fetch恢复至劫持前的状态，调用此方法后，hook方法不再生效。
+        ajaxHooker.unhook();
+     */
+	unhook(): void;
+}