vite-userscript-plugin 1.4.0 → 1.5.0

package/README.md

@@ -1,10 +1,10 @@
 # vite-userscript-plugin
 
-![npm](https://img.shields.io/npm/v/vite-userscript-plugin)
-![license](https://img.shields.io/github/license/crashmax-dev/vite-userscript-plugin)
+[![npm](https://img.shields.io/npm/v/vite-userscript-plugin)](https://npmjs.com/vite-userscript-plugin)
+[![license](https://img.shields.io/github/license/crashmax-dev/vite-userscript-plugin)](./LICENCE)
+[![template](https://img.shields.io/github/package-json/v/crashmax-dev/vite-userscript-template?label=vite-userscript-template)](https://github.com/crashmax-dev/vite-userscript-template)
 
-> ⚡️ Tampermonkey userscript developing and build plugin based on [Vite](https://vitejs.dev).\
-> 📦 Use this [template](https://github.com/crashmax-dev/vite-userscript-template) to initialize your project.
+> ⚡️ Tampermonkey userscript developing and build plugin based on [Vite](https://vitejs.dev).
 
 ## Features
 
@@ -12,7 +12,7 @@
 - 🔧 Configure Tampermonkey's Userscript header.
 - 💨 Import all `grant` by default in development mode.
 - 📝 Automatically add used `grant` when building for production.
-- 📦 Built-in Tampermonkey's TypeScript type difinition.
+- 📦 Built-in Tampermonkey's TypeScript type definition.
 
 ## Install
 
@@ -110,17 +110,10 @@ interface UserscriptPluginConfig {
 }
 ```
 
-## Example
+## Examples
 
 See the [examples](https://github.com/crashmax-dev/vite-userscript-plugin/tree/master/examples) folder.
 
-## Used by
-
-- [vite-userscript-template](https://github.com/crashmax-dev/vite-userscript-template)
-- [netangels-userscript](https://github.com/crashmax-dev/netangels-userscript)
-- [godev-code-highlight](https://github.com/crashmax-dev/godev-code-highlight)
-- [beautifier-userscript](https://github.com/crashmax-dev/beautifier-userscript)
-
 ## License
 
 [MIT](./LICENCE) © [crashmax](https://github.com/crashmax-dev)

package/dist/index.cjs

@@ -1,5 +1,5 @@
 "use strict";var Z=Object.create;var b=Object.defineProperty;var ee=Object.getOwnPropertyDescriptor;var te=Object.getOwnPropertyNames;var re=Object.getPrototypeOf,ne=Object.prototype.hasOwnProperty;var oe=(e,r)=>{for(var t in r)b(e,t,{get:r[t],enumerable:!0})},T=(e,r,t,n)=>{if(r&&typeof r=="object"||typeof r=="function")for(let s of te(r))!ne.call(e,s)&&s!==t&&b(e,s,{get:()=>r[s],enumerable:!(n=ee(r,s))||n.enumerable});return e};var u=(e,r,t)=>(t=e!=null?Z(re(e)):{},T(r||!e||!e.__esModule?b(t,"default",{value:e,enumerable:!0}):t,e)),se=e=>T(b({},"__esModule",{value:!0}),e);var le={};oe(le,{default:()=>N});module.exports=se(le);var V=u(require("get-port"),1),c=require("fs"),D=require("http"),a=require("path"),K=require("url"),A=u(require("open"),1),M=u(require("picocolors"),1),H=u(require("sanitize-filename"),1),W=u(require("serve-handler"),1),q=require("vite"),B=require("websocket");var g=class{constructor(r){this.config=r;this.downloadMeta(),this.configKeys=Object.keys(this.config),this.maxKeyLength=Math.max(...this.configKeys.map(t=>t.length))+1}header=[];configKeys;maxKeyLength;downloadMeta(){let{name:r,homepage:t,updateURL:n,downloadURL:s}=this.config;t&&!n&&!s&&(this.config.updateURL=new URL(`${r}.meta.js`,t).href,this.config.downloadURL=new URL(`${r}.user.js`,t).href)}addSpaces(r){return" ".repeat(this.maxKeyLength-r.length)}addMetadata(r,t){let n=typeof t=="boolean";n&&!t||(t=n?"":`${this.addSpaces(r)}${t}`,this.header.push(`// @${r}${t}`))}generate(){for(let[r,t]of Object.entries(this.config))if(Array.isArray(t))t.forEach(n=>this.addMetadata(r,n));else{if(t===void 0)continue;this.addMetadata(r,t)}return["// ==UserScript==",...this.header,"// ==/UserScript=="].join(`
-`)}};function E({entry:e,header:r}){return{build:{lib:{entry:e,name:r.name,formats:["iife"],fileName:()=>`${r.name}.js`},rollupOptions:{output:{extend:!0}}}}}var F=new RegExp(/.(t|j)sx?/),L=new RegExp(/\.(s?css|sass)$/),ie=["setValue","getValue","deleteValue","listValues","setClipboard","addStyle","addElement","addValueChangeListener","removeValueChangeListener","registerMenuCommand","unregisterMenuCommand","download","getTab","getTabs","saveTab","openInTab","notification","getResourceURL","getResourceText","xmlhttpRequest","log","info"],ae=["unsafeWindow","window.onurlchange","window.focus","window.close"],h=ie.map(e=>[`GM_${e}`,`GM.${e}`]).flat();h.push(...ae);var O=require("vite");function U(e){return[...new Set(Array.isArray(e)?e:e?[e]:[])]}async function y({file:e,name:r,loader:t}){let{code:n}=await(0,O.transformWithEsbuild)(e,r,{loader:t,minify:!0,sourcemap:!1,legalComments:"none"});return n}function k(e){let r=[];for(let t of h)e.indexOf(t)!==-1&&r.push(t);return r}var _=class{styles=new Map;async add(r,t){let n=await y({file:r,name:t,loader:"css"});return this.styles.set(t,n.replace(`
-`,"")),""}inject(){return this.styles.size?`GM_addStyle(\`${[...this.styles.values()].join("")}\`)`:void 0}merge(r){let t=[];for(let n of r){let s=this.styles.get(n);!s||t.push([n,s])}this.styles.clear(),t.forEach(n=>this.styles.set(...n))}},j=new _;var ce={};function N(e){let r,t,n=null,s=(0,a.dirname)((0,K.fileURLToPath)(ce.url)),S=(0,q.createLogger)("info",{prefix:"[vite-userscript-plugin]",allowClearScreen:!0}),w=(0,D.createServer)((o,i)=>(0,W.default)(o,i,{public:r.build.outDir})),z=B.server;return new z({httpServer:w}).on("request",o=>{n=o.accept(null,o.origin)}),{name:"vite-userscript-plugin",apply:"build",config(){return E(e)},async configResolved(o){r=o,t=o.build.watch??!1,e.entry=(0,a.resolve)(o.root,e.entry),e.header.name=(0,H.default)(e.header.name),Array.from(["match","require","include","exclude","resource","connect"]).forEach(i=>{let p=e.header[i];e.header[i]=U(p)}),e.server={port:await(0,V.default)(),open:!1,...e.server}},async transform(o,i){let p=o;return L.test(i)&&(p=await j.add(o,i)),i.includes(e.entry)&&(p=o+"__STYLE__"),{code:p,map:null}},generateBundle(o,i){for(let[p,m]of Object.entries(i)){let f=Object.keys(m.modules).filter($=>L.test($));f.length&&j.merge(f)}},async writeBundle(o,i){let{open:p,port:m}=e.server,P=`${e.header.name}.user.js`,f=`${e.header.name}.proxy.user.js`,$=`${e.header.name}.meta.js`;for(let[d]of Object.entries(i))if(F.test(d)){let x=r.root,v=r.build.outDir,C=(0,a.resolve)(x,v,d),Y=(0,a.resolve)(x,v,P),I=(0,a.resolve)(x,v,f),J=(0,a.resolve)(x,v,$),R=(0,a.resolve)(s,`hot-reload-${e.header.name}.js`);try{let l=(0,c.readFileSync)(C,"utf8");if(l=l.replace("__STYLE__",`${j.inject()}`),l=await y({file:l,name:d,loader:"js"}),e.header.grant=U(t?h:[...k(l),...e.header.grant??[]]),t){let Q=(0,c.readFileSync)((0,a.resolve)(s,"hot-reload.js"),"utf8"),X=await y({file:Q.replace("__WS__",`ws://localhost:${m}`),name:R,loader:"js"});(0,c.writeFileSync)(R,X),(0,c.writeFileSync)(I,new g({...e.header,require:[...e.header.require,"file://"+R,"file://"+C]}).generate())}let G=new g(e.header).generate();(0,c.writeFileSync)(C,l),(0,c.writeFileSync)(J,G),(0,c.writeFileSync)(Y,`${G}
+`)}};function E({entry:e,header:r}){return{build:{lib:{entry:e,name:r.name,formats:["iife"],fileName:()=>`${r.name}.js`},rollupOptions:{output:{extend:!0}}}}}var F=new RegExp(/\.(t|j)sx?$/),L=new RegExp(/\.(s[ac]|c|le)ss$/),ie=["setValue","getValue","deleteValue","listValues","setClipboard","addStyle","addElement","addValueChangeListener","removeValueChangeListener","registerMenuCommand","unregisterMenuCommand","download","getTab","getTabs","saveTab","openInTab","notification","getResourceURL","getResourceText","xmlhttpRequest","log","info"],ae=["unsafeWindow","window.onurlchange","window.focus","window.close"],h=ie.map(e=>[`GM_${e}`,`GM.${e}`]).flat();h.push(...ae);var O=require("vite");function U(e){return[...new Set(Array.isArray(e)?e:e?[e]:[])]}async function y({file:e,name:r,loader:t}){let{code:n}=await(0,O.transformWithEsbuild)(e,r,{loader:t,minify:!0,sourcemap:!1,legalComments:"none"});return n}function k(e){let r=[];for(let t of h)e.indexOf(t)!==-1&&r.push(t);return r}var _=class{styles=new Map;async add(r,t){let n=await y({file:r,name:t,loader:"css"});return this.styles.set(t,n.replace(`
+`,"")),""}inject(){return this.styles.size?`GM_addStyle(\`${[...this.styles.values()].join("")}\`)`:void 0}merge(r){let t=[];for(let n of r){let s=this.styles.get(n);!s||t.push([n,s])}this.styles.clear(),t.forEach(n=>this.styles.set(...n))}},j=new _;var ce={};function N(e){let r,t,n=null,s=(0,a.dirname)((0,K.fileURLToPath)(ce.url)),$=(0,q.createLogger)("info",{prefix:"[vite-userscript-plugin]",allowClearScreen:!0}),w=(0,D.createServer)((o,i)=>(0,W.default)(o,i,{public:r.build.outDir})),z=B.server;return new z({httpServer:w}).on("request",o=>{n=o.accept(null,o.origin)}),{name:"vite-userscript-plugin",apply:"build",config(){return E(e)},async configResolved(o){r=o,t=o.build.watch??!1,e.entry=(0,a.resolve)(o.root,e.entry),e.header.name=(0,H.default)(e.header.name),Array.from(["match","require","include","exclude","resource","connect"]).forEach(i=>{let p=e.header[i];e.header[i]=U(p)}),e.server={port:await(0,V.default)(),open:!1,...e.server}},async transform(o,i){let p=o;return L.test(i)&&(p=await j.add(o,i)),i.includes(e.entry)&&(p=o+"__STYLE__"),{code:p,map:null}},generateBundle(o,i){for(let[p,m]of Object.entries(i)){let f=Object.keys(m.modules).filter(S=>L.test(S));f.length&&j.merge(f)}},async writeBundle(o,i){let{open:p,port:m}=e.server,P=`${e.header.name}.user.js`,f=`${e.header.name}.proxy.user.js`,S=`${e.header.name}.meta.js`;for(let[d]of Object.entries(i))if(F.test(d)){let x=r.root,v=r.build.outDir,C=(0,a.resolve)(x,v,d),Y=(0,a.resolve)(x,v,P),I=(0,a.resolve)(x,v,f),J=(0,a.resolve)(x,v,S),R=(0,a.resolve)(s,`hot-reload-${e.header.name}.js`);try{let l=(0,c.readFileSync)(C,"utf8");if(l=l.replace("__STYLE__",`${j.inject()}`),l=await y({file:l,name:d,loader:"js"}),e.header.grant=U(t?h:[...k(l),...e.header.grant??[]]),t){let Q=(0,c.readFileSync)((0,a.resolve)(s,"hot-reload.js"),"utf8"),X=await y({file:Q.replace("__WS__",`ws://localhost:${m}`),name:R,loader:"js"});(0,c.writeFileSync)(R,X),(0,c.writeFileSync)(I,new g({...e.header,require:[...e.header.require,"file://"+R,"file://"+C]}).generate())}let G=new g(e.header).generate();(0,c.writeFileSync)(C,l),(0,c.writeFileSync)(J,G),(0,c.writeFileSync)(Y,`${G}
 
-${l}`)}catch(l){console.log(l)}}if(t&&!w.listening){let d=`http://localhost:${m}`;w.listen(m,()=>{S.clearScreen("info"),S.info(M.default.blue(`Running at: ${M.default.gray(d)}`))}),p&&await(0,A.default)(`${d}/${f}`)}else t||(w.close(),process.exit(0))},buildEnd(){t&&(S.clearScreen("info"),n&&n.sendUTF(JSON.stringify({message:"reload"})))}}}0&&(module.exports={});
+${l}`)}catch(l){console.log(l)}}if(t&&!w.listening){let d=`http://localhost:${m}`;w.listen(m,()=>{$.clearScreen("info"),$.info(M.default.blue(`Running at: ${M.default.gray(d)}`))}),p&&await(0,A.default)(`${d}/${f}`)}else t||(w.close(),process.exit(0))},buildEnd(){t&&($.clearScreen("info"),n&&n.sendUTF(JSON.stringify({message:"reload"})))}}}0&&(module.exports={});

package/dist/index.js

@@ -1,5 +1,5 @@
 import q from"get-port";import{readFileSync as T,writeFileSync as h}from"fs";import{createServer as B}from"http";import{dirname as N,resolve as c}from"path";import{fileURLToPath as z}from"url";import Y from"open";import E from"picocolors";import I from"sanitize-filename";import J from"serve-handler";import{createLogger as Q}from"vite";import{server as X}from"websocket";var f=class{constructor(r){this.config=r;this.downloadMeta(),this.configKeys=Object.keys(this.config),this.maxKeyLength=Math.max(...this.configKeys.map(t=>t.length))+1}header=[];configKeys;maxKeyLength;downloadMeta(){let{name:r,homepage:t,updateURL:n,downloadURL:l}=this.config;t&&!n&&!l&&(this.config.updateURL=new URL(`${r}.meta.js`,t).href,this.config.downloadURL=new URL(`${r}.user.js`,t).href)}addSpaces(r){return" ".repeat(this.maxKeyLength-r.length)}addMetadata(r,t){let n=typeof t=="boolean";n&&!t||(t=n?"":`${this.addSpaces(r)}${t}`,this.header.push(`// @${r}${t}`))}generate(){for(let[r,t]of Object.entries(this.config))if(Array.isArray(t))t.forEach(n=>this.addMetadata(r,n));else{if(t===void 0)continue;this.addMetadata(r,t)}return["// ==UserScript==",...this.header,"// ==/UserScript=="].join(`
-`)}};function M({entry:e,header:r}){return{build:{lib:{entry:e,name:r.name,formats:["iife"],fileName:()=>`${r.name}.js`},rollupOptions:{output:{extend:!0}}}}}var P=new RegExp(/.(t|j)sx?/),C=new RegExp(/\.(s?css|sass)$/),A=["setValue","getValue","deleteValue","listValues","setClipboard","addStyle","addElement","addValueChangeListener","removeValueChangeListener","registerMenuCommand","unregisterMenuCommand","download","getTab","getTabs","saveTab","openInTab","notification","getResourceURL","getResourceText","xmlhttpRequest","log","info"],H=["unsafeWindow","window.onurlchange","window.focus","window.close"],u=A.map(e=>[`GM_${e}`,`GM.${e}`]).flat();u.push(...H);import{transformWithEsbuild as W}from"vite";function R(e){return[...new Set(Array.isArray(e)?e:e?[e]:[])]}async function g({file:e,name:r,loader:t}){let{code:n}=await W(e,r,{loader:t,minify:!0,sourcemap:!1,legalComments:"none"});return n}function G(e){let r=[];for(let t of u)e.indexOf(t)!==-1&&r.push(t);return r}var L=class{styles=new Map;async add(r,t){let n=await g({file:r,name:t,loader:"css"});return this.styles.set(t,n.replace(`
-`,"")),""}inject(){return this.styles.size?`GM_addStyle(\`${[...this.styles.values()].join("")}\`)`:void 0}merge(r){let t=[];for(let n of r){let l=this.styles.get(n);!l||t.push([n,l])}this.styles.clear(),t.forEach(n=>this.styles.set(...n))}},v=new L;function Z(e){let r,t,n=null,l=N(z(import.meta.url)),b=Q("info",{prefix:"[vite-userscript-plugin]",allowClearScreen:!0}),y=B((o,s)=>J(o,s,{public:r.build.outDir})),F=X;return new F({httpServer:y}).on("request",o=>{n=o.accept(null,o.origin)}),{name:"vite-userscript-plugin",apply:"build",config(){return M(e)},async configResolved(o){r=o,t=o.build.watch??!1,e.entry=c(o.root,e.entry),e.header.name=I(e.header.name),Array.from(["match","require","include","exclude","resource","connect"]).forEach(s=>{let a=e.header[s];e.header[s]=R(a)}),e.server={port:await q(),open:!1,...e.server}},async transform(o,s){let a=o;return C.test(s)&&(a=await v.add(o,s)),s.includes(e.entry)&&(a=o+"__STYLE__"),{code:a,map:null}},generateBundle(o,s){for(let[a,d]of Object.entries(s)){let m=Object.keys(d.modules).filter(j=>C.test(j));m.length&&v.merge(m)}},async writeBundle(o,s){let{open:a,port:d}=e.server,U=`${e.header.name}.user.js`,m=`${e.header.name}.proxy.user.js`,j=`${e.header.name}.meta.js`;for(let[p]of Object.entries(s))if(P.test(p)){let w=r.root,x=r.build.outDir,S=c(w,x,p),O=c(w,x,U),k=c(w,x,m),V=c(w,x,j),$=c(l,`hot-reload-${e.header.name}.js`);try{let i=T(S,"utf8");if(i=i.replace("__STYLE__",`${v.inject()}`),i=await g({file:i,name:p,loader:"js"}),e.header.grant=R(t?u:[...G(i),...e.header.grant??[]]),t){let D=T(c(l,"hot-reload.js"),"utf8"),K=await g({file:D.replace("__WS__",`ws://localhost:${d}`),name:$,loader:"js"});h($,K),h(k,new f({...e.header,require:[...e.header.require,"file://"+$,"file://"+S]}).generate())}let _=new f(e.header).generate();h(S,i),h(V,_),h(O,`${_}
+`)}};function M({entry:e,header:r}){return{build:{lib:{entry:e,name:r.name,formats:["iife"],fileName:()=>`${r.name}.js`},rollupOptions:{output:{extend:!0}}}}}var P=new RegExp(/\.(t|j)sx?$/),C=new RegExp(/\.(s[ac]|c|le)ss$/),A=["setValue","getValue","deleteValue","listValues","setClipboard","addStyle","addElement","addValueChangeListener","removeValueChangeListener","registerMenuCommand","unregisterMenuCommand","download","getTab","getTabs","saveTab","openInTab","notification","getResourceURL","getResourceText","xmlhttpRequest","log","info"],H=["unsafeWindow","window.onurlchange","window.focus","window.close"],u=A.map(e=>[`GM_${e}`,`GM.${e}`]).flat();u.push(...H);import{transformWithEsbuild as W}from"vite";function R(e){return[...new Set(Array.isArray(e)?e:e?[e]:[])]}async function g({file:e,name:r,loader:t}){let{code:n}=await W(e,r,{loader:t,minify:!0,sourcemap:!1,legalComments:"none"});return n}function G(e){let r=[];for(let t of u)e.indexOf(t)!==-1&&r.push(t);return r}var L=class{styles=new Map;async add(r,t){let n=await g({file:r,name:t,loader:"css"});return this.styles.set(t,n.replace(`
+`,"")),""}inject(){return this.styles.size?`GM_addStyle(\`${[...this.styles.values()].join("")}\`)`:void 0}merge(r){let t=[];for(let n of r){let l=this.styles.get(n);!l||t.push([n,l])}this.styles.clear(),t.forEach(n=>this.styles.set(...n))}},v=new L;function Z(e){let r,t,n=null,l=N(z(import.meta.url)),b=Q("info",{prefix:"[vite-userscript-plugin]",allowClearScreen:!0}),y=B((o,s)=>J(o,s,{public:r.build.outDir})),F=X;return new F({httpServer:y}).on("request",o=>{n=o.accept(null,o.origin)}),{name:"vite-userscript-plugin",apply:"build",config(){return M(e)},async configResolved(o){r=o,t=o.build.watch??!1,e.entry=c(o.root,e.entry),e.header.name=I(e.header.name),Array.from(["match","require","include","exclude","resource","connect"]).forEach(s=>{let a=e.header[s];e.header[s]=R(a)}),e.server={port:await q(),open:!1,...e.server}},async transform(o,s){let a=o;return C.test(s)&&(a=await v.add(o,s)),s.includes(e.entry)&&(a=o+"__STYLE__"),{code:a,map:null}},generateBundle(o,s){for(let[a,d]of Object.entries(s)){let m=Object.keys(d.modules).filter(j=>C.test(j));m.length&&v.merge(m)}},async writeBundle(o,s){let{open:a,port:d}=e.server,U=`${e.header.name}.user.js`,m=`${e.header.name}.proxy.user.js`,j=`${e.header.name}.meta.js`;for(let[p]of Object.entries(s))if(P.test(p)){let w=r.root,x=r.build.outDir,$=c(w,x,p),O=c(w,x,U),k=c(w,x,m),V=c(w,x,j),S=c(l,`hot-reload-${e.header.name}.js`);try{let i=T($,"utf8");if(i=i.replace("__STYLE__",`${v.inject()}`),i=await g({file:i,name:p,loader:"js"}),e.header.grant=R(t?u:[...G(i),...e.header.grant??[]]),t){let D=T(c(l,"hot-reload.js"),"utf8"),K=await g({file:D.replace("__WS__",`ws://localhost:${d}`),name:S,loader:"js"});h(S,K),h(k,new f({...e.header,require:[...e.header.require,"file://"+S,"file://"+$]}).generate())}let _=new f(e.header).generate();h($,i),h(V,_),h(O,`${_}
 
 ${i}`)}catch(i){console.log(i)}}if(t&&!y.listening){let p=`http://localhost:${d}`;y.listen(d,()=>{b.clearScreen("info"),b.info(E.blue(`Running at: ${E.gray(p)}`))}),a&&await Y(`${p}/${m}`)}else t||(y.close(),process.exit(0))},buildEnd(){t&&(b.clearScreen("info"),n&&n.sendUTF(JSON.stringify({message:"reload"})))}}}export{Z as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-userscript-plugin",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.cjs",
@@ -11,7 +11,7 @@
   },
   "files": [
     "dist",
-    "tampermonkey.d.ts"
+    "types"
   ],
   "repository": {
     "type": "git",
@@ -48,13 +48,13 @@
     "@types/node": "^18.7.18",
     "@types/serve-handler": "^6.1.1",
     "@types/websocket": "^1.0.5",
-    "@vitest/ui": "^0.23.2",
+    "@vitest/ui": "^0.23.4",
     "tsup": "^6.2.3",
     "turbo": "^1.4.7",
     "typescript": "^4.8.3",
     "vite": "^3.1.2",
     "vite-plugin-dts": "^1.5.0",
-    "vitest": "^0.23.2"
+    "vitest": "^0.23.4"
   },
   "peerDependencies": {
     "vite": ">=2.9.0"

package/types/README.md

@@ -0,0 +1,21 @@
+# Userscript type definitions
+
+[![tampermonkey](https://img.shields.io/npm/v/@types/tampermonkey?label=%40types%2Ftampermonkey)](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/tampermonkey)
+[![greasemonkey](https://img.shields.io/npm/v/@types/greasemonkey?label=%40types%2Fgreasemonkey)](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/greasemonkey)
+[![violentmonkey](https://img.shields.io/npm/v/@violentmonkey/types?label=%40violentmonkey%2Ftypes)](https://github.com/violentmonkey/types)
+
+> Type declaration for `GM_*`, `GM.*` APIs in Tampermonkey, Greasemonkey and Violentmonkey.
+
+## Installation
+
+```sh
+npm install --save @types/tampermonkey
+```
+
+```sh
+npm install --save @types/greasemonkey
+```
+
+```sh
+npm install --save @violentmonkey/types
+```

package/types/greasemonkey.d.ts

@@ -0,0 +1,314 @@
+// Type definitions for Greasemonkey 4.x
+// Project: http://www.greasespot.net/
+// Definitions by: Kota Saito <https://github.com/kotas>
+//                 Nikolay Borzov <https://github.com/nikolay-borzov>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// This definition is based on the API reference of Greasemonkey
+// https://wiki.greasespot.net/Greasemonkey_Manual:API
+// TypeScript Version: 3.2
+
+declare namespace GM {
+  interface ScriptInfo {
+    /** Possibly empty string. */
+    description: string
+    excludes: string[]
+    includes: string[]
+    matches: string[]
+    name: string
+    /** Possibly empty string. */
+    namespace: string
+    /**
+     * An object keyed by resource name.
+     * Each value is an object with keys `name` and `mimetype` and `url`
+     * with string values.
+     */
+    resources: {
+      [resourceName: string]: {
+        name: string
+        mimetype: string
+        url: string
+      }
+    }
+    /** @default 'end' */
+    runAt: 'start' | 'end' | 'idle'
+    uuid: string
+    /** Possibly empty string. */
+    version: string
+  }
+
+  type Value = string | boolean | number
+
+  interface Response<TContext> {
+    readonly responseHeaders: string
+    readonly finalUrl: string
+    /** The same object passed into the original request */
+    readonly context?: TContext | undefined
+
+    readonly readyState: 1 | 2 | 3 | 4
+    readonly response: any
+    readonly responseText: string
+    readonly responseXML: Document | false
+    readonly status: number
+    readonly statusText: string
+  }
+
+  interface ProgressResponse<TContext> extends Response<TContext> {
+    lengthComputable: boolean
+    loaded: number
+    total: number
+  }
+
+  interface Request<TContext = any> {
+    // Fields
+
+    /**
+     * The URL to make the request to. Must be an absolute URL, beginning
+     * with the scheme. May be relative to the current page.
+     */
+    url: string
+    /** String type of HTTP request to make (E.G. "GET", "POST") */
+    method:
+      | 'GET'
+      | 'POST'
+      | 'PUT'
+      | 'DELETE'
+      | 'PATCH'
+      | 'HEAD'
+      | 'TRACE'
+      | 'OPTIONS'
+      | 'CONNECT'
+    /**
+     * When true, the data is sent as a Blob
+     * @default false
+     */
+    binary?: boolean | undefined
+    /**
+     * Any object (Compatibility: 1.10+). This object will also be the
+     * context property of the Response Object.
+     */
+    context?: TContext | undefined
+    /**
+     * Data to send in the request body. Usually for POST method requests.
+     * If the data field contains form-encoded data, you usually must also
+     * set the header `'Content-Type': 'application/x-www-form-urlencoded'`
+     * in the `headers` field.
+     */
+    data?: string | undefined
+    /** A set of headers to include in the request */
+    headers?:
+      | {
+          [header: string]: string
+        }
+      | undefined
+    /**
+     * A MIME type to specify with the request (e.g.
+     * "text/html; charset=ISO-8859-1")
+     */
+    overrideMimeType?: string | undefined
+    /** User name to use for authentication purposes. */
+    user?: string | undefined
+    /** Password to use for authentication purposes */
+    password?: string | undefined
+    /** Decode the response as specified type. Default value is "text" */
+    responseType?: XMLHttpRequestResponseType | undefined
+    /**
+     * When `true`, this is a synchronous request.
+     * Be careful: The entire Firefox UI will be locked and frozen until the
+     * request completes.In this mode, more data will be available in the
+     * return value.
+     */
+    synchronous?: boolean | undefined
+    /**
+     * The number of milliseconds to wait before terminating the call. Zero
+     * (the default) means wait forever.
+     */
+    timeout?: number | undefined
+    /**
+     * Object containing optional function callbacks to monitor the upload
+     * of data.
+     */
+    upload?:
+      | {
+          onabort?(response: Response<TContext>): void
+          onerror?(response: Response<TContext>): void
+          onload?(response: Response<TContext>): void
+          onprogress?(response: ProgressResponse<TContext>): void
+        }
+      | undefined
+
+    // Event handlers
+
+    /** Will be called when the request is aborted */
+    onabort?(response: Response<TContext>): void
+    /** Will be called if an error occurs while processing the request */
+    onerror?(response: Response<TContext>): void
+    /** Will be called when the request has completed successfully */
+    onload?(response: Response<TContext>): void
+    /** Will be called when the request progress changes */
+    onprogress?(response: ProgressResponse<TContext>): void
+    /** Will be called repeatedly while the request is in progress */
+    onreadystatechange?(response: Response<TContext>): void
+    /** Will be called if/when the request times out */
+    ontimeout?(response: Response<TContext>): void
+  }
+}
+
+/**
+ * Window object of the content page where the user script is running on.
+ * @see {@link http://wiki.greasespot.net/UnsafeWindow}
+ */
+declare var unsafeWindow: Window
+
+declare var GM: {
+  // Headers
+
+  /**
+   * Meta data about the running user script.
+   * @see {@link https://wiki.greasespot.net/GM.info}
+   */
+  info: {
+    /** An object containing data about the currently running script */
+    script: GM.ScriptInfo
+    /**
+     * A string, the entire literal Metadata Block (without the delimiters)
+     * for the currently running script
+     */
+    scriptMetaStr: string
+    /**
+     * The name of the user script engine handling this script's execution.
+     * The string `Greasemonkey`
+     */
+    scriptHandler: string
+    /** The version of Greasemonkey, a string e.g. `4.0` */
+    version: string
+  }
+
+  // Values
+
+  /**
+   * Allows user script authors to persist simple values across page loads and
+   * across origins.
+   * Strings, booleans, and integers are currently the only allowed data types.
+   * @see {@link https://wiki.greasespot.net/GM.setValue}
+   * @param name The unique (within this script) name for this value.
+   * Should be restricted to valid Javascript identifier characters.
+   * @param value Any valid value of these types. Any other type may cause
+   * undefined behavior, including crashes
+   * @returns A Promise, resolved successfully with no value on success,
+   * rejected with no value on failure
+   */
+  setValue(name: string, value: GM.Value): Promise<void>
+
+  /**
+   * Retrieves a value that was set with `GM.setValue`
+   * @see {@link https://wiki.greasespot.net/GM.getValue}
+   * @param name The property name to get
+   * @param defaultValue The default value to be returned when none has
+   * previously been set
+   * @returns A Promise, rejected in case of error and otherwise resolved with:
+   * - When this name has been set - `string`, `integer` or `boolean` as
+   * previously set
+   * - When this name has not been set, and default is provided - The value
+   * passed as default
+   * - When this name has not been set, and default is not provided -
+   * `undefined`
+   * @example
+   * // Retrieving the value associated with the name 'timezoneOffset' with a default value defined:
+   * const timezoneOffset = await GM.getValue("timezoneOffset", -5)
+   * @example
+   * // For structured data used `JSON.stringify()` to place an object into storage and then `JSON.parse()` to convert it back
+   * const storedObject = JSON.parse(await GM.getValue('foo', '{}'));
+   */
+  getValue(name: string): Promise<GM.Value | undefined>
+  getValue<TValue = GM.Value>(
+    name: string,
+    defaultValue: TValue
+  ): Promise<TValue>
+
+  /**
+   * Deletes an existing name / value pair from storage.
+   * @see {@link https://wiki.greasespot.net/GM.deleteValue}
+   * @param name Property name to delete
+   * @returns A Promise, resolved successfully with no value on success,
+   * rejected with no value on failure.
+   */
+  deleteValue(name: string): Promise<void>
+
+  /**
+   * Retrieves an array of preference names that this script has stored
+   * @see {@link https://wiki.greasespot.net/GM.listValues}
+   * @returns A Promise, rejected in case of error and otherwise resolved with
+   * an string[] for previously set values
+   */
+  listValues(): Promise<string[]>
+
+  // Resources
+
+  /**
+   * Given a defined `@resource`, this method returns it as a URL
+   * @see {@link https://wiki.greasespot.net/GM.getResourceUrl}
+   * @param resourceName The name provided when the `@resource` was defined
+   * @returns A Promise, rejected on failure and resolved with a string URL on
+   * success.
+   * Treat the result as opaque string. It will work where you need a URL
+   * (for a `<link>` or `<style>` for CSS, for an `<img>` tag, or similar).
+   */
+  getResourceUrl(resourceName: string): Promise<string>
+
+  // Other
+
+  /**
+   * Displays a notification to the user, using the underlying operating
+   * system's notification mechanism
+   * @see {@link https://wiki.greasespot.net/GM.notification}
+   * @param text The main notification text
+   * @param title The title of the notification
+   * @param image The URL for an image to display in the dialog. If not
+   * provided, the Greasemonkey logo by default.
+   * @param onClick Callback, triggered when the notification's button is
+   * clicked.
+   */
+  notification(
+    text: string,
+    title: string,
+    image?: string,
+    onClick?: () => void
+  ): void
+
+  /**
+   * Opens the specified URL in a new tab.
+   * @see {@link https://wiki.greasespot.net/GM.openInTab}
+   * @param url The URL to navigate the new tab to
+   * @param openInBackground Force tab to/to not open in a background tab.
+   * Default (unspecified) behavior honors Firefox configuration.
+   */
+  openInTab(url: string, openInBackground?: boolean): void
+
+  /**
+   * Adds an item to the User Script Commands menu.
+   * @param caption The caption to display on the menu item.
+   * @param commandFunc The function to call when the menu item is selected.
+   * @param accessKey A single character that can be used to select the
+   * item when the menu is open. It should be a letter in the caption.
+   * @see {@link https://wiki.greasespot.net/GM.registerMenuCommand}
+   */
+  registerMenuCommand(
+    caption: string,
+    commandFunc: () => void,
+    accessKey?: string
+  ): void
+
+  /**
+   * Sets the current contents of the operating system's clipboard
+   * @see {@link https://wiki.greasespot.net/GM.setClipboard}
+   */
+  setClipboard(text: string): void
+
+  /**
+   * Performs a similar function to the standard XMLHttpRequest object, but
+   * allows these requests to cross the [same origin policy]{@link https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy} boundaries.
+   * @see {@link https://wiki.greasespot.net/GM.xmlHttpRequest}
+   */
+  xmlHttpRequest(details: GM.Request): void
+}

package/types/violentmonkey.d.ts

@@ -0,0 +1,376 @@
+declare const unsafeWindow: Window
+
+declare type VMScriptRunAt =
+  | 'document-start'
+  | 'document-body'
+  | 'document-end'
+  | 'document-idle'
+
+/** Injection mode of a script. */
+declare type VMScriptInjectInto = 'auto' | 'page' | 'content'
+
+declare interface VMScriptGMInfoPlatform {
+  arch: 'arm' | 'arm64' | 'x86-32' | 'x86-64' | 'mips' | 'mips64'
+  /** `chrome`, `firefox` or whatever was returned by the API. */
+  browserName: string
+  browserVersion: string
+  os: 'mac' | 'win' | 'android' | 'cros' | 'linux' | 'openbsd' | 'fuchsia'
+}
+
+declare interface VMScriptGMInfoScriptMeta {
+  description: string
+  excludes: string[]
+  includes: string[]
+  matches: string[]
+  name: string
+  namespace: string
+  resources: Array<{ name: string; url: string }>
+  runAt: VMScriptRunAt
+  version: string
+}
+
+declare interface VMScriptGMInfoObject {
+  /** Unique ID of the script. */
+  uuid: string
+  /** The meta block of the script. */
+  scriptMetaStr: string
+  /** Whether the script will be updated automatically. */
+  scriptWillUpdate: boolean
+  /** The name of userscript manager, which should be the string `Violentmonkey`. */
+  scriptHandler: string
+  /** Version of Violentmonkey. */
+  version: string
+  /**
+   * Unlike `navigator.userAgent`, which can be overriden by other extensions/userscripts
+   * or by devtools in device-emulation mode, `GM_info.platform` is more reliable as the
+   * data is obtained in the background page of Violentmonkey using a specialized
+   * extension API (`browser.runtime.getPlatformInfo` and `getBrowserInfo`).
+   */
+  platform: VMScriptGMInfoPlatform
+  /** Contains structured fields from the *Metadata Block*. */
+  script: VMScriptGMInfoScriptMeta
+  /** The injection mode of current script. */
+  injectInto: VMScriptInjectInto
+}
+
+/**
+ * An object that exposes information about the current userscript.
+ */
+declare const GM_info: VMScriptGMInfoObject
+
+/** Retrieves a value for current script from storage. */
+declare function GM_getValue<T>(name: string, defaultValue?: T): T
+/** Sets a key / value pair for current script to storage. */
+declare function GM_setValue<T>(name: string, value: T): void
+/** Deletes an existing key / value pair for current script from storage. */
+declare function GM_deleteValue(name: string): void
+/** Returns an array of keys of all available values within this script. */
+declare function GM_listValues(): string[]
+
+declare type VMScriptGMValueChangeCallback<T> = (
+  /** The name of the observed variable */
+  name: string,
+  /** The old value of the observed variable (`undefined` if it was created) */
+  oldValue: T,
+  /** The new value of the observed variable (`undefined` if it was deleted) */
+  newValue: T,
+  /** `true` if modified by the userscript instance of another tab or `false` for this script instance. Can be used by scripts of different browser tabs to communicate with each other. */
+  remote: boolean
+) => void
+
+/** Adds a change listener to the storage and returns the listener ID. */
+declare function GM_addValueChangeListener<T>(
+  name: string,
+  callback: VMScriptGMValueChangeCallback<T>
+): string
+/** Removes a change listener by its ID. */
+declare function GM_removeValueChangeListener(listenerId: string): void
+
+/** Retrieves a text resource from the *Metadata Block*. */
+declare function GM_getResourceText(
+  /** Name of a resource defined in the *Metadata Block*. */
+  name: string
+): string
+/**
+ * Retrieves a `blob:` or `data:` URL of a resource from the *Metadata Block*.
+ *
+ * Note: when setting this URL as `src` or `href` of a DOM element, it may fail on some sites with a particularly strict CSP that forbids `blob:` or `data:` URLs. Such sites are rare though. The workaround in Chrome is to use `GM_addElement`, whereas in Firefox you'll have to disable CSP either globally via `about:config` or by using an additional extension that modifies HTTP headers selectively.
+ */
+declare function GM_getResourceURL(
+  /** Name of a resource defined in the *Metadata Block*. */
+  name: string,
+  /**
+   * - If `true`, returns a `blob:` URL. It's short and cacheable, so it's good for reusing in multiple DOM elements.
+   * - If `false`, returns a `data:` URL. It's long so reusing it in DOM may be less performant due to the lack of caching, but it's particularly handy for direct synchronous decoding of the data on sites that forbid fetching `blob:` in their CSP.
+   */
+  isBlobUrl?: boolean
+): string
+
+/**
+ * Appends and returns an element with the specified attributes.
+ *
+ * Examples:
+ *
+ * ```js
+ * // using a private function in `onload`
+ * let el = GM_addElement('script', { src: 'https://....' });
+ * el.onload = () => console.log('loaded', el);
+ *
+ * // same as GM_addStyle('a { color:red }')
+ * let el = GM_addElement('style', { textContent: 'a { color:red }' });
+ *
+ * // appending to an arbitrary node
+ * let el = GM_addElement(parentElement.shadowRoot, 'iframe', { src: url });
+ * ```
+ */
+declare function GM_addElement(
+  /** A tag name like `script`. Any valid HTML tag can be used, but the only motivation for this API was to add `script`, `link`, `style` elements when they are disallowed by a strict `Content-Security-Policy` of the site e.g. github.com, twitter.com. */
+  tagName: string,
+  /** The keys are HTML attributes, not DOM properties, except `textContent` which sets DOM property `textContent`. The values are strings so if you want to assign a private function to `onload` you can do it after the element is created. */
+  attributes?: Record<string, string>
+): HTMLElement
+declare function GM_addElement(
+  /**
+   * The parent node to which the new node will be appended.
+   * It can be inside ShadowDOM: `someElement.shadowRoot`.
+   * When omitted, it'll be determined automatically:
+   *
+   * - `document.head` (`<head>`) for `script`, `link`, `style`, `meta` tags.
+   * - `document.body` (`<body>`) for other tags or when there's no `<head>`.
+   * - `document.documentElement` (`<html>` or an XML root node) otherwise.
+   */
+  parentNode: HTMLElement,
+  /** A tag name like `script`. Any valid HTML tag can be used, but the only motivation for this API was to add `script`, `link`, `style` elements when they are disallowed by a strict `Content-Security-Policy` of the site e.g. github.com, twitter.com. */
+  tagName: string,
+  /** The keys are HTML attributes, not DOM properties, except `textContent` which sets DOM property `textContent`. The values are strings so if you want to assign a private function to `onload` you can do it after the element is created. */
+  attributes?: Record<string, string>
+): HTMLElement
+
+/** Appends and returns a `<style>` element with the specified CSS. */
+declare function GM_addStyle(css: string): HTMLStyleElement
+
+declare interface VMScriptGMTabControl {
+  /** Сan be assigned to a function. If provided, it will be called when the opened tab is closed. */
+  onclose?: () => void
+  /** Whether the opened tab is closed. */
+  closed: boolean
+  /** A function to explicitly close the opened tab. */
+  close: () => void
+}
+
+declare interface VMScriptGMTabOptions {
+  /** Make the new tab active (i.e. open in foreground). Default as `true`. */
+  active?: boolean
+  /**
+   * Firefox only.
+   *
+   * - not specified = reuse script's tab container
+   * - `0` = default (main) container
+   * - `1`, `2`, etc. = internal container index
+   */
+  container?: number
+  /** Insert the new tab next to the current tab and set its `openerTab` so when it's closed the original tab will be focused automatically. When `false` or not specified, the usual browser behavior is to open the tab at the end of the tab list. Default as `true`. */
+  insert?: boolean
+  /** Pin the tab (i.e. show without a title at the beginning of the tab list). Default as `false`. */
+  pinned?: boolean
+}
+
+/** Opens URL in a new tab. */
+declare function GM_openInTab(
+  /** The URL to open in a new tab. URL relative to current page is also allowed. Note: Firefox does not support data URLs. */
+  url: string,
+  options?: VMScriptGMTabOptions
+): VMScriptGMTabControl
+declare function GM_openInTab(
+  /** The URL to open in a new tab. URL relative to current page is also allowed. Note: Firefox does not support data URLs. */
+  url: string,
+  /** Open the tab in background. Note, this is a reverse of the first usage method so for example `true` is the same as `{ active: false }`. */
+  openInBackground?: boolean
+): VMScriptGMTabControl
+
+/**
+ * Registers a command in Violentmonkey popup menu.
+ * If you want to add a shortcut, please see `@violentmonkey/shortcut`.
+ */
+declare function GM_registerMenuCommand(
+  /** The name to show in the popup menu. */
+  caption: string,
+  /** Callback function when the command is clicked in the menu. */
+  onClick: (event: MouseEvent) => void
+): string
+/** Unregisters a command which has been registered to Violentmonkey popup menu. */
+declare function GM_unregisterMenuCommand(
+  /** The name of command to unregister. */
+  caption: string
+): void
+
+/**
+ * A control object returned by `GM_notification`.
+ * `control.remove()` can be used to remove the notification.
+ */
+declare interface VMScriptGMNotificationControl {
+  /** Remove the notification immediately. */
+  remove: () => Promise<void>
+}
+
+declare interface VMScriptGMNotificationOptions {
+  /** Main text of the notification. */
+  text: string
+  /** Title of the notification. */
+  title?: string
+  /** URL of an image to show in the notification. */
+  image?: string
+  /** Callback when the notification is clicked by user. */
+  onclick?: () => void
+  /** Callback when the notification is closed, either by user or by system. */
+  ondone?: () => void
+}
+
+/** Shows an HTML5 desktop notification. */
+declare function GM_notification(
+  options: VMScriptGMNotificationOptions
+): VMScriptGMNotificationControl
+declare function GM_notification(
+  /** Main text of the notification. */
+  text: string,
+  /** Title of the notification. */
+  title?: string,
+  /** URL of an image to show in the notification. */
+  image?: string,
+  /** Callback when the notification is clicked by user. */
+  onclick?: () => void
+): VMScriptGMNotificationControl
+
+/** Sets data to system clipboard. */
+declare function GM_setClipboard(
+  /** The data to be copied to system clipboard. */
+  data: string,
+  /** The MIME type of data to copy. Default as `text/plain`. */
+  type?: string
+): void
+
+/**
+ * A control object returned by `GM_xmlhttpRequest`.
+ * `control.abort()` can be used to abort the request.
+ */
+declare interface VMScriptXHRControl {
+  abort: () => void
+}
+
+declare type VMScriptResponseType =
+  | 'text'
+  | 'json'
+  | 'blob'
+  | 'arraybuffer'
+  | 'document'
+
+declare interface VMScriptResponseObject<T> {
+  status: number
+  statusText: string
+  readyState: number
+  responseHeaders: string
+  response: T
+  responseText: string | null
+  /** The final URL after redirection. */
+  finalUrl: string
+  /** The same `context` object you specified in `details`. */
+  context?: unknown
+}
+
+declare interface VMScriptGMXHRDetails<T> {
+  /** URL relative to current page is also allowed. */
+  url: string
+  /** HTTP method, default as `GET`. */
+  method?: string
+  /** User for authentication. */
+  user?: string
+  /** Password for authentication. */
+  password?: string
+  /** A MIME type to specify with the request. */
+  overrideMimeType?: string
+  /**
+   * Some special headers are also allowed:
+   *
+   * - `Cookie`
+   * - `Host`
+   * - `Origin`
+   * - `Referer`
+   * - `User-Agent`
+   */
+  headers?: Record<string, string>
+  /**
+   * One of the following:
+   *
+   * - `text` (default value)
+   * - `json`
+   * - `blob`
+   * - `arraybuffer`
+   * - `document`
+   */
+  responseType?: VMScriptResponseType
+  /** Time to wait for the request, none by default. */
+  timeout?: number
+  /** Data to send with the request, usually for `POST` and `PUT` requests. */
+  data?: string | FormData | Blob
+  /** Send the `data` string as a `blob`. This is for compatibility with Tampermonkey/Greasemonkey, where only `string` type is allowed in `data`. */
+  binary?: boolean
+  /** Can be an object and will be assigned to context of the response object. */
+  context?: unknown
+  /** When set to `true`, no cookie will be sent with the request and the response cookies will be ignored. The default value is `false`. */
+  anonymous?: boolean
+  onabort?: (resp: VMScriptResponseObject<T>) => void
+  onerror?: (resp: VMScriptResponseObject<T>) => void
+  onload?: (resp: VMScriptResponseObject<T>) => void
+  onloadend?: (resp: VMScriptResponseObject<T>) => void
+  onloadstart?: (resp: VMScriptResponseObject<T>) => void
+  onprogress?: (resp: VMScriptResponseObject<T>) => void
+  onreadystatechange?: (resp: VMScriptResponseObject<T>) => void
+  ontimeout?: (resp: VMScriptResponseObject<T>) => void
+}
+
+/** Makes a request like XMLHttpRequest, with some special capabilities, not restricted by same-origin policy. */
+declare function GM_xmlhttpRequest<T>(
+  details: VMScriptGMXHRDetails<T>
+): VMScriptXHRControl
+
+declare interface VMScriptGMDownloadOptions {
+  /** The URL to download. */
+  url: string
+  /** The filename to save as. */
+  name?: string
+  /** The function to call when download starts successfully. */
+  onload?: () => void
+  headers?: Record<string, string>
+  timeout?: number
+  onerror?: (resp: VMScriptResponseObject<Blob>) => void
+  onprogress?: (resp: VMScriptResponseObject<Blob>) => void
+  ontimeout?: (resp: VMScriptResponseObject<Blob>) => void
+}
+
+/** Downloads a URL to a local file. */
+declare function GM_download(options: VMScriptGMDownloadOptions): void
+declare function GM_download(
+  /** The URL to download. */
+  url: string,
+  /** The filename to save as. */
+  name?: string
+): void
+
+declare interface VMScriptGMObject {
+  unsafeWindow: Window
+  info: typeof GM_info
+  getValue: <T>(name: string, defaultValue?: T) => Promise<T>
+  setValue: <T>(name: string, value: T) => Promise<void>
+  deleteValue: (name: string) => Promise<void>
+  listValues: () => Promise<string[]>
+  addStyle: typeof GM_addStyle
+  addElement: typeof GM_addElement
+  registerMenuCommand: typeof GM_registerMenuCommand
+  getResourceUrl: (name: string, isBlobUrl?: boolean) => Promise<string>
+  notification: typeof GM_notification
+  openInTab: typeof GM_openInTab
+  setClipboard: typeof GM_setClipboard
+  xmlHttpRequest: typeof GM_xmlhttpRequest
+}
+
+declare const GM: VMScriptGMObject