@whitesev/utils 1.0.0

package/src/types/Indexdb.d.ts

@@ -0,0 +1,128 @@
+/** indexedDB */
+declare interface UtilsIndexedDBConstructor {
+	dbName: string;
+	slqVersion: string;
+	dbVersion: number;
+	storeName: string;
+	indexedDB: IDBFactory;
+	db: UtilsNestedObjectWithToString;
+	store: null;
+	errorCode: UtilsNestedObjectWithToString;
+	/**
+	 * 创建 “表”
+	 * @param dbName 表名
+	 */
+	createStore(dbName: string): any;
+	/**
+	 * 打开数据库
+	 * @param callback 回调
+	 * @param dbName 数据库名
+	 */
+	open(
+		callback: (
+			store:
+				| UtilsNestedObjectWithToString
+				| {
+						code: number;
+						msg: string;
+						error: Error;
+				  }
+		) => void,
+		dbName: string
+	): void;
+	/**
+	 * 保存数据到数据库
+	 * @param key 数据key
+	 * @param value 数据值
+	 */
+	save(
+		key: string,
+		value: any
+	): Promise<{
+		code: number;
+		msg: string;
+		success: boolean;
+	}>;
+	/**
+	 * 根据key获取值
+	 * @param key 数据key
+	 */
+	get(key: string): Promise<
+		| {
+				code: number;
+				msg: string;
+				data: any[];
+				success: true;
+		  }
+		| {
+				code: number;
+				msg: string;
+				error: Error;
+				result: any;
+		  }
+	>;
+	/**
+	 * 正则获取数据
+	 * @param key 数据键
+	 */
+	regexpGet(key: string): Promise<
+		| {
+				code: number;
+				msg: string;
+				data: any[];
+				success: true;
+		  }
+		| {
+				code: number;
+				msg: string;
+				error: Error;
+				result: any;
+		  }
+	>;
+	/**
+	 * 删除数据
+	 * @param key 数据键
+	 */
+	delete(key: string): Promise<
+		| {
+				code: number;
+				msg: string;
+				success: true;
+		  }
+		| {
+				code: number;
+				msg: string;
+				error: Error;
+		  }
+	>;
+	/**
+	 * 删除所有数据
+	 */
+	deleteAll(): Promise<
+		| {
+				code: number;
+				msg: string;
+				error: Error;
+				result: any;
+		  }
+		| {
+				code: number;
+				msg: string;
+				success: true;
+		  }
+	>;
+}
+
+/** indexedDB */
+declare interface UtilsIndexedDB {
+	/**
+	 * @param dbName 数据存储名，默认为：default_db
+	 * @param storeName 表名，默认为：default_form
+	 * @param dbVersion indexDB的版本号，默认为：1
+	 */
+	new (
+		dbName?: string,
+		storeName?: string,
+		dbVersion?: number
+	): UtilsIndexedDBConstructor;
+}

package/src/types/LockFunction.d.ts

@@ -0,0 +1,47 @@
+/** Utils.LockFunction */
+declare interface UtilsLockFunction {
+	/**
+	 * @param callback 需要执行的函数
+	 * @param delayTime （可选）延迟xx毫秒后解锁，默认：0
+	 */
+	new <K extends (...args: any[]) => any | Promise<any> | void>(
+		callback: K,
+		delayTime?: number
+	): {
+		/**
+		 * 上锁
+		 */
+		lock: () => void;
+		/**
+		 * 解锁
+		 */
+		unlock: () => void;
+		/**
+		 * 执行函数
+		 */
+		run: () => ReturnType<K>;
+	};
+	/**
+	 * @param callback 需要执行的函数
+	 * @param context （可选）函数作用域，默认：this(Utils)
+	 * @param delayTime （可选）延迟xx毫秒后解锁，默认：0
+	 */
+	new <K extends (...args: any[]) => any | Promise<any>>(
+		callback: K,
+		context?: UtilsNestedObjectWithToString,
+		delayTime?: number
+	): {
+		/**
+		 * 上锁
+		 */
+		lock: () => void;
+		/**
+		 * 解锁
+		 */
+		unlock: () => void;
+		/**
+		 * 执行函数
+		 */
+		run: () => ReturnType<K>;
+	};
+}

package/src/types/Log.d.ts

