@whitesev/utils 2.3.8 → 2.4.0

package/dist/types/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/dist/types/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/dist/types/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/dist/types/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/dist/types/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/VueObject.ts → dist/types/src/types/Vue2.d.ts}

@@ -1,13 +1,16 @@
-export declare interface Vue2Object {
+/**
+ * Vue2实例
+ */
+export declare interface Vue2Instance {
 	$attrs: any;
-	$children: Vue2Object[];
+	$children: Vue2Instance[];
 	$createElement: (...args: any[]) => any;
 	$el: HTMLElement;
 	$listeners: any;
 	$options: any;
-	$parent: Vue2Object;
+	$parent: Vue2Instance;
 	$refs: any;
-	$root: Vue2Object;
+	$root: Vue2Instance;
 	$scopedSlots: any;
 	$slots: any;
 	$store: any;
@@ -38,15 +41,15 @@ export declare interface Vue2Object {
 	};
 	$router: {
 		afterHooks: Function[];
-		app: Vue2Object;
-		apps: Vue2Object[];
+		app: Vue2Instance;
+		apps: Vue2Instance[];
 		beforeHooks: Function[];
 		fallback: boolean;
 		history: {
 			base: string;
-			current: Vue2Object["$route"];
+			current: Vue2Instance["$route"];
 			listeners: any[];
-			router: Vue2Object["$router"];
+			router: Vue2Instance["$router"];
 			/**
 			 *
 			 * @param delta 访问的距离。如果 delta < 0 则后退相应数量的记录，如果 > 0 则前进。
@@ -82,14 +85,14 @@ export declare interface Vue2Object {
 			[key: string]: any;
 		};
 		resolveHooks: ((...args: any[]) => any)[];
-		currentRoute: Vue2Object["$route"];
+		currentRoute: Vue2Instance["$route"];
 		beforeEach: (
 			callback:
 				| ((
 						/** 即将要进入的目标 路由对象 */
-						to: Vue2Object["$route"],
+						to: Vue2Instance["$route"],
 						/** 当前导航正要离开的路由 */
-						from: Vue2Object["$route"],
+						from: Vue2Instance["$route"],
 						/**
 						 *
 						 * + next(): 进行管道中的下一个钩子。如果全部钩子执行完了，则导航的状态就是 confirmed (确认的)。
@@ -107,9 +110,9 @@ export declare interface Vue2Object {
 			callback:
 				| ((
 						/** 即将要进入的目标 路由对象 */
-						to: Vue2Object["$route"],
+						to: Vue2Instance["$route"],
 						/** 当前导航正要离开的路由 */
-						from: Vue2Object["$route"]
+						from: Vue2Instance["$route"]
 				  ) => void)
 				/** 移除上一个添加的监听 */
 				| (() => void)
@@ -136,6 +139,16 @@ export declare interface Vue2Object {
 	[key: string]: any;
 }
 
-export declare interface HTMLVue2DivElement extends HTMLDivElement {
-	__vue__: Vue2Object;
+/**
+ * 包含vue属性的HTMLElement
+ */
+export declare interface Vue2HTMLElement extends HTMLElement {
+	__vue__: Vue2Instance;
+}
+
+/**
+ * 包含vue属性的HTMLElement
+ */
+export declare interface Vue2HTMLDivElement extends HTMLDivElement {
+	__vue__: Vue2Instance;
 }

package/dist/types/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/types/global.d.ts

@@ -1 +1,24 @@
-declare var GM_xmlhttpRequest: any;
+export type JSTypeMap = {
+	string: string;
+	number: number;
+	boolean: boolean;
+	object: object;
+	symbol: symbol;
+	bigint: bigint;
+	undefined: undefined;
+	null: null;
+};
+
+export type JSTypeNames = keyof JSTypeMap;
+
+export type ArgsType<T extends JSTypeNames[]> = {
+	[I in keyof T]: JSTypeMap[T[I]];
+};
+
+export declare interface UtilsOwnObject<V extends any> {
+	[key: string]: V | UtilsOwnObject<V>;
+}
+export declare interface AnyObject {
+	[key: string]: any | AnyObject;
+	toString(): string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@whitesev/utils",
-  "version": "2.3.8",
+  "version": "2.4.0",
   "description": "一个常用的工具库",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",

package/src/GBKEncoder.ts

@@ -1,4 +1,4 @@
-import { UtilsOwnObject } from "./Utils";
+import type { UtilsOwnObject } from "./types/global";
 
 class GBKEncoder {
 	#data: RegExpMatchArray = [] as any;