vite-userscript-plugin 1.6.7 → 1.7.1

package/README.md

@@ -44,9 +44,9 @@ export default defineConfig((config) => {
           name,
           version,
           match: [
-            'https://example.com',
-            'https://example.org',
-            'https://example.edu'
+            'https://example.com/',
+            'https://example.org/',
+            'https://example.edu/'
           ]
         },
         server: {
@@ -87,29 +87,34 @@ export default defineConfig((config) => {
 
 ```ts
 interface ServerConfig {
-    /**
-     * {@link https://github.com/sindresorhus/get-port}
-     */
-    port?: number;
-    /**
-     * @default false
-     */
-    open?: boolean;
+  /**
+   * {@link https://github.com/sindresorhus/get-port}
+   */
+  port?: number;
+
+  /**
+   * @default false
+   */
+  open?: boolean;
 }
 
 interface UserscriptPluginConfig {
-    /**
-     * Path of userscript entry.
-     */
-    entry: string;
-    /**
-     * Userscript header config.
-     */
-    header: HeaderConfig;
-    /**
-     * Server config.
-     */
-    server?: ServerConfig;
+  /**
+   * Path of userscript entry.
+   */
+  entry: string;
+
+  /**
+   * Userscript header config.
+   *
+   * @see https://www.tampermonkey.net/documentation.php
+   */
+  header: HeaderConfig;
+
+  /**
+   * Server config.
+   */
+  server?: ServerConfig;
 }
 ```
 

package/dist/index.cjs

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

package/dist/index.d.ts

@@ -10,185 +10,134 @@ type Grants = GMWindow | GMLiterals<typeof GM[number]>[number];
 type HeaderConfig = {
     [property: string]: any;
     /**
-     * The name of the script.
-     * Internationalization is done by adding an appendix naming the locale.
+     * @see https://www.tampermonkey.net/documentation.php#meta:name
      */
     name: string;
     /**
-     * Version of the script,
-     * it can be used to check if a script has new versions. It is composed
-     * of several parts, joined by `.` Each part must start with numbers,
-     * and can be followed by alphabetic characters.
+     * @see https://www.tampermonkey.net/documentation.php#meta:namespace
+     */
+    namespace?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:copyright
+     */
+    copyright?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:version
      */
     version: string;
     /**
-     * A brief summary to describe the script.
+     * @see https://www.tampermonkey.net/documentation.php#meta:description
      */
     description?: string;
     /**
-     * The scripts author.
+     * @see https://www.tampermonkey.net/documentation.php#meta:icon
      */
-    author?: string;
+    icon?: string;
     /**
-     * The script license.
+     * @see https://www.tampermonkey.net/documentation.php#meta:icon
      */
-    license?: string;
+    iconURL?: string;
     /**
-     * The combination of `@namespace` and `@name` is the unique identifier for
-     * a userscript. `@namespace` can be any string, for example the homepage
-     * of a group of userscripts by the same author. If not provided
-     * the `@namespace` falls back to an empty string ('').
+     * @see https://www.tampermonkey.net/documentation.php#meta:icon
      */
-    namespace?: string;
+    defaulticon?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:icon64
+     */
+    icon64?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:icon64
+     */
+    icon64URL?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:grant
+     */
+    grant?: Grants[];
     /**
-     * The authors homepage that is used at the options page to link from
-     * the scripts name to the given page. Please note that if the `@namespace`
-     * tag starts with `https://` its content will be used for this too.
+     * @see https://www.tampermonkey.net/documentation.php#meta:author
+     */
+    author?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
      */
     homepage?: string;
     /**
-     * An update URL for the userscript.
-     * Note:
-     * - a `@version` tag is required to make update checks work.
+     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
      */
-    updateURL?: string;
+    homepageURL?: string;
     /**
-     * Defines the URL where the script will be downloaded from when an update was
-     * detected. If the value none is used, then no update check will be done.
+     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
      */
-    downloadURL?: string;
+    website?: string;
     /**
-     * Defines the URL where the user can report issues and get personal support.
+     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
      */
-    supportURL?: string;
+    source?: string;
     /**
-     * Specify an icon for the script. Almost any image will work,
-     * but a 32x32 pixel size is best. This value may be specified relative
-     * to the URL the script itself is downloaded from.
+     * @see https://www.tampermonkey.net/documentation.phpmeta:antifeature
      */
-    icon?: string;
-    icon64?: string;
+    antifeature?: [type: string, description: string][];
     /**
-     * Each `@include` and `@exclude` rule can be one of the following:
-     * - a normal string
-     *   > If the string does not start or end with a slash (/),
-     *   > it will be used as a normal string.
-     *   > If there are wildcards (*), each of them matches any characters.
-     *   > e.g. https://www.google.com/* matches the following:
-     *    - https://www.google.com/
-     *    - https://www.google.com/any/subview
-     *   > but not the following:
-     *    - http://www.google.com/
-     *    - https://www.google.com.hk/
-     *   > If there is no wildcard in the string, the rule matches the entire URL.
-     *   > e.g. https://www.google.com/ matches only https://www.google.com/
-     *   > but not https://www.google.com/any/subview.
-     *   > The host part accepts .tld to match top level domain suffix.
-     *   > e.g. https://www.google.tld/ matches both https://www.google.com/
-     *   > and https://www.google.co.jp/.
-     *
-     * - a regular expression
-     *   > If the string starts and ends with a slash (/),
-     *   > it will be compiled as a regular expression.
-     *   > e.g. /\.google\.com[\.\/]/ matches the following:
-     *    - https://www.google.com/,
-     *    - https://www.google.com/any/subview
-     *    - http://www.google.com/
-     *    - https://www.google.com.hk/
+     * @see https://www.tampermonkey.net/documentation.php#meta:require
+     */
+    require?: string[] | string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:resource
+     */
+    resource?: [key: string, value: string][];
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:include
      */
     include?: string[] | string;
-    exclude?: string[] | string;
     /**
-     * More or less equal to the `@include` tag.
-     * You can get more information
-     * [here](https://developer.chrome.com/docs/extensions/mv2/match_patterns/).
-     *
-     * Note:
-     * - The `<all_urls>` statement is not yet supported and the scheme part also
-     * accepts `http*://`.
+     * @see https://www.tampermonkey.net/documentation.php#meta:match
+     * @see https://violentmonkey.github.io/api/metadata-block/#match--exclude-match
      */
     match: string[] | string;
     /**
-     * Points to a JavaScript file that is loaded and executed before the script
-     * itself starts running.
-     *
-     * Note:
-     * - The scripts loaded via `@require` and their "use strict" statements
-     * might influence the userscript's strict mode!
+     * @see https://violentmonkey.github.io/api/metadata-block/#match--exclude-match
      */
-    require?: string[] | string;
+    'exclude-match'?: string[] | string;
     /**
-     * Preloads resources that can by accessed
-     * via `GM_getResourceURL` and `GM_getResourceText` by the script.
+     * @see https://www.tampermonkey.net/documentation.php#meta:exclude
      */
-    resource?: [string, string][];
+    exclude?: string[] | string;
     /**
-     * This tag defines the domains (no top-level domains) including subdomains
-     * which are allowed to be retrieved by `GM_xmlhttpRequest`
-     *
-     * - domains like tampermonkey.net (this will also allow all sub-domains)
-     * - sub-domains i.e. safari.tampermonkey.net
-     * - self to whitelist the domain the script is currently running at
-     * - localhost to access the localhost
-     * - 1.2.3.4 to connect to an IP address
-     *
-     * If it's not possible to declare all domains a userscript might connect
-     * to then it's a good practice to do the following: ***Declare all known or
-     * at least all common domains*** that might be connected by the script.
-     * This way the confirmation dialog can be avoided for most of the users.
-     *
-     * Additionally add `@connect *` to the script. By doing so Tampermonkey will
-     * still ask the user whether the next connection to a not mentioned domain
-     * is allowed, but also ***offer a "Always allow all domains" button***.
-     * If the user clicks at this button then all future requestswill
-     * be permitted automatically.
+     * @see https://www.tampermonkey.net/documentation.php#meta:run_at
+     */
+    'run-at'?: RunAt;
+    /**
+     * @see https://www.tampermonkey.net/documentation.phpmeta:sandbox
+     */
+    sandbox?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:connect
      */
     connect?: string[] | string;
     /**
-     * This tag makes the script running on the main pages, but not at iframes.
-     * @default false
+     * @see https://www.tampermonkey.net/documentation.php#meta:noframes
      */
     noframes?: boolean;
     /**
-     * `@grant` is used to whitelist GM_* functions, the `unsafeWindow` object and
-     * some powerful window functions. If no `@grant` tag is given TM guesses
-     * the scripts needs.
+     * @see https://www.tampermonkey.net/documentation.php#meta:updateURL
      */
-    grant?: Grants[];
+    updateURL?: string;
     /**
-     * Defines the moment the script is injected. In opposition to other script
-     * handlers, `@run-at` defines the first possible moment a script wants to
-     * run. This means it may happen, that a script that uses the `@require` tag
-     * may be executed after the document is already loaded, cause fetching the
-     * required script took that long. Anyhow, all `DOMNodeInserted` and
-     * `DOMContentLoaded` events that happended after the given injection
-     * moment are cached and delivered to the script when it is injected.
-     *
-     * - `document-start`
-     * The script will be injected as fast as possible.
-     *
-     * - `document-body`
-     * The script will be injected if the body element exists.
-     *
-     * - `document-end`
-     * The script will be injected when or after the `DOMContentLoaded` event
-     * was dispatched.
-     *
-     * - `document-idle`
-     * The script will be injected after the DOMContentLoaded event was
-     * dispatched. This is the default value if no `@run-at` tag is given.
-     *
-     * - `context-menu`
-     * The script will be injected if it is clicked at the browser context menu
-     * (desktop Chrome-based browsers only).
-     *
-     * Note:
-     * - all `@include` and `@exclude` statements will be ignored if this value
-     * is used, but this may change in the future.
-     *
-     * @default 'document-idle'
+     * @see https://www.tampermonkey.net/documentation.php#meta:downloadURL
      */
-    'run-at'?: RunAt;
+    downloadURL?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:supportURL
+     */
+    supportURL?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:webRequest
+     */
+    webRequest?: string[];
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:unwrap
+     */
+    unwrap?: boolean;
 };
 interface ServerConfig {
     /**
@@ -207,6 +156,8 @@ interface UserscriptPluginConfig {
     entry: string;
     /**
      * Userscript header config.
+     *
+     * @see https://www.tampermonkey.net/documentation.php
      */
     header: HeaderConfig;
     /**

package/dist/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-userscript-plugin",
-  "version": "1.6.7",
+  "version": "1.7.1",
   "type": "module",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.cjs",
@@ -45,28 +45,27 @@
     "url": "https://github.com/crashmax-dev/vite-userscript-plugin/issues"
   },
   "dependencies": {
-    "get-port": "^6.1.2",
-    "open": "^8.4.0",
-    "picocolors": "^1.0.0",
-    "sanitize-filename": "^1.6.3",
-    "serve-handler": "^6.1.5",
-    "websocket": "^1.0.34"
+    "get-port": "6.1.2",
+    "open": "8.4.2",
+    "picocolors": "1.0.0",
+    "serve-handler": "6.1.5",
+    "websocket": "1.0.34"
   },
   "devDependencies": {
-    "@crashmax/prettier-config": "^2.1.0",
-    "@crashmax/tsconfig": "^1.0.2",
-    "@types/node": "^18.11.9",
-    "@types/serve-handler": "^6.1.1",
-    "@types/websocket": "^1.0.5",
-    "@vitest/ui": "^0.25.3",
-    "tsup": "^6.5.0",
-    "turbo": "^1.6.3",
-    "typescript": "^4.9.3",
-    "vite": "^3.2.4",
-    "vite-plugin-dts": "^1.7.1",
-    "vitest": "^0.25.3"
+    "@crashmax/prettier-config": "3.2.1",
+    "@crashmax/tsconfig": "2.0.1",
+    "@types/node": "18.15.3",
+    "@types/serve-handler": "6.1.1",
+    "@types/websocket": "1.0.5",
+    "@vitest/ui": "0.29.2",
+    "tsup": "6.6.3",
+    "turbo": "1.8.3",
+    "typescript": "4.9.5",
+    "vite": "4.1.4",
+    "vite-plugin-dts": "2.1.0",
+    "vitest": "0.29.2"
   },
   "peerDependencies": {
-    "vite": ">=2.9.0"
+    "vite": ">=3.0.0"
   }
 }

package/types/greasemonkey.d.ts

@@ -1,314 +1,246 @@
-// Type definitions for Greasemonkey 4.x
+// Type definitions for Greasemonkey 3.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
+// This definition is based on the API reference of Greasemonkey.
+// http://wiki.greasespot.net/Greasemonkey_Manual:API
 
-declare namespace GM {
-  interface ScriptInfo {
-    /** Possibly empty string. */
+////////////////
+// Global variable
+////////////////
+
+/**
+ * Window object of the content page where the user script is running on.
+ * @see {@link http://wiki.greasespot.net/UnsafeWindow}
+ */
+declare var unsafeWindow: Window
+
+/**
+ * Meta data about the running user script.
+ * @see {@link http://wiki.greasespot.net/GM_info}
+ */
+declare var GM_info: {
+  script: {
     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. */
+    resources: Object
+    'run-at': string
+    unwrap: boolean
     version: string
   }
+  scriptMetaStr: string
+  scriptWillUpdate: boolean
+  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
-  }
+////////////////
+// Values
+////////////////
 
-  interface ProgressResponse<TContext> extends Response<TContext> {
-    lengthComputable: boolean
-    loaded: number
-    total: number
-  }
+/**
+ * Deletes an existing name / value pair from the script storage.
+ * @param  name  a name of the pair to delete.
+ * @see    {@link http://wiki.greasespot.net/GM_deleteValue}
+ */
+declare function GM_deleteValue(name: string): void
 
-  interface Request<TContext = any> {
-    // Fields
+/**
+ * Retrieves a value from the script storage.
+ * @param    name          a name to retrieve.
+ * @param    defaultValue  a value to be returned when the name does not exist.
+ * @returns  a retrieved value, or passed default value, or undefined.
+ * @see      {@link http://wiki.greasespot.net/GM_getValue}
+ */
+declare function GM_getValue(name: string, defaultValue?: any): any
+declare function GM_getValue(name: string, defaultValue?: string): string
+declare function GM_getValue(name: string, defaultValue?: number): number
+declare function GM_getValue(name: string, defaultValue?: boolean): boolean
 
-    /**
-     * 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
+/**
+ * Retrieves an array of names stored in the script storage.
+ * @returns  an array of names in the storage.
+ * @see      {@link http://wiki.greasespot.net/GM_listValues}
+ */
+declare function GM_listValues(): string[]
 
-    // Event handlers
+/**
+ * Stores a name / value pair to the script storage.
+ * @param  name   a name of the pair.
+ * @param  value  a value to be stored.
+ * @see    {@link http://wiki.greasespot.net/GM_setValue}
+ */
+declare function GM_setValue(name: string, value: string): void
+declare function GM_setValue(name: string, value: boolean): void
+declare function GM_setValue(name: string, value: number): void
 
-    /** 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
-  }
-}
+////////////////
+// Resources
+////////////////
 
 /**
- * Window object of the content page where the user script is running on.
- * @see {@link http://wiki.greasespot.net/UnsafeWindow}
+ * Gets a content of a resouce defined by {@link http://wiki.greasespot.net/Metadata_Block#.40resource|@resource}.
+ * @param    resourceName  a name of the resource to get.
+ * @returns  the content of the resource.
+ * @see      {@link http://wiki.greasespot.net/GM_getResourceText}
  */
-declare var unsafeWindow: Window
+declare function GM_getResourceText(resourceName: string): string
 
-declare var GM: {
-  // Headers
+/**
+ * Gets a URL of a resource defined by {@link http://wiki.greasespot.net/Metadata_Block#.40resource|@resource}.
+ * @param    resourceName  a name of the resource.
+ * @returns  a URL that returns the content of the resource.
+ * @see      {@link http://wiki.greasespot.net/GM_getResourceURL}
+ */
+declare function GM_getResourceURL(resourceName: string): string
 
-  /**
-   * 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
-  }
+////////////////
+// Utilities
+////////////////
 
-  // Values
+/**
+ * Adds CSS to the content page.
+ * @param  css  a CSS string. It can have multiple style definitions.
+ * @see    {@link http://wiki.greasespot.net/GM_addStyle}
+ */
+declare function GM_addStyle(css: string): void
 
-  /**
-   * 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>
+/**
+ * Writes a message as a log to the console with the script identifier.
+ * @param  message  a message to be written.
+ * @see    {@link http://wiki.greasespot.net/GM_log}
+ */
+declare function GM_log(message: any): 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>
+/**
+ * Opens a URL in a new tab.
+ * @param    url  a URL to open.
+ * @returns  window object of the opened tab.
+ * @see      {@link http://wiki.greasespot.net/GM_openInTab}
+ */
+declare function GM_openInTab(url: string): Window
 
-  /**
-   * 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>
+/**
+ * Registers an item as a submenu of User Script Commands.
+ * @param  caption      a caption of the menu item.
+ * @param  commandFunc  a function to be invoked when the item has been selected.
+ * @param  accessKey    a single character that can be used to select the item by keyboard.
+ *                      It should be a letter in the caption.
+ * @see    {@link http://wiki.greasespot.net/GM_registerMenuCommand}
+ */
+declare function GM_registerMenuCommand(
+  caption: string,
+  commandFunc: Function,
+  accessKey?: string
+): 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[]>
+/**
+ * Sets a text to the clipboard of the opeating system.
+ * @param  text  a text to be set to the clipboard.
+ * @see    {@link http://wiki.greasespot.net/GM_setClipboard}
+ */
+declare function GM_setClipboard(text: string): void
 
-  // Resources
+////////////////
+// XMLHttpRequest
+////////////////
 
-  /**
-   * 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>
+/**
+ * Request options for {@link GM_xmlhttpRequest}.
+ * @see {@link http://wiki.greasespot.net/GM_xmlhttpRequest#Arguments}
+ */
+interface GMXMLHttpRequestOptions {
+  binary?: boolean | undefined
+  context?: any
+  data?: string | undefined
+  headers?: Object | undefined
+  method: string
+  onabort?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+  onerror?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+  onload?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+  onprogress?: ((response: GMXMLHttpRequestProgressResponse) => any) | undefined
+  onreadystatechange?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+  ontimeout?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+  overrideMimeType?: string | undefined
+  password?: string | undefined
+  synchronous?: boolean | undefined
+  timeout?: number | undefined
+  upload?:
+    | {
+        onabort?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+        onerror?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+        onload?: ((response: GMXMLHttpRequestResponse) => any) | undefined
+        onprogress?:
+          | ((response: GMXMLHttpRequestProgressResponse) => any)
+          | undefined
+      }
+    | undefined
+  url: string
+  user?: string | undefined
+}
 
-  // Other
+/**
+ * Response object for general events of {@link GM_xmlhttpRequest}.
+ * @see {@link http://wiki.greasespot.net/GM_xmlhttpRequest#Response_Object}
+ */
+interface GMXMLHttpRequestResponse {
+  readyState: number
+  responseHeaders: string
+  responseText: string
+  status: number
+  statusText: string
+  context: any
+  finalUrl: string
+}
 
-  /**
-   * 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
+/**
+ * Response object for onprogress event of {@link GM_xmlhttpRequest}.
+ */
+interface GMXMLHttpRequestProgressResponse extends GMXMLHttpRequestResponse {
+  lengthComputable: boolean
+  loaded: number
+  total: number
+}
 
-  /**
-   * 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
+/**
+ * Returned object by {@link GM_xmlhttpRequest} in asynchronous mode.
+ */
+interface GMXMLHttpRequestAsyncResult {
+  abort(): 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
+/**
+ * Returned object by {@link GM_xmlhttpRequest} in synchronouse mode.
+ */
+interface GMXMLHttpRequestSyncResult {
+  abort(): void
+  finalUrl: string
+  readyState: number
+  responseHeaders: string
+  responseText: string
+  status: number
+  statusText: string
+}
 
-  /**
-   * Sets the current contents of the operating system's clipboard
-   * @see {@link https://wiki.greasespot.net/GM.setClipboard}
-   */
-  setClipboard(text: string): void
+/**
+ * Returned object by {@link GM_xmlhttpRequest}.
+ * @see  {@link http://wiki.greasespot.net/GM_xmlhttpRequest#Returns}
+ */
+interface GMXMLHttpRequestResult
+  extends GMXMLHttpRequestAsyncResult,
+    GMXMLHttpRequestSyncResult {}
 
-  /**
-   * 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
-}
+/**
+ * Sends a HTTP request to a URL.
+ * @param    options  options and callbacks for HTTP request.
+ * @returns  an object which can abort the request.
+ *           If the request is sent in the synchronous mode, it also contains the response information.
+ * @see      {@link http://wiki.greasespot.net/GM_setClipboard}
+ */
+declare function GM_xmlhttpRequest(
+  options: GMXMLHttpRequestOptions
+): GMXMLHttpRequestResult

package/types/tampermonkey.d.ts

@@ -2,6 +2,8 @@
 // Project: https://tampermonkey.net
 // Definitions by: Steven Wang <https://github.com/silverwzw>
 //                 Nikolay Borzov <https://github.com/nikolay-borzov>
+//                 taozhiyu <https://github.com/taozhiyu>
+//                 double-beep <https://github.com/double-beep>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 // This definition is based on the API reference of Tampermonkey
@@ -69,19 +71,8 @@ declare namespace Tampermonkey {
     response: TResponse
   ) => void
 
-  type RequestMethods =
-    | 'POST'
-    | 'GET'
-    | 'PUT'
-    | 'PATCH'
-    | 'DELETE'
-    | 'HEAD'
-    | 'TRACE'
-    | 'OPTIONS'
-    | 'CONNECT'
-
   interface Request<TContext = object> {
-    method?: RequestMethods
+    method?: 'GET' | 'HEAD' | 'POST' | undefined
     /** Destination URL */
     url: string
     /**
@@ -284,11 +275,16 @@ declare namespace Tampermonkey {
     comment: string | null
     compat_foreach: boolean
     compat_metadata: boolean
+    compat_powerful_this: boolean | null
     compat_prototypes: boolean
     compat_wrappedjsobject: boolean
     compatopts_for_requires: boolean
     noframes: boolean | null
     run_at: string
+    sandbox: string | null
+    tab_types: string | null
+    unwrap: boolean | null
+
     override: ScriptMetadataOverrides
   }
 
@@ -298,9 +294,32 @@ declare namespace Tampermonkey {
    */
   interface ScriptResource {
     name: string
-    url: string
-    content: string
-    meta: string
+    url?: string
+    content?: string
+    meta?: string
+    error?: string
+  }
+
+  interface WebRequestRule {
+    selector:
+      | {
+          include?: string | string[]
+          match?: string | string[]
+          exclude?: string | string[]
+        }
+      | string
+    action:
+      | string
+      | {
+          cancel?: boolean
+          redirect?:
+            | {
+                url: string
+                from?: string
+                to?: string
+              }
+            | string
+        }
   }
 
   /**
@@ -311,18 +330,17 @@ declare namespace Tampermonkey {
     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[]
+    blockers: string[]
 
     copyright: string | null
+    deleted?: number | undefined
     description: string | null
-    description_i18n: Record<string, string>
+    description_i18n: Record<string, string> | null
     downloadURL: string | null
+    enabled?: boolean
     evilness: number
     excludes: string[]
+    fileURL?: string | null
     grant: string[]
     header: string
     homepage: string | null
@@ -332,7 +350,7 @@ declare namespace Tampermonkey {
     lastModified: number
     matches: string[]
     name: string
-    name_i18n: Record<string, string>
+    name_i18n: Record<string, string> | null
     namespace: string | null
     options: ScriptSettings
 
@@ -345,21 +363,23 @@ declare namespace Tampermonkey {
     'run-at': string
 
     supportURL: string | null
-    sync: {
-      imported: boolean
+    sync?: {
+      imported?: number | undefined
     }
+    system?: boolean | undefined
     unwrap: boolean
     updateURL: string | null
     uuid: string
     version: string
-    webRequest: string[]
+    webRequest: WebRequestRule[] | null
   }
 
   interface ScriptInfo {
     downloadMode: 'native' | 'browser' | 'disabled'
-    isFirstPartyIsolation: boolean | undefined
+    isFirstPartyIsolation?: boolean
     isIncognito: boolean
     script: ScriptMetadata
+    sandboxMode: 'js' | 'raw' | 'dom'
 
     /**
      * In tampermonkey it's "Tampermonkey"
@@ -368,13 +388,13 @@ declare namespace Tampermonkey {
      */
     scriptHandler: string
 
-    scriptMetaStr: string
+    scriptMetaStr: string | null
     scriptSource: string
-    scriptUpdateURL: string | undefined
+    scriptUpdateURL: string | null
     scriptWillUpdate: boolean
 
     /** This refers to tampermonkey's version */
-    version: string
+    version?: string
   }
 
   type ContentType =
@@ -386,7 +406,57 @@ declare namespace Tampermonkey {
  * The unsafeWindow object provides full access to the pages javascript
  * functions and variables
  */
-declare var unsafeWindow: Window
+declare var unsafeWindow: Window &
+  Omit<
+    typeof globalThis,
+    | 'GM_addStyle'
+    | 'GM_addValueChangeListener'
+    | 'GM_deleteValue'
+    | 'GM_download'
+    | 'GM_download'
+    | 'GM_getResourceText'
+    | 'GM_getResourceURL'
+    | 'GM_getTab'
+    | 'GM_getTabs'
+    | 'GM_getValue'
+    | 'GM_info'
+    | 'GM_listValues'
+    | 'GM_log'
+    | 'GM_notification'
+    | 'GM_notification'
+    | 'GM_openInTab'
+    | 'GM_registerMenuCommand'
+    | 'GM_removeValueChangeListener'
+    | 'GM_saveTab'
+    | 'GM_setClipboard'
+    | 'GM_setValue'
+    | 'GM_unregisterMenuCommand'
+    | 'GM_xmlhttpRequest'
+    | 'GM'
+  >
+
+/**
+ *
+ * Patched onurlchange attribute based on document {@link https://www.tampermonkey.net/documentation.php#meta:grant}
+ * @url https://www.tampermonkey.net/documentation.php#meta:grant
+ */
+interface Window {
+  /**
+   * check before use addEventListener
+   *
+   * According to the documentation and code, the value can currently only be of type null
+   * @url https://www.tampermonkey.net/documentation.php#meta:grant
+   * @example
+   * if (window.onurlchange === null) {
+   *   window.addEventListener('urlchange', (info) => console.log(info));
+   * }
+   */
+  onurlchange: null
+  addEventListener(
+    type: 'urlchange',
+    listener: (urlObject: { url: string }) => void
+  ): void
+}
 
 // Styles
 
@@ -461,7 +531,7 @@ declare function GM_unregisterMenuCommand(menuCommandId: number): void
 
 /** Makes an xmlHttpRequest */
 declare function GM_xmlhttpRequest<TContext = any>(
-  details: Tampermonkey.Request<TContext> // tslint:disable-line:no-unnecessary-generics
+  details: Tampermonkey.Request<TContext> // eslint-disable-line no-unnecessary-generics
 ): Tampermonkey.AbortHandle<void>
 
 /** Downloads a given URL to the local disk */
@@ -488,7 +558,7 @@ declare function GM_getTabs(
 
 // Utils
 
-declare const GM_info: Tampermonkey.ScriptInfo
+declare var GM_info: Tampermonkey.ScriptInfo
 
 /** Log a message to the console */
 declare function GM_log(...message: any[]): void
@@ -552,7 +622,7 @@ declare function GM_setClipboard(
 /**
  * `GM` has all the `GM_*` apis in promisified form
  */
-declare const GM: Readonly<{
+declare var GM: Readonly<{
   // Styles
 
   /**
@@ -628,7 +698,7 @@ declare const GM: Readonly<{
    */
   xmlHttpRequest<TContext = any>(
     // onload and the like still work
-    details: Tampermonkey.Request<TContext> // tslint:disable-line:no-unnecessary-generics
+    details: Tampermonkey.Request<TContext> // eslint-disable-line no-unnecessary-generics
   ): Promise<Tampermonkey.Response<TContext>>
 
   // GM_download has two signatures, GM.download has one