vite-userscript-plugin 1.3.0 → 1.4.0

package/README.md

@@ -12,6 +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.
 
 ## Install
 
@@ -36,21 +37,23 @@ import { defineConfig } from 'vite'
 import Userscript from 'vite-userscript-plugin'
 import { name, version } from './package.json'
 
-export default defineConfig({
-  plugins: [
-    Userscript({
-      entry: 'src/index.ts',
-      header: {
-        name,
-        version,
-        match: [
-          'https://example.com',
-          'https://example.org',
-          'https://example.edu'
-        ]
-      }
-    })
-  ]
+export default defineConfig((config) => {
+  return {
+    plugins: [
+      Userscript({
+        entry: 'src/index.ts',
+        header: {
+          name,
+          version,
+          match: [
+            '*://example.com',
+            '*://example.org',
+            '*://example.edu'
+          ]
+        }
+      })
+    ]
+  }
 })
 ```
 
@@ -65,6 +68,18 @@ export default defineConfig({
 }
 ```
 
+### `tsconfig.json`
+
+```json
+{
+  "compilerOptions": {
+    "types": [
+      "vite-userscript-plugin/tampermonkey"
+    ]
+  }
+}
+```
+
 ## Plugin Configuration
 
 ```ts

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});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(`
+`)}};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}
 
 ${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={});

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});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(`
+`)}};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,`${_}
 
 ${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.3.0",
+  "version": "1.4.0",
   "type": "module",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.cjs",
@@ -10,7 +10,8 @@
     "import": "./dist/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "tampermonkey.d.ts"
   ],
   "repository": {
     "type": "git",
@@ -34,7 +35,6 @@
     "url": "https://github.com/crashmax-dev/vite-userscript-plugin/issues"
   },
   "dependencies": {
-    "@types/tampermonkey": "^4.0.5",
     "get-port": "^6.1.2",
     "open": "^8.4.0",
     "picocolors": "^1.0.0",
@@ -50,14 +50,13 @@
     "@types/websocket": "^1.0.5",
     "@vitest/ui": "^0.23.2",
     "tsup": "^6.2.3",
-    "turbo": "^1.4.6",
+    "turbo": "^1.4.7",
     "typescript": "^4.8.3",
-    "vite": "^3.1.1",
+    "vite": "^3.1.2",
     "vite-plugin-dts": "^1.5.0",
     "vitest": "^0.23.2"
   },
   "peerDependencies": {
-    "@types/tampermonkey": ">=4.0.0",
     "vite": ">=2.9.0"
   },
   "scripts": {

package/tampermonkey.d.ts

@@ -0,0 +1,711 @@
+// Type definitions for non-npm package Tampermonkey 4.x
+// Project: https://tampermonkey.net
+// Definitions by: Steven Wang <https://github.com/silverwzw>
+//                 Nikolay Borzov <https://github.com/nikolay-borzov>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+// This definition is based on the API reference of Tampermonkey
+// https://tampermonkey.net/documentation.php
+// TypeScript Version: 3.3
+
+declare namespace Tampermonkey {
+  type ValueChangeListener = (
+    name: string,
+    oldValue: any,
+    newValue: any,
+    remote: boolean
+  ) => void
+
+  // Response
+
+  enum ReadyState {
+    Unsent = 0,
+    Opened = 1,
+    HeadersReceived = 2,
+    Loading = 3,
+    Done = 4
+  }
+
+  interface ResponseBase {
+    readonly responseHeaders: string
+    readonly readyState: ReadyState
+    readonly response: any
+    readonly responseText: string
+    readonly responseXML: Document | null
+    readonly status: number
+    readonly statusText: string
+  }
+
+  interface ProgressResponseBase {
+    done: number
+    lengthComputable: boolean
+    loaded: number
+    position: number
+    total: number
+    totalSize: number
+  }
+
+  interface ErrorResponse extends ResponseBase {
+    readonly error: string
+  }
+
+  interface Response<TContext> extends ResponseBase {
+    readonly finalUrl: string
+    readonly context: TContext
+  }
+
+  interface ProgressResponse<TContext>
+    extends Response<TContext>,
+      ProgressResponseBase {}
+
+  // Request
+
+  interface RequestHeaders {
+    readonly [header: string]: string
+  }
+
+  type RequestEventListener<TResponse> = (
+    this: TResponse,
+    response: TResponse
+  ) => void
+
+  type RequestMethods =
+    | 'POST'
+    | 'GET'
+    | 'PUT'
+    | 'PATCH'
+    | 'DELETE'
+    | 'HEAD'
+    | 'TRACE'
+    | 'OPTIONS'
+    | 'CONNECT'
+
+  interface Request<TContext = object> {
+    method?: RequestMethods
+    /** Destination URL */
+    url: string
+    /**
+     * i.e. user-agent, referer... (some special headers are not supported
+     * by Safari and Android browsers)
+     */
+    headers?: RequestHeaders | undefined
+    /** String to send via a POST request */
+    data?: string | undefined
+    /** A cookie to be patched into the sent cookie set */
+    cookie?: string | undefined
+    /** Send the data string in binary mode */
+    binary?: boolean | undefined
+    /** Don't cache the resource */
+    nocache?: boolean | undefined
+    /** Revalidate maybe cached content */
+    revalidate?: boolean | undefined
+    /** Timeout in ms */
+    timeout?: number | undefined
+    /** Property which will be added to the response object */
+    context?: TContext | undefined
+    responseType?: 'arraybuffer' | 'blob' | 'json' | undefined
+    /** MIME type for the request */
+    overrideMimeType?: string | undefined
+    /** Don't send cookies with the requests (please see the fetch notes) */
+    anonymous?: boolean | undefined
+    /**
+     * (Beta) Use a fetch instead of a xhr request(at Chrome this causes
+     * `xhr.abort`, `details.timeout` and `xhr.onprogress` to not work and
+     * makes `xhr.onreadystatechange` receive only readyState 4 events)
+     */
+    fetch?: boolean | undefined
+    /** Username for authentication */
+    user?: string | undefined
+    password?: string | undefined
+
+    // Events
+
+    /** Callback to be executed if the request was aborted */
+    onabort?(): void
+    /** Callback to be executed if the request ended up with an error */
+    onerror?: RequestEventListener<ErrorResponse> | undefined
+    /** Callback to be executed if the request started to load */
+    onloadstart?: RequestEventListener<Response<TContext>> | undefined
+    /** Callback to be executed if the request made some progress */
+    onprogress?: RequestEventListener<ProgressResponse<TContext>> | undefined
+    /** Callback to be executed if the request's ready state changed */
+    onreadystatechange?: RequestEventListener<Response<TContext>> | undefined
+    /** Callback to be executed if the request failed due to a timeout */
+    ontimeout?(): void
+    /** Callback to be executed if the request was loaded */
+    onload?: RequestEventListener<Response<TContext>> | undefined
+  }
+
+  // Download Response
+
+  interface DownloadProgressResponse extends ProgressResponseBase {
+    readonly finalUrl: string
+  }
+
+  interface DownloadErrorResponse {
+    /**
+     * Error reason
+     * - `not_enabled` - the download feature isn't enabled by the user
+     * - `not_whitelisted` - the requested file extension is not
+     * whitelisted
+     * - `not_permitted` - the user enabled the download feature, but did
+     * not give the downloads permission
+     * - `not_supported` - the download feature isn't supported by the
+     * browser/version
+     * - `not_succeeded` - the download wasn't started or failed, the
+     * details attribute may provide more information
+     */
+    error:
+      | 'not_enabled'
+      | 'not_whitelisted'
+      | 'not_permitted'
+      | 'not_supported'
+      | 'not_succeeded'
+    /** Detail about that error */
+    details?: string | undefined
+  }
+
+  // Download Request
+
+  interface DownloadRequest {
+    /** URL from where the data should be downloaded */
+    url: string
+    /**
+     * Filename - for security reasons the file extension needs to be
+     * whitelisted at Tampermonkey options page
+     */
+    name: string
+    headers?: RequestHeaders | undefined
+    /** Show 'Save As' dialog */
+    saveAs?: boolean | undefined
+    timeout?: number | undefined
+    /** Callback to be executed if this download ended up with an error */
+    onerror?: RequestEventListener<DownloadErrorResponse> | undefined
+    /** Callback to be executed if this download finished */
+    ontimeout?(): void
+    /** Callback to be executed if this download finished */
+    onload?(): void
+    /** Callback to be executed if this download failed due to a timeout */
+    onprogress?: RequestEventListener<DownloadProgressResponse> | undefined
+  }
+
+  interface AbortHandle<TReturn> {
+    abort(): TReturn
+  }
+
+  interface OpenTabOptions {
+    /** Decides whether the new tab should be focused */
+    active?: boolean | undefined
+    /** Inserts the new tab after the current one */
+    insert?: boolean | undefined
+    /** Makes the browser re-focus the current tab on close */
+    setParent?: boolean | undefined
+  }
+
+  interface OpenTabObject {
+    /** Closes tab */
+    close(): void
+    /** Set closed listener */
+    onclose?(): void
+    closed: boolean
+  }
+
+  interface NotificationThis extends Notification {
+    id: string
+  }
+
+  type NotificationOnClick = (this: NotificationThis) => void
+  /** `clicked` is `true` when `text` was set */
+  type NotificationOnDone = (this: NotificationThis, clicked: boolean) => void
+
+  interface Notification {
+    /** Text of the notification (optional if highlight is set) */
+    text?: string | undefined
+    /** Notification title. If not specified the script name is used */
+    title?: string | undefined
+    image?: string | undefined
+    /** Flag whether to highlight the tab that sends the notification */
+    highlight?: boolean | undefined
+    /** Whether to play or not play a sound */
+    silent?: boolean | undefined
+    /** Time after that the notification will be hidden. `0` = disabled */
+    timeout?: number | undefined
+    /**
+     * Called when the notification is closed (no matter if this was
+     * triggered by a timeout or a click) or the tab was highlighted
+     */
+    onclick?: NotificationOnClick | undefined
+    /** Called in case the user clicks the notification */
+    ondone?: NotificationOnDone | undefined
+  }
+
+  interface TextNotification extends Notification {
+    /** Text of the notification (optional if highlight is set) */
+    text: string
+  }
+
+  interface HighlightNotification extends Notification {
+    text?: undefined
+    highlight: true
+  }
+
+  type NotificationDetails = TextNotification | HighlightNotification
+
+  // Interfaces for GM_info
+
+  /**
+   * The metadata that the user can override in the settings
+   * for example run-at or excludes
+   */
+  interface ScriptMetadataOverrides {
+    merge_connects: boolean
+    merge_excludes: boolean
+    merge_includes: boolean
+    merge_matches: boolean
+    orig_connects: string[]
+    orig_excludes: string[]
+    orig_includes: string[]
+    orig_matches: string[]
+    orig_noframes: string | null
+    orig_run_at: string | null
+    use_blockers: string[]
+    use_connects: string[]
+    use_excludes: string[]
+    use_includes: string[]
+    use_matches: string[]
+  }
+
+  /**
+   * The options that the user of the userscript
+   * can set in the settings (!== overrides)
+   */
+  interface ScriptSettings {
+    check_for_updates: boolean
+    comment: string | null
+    compat_foreach: boolean
+    compat_metadata: boolean
+    compat_prototypes: boolean
+    compat_wrappedjsobject: boolean
+    compatopts_for_requires: boolean
+    noframes: boolean | null
+    run_at: string
+    override: ScriptMetadataOverrides
+  }
+
+  /**
+   * The resources from the metadata block (@resources)
+   * that tampermonkey should preload
+   */
+  interface ScriptResource {
+    name: string
+    url: string
+    content: string
+    meta: string
+  }
+
+  /**
+   * `.. | null` means if it was not explicitely set in the metadata
+   * block it is null
+   */
+  interface ScriptMetadata {
+    antifeatures: Record<string, Record<string, string>>
+    author: string | null
+
+    /**
+     * Idk what this is, nothing I did changed this from any empty array
+     * and it's not documented anywhere
+     */
+    blockers: any[]
+
+    copyright: string | null
+    description: string | null
+    description_i18n: Record<string, string>
+    downloadURL: string | null
+    evilness: number
+    excludes: string[]
+    grant: string[]
+    header: string
+    homepage: string | null
+    icon: string | null
+    icon64: string | null
+    includes: string[]
+    lastModified: number
+    matches: string[]
+    name: string
+    name_i18n: Record<string, string>
+    namespace: string | null
+    options: ScriptSettings
+
+    position: number
+    resources: ScriptResource[]
+
+    /**
+     * Never null, defaults to document-idle
+     */
+    'run-at': string
+
+    supportURL: string | null
+    sync: {
+      imported: boolean
+    }
+    unwrap: boolean
+    updateURL: string | null
+    uuid: string
+    version: string
+    webRequest: string[]
+  }
+
+  interface ScriptInfo {
+    downloadMode: 'native' | 'browser' | 'disabled'
+    isFirstPartyIsolation: boolean | undefined
+    isIncognito: boolean
+    script: ScriptMetadata
+
+    /**
+     * In tampermonkey it's "Tampermonkey"
+     * but I'll leave it as string so this can be used
+     * for other managers
+     */
+    scriptHandler: string
+
+    scriptMetaStr: string
+    scriptSource: string
+    scriptUpdateURL: string | undefined
+    scriptWillUpdate: boolean
+
+    /** This refers to tampermonkey's version */
+    version: string
+  }
+
+  type ContentType =
+    | string
+    | { type?: string | undefined; mimetype?: string | undefined }
+}
+
+/**
+ * The unsafeWindow object provides full access to the pages javascript
+ * functions and variables
+ */
+declare var unsafeWindow: Window
+
+// Styles
+
+/**
+ * Adds the given style to the document and returns the injected style element.
+ */
+declare function GM_addStyle(css: string): HTMLStyleElement
+
+// Storage
+
+/** Sets the value of `name` to the storage */
+declare function GM_setValue(name: string, value: any): void
+
+/**
+ * Adds a change listener to the storage and returns the listener ID.
+ * The `remote` argument of the callback function shows whether this value was
+ * modified from the instance of another tab (`true`) or within this script
+ * instance (`false`). Therefore this functionality can be used by scripts of
+ * different browser tabs to communicate with each other.
+ * @param name Name of the observed variable
+ */
+declare function GM_addValueChangeListener(
+  name: string,
+  listener: Tampermonkey.ValueChangeListener
+): number
+
+/** Removes a change listener by its ID */
+declare function GM_removeValueChangeListener(listenerId: number): void
+
+/** Gets the value of 'name' from storage */
+declare function GM_getValue<TValue>(
+  name: string,
+  defaultValue?: TValue
+): TValue
+
+/** Deletes 'name' from storage */
+declare function GM_deleteValue(name: string): void
+
+/** Lists all names of the storage */
+declare function GM_listValues(): string[]
+
+// Resources
+
+/** Get the content of a predefined `@resource` tag at the script header */
+declare function GM_getResourceText(name: string): string
+
+/**
+ * Get the base64 encoded URI of a predefined `@resource` tag at the script
+ * header
+ */
+declare function GM_getResourceURL(name: string): string
+
+// Menu commands
+
+/**
+ * Register a menu to be displayed at the Tampermonkey menu at pages where this
+ * script runs and returns a menu command ID.
+ */
+declare function GM_registerMenuCommand(
+  name: string,
+  onClick: () => void,
+  accessKey?: string
+): number
+
+/**
+ *  Unregister a menu command that was previously registered by
+ * `GM_registerMenuCommand` or `GM.registerMenuCommand` with the given menu command ID.
+ */
+declare function GM_unregisterMenuCommand(menuCommandId: number): void
+
+// Requests
+
+/** Makes an xmlHttpRequest */
+declare function GM_xmlhttpRequest<TContext = any>(
+  details: Tampermonkey.Request<TContext> // tslint:disable-line:no-unnecessary-generics
+): Tampermonkey.AbortHandle<void>
+
+/** Downloads a given URL to the local disk */
+declare function GM_download(
+  details: Tampermonkey.DownloadRequest
+): Tampermonkey.AbortHandle<boolean>
+declare function GM_download(
+  url: string,
+  name: string
+): Tampermonkey.AbortHandle<boolean>
+
+// Tabs
+
+/** Saves the tab object to reopen it after a page unload */
+declare function GM_saveTab(obj: object): void
+
+/** Gets a object that is persistent as long as this tab is open */
+declare function GM_getTab(callback: (obj: any) => void): void
+
+/** Gets all tab objects as a hash to communicate with other script instances */
+declare function GM_getTabs(
+  callback: (tabsMap: { [tabId: number]: any }) => void
+): void
+
+// Utils
+
+declare const GM_info: Tampermonkey.ScriptInfo
+
+/** Log a message to the console */
+declare function GM_log(...message: any[]): void
+
+/**
+ * Opens a new tab with this url.
+ * The options object can have the following properties:
+ * - `active` decides whether the new tab should be focused,
+ * - `insert` that inserts the new tab after the current one and
+ * - `setParent` makes the browser re-focus the current tab on close.
+ *
+ * Otherwise the new tab is just appended.
+ * If `options` is boolean (loadInBackground) it has the opposite meaning of
+ * active and was added to achieve Greasemonkey 3.x compatibility.
+ *
+ * If neither active nor loadInBackground is given, then the tab will not be
+ * focused.
+ * @returns Object with the function `close`, the listener `onclose` and a flag
+ * called `closed`.
+ */
+declare function GM_openInTab(
+  url: string,
+  options?: Tampermonkey.OpenTabOptions | boolean
+): Tampermonkey.OpenTabObject
+
+/**
+ * Shows a HTML5 Desktop notification and/or highlight the current tab.
+ * @param ondone If specified used instead of `details.ondone`
+ */
+declare function GM_notification(
+  details: Tampermonkey.NotificationDetails,
+  ondone?: Tampermonkey.NotificationOnDone
+): void
+
+/**
+ * Shows a HTML5 Desktop notification and/or highlight the current tab.
+ * @param text Text of the notification
+ * @param title Notification title. If not specified the script name is used
+ * @param onclick Called in case the user clicks the notification
+ */
+declare function GM_notification(
+  text: string,
+  title?: string,
+  image?: string,
+  onclick?: Tampermonkey.NotificationOnClick
+): void
+
+/**
+ * Copies data into the clipboard.
+ * The parameter 'info' can be an object like
+ * `{ type: 'text', mimetype: 'text/plain'}` or just a string expressing the
+ * type ("text" or "html").
+ */
+declare function GM_setClipboard(
+  data: string,
+  info?: Tampermonkey.ContentType
+): void
+
+// GM.*
+
+/**
+ * `GM` has all the `GM_*` apis in promisified form
+ */
+declare const GM: Readonly<{
+  // Styles
+
+  /**
+   * Adds the given style to the document and returns the injected style element.
+   */
+  addStyle(css: string): Promise<HTMLStyleElement>
+
+  // Storage
+
+  /** Sets the value of `name` to the storage */
+  setValue(name: string, value: any): Promise<void>
+
+  /** Gets the value of 'name' from storage */
+  getValue<TValue>(name: string, defaultValue?: TValue): Promise<TValue>
+
+  /** Deletes 'name' from storage */
+  deleteValue(name: string): Promise<void>
+
+  /** Lists all names of the storage */
+  listValues(): Promise<string[]>
+
+  /**
+   * Adds a change listener to the storage and returns the listener ID.
+   * The `remote` argument of the callback function shows whether this value was
+   * modified from the instance of another tab (`true`) or within this script
+   * instance (`false`). Therefore this functionality can be used by scripts of
+   * different browser tabs to communicate with each other.
+   * @param name Name of the observed variable
+   */
+  addValueChangeListener(
+    name: string,
+    listener: Tampermonkey.ValueChangeListener
+  ): Promise<number>
+
+  /** Removes a change listener by its ID */
+  removeValueChangeListener(listenerId: number): Promise<void>
+
+  // Resources
+
+  /** Get the content of a predefined `@resource` tag at the script header */
+  getResourceText(name: string): Promise<string>
+
+  /**
+   * Get the base64 encoded URI of a predefined `@resource` tag at the script
+   * header
+   */
+  getResourceUrl(name: string): Promise<string>
+
+  // Menu commands
+
+  /**
+   * Register a menu to be displayed at the Tampermonkey menu at pages where this
+   * script runs and returns a menu command ID.
+   * @param accessKey The key to use for keyboard shortcuts
+   */
+  registerMenuCommand(
+    name: string,
+    onClick: () => void,
+    accessKey?: string
+  ): Promise<number>
+  /**
+   *  Unregister a menu command that was previously registered by
+   * `GM_registerMenuCommand` or `GM.registerMenuCommand` with the given menu command ID.
+   */
+  unregisterMenuCommand(menuCommandId: number): Promise<void>
+
+  // Requests
+
+  /**
+   * Makes an xmlHttpRequest
+   *
+   * @throws {Tampermonkey.ErrorResponse}
+   */
+  xmlHttpRequest<TContext = any>(
+    // onload and the like still work
+    details: Tampermonkey.Request<TContext> // tslint:disable-line:no-unnecessary-generics
+  ): Promise<Tampermonkey.Response<TContext>>
+
+  // GM_download has two signatures, GM.download has one
+  /**
+   * Downloads a given URL to the local disk
+   *
+   * @throws {Tampermonkey.DownloadErrorResponse}
+   */
+  download(details: Tampermonkey.DownloadRequest): Promise<void>
+
+  // Tabs
+
+  /** Saves the tab object to reopen it after a page unload */
+  saveTab(obj: any): Promise<void>
+
+  /** Gets a object that is persistent as long as this tab is open */
+  getTab(): Promise<any>
+
+  /** Gets all tab objects as a hash to communicate with other script instances */
+  getTabs(): Promise<{ [tabId: number]: any }>
+
+  // Utils
+  info: Tampermonkey.ScriptInfo
+
+  /** Log a message to the console */
+  log(...message: any[]): Promise<void>
+
+  /**
+   * Opens a new tab with this url.
+   * The options object can have the following properties:
+   * - `active` decides whether the new tab should be focused,
+   * - `insert` that inserts the new tab after the current one and
+   * - `setParent` makes the browser re-focus the current tab on close.
+   *
+   * Otherwise the new tab is just appended.
+   * If `options` is boolean (loadInBackground) it has the opposite meaning of
+   * active and was added to achieve Greasemonkey 3.x compatibility.
+   *
+   * If neither active nor loadInBackground is given, then the tab will not be
+   * focused.
+   * @returns Object with the function `close`, the listener `onclose` and a flag
+   * called `closed`.
+   */
+  openInTab(
+    url: string,
+    options?: Tampermonkey.OpenTabOptions | boolean
+  ): Promise<Tampermonkey.OpenTabObject>
+
+  /**
+   * Shows a HTML5 Desktop notification and/or highlight the current tab.
+   * @param ondone If specified used instead of `details.ondone`
+   * @returns True if the notification was clicked
+   */
+  notification(
+    details: Tampermonkey.NotificationDetails,
+    ondone?: Tampermonkey.NotificationOnDone
+  ): Promise<boolean>
+
+  /**
+   * Shows a HTML5 Desktop notification and/or highlight the current tab.
+   * @param text Text of the notification
+   * @param title Notification title. If not specified the script name is used
+   * @param onclick Called in case the user clicks the notification
+   * @returns True if the notification was clicked
+   */
+  notification(
+    text: string,
+    title?: string,
+    image?: string,
+    onclick?: Tampermonkey.NotificationOnClick
+  ): Promise<boolean>
+
+  /**
+   * Copies data into the clipboard.
+   * The parameter 'info' can be an object like
+   * `{ type: 'text', mimetype: 'text/plain'}` or just a string expressing the
+   * type ("text" or "html").
+   */
+  setClipboard(data: string, info?: Tampermonkey.ContentType): Promise<void>
+}>