@whitesev/utils 1.0.4 → 1.0.6

package/dist/src/LockFunction.d.ts

@@ -0,0 +1,31 @@
+declare class LockFunction<K extends (...args: any[]) => any | Promise<any> | void> {
+    #private;
+    /**
+     * @param callback 需要执行的函数
+     * @param delayTime （可选）延迟xx毫秒后解锁，默认：0
+     */
+    constructor(callback: K, delayTime?: number);
+    /**
+     * @param callback 需要执行的函数
+     * @param context （可选）函数作用域，默认：this(Utils)
+     * @param delayTime （可选）延迟xx毫秒后解锁，默认：0
+     */
+    constructor(callback: K, context?: any, delayTime?: number);
+    /**
+     * 判断是否被锁
+     */
+    isLock(): boolean;
+    /**
+     * 锁
+     */
+    lock(): void;
+    /**
+     * 解锁
+     */
+    unlock(): void;
+    /**
+     * 执行
+     */
+    run(...args: any[]): Promise<void>;
+}
+export { LockFunction };

package/dist/src/Log.d.ts

@@ -0,0 +1,96 @@
+import type { AnyObject } from ".";
+/** 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;
+}
+declare class Log {
+    #private;
+    tag: string;
+    /**
+     * @param _GM_info_ 油猴管理器的API GM_info，或者是一个对象，如{"script":{name:"Utils.Log"}}
+     * @param console 可指定console对象为unsafeWindow下的console或者是油猴window下的console
+     */
+    constructor(_GM_info_?: {
+        script: {
+            name: string;
+        };
+    }, console?: Console);
+    /**
+     * 解析Error的堆栈获取实际调用者的函数名及函数所在的位置
+     * @param stack
+     */
+    private parseErrorStack;
+    /**
+     * 检测清理控制台
+     */
+    private checkClearConsole;
+    /**
+     * 输出内容
+     * @param msg 需要输出的内容
+     * @param color 颜色
+     * @param otherStyle 其它CSS
+     */
+    private printContent;
+    /**
+     * 控制台-普通输出
+     * @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: AnyObject[], color?: string, otherStyle?: string): void;
+    /**
+     * 配置Log对象的颜色
+     * @param paramDetails 配置信息
+     */
+    config(paramDetails: Partial<UtilsLogOptions>): void;
+    /** 禁用输出 */
+    disable(): void;
+    /** 恢复输出 */
+    recovery(): void;
+}
+export { Log };

package/dist/src/Progress.d.ts

@@ -0,0 +1,37 @@
+declare 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;
+}
+declare class Progress {
+    #private;
+    /**
+     *
+     * @param paramConfig 配置信息
+     */
+    constructor(paramConfig: ProgressParamConfig);
+    /**
+     * 初始化
+     */
+    private init;
+    /**
+     * 绘制
+     */
+    draw(): void;
+}
+export { Progress };

package/dist/src/UtilsGMMenu.d.ts

@@ -0,0 +1,156 @@
+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 UtilsGMMenuConstructorOptions {
+    /** （可选）配置*/
+    data?: UtilsGMMenuOption[];
+    /** （可选）全局菜单点击菜单后自动刷新网页，默认为true */
+    autoReload?: boolean;
+    /**  油猴函数 @grant GM_getValue */
+    GM_getValue<T extends any>(name: string, defaultValue?: T): T;
+    /**  油猴函数 @grant GM_setValue */
+    GM_setValue(name: string, value: any): Promise<undefined> | undefined;
+    /**  油猴函数 @grant GM_registerMenuCommand */
+    GM_registerMenuCommand(name: string, listener: (event: PointerEvent | MouseEvent) => void, accessKey?: string): number;
+    /**  油猴函数 @grant GM_unregisterMenuCommand */
+    GM_unregisterMenuCommand(id: number): void;
+}
+declare class GMMenu {
+    private GM_Api;
+    private MenuHandle;
+    constructor(details: UtilsGMMenuConstructorOptions);
+    /**
+     * 新增菜单数据
+     * @param paramData
+     */
+    add(paramData: UtilsGMMenuOption[] | UtilsGMMenuOption): void;
+    /**
+     * 更新菜单数据
+     * @param options 数据
+     */
+    update(options?: UtilsGMMenuOption[] | UtilsGMMenuOption): void;
+    /**
+     * 卸载菜单
+     * @param menuId 已注册的菜单id
+     */
+    delete(menuId: number): void;
+    /**
+     * 根据键值获取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
+     */
+    getMenuId(menuKey: string): number | undefined | null;
+    /**
+     * 根据键值获取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 | undefined;
+    /**
+     * 根据键值获取callback函数
+     * @param menuKey 菜单-键key
+     */
+    getCallBack(menuKey: string): Function | undefined;
+    /**
+     * 获取当enable为true时默认显示在菜单中前面的emoji图标
+     */
+    getEnableTrueEmoji(): string;
+    /**
+     * 获取当enable为false时默认显示在菜单中前面的emoji图标
+     */
+    getEnableFalseEmoji(): string;
+    /**
+     * 获取本地存储的菜单外部的键名
+     * @param keyName
+     */
+    getLocalStorageKeyName(): 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;
+}
+export { GMMenu };