@@ -0,0 +1,91 @@
+/** Utils.Log的初始化配置 */
+declare interface UtilsLogOptions {
+	/** 是否输出Tag，false的话其它的颜色也不输出，默认为true */
+	tag?: boolean;
+	/** log.success的颜色，默认#0000FF */
+	successColor?: string;
+	/** log.warn的颜色，默认0 */
+	warnColor?: string;
+	/** log.error的颜色，默认#FF0000 */
+	errorColor?: string;
+	/** log.info的颜色，默认0 */
+	infoColor?: string;
+	/** 是否开启debug模式，true会在控制台每次调用时输出调用函数的所在位置，false不会输出位置，默认false */
+	debug?: boolean;
+	/** 当console输出超过logMaxCount数量自动清理控制台，默认false */
+	autoClearConsole?: boolean;
+	/** console输出的最高数量，autoClearConsole开启则生效，默认999 */
+	logMaxCount?: number;
+}
+
+/** Utils.Log */
+declare interface UtilsLogConstructor {
+	/** 前面的TAG标志 */
+	tag: string;
+	/**
+	 * 控制台-普通输出
+	 * @param msg 需要输出的内容，如果想输出多个，修改成数组，且数组内的长度最大值为4个
+	 * @param color 输出的颜色
+	 * @param otherStyle 其它CSS
+	 */
+	info(msg: any, color?: string, otherStyle?: string): void;
+	/**
+	 * 控制台-警告输出
+	 * @param msg 需要输出的内容，如果想输出多个，修改成数组，且数组内的长度最大值为4个
+	 * @param color 输出的颜色
+	 * @param otherStyle 其它CSS
+	 */
+	warn(msg: any, color?: string, otherStyle?: string): void;
+	/**
+	 * 控制台-错误输出
+	 * @param msg 需要输出的内容，如果想输出多个，修改成数组，且数组内的长度最大值为4个
+	 * @param color 输出的颜色
+	 * @param otherStyle 其它CSS
+	 */
+	error(msg: any, color?: string, otherStyle?: string): void;
+	/**
+	 * 控制台-成功输出
+	 * @param msg 需要输出的内容，如果想输出多个，修改成数组，且数组内的长度最大值为4个
+	 * @param color 输出的颜色
+	 * @param otherStyle 其它CSS
+	 */
+	success(msg: any, color?: string, otherStyle?: string): void;
+	/**
+	 * 控制台-输出表格
+	 * @param msg
+	 * @param color 输出的颜色
+	 * @param otherStyle 其它CSS
+	 * @example
+	 * log.table([{"名字":"example","值":"123"},{"名字":"example2","值":"345"}])
+	 */
+	table(
+		msg: UtilsNestedObjectWithToString[],
+		color?: string,
+		otherStyle?: string
+	): void;
+	/**
+	 * 配置Log对象的颜色
+	 * @param paramDetails 配置信息
+	 */
+	config(paramDetails: UtilsLogOptions): void;
+	/** 禁用输出 */
+	disable(): void;
+	/** 恢复输出 */
+	recovery(): void;
+}
+
+/** Utils.Log */
+declare interface UtilsLog {
+	/**
+	 * @param _GM_info_ 油猴管理器的API GM_info，或者是一个对象，如{"script":{name:"Utils.Log"}}
+	 * @param console 可指定console对象为unsafeWindow下的console或者是油猴window下的console
+	 */
+	new (
+		_GM_info_: {
+			script: {
+				name: string;
+			};
+		},
+		console: Console
+	): UtilsLogConstructor;
+}

package/src/types/Progress.d.ts

@@ -0,0 +1,30 @@
+/** Progress */
+declare interface UtilsProgressConstructor {}
+/** Progress */
+declare interface UtilsProgress {
+	/**
+	 * @param paramConfig 配置信息
+	 */
+	new (paramConfig: {
+		/** canvas元素节点 */
+		canvasNode?: HTMLCanvasElement;
+		/** 绘制角度，默认：95 */
+		deg: number;
+		/** 进度，默认：0 */
+		progress: number;
+		/** 绘制的线宽度，默认：10 */
+		lineWidth: number;
+		/** 绘制的背景颜色，默认：#1e637c */
+		lineBgColor: string;
+		/** 绘制的线的颜色，默认：#25deff */
+		lineColor: string;
+		/** 绘制的字体颜色，默认：#000000 */
+		textColor: string;
+		/** 绘制的字体大小(px)，默认：22px */
+		fontSize: string;
+		/** 绘制的圆的半径，默认：50 */
+		circleRadius: string;
+		/** 控制绘制的函数 */
+		draw?: () => void;
+	}): UtilsProgressConstructor;
+}

package/src/types/TryCatch.d.ts

@@ -0,0 +1,6 @@
+/** tryCatch */
+declare interface UtilsTryCatch {
+	run: UtilsTryCatch;
+	config: UtilsTryCatch;
+	error: UtilsTryCatch;
+}

package/src/types/UtilsCore.d.ts

@@ -0,0 +1,7 @@
+declare interface UtilsCoreOption {
+	document: Document;
+	window: Window;
+	globalThis: typeof globalThis;
+	self: typeof globalThis;
+	top: Window;
+}

package/src/types/UtilsGMMenu.d.ts

