@whitesev/utils 2.8.2 → 2.9.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/README.md +176 -176
  2. package/dist/index.amd.js +283 -776
  3. package/dist/index.amd.js.map +1 -1
  4. package/dist/index.amd.min.js +2 -0
  5. package/dist/index.amd.min.js.map +1 -0
  6. package/dist/index.cjs.js +283 -776
  7. package/dist/index.cjs.js.map +1 -1
  8. package/dist/index.cjs.min.js +2 -0
  9. package/dist/index.cjs.min.js.map +1 -0
  10. package/dist/index.esm.js +283 -776
  11. package/dist/index.esm.js.map +1 -1
  12. package/dist/index.esm.min.js +2 -0
  13. package/dist/index.esm.min.js.map +1 -0
  14. package/dist/index.iife.js +283 -776
  15. package/dist/index.iife.js.map +1 -1
  16. package/dist/index.iife.min.js +2 -0
  17. package/dist/index.iife.min.js.map +1 -0
  18. package/dist/index.system.js +283 -776
  19. package/dist/index.system.js.map +1 -1
  20. package/dist/index.system.min.js +2 -0
  21. package/dist/index.system.min.js.map +1 -0
  22. package/dist/index.umd.js +283 -776
  23. package/dist/index.umd.js.map +1 -1
  24. package/dist/index.umd.min.js +2 -0
  25. package/dist/index.umd.min.js.map +1 -0
  26. package/dist/types/src/Utils.d.ts +132 -448
  27. package/dist/types/src/UtilsGMCookie.d.ts +4 -0
  28. package/dist/types/src/UtilsGMMenu.d.ts +3 -6
  29. package/dist/types/src/types/Httpx.d.ts +1344 -1344
  30. package/dist/types/src/types/Log.d.ts +19 -19
  31. package/dist/types/src/types/Progress.d.ts +20 -20
  32. package/dist/types/src/types/React.d.ts +119 -119
  33. package/dist/types/src/types/TryCatch.d.ts +9 -9
  34. package/dist/types/src/types/UtilsGMCookie.d.ts +93 -93
  35. package/dist/types/src/types/UtilsGMMenu.d.ts +77 -77
  36. package/dist/types/src/types/Vue2.d.ts +166 -166
  37. package/dist/types/src/types/WindowApi.d.ts +14 -14
  38. package/dist/types/src/types/ajaxHooker.d.ts +153 -151
  39. package/dist/types/src/types/env.d.ts +7 -7
  40. package/dist/types/src/types/global.d.ts +31 -31
  41. package/package.json +11 -10
  42. package/src/ColorConversion.ts +105 -105
  43. package/src/CommonUtil.ts +280 -280
  44. package/src/DOMUtils.ts +251 -251
  45. package/src/Dictionary.ts +153 -153
  46. package/src/GBKEncoder.ts +108 -108
  47. package/src/Hooks.ts +73 -73
  48. package/src/Httpx.ts +1457 -1457
  49. package/src/LockFunction.ts +62 -62
  50. package/src/Log.ts +258 -258
  51. package/src/Progress.ts +108 -108
  52. package/src/TryCatch.ts +86 -86
  53. package/src/Utils.ts +3827 -4773
  54. package/src/UtilsCommon.ts +14 -14
  55. package/src/UtilsGMCookie.ts +272 -254
  56. package/src/UtilsGMMenu.ts +441 -445
  57. package/src/Vue.ts +233 -233
  58. package/src/WindowApi.ts +59 -59
  59. package/src/indexedDB.ts +497 -497
  60. package/src/types/Httpx.d.ts +1344 -1344
  61. package/src/types/Log.d.ts +19 -19
  62. package/src/types/Progress.d.ts +20 -20
  63. package/src/types/React.d.ts +119 -119
  64. package/src/types/TryCatch.d.ts +9 -9
  65. package/src/types/UtilsGMCookie.d.ts +93 -93
  66. package/src/types/UtilsGMMenu.d.ts +77 -77
  67. package/src/types/Vue2.d.ts +166 -166
  68. package/src/types/WindowApi.d.ts +14 -14
  69. package/src/types/ajaxHooker.d.ts +153 -151
  70. package/src/types/env.d.ts +7 -7
  71. package/src/types/global.d.ts +31 -31
  72. package/dist/types/src/types/Event.d.ts +0 -188
  73. package/src/types/Event.d.ts +0 -188
