browser-extension-utils 0.3.1 → 0.3.3

package/lib/global.d.ts

@@ -3,6 +3,8 @@ declare module 'css:*' {
   export default cssText
 }
 
+declare const browser: typeof chrome
+
 // eslint-disable-next-line @typescript-eslint/naming-convention
 declare const GM_info: {
   scriptHandler: string
@@ -13,6 +15,10 @@ declare function GM_addValueChangeListener(
   cb: (key: string, oldValue: any, newValue: any, remote: boolean) => void
 ): number
 
+declare type RegisterMenuCommandOptions = Parameters<
+  typeof GM_registerMenuCommand
+>[2]
+
 declare function GM_registerMenuCommand(
   caption: string,
   onClick: () => void,

package/lib/index.ts

@@ -13,6 +13,9 @@ export * from './dom-utils'
 export * from './set-attributes'
 export * from './create-element'
 export * from './add-element'
+export type RegisterMenuCommandOptions = Parameters<
+  typeof GM_registerMenuCommand
+>[2]
 
 export const uniq = <T>(array: T[]): T[] => [...new Set(array)]
 

package/lib/userscript.ts

@@ -40,7 +40,8 @@ export const addElement =
             for (const entry of Object.entries(attributes)) {
               // Some userscript managers do not support innerHTML
               // Stay do not support multiple classes: GM_addElement('div', {"class": "a b"}). Remove `|class` when it is supported
-              if (/^(on\w+|innerHTML|class)$/.test(entry[0])) {
+              // Stay do not support data-* attributes
+              if (/^(on\w+|innerHTML|class|data-.+)$/.test(entry[0])) {
                 entries2.push(entry)
               } else {
                 entries1.push(entry)
@@ -55,7 +56,7 @@ export const addElement =
           }
 
           try {
-            const element = GM_addElement(tagName, attributes1)
+            const element = GM_addElement(tagName, attributes1 || {})
             setAttributes(element, attributes2)
             parentNode.append(element)
             return element
@@ -76,19 +77,34 @@ export const addStyle = (styleText: string): HTMLElement | undefined =>
   addElement(null, 'style', { textContent: styleText })
 
 // Only register menu on top frame
-export const registerMenuCommand = (
+export const registerMenuCommand = async (
   name: string,
   callback: (event?: any) => void,
   options?: Parameters<typeof GM_registerMenuCommand>[2]
-): any => {
+): Promise<number> => {
   if (globalThis.self !== globalThis.top) {
-    return
+    return 0
   }
 
   if (typeof GM.registerMenuCommand !== 'function') {
     console.warn('Do not support GM.registerMenuCommand!')
-    return
+    return 0
   }
 
-  return GM.registerMenuCommand(name, callback, options)
+  try {
+    return await GM.registerMenuCommand(name, callback, options)
+  } catch (error) {
+    if (typeof options === 'object') {
+      // Don't support object options
+      try {
+        return await GM.registerMenuCommand(name, callback, options.accessKey)
+      } catch (error_) {
+        console.error('GM.registerMenuCommand error:', error_)
+      }
+    } else {
+      console.error('GM.registerMenuCommand error:', error)
+    }
+
+    return 0
+  }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-utils",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "description": "Utilities for developing browser extensions and userscripts",
   "type": "module",
   "main": "./lib/index.ts",