package/dist/src/index.d.ts

@@ -1,16 +1,15 @@
 /// <reference path="../../src/ajaxHooker/index.d.ts" />
-/// <reference path="../../src/Dictionary/index.d.ts" />
-/// <reference path="../../src/Hooks/index.d.ts" />
-/// <reference path="../../src/Httpx/index.d.ts" />
-/// <reference path="../../src/indexedDB/index.d.ts" />
-/// <reference path="../../src/LockFunction/index.d.ts" />
-/// <reference path="../../src/Log/index.d.ts" />
-/// <reference path="../../src/Progress/index.d.ts" />
-/// <reference path="../../src/tryCatch/index.d.ts" />
-/// <reference path="../../src/UtilsGMMenu/index.d.ts" />
 import { ColorConversion } from "./ColorConversion";
 import { GBKEncoder } from "./GBKEncoder";
 import { UtilsGMCookie } from "./UtilsGMCookie";
+import { GMMenu } from "./UtilsGMMenu";
+import { Hooks } from "./Hooks";
+import { Httpx } from "./Httpx";
+import { indexedDB } from "./indexedDB";
+import { LockFunction } from "./LockFunction";
+import { Log } from "./Log";
+import { Progress } from "./Progress";
+import { UtilsDictionary } from "./Dictionary";
 export declare var unsafeWindow: Window & typeof globalThis;
 export type JSTypeMap = {
     string: string;
@@ -339,9 +338,7 @@ declare class Utils {
      * > true
      * dictionary.concat(dictionary2);
      **/
-    Dictionary: {
-        new <K, V>(): UtilsDictionaryConstructor<K, V>;
-    };
+    Dictionary: typeof UtilsDictionary;
     /**
      * 主动触发事件
      * @param element 元素
@@ -832,7 +829,7 @@ declare class Utils {
       // 删除键为menu_key的菜单
       GM_Menu.delete("menu_key");
      **/
-    GM_Menu: UtilsGMMenu;
+    GM_Menu: typeof GMMenu;
     /**
      * 基于Function prototype，能够勾住和释放任何函数
      *
@@ -857,7 +854,7 @@ declare class Utils {
       }
       testFunction.hook(testFunction,myFunction,window);
      **/
-    Hooks: UtilsHooks;
+    Hooks: typeof Hooks;
     /**
      * 为减少代码量和回调，把GM_xmlhttpRequest封装
      * 文档地址: https://www.tampermonkey.net/documentation.php?ext=iikm
@@ -896,7 +893,7 @@ declare class Utils {
       })
       // 优先级为 默认details < 全局details < 单独的details
      */
-    Httpx: UtilsHttpx;
+    Httpx: typeof Httpx;
     /**
      * 浏览器端的indexedDB操作封装
      * @example
@@ -922,7 +919,7 @@ declare class Utils {
           console.log(resolve,'清除数据库---->>>>>>name')
       })
      **/
-    indexedDB: UtilsIndexedDB;
+    indexedDB: typeof indexedDB;
     /**
      * 判断目标函数是否是Native Code
      * @param target
@@ -1164,7 +1161,7 @@ declare class Utils {
       await lock.run();
       > 1
      **/
-    LockFunction: UtilsLockFunction;
+    LockFunction: typeof LockFunction;
     /**
      * 日志对象
      * @param _GM_info_ 油猴管理器的API GM_info，或者是一个对象，如{"script":{name:"Utils.Log"}}
@@ -1194,7 +1191,7 @@ declare class Utils {
       log.success("颜色为#31dc02");
       > 颜色为#31dc02
      */
-    Log: UtilsLog;
+    Log: typeof Log;
     /**
      * 合并数组内的JSON的值字符串
      * @param data 需要合并的数组
@@ -1386,7 +1383,7 @@ declare class Utils {
       let progress = new Utils.Process({canvasNode:document.querySelector("canvas")});
       progress.draw();
      * **/
-    Progress: UtilsProgress;
+    Progress: typeof Progress;
     /**
      * 劫持Event的isTrust为true，注入时刻，ducument-start
      * @param isTrustValue （可选）让isTrusted为true
@@ -1539,7 +1536,6 @@ declare class Utils {
     toSearchParamsStr(obj: object | object[]): string;
     /**
      * 提供一个封装了 try-catch 的函数，可以执行传入的函数并捕获其可能抛出的错误，并通过传入的错误处理函数进行处理。
-     * @returns 返回一个对象，其中包含 error 和 run 两个方法。
      * @example
      * Utils.tryCatch().error().run(()=>{console.log(1)});
      * > 1
@@ -1547,13 +1543,10 @@ declare class Utils {
      * Utils.tryCatch().config({log:true}).error((error)=>{console.log(error)}).run(()=>{throw new Error('测试错误')});
      * > ()=>{throw new Error('测试错误')}出现错误
      */
-    tryCatch: (...args: any[]) => {
-        (): void;
-        config(paramDetails: {
-            log: boolean;
-        }): any;
-        error(handler: string | Function): any;
-        run(callback: string | Function, __context__?: object | null | undefined): any;
+    tryCatch: (...args: any) => {
+        config(paramDetails: import("./tryCatch").UtilsTryCatchConfig): any;
+        error(handler: string | Function | ((...args: any[]) => any)): any;
+        run<A extends any[], R>(callback: string | Function | ((...args: A) => R), __context__?: any): import("./tryCatch").UtilsTryCatchType;
     };
     /**
      * 数组去重，去除重复的值

package/dist/src/indexedDB.d.ts

@@ -0,0 +1,73 @@
+declare class indexedDB {
+    #private;
+    /**
+     * @param dbName 数据存储名，默认为：default_db
+     * @param storeName 表名，默认为：default_form
+     * @param dbVersion indexDB的版本号，默认为：1
+     */
+    constructor(dbName?: string, storeName?: string, dbVersion?: number);
+    /**
+     * 创建 “表”
+     * @param dbName 表名
+     */
+    createStore(dbName: string): IDBObjectStore;
+    /**
+     * 打开数据库
+     * @param callback  回调
+     * @param dbName 数据库名
+     */
+    private open;
+    /**
+     * 保存数据到数据库
+     * @param key 数据key
+     * @param value 数据值
+     */
+    save(key: string, value: any): Promise<{
+        success: boolean;
+        code: number;
+        msg: string;
+        event?: Event;
+    }>;
+    /**
+     * 根据key获取值
+     * @param key 数据key
+     */
+    get<T extends any>(key: string): Promise<{
+        success: boolean;
+        code: number;
+        msg: string;
+        data: T;
+        event?: Event;
+        result?: any;
+    }>;
+    /**
+     * 正则获取数据
+     * @param key 数据键
+     */
+    regexpGet<T extends any>(key: string): Promise<{
+        success: boolean;
+        code: number;
+        msg: string;
+        data: T[];
+        event?: Event;
+    }>;
+    /**
+     * 删除数据
+     * @param {string} key 数据键
+     */
+    delete(key: string): Promise<{
+        success: boolean;
+        code: number;
+        msg: string;
+        event?: Event;
+    }>;
+    /**
+     * 删除所有数据
+     */
+    deleteAll(): Promise<{
+        success: boolean;
+        code: number;
+        msg: string;
+    }>;
+}
+export { indexedDB };

package/dist/src/tryCatch.d.ts

@@ -0,0 +1,31 @@
+export declare interface UtilsTryCatchConfig {
+    log: boolean;
+}
+/** tryCatch */
+export declare interface UtilsTryCatchType {
+    run: UtilsTryCatchType;
+    config: UtilsTryCatchType;
+    error: UtilsTryCatchType;
+}
+declare const TryCatch: (...args: any) => {
+    /**
+     *
+     * @param paramDetails 配置
+     * @returns
+     */
+    config(paramDetails: UtilsTryCatchConfig): any;
+    /**
+     * 处理错误
+     * @param handler
+     */
+    error(handler: ((...args: any[]) => any) | string | Function): any;
+    /**
+     * 执行传入的函数并捕获其可能抛出的错误，并通过传入的错误处理函数进行处理。
+     * @param callback 待执行函数，可以是 function 或者 string 类型。如果是 string 类型，则会被当做代码进行执行。
+     * @param __context__ 待执行函数的作用域，用于apply指定
+     * @returns 如果函数有返回值，则返回该返回值；否则返回 tryCatchObj 函数以支持链式调用。
+     * @throws {Error} 如果传入参数不符合要求，则会抛出相应类型的错误。
+     */
+    run<A extends any[], R>(callback: ((...args: A) => R) | string | Function, __context__?: any): UtilsTryCatchType;
+};
+export { TryCatch };

package/package.json

@@ -1,37 +1,36 @@
-{
-	"name": "@whitesev/utils",
-	"version": "1.0.4",
-	"description": "一个常用的工具库",
-	"main": "dist/index.cjs.js",
-	"module": "dist/node/index.esm.js",
-	"types": "dist/index.d.ts",
-	"jsdelivr": "dist/index.umd.js",
-	"exports": {
-		"./package.json": "./package.json",
-		".": {
-			"import": "./dist/index.esm.js",
-			"require": "./dist/index.cjs.js",
-			"types": "./dist/index.d.ts"
-		}
-	},
-	"scripts": {
-		"build": "rollup --config"
-	},
-	"keywords": [
-		"typescript"
-	],
-	"author": "WhiteSev",
-	"license": "MIT",
-	"dependencies": {
-		"@rollup/plugin-babel": "^6.0.4",
-		"@rollup/plugin-commonjs": "^25.0.8",
-		"@rollup/plugin-node-resolve": "^15.2.3",
-		"@rollup/plugin-typescript": "^11.1.6",
-		"rollup-plugin-clear": "^2.0.7",
-		"rollup-plugin-dts": "^6.1.1",
-		"tslib": "^2.6.2"
-	},
-	"devDependencies": {
-		"typescript": "^5.4.5"
-	}
-}
+{
+	"name": "@whitesev/utils",
+	"version": "1.0.6",
+	"description": "一个常用的工具库",
+	"main": "dist/index.cjs.js",
+	"module": "dist/node/index.esm.js",
+	"types": "dist/index.d.ts",
+	"jsdelivr": "dist/index.umd.js",
+	"exports": {
+		"./package.json": "./package.json",
+		".": {
+			"import": "./dist/index.esm.js",
+			"require": "./dist/index.cjs.js",
+			"types": "./dist/index.d.ts"
+		}
+	},
+	"scripts": {
+		"build": "rollup --config"
+	},
+	"keywords": [
+		"typescript"
+	],
+	"author": "WhiteSev",
+	"license": "MIT",
+	"dependencies": {
+		"@rollup/plugin-babel": "^6.0.4",
+		"@rollup/plugin-commonjs": "^25.0.8",
+		"@rollup/plugin-node-resolve": "^15.2.3",
+		"@rollup/plugin-typescript": "^11.1.6",
+		"rollup-plugin-clear": "^2.0.7",
+		"tslib": "^2.6.2"
+	},
+	"devDependencies": {
+		"typescript": "^5.4.5"
+	}
+}

package/rollup.config.js

@@ -6,8 +6,6 @@ const { nodeResolve } = require("@rollup/plugin-node-resolve");
 const typescript = require("@rollup/plugin-typescript");
 // 清空 dist
 const cleaner = require("rollup-plugin-clear");
-// 处理 .d.ts 声明文件
-const { dts } = require("rollup-plugin-dts");
 
 // 模块名
 const moduleName = "Utils";
@@ -16,7 +14,6 @@ module.exports = {
 		cleaner({
 			targets: ["./dist"],
 		}),
-		dts(),
 		nodeResolve(),
 		commonjs(),
 		typescript(),