@@ -0,0 +1,224 @@
+/**
+ * 保存值到本地存储
+ *
+ * 可以使用Promise实际等待值的设置完成
+ */
+declare function GM_setValue(
+	name: string,
+	value: any
+): Promise<undefined> | undefined;
+
+/**
+ * 获取本地存储的值
+ */
+declare function GM_getValue<T extends any>(name: string, defaultValue?: T): T;
+
+/**
+ * 注册功能到油猴菜单中
+ */
+declare function GM_registerMenuCommand(
+	name: string,
+	listener: (event: PointerEvent | MouseEvent) => void,
+	accessKey?: string
+): number;
+/**
+ * 从替换菜单中卸载某个菜单
+ */
+declare function GM_unregisterMenuCommand(id: number): void;
+
+declare interface UtilsGMMenuClickCallBackData {
+	/** 菜单键名 */
+	key: string;
+	/** 是否启用 */
+	enable: boolean;
+	/** 点击前的enable值 */
+	oldEnable: boolean;
+	/** 触发的事件 */
+	event: MouseEvent | KeyboardEvent;
+	/** 将enable值写入本地的回调，设置参数false就不保存到本地 */
+	storeValue(enable: boolean): void;
+}
+
+declare 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;
+}
+
+declare interface UtilsGMMenuHandledOption extends UtilsGMMenuOption {
+	/**
+	 * 删除该菜单
+	 */
+	deleteMenu(): void;
+}
+
+declare interface UtilsGMMenuOptionData {
+	/**
+	 * 菜单id
+	 */
+	id: number;
+	/**
+	 * 菜单配置
+	 */
+	data: UtilsGMMenuOption;
+	/**
+	 * 处理后的菜单配置
+	 * 对autoReload进行处理，如果未赋值，按默认的true赋值
+	 * 对isStoreValue进行处理，如果未赋值，按默认的true赋值
+	 * 新增一个deleteMenu
+	 */
+	handleData: UtilsGMMenuHandledOption;
+}
+
+declare interface UtilsGMMenuConstructorOptions {
+	/** （可选）配置*/
+	data?: UtilsGMMenuOption[];
+	/** （可选）全局菜单点击菜单后自动刷新网页，默认为true */
+	autoReload?: boolean;
+	/**  油猴函数 @grant GM_getValue */
+	GM_getValue: Function;
+	/**  油猴函数 @grant GM_setValue */
+	GM_setValue: Function;
+	/**  油猴函数 @grant GM_registerMenuCommand */
+	GM_registerMenuCommand: Function;
+	/**  油猴函数 @grant GM_unregisterMenuCommand */
+	GM_unregisterMenuCommand: Function;
+}
+
+/** GM_Menu */
+declare interface UtilsGMMenuConstructor {
+	/**
+	 * 根据键值获取enable值
+	 * @param menuKey 菜单-键key
+	 **/
+	get(menuKey: string): boolean;
+	/**
+	 * 根据键值获取enable值
+	 * @param menuKey 菜单-键key
+	 **/
+	getEnable(menuKey: string): boolean;
+	/**
+	 * 根据键值获取text值
+	 * @param menuKey 菜单-键key
+	 **/
+	getText(menuKey: string): string;
+	/**
+	 * 根据键值获取showText函数的值
+	 * @param menuKey 菜单-键key
+	 **/
+	getShowTextValue(menuKey: string): string;
+	/**
+	 * 获取当前已注册菜单的id
+	 * @param menuKey 菜单-键key
+	 */
+	getMenuId(menuKey: string): number | undefined;
+	/**
+	 * 根据键值获取accessKey值
+	 * @param menuKey 菜单-键key
+	 */
+	getAccessKey(menuKey: string): string | undefined;
+	/**
+	 * 根据键值获取autoClose值
+	 * @param menuKey 菜单-键key
+	 */
+	getAutoClose(menuKey: string): boolean | undefined;
+	/**
+	 * 根据键值获取autoReload值
+	 * @param menuKey 菜单-键key
+	 */
+	getAutoReload(menuKey: string): boolean;
+	/**
+	 * 根据键值获取callback函数
+	 * @param menuKey 菜单-键key
+	 */
+	getCallBack(menuKey: string): () => void | undefined;
+	/**
+	 * 获取当enable为true时默认显示在菜单中前面的emoji图标
+	 */
+	getEnableTrueEmoji(): string;
+	/**
+	 * 获取当enable为false时默认显示在菜单中前面的emoji图标
+	 */
+	getEnableFalseEmoji(): string;
+	/**
+	 * 获取本地存储的菜单外部的键名
+	 * @param keyName
+	 */
+	getLocalStorageKeyName(keyName: string): string;
+	/**
+	 * 设置菜单的值
+	 * @param menuKey 菜单-键key
+	 * @param value 需要设置的值
+	 */
+	setValue(menuKey: string, value: any): void;
+	/**
+	 * 设置菜单的值
+	 * @param menuKey 菜单-键key
+	 * @param value 需要设置的值
+	 */
+	setEnable(menuKey: string, value: boolean): void;
+	/**
+	 * 设置当enable为true时默认显示在菜单中前面的emoji图标
+	 * @param emojiString
+	 */
+	setEnableTrueEmoji(emojiString: string): void;
+	/**
+	 * 设置当enable为false时默认显示在菜单中前面的emoji图标
+	 * @param emojiString
+	 */
+	setEnableFalseEmoji(emojiString: string): void;
+	/**
+	 * 设置本地存储的菜单外部的键名
+	 * @param keyName
+	 */
+	setLocalStorageKeyName(keyName: string): void;
+	/**
+	 * 新增菜单数据
+	 * @param paramData
+	 */
+	add(paramData: UtilsGMMenuOption[] | UtilsGMMenuOption): void;
+	/**
+	 * 更新菜单数据
+	 * 方式：先卸载全部的菜单，再重新注册菜单
+	 * @param options 数据
+	 */
+	update(options?: UtilsGMMenuOption[] | UtilsGMMenuOption): Promise<void>;
+	/**
+	 * 根据已注册菜单的id，来更新菜单配置，不会卸载菜单导致可能菜单选项可能会变化的情况
+	 * @param options 配置
+	 * @deprecated
+	 */
+	updateOptionsWithId?(options?: UtilsGMMenuOption[] | UtilsGMMenuOption): void;
+	/**
+	 * 卸载菜单
+	 * @param menuId 已注册的菜单id
+	 */
+	delete(menuId: number): void;
+}
+
+/** GM_Menu */
+declare interface UtilsGMMenu {
+	/**
+	 * @param details 传递的菜单配置
+	 */
+	new (details: UtilsGMMenuConstructorOptions): UtilsGMMenuConstructor;
+}