@@ -1,445 +1,441 @@
1
- import { CommonUtil } from "./CommonUtil";
2
- import type { UtilsGMMenuConstructorOptions, UtilsGMMenuOption, UtilsGMMenuOptionData } from "./types/UtilsGMMenu";
3
-
4
- export class GMMenu {
5
- private GM_Api = {
6
- /**
7
- * 获取存储的数据
8
- */
9
- getValue: null as any,
10
- /**
11
- * 设置数据到存储
12
- */
13
- setValue: null as any,
14
- /**
15
- * 注册菜单
16
- */
17
- registerMenuCommand: null as any,
18
- /**
19
- * 卸载菜单
20
- */
21
- unregisterMenuCommand: null as any,
22
- };
23
- private MenuHandle = {
24
- context: this,
25
- $data: {
26
- /**
27
- * 菜单数据
28
- */
29
- data: <UtilsGMMenuOptionData[]>[],
30
- /**
31
- * 本地存储的键名
32
- */
33
- key: "GM_Menu_Local_Map",
34
- },
35
- $default: {
36
- /** 自动刷新网页,默认为true */
37
- autoReload: true,
38
- /**
39
- * 菜单isStoreValue的默认值
40
- */
41
- isStoreValue: true,
42
- },
43
- $emoji: {
44
- /**
45
- * 菜单enable为true的emoji
46
- */
47
- success: "✅",
48
- /**
49
- * 菜单enable为false的emoji
50
- */
51
- error: "❌",
52
- },
53
- /**
54
- * 初始化数据
55
- */
56
- init() {
57
- for (let index = 0; index < this.$data.data.length; index++) {
58
- const menuOption = this.$data.data[index]["data"];
59
- menuOption.enable = Boolean(this.getLocalMenuData(menuOption.key, menuOption.enable as boolean));
60
- if (typeof menuOption.showText !== "function") {
61
- menuOption.showText = (menuText, menuEnable) => {
62
- if (menuEnable) {
63
- return `${this.$emoji.success} ${menuText}`;
64
- } else {
65
- return `${this.$emoji.error} ${menuText}`;
66
- }
67
- };
68
- }
69
- }
70
- },
71
- /**
72
- * 注册油猴菜单
73
- * @param menuOptions 如果存在,使用它
74
- */
75
- register(menuOptions?: UtilsGMMenuOptionData[]) {
76
- const that = this;
77
- if (menuOptions == null) {
78
- throw new TypeError("register菜单数据不能为空");
79
- }
80
- if (!Array.isArray(menuOptions)) {
81
- menuOptions = [menuOptions];
82
- }
83
- for (let index = 0; index < menuOptions.length; index++) {
84
- const cloneMenuOptionData = CommonUtil.deepClone(menuOptions[index].data);
85
- const { showText, clickCallBack } = this.handleMenuData(cloneMenuOptionData as Required<UtilsGMMenuOption>);
86
- const menuId = that.context.GM_Api.registerMenuCommand(showText, clickCallBack);
87
- menuOptions[index].id = menuId;
88
- (cloneMenuOptionData as any).deleteMenu = function () {
89
- that.context.GM_Api.unregisterMenuCommand(menuId);
90
- };
91
- Reflect.deleteProperty(menuOptions[index], "handleData");
92
- (menuOptions[index] as any).handleData = cloneMenuOptionData;
93
- }
94
- },
95
- /**
96
- * 获取本地存储菜单键值
97
- * @param {string} key 键
98
- */
99
- getLocalMenuData(key: string, defaultValue: boolean): boolean {
100
- const localData = this.context.GM_Api.getValue(this.$data.key, {});
101
- if (key in localData) {
102
- return (localData as any)[key];
103
- } else {
104
- return defaultValue;
105
- }
106
- },
107
- /**
108
- * 设置本地存储菜单键值
109
- * @param key 键
110
- * @param value
111
- */
112
- setLocalMenuData(key: string, value: boolean) {
113
- const localData = this.context.GM_Api.getValue(this.$data.key, {});
114
- (localData as any)[key] = value;
115
- this.context.GM_Api.setValue(this.$data.key, localData);
116
- },
117
- /**
118
- * 处理初始化配置
119
- * @param menuOption
120
- */
121
- handleInitDetail(menuOption: Required<UtilsGMMenuOption>) {
122
- menuOption.enable = Boolean(this.getLocalMenuData(menuOption.key, menuOption.enable));
123
- if (typeof menuOption.showText !== "function") {
124
- menuOption.showText = (menuText, menuEnable) => {
125
- if (menuEnable) {
126
- return `${this.$emoji.success} ${menuText}`;
127
- } else {
128
- return `${this.$emoji.error} ${menuText}`;
129
- }
130
- };
131
- }
132
- return menuOption;
133
- },
134
- /**
135
- * 对菜单数据进行处理
136
- * @param menuOption
137
- */
138
- handleMenuData(menuOption: Required<UtilsGMMenuOption>) {
139
- const that = this;
140
- const menuLocalDataItemKey = menuOption.key;
141
- /* 菜单默认开启的状态 */
142
- const defaultEnable = Boolean(this.getLocalMenuData(menuLocalDataItemKey, menuOption.enable));
143
- /** 油猴菜单上显示的文本 */
144
- const showText = menuOption.showText(menuOption.text, defaultEnable);
145
- // const GMMenuOptions = {
146
- // /**
147
- // * 菜单的id
148
- // */
149
- // id: menuOption.id,
150
- // /**
151
- // * 点击菜单项后是否应关闭弹出菜单
152
- // */
153
- // autoClose: menuOption.autoClose,
154
- // /**
155
- // * 菜单项的可选访问键
156
- // */
157
- // accessKey: menuOption.accessKey,
158
- // /**
159
- // * 菜单项的鼠标悬浮上的工具提示
160
- // */
161
- // title: menuOption.title,
162
- // };
163
- /* 点击菜单后触发callback后的网页是否刷新 */
164
- menuOption.autoReload =
165
- typeof menuOption.autoReload !== "boolean" ? this.$default.autoReload : menuOption.autoReload;
166
- /* 点击菜单后触发callback后的网页是否存储值 */
167
- menuOption.isStoreValue =
168
- typeof menuOption.isStoreValue !== "boolean" ? this.$default.isStoreValue : menuOption.isStoreValue;
169
- /**
170
- * 用户点击菜单后的回调函数
171
- * @param event
172
- */
173
- function clickCallBack(event: MouseEvent | PointerEvent) {
174
- const localEnable = Boolean(that.getLocalMenuData(menuLocalDataItemKey, defaultEnable));
175
- if (menuOption.isStoreValue) {
176
- that.setLocalMenuData(menuLocalDataItemKey, !localEnable);
177
- }
178
- if (typeof menuOption.callback === "function") {
179
- menuOption.callback({
180
- key: menuLocalDataItemKey,
181
- enable: !localEnable,
182
- oldEnable: localEnable,
183
- event: event,
184
- storeValue(value) {
185
- that.setLocalMenuData(menuLocalDataItemKey, value);
186
- },
187
- });
188
- }
189
- /* 不刷新网页就刷新菜单 */
190
- if (menuOption.autoReload) {
191
- window.location.reload();
192
- } else {
193
- that.context.update();
194
- }
195
- }
196
-
197
- return {
198
- showText,
199
- clickCallBack,
200
- };
201
- },
202
- /**
203
- * 获取目标菜单配置数据
204
- * @param menuKey 菜单-键key
205
- */
206
- getMenuData(menuKey: string) {
207
- return this.$data.data.find((item) => item.data.key === menuKey);
208
- },
209
- /**
210
- * 获取目标菜单配置
211
- * @param menuKey 菜单-键key
212
- */
213
- getMenuOption(menuKey: string) {
214
- return this.$data.data.find((item) => item.data.key === menuKey)?.data;
215
- },
216
- /**
217
- * 获取目标菜单处理后的配置
218
- * @param menuKey 菜单-键key
219
- */
220
- getMenuHandledOption(menuKey: string) {
221
- return this.$data.data.find((item) => item!.handleData!.key === menuKey)?.handleData;
222
- },
223
- };
224
- constructor(details: UtilsGMMenuConstructorOptions) {
225
- this.GM_Api.getValue = details.GM_getValue;
226
- this.GM_Api.setValue = details.GM_setValue;
227
- this.GM_Api.registerMenuCommand = details.GM_registerMenuCommand;
228
- this.GM_Api.unregisterMenuCommand = details.GM_unregisterMenuCommand;
229
- this.MenuHandle.$default.autoReload = typeof details.autoReload === "boolean" ? details.autoReload : true;
230
- for (const keyName of Object.keys(this.GM_Api)) {
231
- if (typeof (this.GM_Api as any)[keyName] !== "function") {
232
- throw new Error(`Utils.GM_Menu 请在脚本开头加上 @grant ${keyName},且传入该对象`);
233
- }
234
- }
235
- this.add(details?.data || []);
236
- }
237
- /**
238
- * 新增菜单数据
239
- * @param menuOption
240
- */
241
- private __add(menuOption: UtilsGMMenuOption[] | UtilsGMMenuOption) {
242
- if (Array.isArray(menuOption)) {
243
- for (let index = 0; index < menuOption.length; index++) {
244
- const option = menuOption[index];
245
- this.MenuHandle.$data.data.push({
246
- data: option,
247
- id: void 0,
248
- });
249
- }
250
- } else {
251
- this.MenuHandle.$data.data.push({
252
- data: menuOption,
253
- id: void 0,
254
- });
255
- }
256
- }
257
- /**
258
- * 新增菜单数据
259
- *
260
- * 自动调用.update()
261
- * @param menuOption
262
- */
263
- add(menuOption: UtilsGMMenuOption[] | UtilsGMMenuOption) {
264
- this.__add(menuOption);
265
- this.update();
266
- }
267
- /**
268
- * 更新菜单数据
269
- *
270
- * 实现方式:先取消注册所有已注册的菜单、再依次注册所有菜单项
271
- *
272
- * 如果菜单不存在,新增菜单项
273
- *
274
- * 如果菜单已存在,新菜单项覆盖旧的菜单项
275
- * @param options 数据
276
- */
277
- update(options?: UtilsGMMenuOption[] | UtilsGMMenuOption) {
278
- let menuOptionList: UtilsGMMenuOption[] = [];
279
- if (Array.isArray(options)) {
280
- menuOptionList = [...menuOptionList, ...options];
281
- } else if (options != null) {
282
- menuOptionList = [...menuOptionList, options];
283
- }
284
- menuOptionList.forEach((menuOption) => {
285
- const oldMenuOption = this.MenuHandle.getMenuOption(menuOption.key);
286
- if (oldMenuOption) {
287
- // 覆盖
288
- Object.assign(oldMenuOption, menuOption);
289
- } else {
290
- this.__add(menuOption);
291
- }
292
- });
293
- this.MenuHandle.$data.data.forEach((value) => {
294
- if (value.handleData) {
295
- value.handleData.deleteMenu();
296
- }
297
- });
298
- this.MenuHandle.init();
299
- this.MenuHandle.register(this.MenuHandle.$data.data);
300
- }
301
- /**
302
- * 卸载菜单
303
- * @param menuId 已注册的菜单id
304
- */
305
- delete(menuId: number) {
306
- this.GM_Api.unregisterMenuCommand(menuId);
307
- }
308
- /**
309
- * 根据键值获取enable值
310
- * @param menuKey 菜单-键key
311
- * @deprecated
312
- */
313
- get(menuKey: string): boolean {
314
- return this.getEnable(menuKey);
315
- }
316
- /**
317
- * 根据键值获取enable
318
- * @param menuKey 菜单-键key
319
- */
320
- getEnable(menuKey: string): boolean {
321
- return this.MenuHandle.getMenuHandledOption(menuKey)!.enable as boolean;
322
- }
323
- /**
324
- * 根据键值获取text
325
- * @param menuKey 菜单-键key
326
- */
327
- getText(menuKey: string): string {
328
- return this.MenuHandle.getMenuHandledOption(menuKey)!.text;
329
- }
330
- /**
331
- * 根据键值获取showText函数的值
332
- * @param menuKey 菜单-键key
333
- */
334
- getShowTextValue(menuKey: string): string {
335
- return this.MenuHandle.getMenuHandledOption(menuKey)!.showText(this.getText(menuKey), this.getEnable(menuKey));
336
- }
337
- /**
338
- * 获取当前已注册菜单的id
339
- * @param menuKey
340
- */
341
- getMenuId(menuKey: string): number | undefined | null {
342
- let result = null;
343
- for (let index = 0; index < this.MenuHandle.$data.data.length; index++) {
344
- const optionData = this.MenuHandle.$data.data[index];
345
- if (optionData!.handleData!.key === menuKey) {
346
- result = optionData.id;
347
- break;
348
- }
349
- }
350
- return result;
351
- }
352
- /**
353
- * 根据键值获取accessKey
354
- * @param menuKey 菜单-键key
355
- */
356
- getAccessKey(menuKey: string): string | undefined {
357
- return this.MenuHandle.getMenuHandledOption(menuKey)?.accessKey;
358
- }
359
- /**
360
- * 根据键值获取autoClose
361
- * @param menuKey 菜单-键key
362
- */
363
- getAutoClose(menuKey: string): boolean | undefined {
364
- return this.MenuHandle.getMenuHandledOption(menuKey)?.autoClose;
365
- }
366
- /**
367
- * 根据键值获取autoReload
368
- * @param menuKey 菜单-键key
369
- */
370
- getAutoReload(menuKey: string): boolean | undefined {
371
- return this.MenuHandle.getMenuHandledOption(menuKey)?.autoReload;
372
- }
373
- /**
374
- * 根据键值获取callback函数
375
- * @param menuKey 菜单-键key
376
- */
377
- getCallBack(menuKey: string): ((...args: any[]) => any) | undefined {
378
- return this.MenuHandle.getMenuHandledOption(menuKey)?.callback;
379
- }
380
- /**
381
- * 获取当enable为true时默认显示在菜单中前面的emoji图标
382
- */
383
- getEnableTrueEmoji() {
384
- return this.MenuHandle.$emoji.success;
385
- }
386
- /**
387
- * 获取当enable为false时默认显示在菜单中前面的emoji图标
388
- */
389
- getEnableFalseEmoji() {
390
- return this.MenuHandle.$emoji.error;
391
- }
392
- /**
393
- * 获取本地存储的菜单外部的键名
394
- * @param keyName
395
- */
396
- getLocalStorageKeyName() {
397
- return this.MenuHandle.$data.key;
398
- }
399
- /**
400
- * 设置菜单的值
401
- * @param menuKey 菜单-键key
402
- * @param value 需要设置的值
403
- */
404
- setValue(menuKey: string, value: any) {
405
- this.MenuHandle.setLocalMenuData(menuKey, value);
406
- }
407
- /**
408
- * 设置菜单的值
409
- * @param menuKey 菜单-键key
410
- * @param value 需要设置的值
411
- */
412
- setEnable(menuKey: string, value: boolean) {
413
- this.setValue(menuKey, Boolean(value));
414
- }
415
- /**
416
- * 设置当enable为true时默认显示在菜单中前面的emoji图标
417
- * @param emojiString
418
- */
419
- setEnableTrueEmoji(emojiString: string) {
420
- if (typeof emojiString !== "string") {
421
- throw new Error("参数emojiString必须是string类型");
422
- }
423
- this.MenuHandle.$emoji.success = emojiString;
424
- }
425
- /**
426
- * 设置当enable为false时默认显示在菜单中前面的emoji图标
427
- * @param emojiString
428
- */
429
- setEnableFalseEmoji(emojiString: string) {
430
- if (typeof emojiString !== "string") {
431
- throw new Error("参数emojiString必须是string类型");
432
- }
433
- this.MenuHandle.$emoji.error = emojiString;
434
- }
435
- /**
436
- * 设置本地存储的菜单外部的键名
437
- * @param keyName
438
- */
439
- setLocalStorageKeyName(keyName: string) {
440
- if (typeof keyName !== "string") {
441
- throw new Error("参数keyName必须是string类型");
442
- }
443
- this.MenuHandle.$data.key = keyName;
444
- }
445
- }
1
+ import { CommonUtil } from "./CommonUtil";
2
+ import type { UtilsGMMenuConstructorOptions, UtilsGMMenuOption, UtilsGMMenuOptionData } from "./types/UtilsGMMenu";
3
+
4
+ export class GMMenu {
5
+ private GM_Api = {
6
+ /**
7
+ * 获取存储的数据
8
+ */
9
+ getValue: null as any,
10
+ /**
11
+ * 设置数据到存储
12
+ */
13
+ setValue: null as any,
14
+ /**
15
+ * 注册菜单
16
+ */
17
+ registerMenuCommand: null as any,
18
+ /**
19
+ * 卸载菜单
20
+ */
21
+ unregisterMenuCommand: null as any,
22
+ };
23
+ private MenuHandle = {
24
+ context: this,
25
+ $data: {
26
+ /**
27
+ * 菜单数据
28
+ */
29
+ data: <UtilsGMMenuOptionData[]>[],
30
+ /**
31
+ * 本地存储的键名
32
+ */
33
+ key: "GM_Menu_Local_Map",
34
+ },
35
+ $default: {
36
+ /** 自动刷新网页,默认为true */
37
+ autoReload: true,
38
+ /**
39
+ * 菜单isStoreValue的默认值
40
+ */
41
+ isStoreValue: true,
42
+ },
43
+ $emoji: {
44
+ /**
45
+ * 菜单enable为true的emoji
46
+ */
47
+ success: "✅",
48
+ /**
49
+ * 菜单enable为false的emoji
50
+ */
51
+ error: "❌",
52
+ },
53
+ /**
54
+ * 初始化数据
55
+ */
56
+ init() {
57
+ for (let index = 0; index < this.$data.data.length; index++) {
58
+ const menuOption = this.$data.data[index]["data"];
59
+ menuOption.enable = Boolean(this.getLocalMenuData(menuOption.key, menuOption.enable as boolean));
60
+ if (typeof menuOption.showText !== "function") {
61
+ menuOption.showText = (menuText, menuEnable) => {
62
+ if (menuEnable) {
63
+ return `${this.$emoji.success} ${menuText}`;
64
+ } else {
65
+ return `${this.$emoji.error} ${menuText}`;
66
+ }
67
+ };
68
+ }
69
+ }
70
+ },
71
+ /**
72
+ * 注册油猴菜单
73
+ * @param menuOptions (可选)菜单配置
74
+ */
75
+ register(menuOptions?: UtilsGMMenuOptionData[]) {
76
+ const that = this;
77
+ if (menuOptions == null) {
78
+ throw new TypeError("register菜单数据不能为空");
79
+ }
80
+ if (!Array.isArray(menuOptions)) {
81
+ menuOptions = [menuOptions];
82
+ }
83
+ for (let index = 0; index < menuOptions.length; index++) {
84
+ const cloneMenuOptionData = CommonUtil.deepClone(menuOptions[index].data);
85
+ const { showText, clickCallBack } = this.handleMenuData(cloneMenuOptionData as Required<UtilsGMMenuOption>);
86
+ const menuId = that.context.GM_Api.registerMenuCommand(showText, clickCallBack);
87
+ menuOptions[index].id = menuId;
88
+ (cloneMenuOptionData as any).deleteMenu = function () {
89
+ that.context.GM_Api.unregisterMenuCommand(menuId);
90
+ };
91
+ Reflect.deleteProperty(menuOptions[index], "handleData");
92
+ (menuOptions[index] as any).handleData = cloneMenuOptionData;
93
+ }
94
+ },
95
+ /**
96
+ * 获取本地存储菜单键值
97
+ * @param key 键
98
+ * @param defaultValue 默认值
99
+ */
100
+ getLocalMenuData(key: string, defaultValue: boolean): boolean {
101
+ const localData = this.context.GM_Api.getValue(this.$data.key, {});
102
+ if (key in localData) {
103
+ return (localData as any)[key];
104
+ } else {
105
+ return defaultValue;
106
+ }
107
+ },
108
+ /**
109
+ * 设置本地存储菜单键值
110
+ * @param key
111
+ * @param value 值
112
+ */
113
+ setLocalMenuData(key: string, value: boolean) {
114
+ const localData = this.context.GM_Api.getValue(this.$data.key, {});
115
+ (localData as any)[key] = value;
116
+ this.context.GM_Api.setValue(this.$data.key, localData);
117
+ },
118
+ /**
119
+ * 处理初始化配置
120
+ * @param menuOption 菜单配置
121
+ */
122
+ handleInitDetail(menuOption: Required<UtilsGMMenuOption>) {
123
+ menuOption.enable = Boolean(this.getLocalMenuData(menuOption.key, menuOption.enable));
124
+ if (typeof menuOption.showText !== "function") {
125
+ menuOption.showText = (menuText, menuEnable) => {
126
+ if (menuEnable) {
127
+ return `${this.$emoji.success} ${menuText}`;
128
+ } else {
129
+ return `${this.$emoji.error} ${menuText}`;
130
+ }
131
+ };
132
+ }
133
+ return menuOption;
134
+ },
135
+ /**
136
+ * 对菜单数据进行处理
137
+ * @param menuOption 菜单配置
138
+ */
139
+ handleMenuData(menuOption: Required<UtilsGMMenuOption>) {
140
+ const that = this;
141
+ const menuLocalDataItemKey = menuOption.key;
142
+ /* 菜单默认开启的状态 */
143
+ const defaultEnable = Boolean(this.getLocalMenuData(menuLocalDataItemKey, menuOption.enable));
144
+ /** 油猴菜单上显示的文本 */
145
+ const showText = menuOption.showText(menuOption.text, defaultEnable);
146
+ // const GMMenuOptions = {
147
+ // /**
148
+ // * 菜单的id
149
+ // */
150
+ // id: menuOption.id,
151
+ // /**
152
+ // * 点击菜单项后是否应关闭弹出菜单
153
+ // */
154
+ // autoClose: menuOption.autoClose,
155
+ // /**
156
+ // * 菜单项的可选访问键
157
+ // */
158
+ // accessKey: menuOption.accessKey,
159
+ // /**
160
+ // * 菜单项的鼠标悬浮上的工具提示
161
+ // */
162
+ // title: menuOption.title,
163
+ // };
164
+ /* 点击菜单后触发callback后的网页是否刷新 */
165
+ menuOption.autoReload =
166
+ typeof menuOption.autoReload !== "boolean" ? this.$default.autoReload : menuOption.autoReload;
167
+ /* 点击菜单后触发callback后的网页是否存储值 */
168
+ menuOption.isStoreValue =
169
+ typeof menuOption.isStoreValue !== "boolean" ? this.$default.isStoreValue : menuOption.isStoreValue;
170
+ /**
171
+ * 用户点击菜单后的回调函数
172
+ * @param event
173
+ */
174
+ function clickCallBack(event: MouseEvent | PointerEvent) {
175
+ const localEnable = Boolean(that.getLocalMenuData(menuLocalDataItemKey, defaultEnable));
176
+ if (menuOption.isStoreValue) {
177
+ that.setLocalMenuData(menuLocalDataItemKey, !localEnable);
178
+ }
179
+ if (typeof menuOption.callback === "function") {
180
+ menuOption.callback({
181
+ key: menuLocalDataItemKey,
182
+ enable: !localEnable,
183
+ oldEnable: localEnable,
184
+ event: event,
185
+ storeValue(value) {
186
+ that.setLocalMenuData(menuLocalDataItemKey, value);
187
+ },
188
+ });
189
+ }
190
+ /* 不刷新网页就刷新菜单 */
191
+ if (menuOption.autoReload) {
192
+ window.location.reload();
193
+ } else {
194
+ that.context.update();
195
+ }
196
+ }
197
+
198
+ return {
199
+ showText,
200
+ clickCallBack,
201
+ };
202
+ },
203
+ /**
204
+ * 获取目标菜单配置数据
205
+ * @param menuKey 菜单-键key
206
+ */
207
+ getMenuData(menuKey: string) {
208
+ return this.$data.data.find((item) => item.data.key === menuKey);
209
+ },
210
+ /**
211
+ * 获取目标菜单配置
212
+ * @param menuKey 菜单-键key
213
+ */
214
+ getMenuOption(menuKey: string) {
215
+ return this.$data.data.find((item) => item.data.key === menuKey)?.data;
216
+ },
217
+ /**
218
+ * 获取目标菜单处理后的配置
219
+ * @param menuKey 菜单-键key
220
+ */
221
+ getMenuHandledOption(menuKey: string) {
222
+ return this.$data.data.find((item) => item!.handleData!.key === menuKey)?.handleData;
223
+ },
224
+ };
225
+ /**
226
+ * @param details 菜单配置
227
+ */
228
+ constructor(details: UtilsGMMenuConstructorOptions) {
229
+ this.GM_Api.getValue = details.GM_getValue;
230
+ this.GM_Api.setValue = details.GM_setValue;
231
+ this.GM_Api.registerMenuCommand = details.GM_registerMenuCommand;
232
+ this.GM_Api.unregisterMenuCommand = details.GM_unregisterMenuCommand;
233
+ this.MenuHandle.$default.autoReload = typeof details.autoReload === "boolean" ? details.autoReload : true;
234
+ for (const keyName of Object.keys(this.GM_Api)) {
235
+ if (typeof (this.GM_Api as any)[keyName] !== "function") {
236
+ throw new Error(`Utils.GM_Menu 请在脚本开头加上 @grant ${keyName},且传入该对象`);
237
+ }
238
+ }
239
+ this.add(details?.data || []);
240
+ }
241
+ /**
242
+ * 新增菜单数据
243
+ * @param menuOption
244
+ */
245
+ private __add(menuOption: UtilsGMMenuOption[] | UtilsGMMenuOption) {
246
+ if (Array.isArray(menuOption)) {
247
+ for (let index = 0; index < menuOption.length; index++) {
248
+ const option = menuOption[index];
249
+ this.MenuHandle.$data.data.push({
250
+ data: option,
251
+ id: void 0,
252
+ });
253
+ }
254
+ } else {
255
+ this.MenuHandle.$data.data.push({
256
+ data: menuOption,
257
+ id: void 0,
258
+ });
259
+ }
260
+ }
261
+ /**
262
+ * 新增菜单数据
263
+ *
264
+ * 自动调用.update()
265
+ * @param menuOption
266
+ */
267
+ add(menuOption: UtilsGMMenuOption[] | UtilsGMMenuOption) {
268
+ this.__add(menuOption);
269
+ this.update();
270
+ }
271
+ /**
272
+ * 更新菜单数据
273
+ *
274
+ * 实现方式:先取消注册所有已注册的菜单、再依次注册所有菜单项
275
+ *
276
+ * 如果菜单不存在,新增菜单项
277
+ *
278
+ * 如果菜单已存在,新菜单项覆盖旧的菜单项
279
+ * @param options 数据
280
+ */
281
+ update(options?: UtilsGMMenuOption[] | UtilsGMMenuOption) {
282
+ let menuOptionList: UtilsGMMenuOption[] = [];
283
+ if (Array.isArray(options)) {
284
+ menuOptionList = [...menuOptionList, ...options];
285
+ } else if (options != null) {
286
+ menuOptionList = [...menuOptionList, options];
287
+ }
288
+ menuOptionList.forEach((menuOption) => {
289
+ const oldMenuOption = this.MenuHandle.getMenuOption(menuOption.key);
290
+ if (oldMenuOption) {
291
+ // 覆盖
292
+ Object.assign(oldMenuOption, menuOption);
293
+ } else {
294
+ this.__add(menuOption);
295
+ }
296
+ });
297
+ this.MenuHandle.$data.data.forEach((value) => {
298
+ if (value.handleData) {
299
+ value.handleData.deleteMenu();
300
+ }
301
+ });
302
+ this.MenuHandle.init();
303
+ this.MenuHandle.register(this.MenuHandle.$data.data);
304
+ }
305
+ /**
306
+ * 卸载菜单
307
+ * @param menuId 已注册的菜单id
308
+ */
309
+ delete(menuId: number) {
310
+ this.GM_Api.unregisterMenuCommand(menuId);
311
+ }
312
+ /**
313
+ * 根据键值获取enable值
314
+ * @param menuKey 菜单-键key
315
+ */
316
+ getEnable(menuKey: string): boolean {
317
+ return this.MenuHandle.getMenuHandledOption(menuKey)!.enable as boolean;
318
+ }
319
+ /**
320
+ * 根据键值获取text值
321
+ * @param menuKey 菜单-键key
322
+ */
323
+ getText(menuKey: string): string {
324
+ return this.MenuHandle.getMenuHandledOption(menuKey)!.text;
325
+ }
326
+ /**
327
+ * 根据键值获取showText函数的值
328
+ * @param menuKey 菜单-键key
329
+ */
330
+ getShowTextValue(menuKey: string): string {
331
+ return this.MenuHandle.getMenuHandledOption(menuKey)!.showText(this.getText(menuKey), this.getEnable(menuKey));
332
+ }
333
+ /**
334
+ * 获取当前已注册菜单的id
335
+ * @param menuKey
336
+ */
337
+ getMenuId(menuKey: string): number | undefined | null {
338
+ let result = null;
339
+ for (let index = 0; index < this.MenuHandle.$data.data.length; index++) {
340
+ const optionData = this.MenuHandle.$data.data[index];
341
+ if (optionData!.handleData!.key === menuKey) {
342
+ result = optionData.id;
343
+ break;
344
+ }
345
+ }
346
+ return result;
347
+ }
348
+ /**
349
+ * 根据键值获取accessKey值
350
+ * @param menuKey 菜单-键key
351
+ */
352
+ getAccessKey(menuKey: string): string | undefined {
353
+ return this.MenuHandle.getMenuHandledOption(menuKey)?.accessKey;
354
+ }
355
+ /**
356
+ * 根据键值获取autoClose值
357
+ * @param menuKey 菜单-键key
358
+ */
359
+ getAutoClose(menuKey: string): boolean | undefined {
360
+ return this.MenuHandle.getMenuHandledOption(menuKey)?.autoClose;
361
+ }
362
+ /**
363
+ * 根据键值获取autoReload值
364
+ * @param menuKey 菜单-键key
365
+ */
366
+ getAutoReload(menuKey: string): boolean | undefined {
367
+ return this.MenuHandle.getMenuHandledOption(menuKey)?.autoReload;
368
+ }
369
+ /**
370
+ * 根据键值获取callback函数
371
+ * @param menuKey 菜单-键key
372
+ */
373
+ getCallBack(menuKey: string): ((...args: any[]) => any) | undefined {
374
+ return this.MenuHandle.getMenuHandledOption(menuKey)?.callback;
375
+ }
376
+ /**
377
+ * 获取当enable为true时默认显示在菜单中前面的emoji图标
378
+ */
379
+ getEnableTrueEmoji() {
380
+ return this.MenuHandle.$emoji.success;
381
+ }
382
+ /**
383
+ * 获取当enable为false时默认显示在菜单中前面的emoji图标
384
+ */
385
+ getEnableFalseEmoji() {
386
+ return this.MenuHandle.$emoji.error;
387
+ }
388
+ /**
389
+ * 获取本地存储的菜单外部的键名
390
+ * @param keyName
391
+ */
392
+ getLocalStorageKeyName() {
393
+ return this.MenuHandle.$data.key;
394
+ }
395
+ /**
396
+ * 设置菜单的值
397
+ * @param menuKey 菜单-键key
398
+ * @param value 需要设置的值
399
+ */
400
+ setValue(menuKey: string, value: any) {
401
+ this.MenuHandle.setLocalMenuData(menuKey, value);
402
+ }
403
+ /**
404
+ * 设置菜单的值
405
+ * @param menuKey 菜单-键key
406
+ * @param value 需要设置的值
407
+ */
408
+ setEnable(menuKey: string, value: boolean) {
409
+ this.setValue(menuKey, Boolean(value));
410
+ }
411
+ /**
412
+ * 设置当enable为true时默认显示在菜单中前面的emoji图标
413
+ * @param emojiString
414
+ */
415
+ setEnableTrueEmoji(emojiString: string) {
416
+ if (typeof emojiString !== "string") {
417
+ throw new Error("参数emojiString必须是string类型");
418
+ }
419
+ this.MenuHandle.$emoji.success = emojiString;
420
+ }
421
+ /**
422
+ * 设置当enable为false时默认显示在菜单中前面的emoji图标
423
+ * @param emojiString
424
+ */
425
+ setEnableFalseEmoji(emojiString: string) {
426
+ if (typeof emojiString !== "string") {
427
+ throw new Error("参数emojiString必须是string类型");
428
+ }
429
+ this.MenuHandle.$emoji.error = emojiString;
430
+ }
431
+ /**
432
+ * 设置本地存储的菜单外部的键名
433
+ * @param keyName
434
+ */
435
+ setLocalStorageKeyName(keyName: string) {
436
+ if (typeof keyName !== "string") {
437
+ throw new Error("参数keyName必须是string类型");
438
+ }
439
+ this.MenuHandle.$data.key = keyName;
440
+ }
441
+ }