package/src/types/global.d.ts

@@ -0,0 +1,58 @@
+declare var unsafeWindow: Window & typeof globalThis;
+
+type JSTypeMap = {
+	string: string;
+	number: number;
+	boolean: boolean;
+	object: object;
+	symbol: symbol;
+	bigint: bigint;
+	undefined: undefined;
+	null: null;
+};
+
+type JSTypeNames = keyof JSTypeMap;
+
+type ArgsType<T extends JSTypeNames[]> = {
+	[I in keyof T]: JSTypeMap[T[I]];
+};
+
+/**
+ * 空对象
+ *
+ * 类似
+ * {
+ *  "xxx": string,
+ * }
+ */
+declare interface UtilsNestedObjectWithToString<V extends any> {
+	[key: string]: V | NestedObjectWithToString<V>;
+	toString(): string;
+}
+declare interface AnyObject {
+	[key: string]: any | AnyObject;
+	toString(): string;
+}
+
+declare interface Vue2Context extends AnyObject {
+	_isVue: true;
+	$options: UtilsNestedObjectWithToString;
+	$parent: Vue2Context;
+	$root: Vue2Context;
+	$children: Vue2Context[];
+	$vnode: UtilsNestedObjectWithToString;
+	$slots: UtilsNestedObjectWithToString;
+	$scopedSlots: UtilsNestedObjectWithToString;
+	$attrs: UtilsNestedObjectWithToString;
+	$listeners: UtilsNestedObjectWithToString;
+	$store: UtilsNestedObjectWithToString;
+	$watch: (
+		key: string | string[],
+		handler: (this: any, newVal: any, oldVal: any) => void,
+		options?: {
+			immediate?: boolean;
+			deep?: boolean;
+		}
+	) => void;
+	$el: Element;
+}

package/tsconfig.json

@@ -0,0 +1,32 @@
+{
+	"compilerOptions": {
+		// es最新版
+		"target": "ESNext",
+		// 运行环境: es6、浏览器
+		"lib": ["ESNext", "DOM"],
+		"allowJs": true,
+		"checkJs": false,
+		"allowSyntheticDefaultImports": true,
+		"module": "ESNext",
+		"moduleResolution": "Node",
+		//"module": "AMD",
+		//"moduleResolution": "Bundler",
+		//"resolveJsonModule": true,
+		// 启用严格模式
+		"strict": true,
+		"strictNullChecks": true,
+		"esModuleInterop": true,
+		// 跳过默认库检查
+		"skipDefaultLibCheck": true,
+		// 跳过库检查
+		"skipLibCheck": true,
+		// 输出目录
+		"outDir": "./dist",
+		// 输出.d.ts声明文件
+		"declaration": true,
+		"sourceMap": true,
+		"typeRoots": ["./src/types"]
+	},
+	// 包含src下的所有文件
+	"include": ["src/**/*", "index.ts"]
+}