vite-userscript-plugin 1.10.0 → 1.11.0

package/types/violentmonkey.d.ts

@@ -9,10 +9,21 @@ declare type VMScriptRunAt =
 /** Injection mode of a script. */
 declare type VMScriptInjectInto = 'auto' | 'page' | 'content'
 
+declare type GenericObject = Record<string, unknown>
+
 declare interface VMScriptGMInfoPlatform {
-  arch: 'arm' | 'arm64' | 'x86-32' | 'x86-64' | 'mips' | 'mips64'
-  /** `chrome`, `firefox` or whatever was returned by the API. */
-  browserName: string
+  arch:
+    | 'aarch64'
+    | 'arm'
+    | 'arm64'
+    | 'mips'
+    | 'mips64'
+    | 'ppc64'
+    | 's390x'
+    | 'sparc64'
+    | 'x86-32'
+    | 'x86-64'
+  browserName: 'chrome' | 'firefox' | string
   browserVersion: string
   os: 'mac' | 'win' | 'android' | 'cros' | 'linux' | 'openbsd' | 'fuchsia'
 }
@@ -53,6 +64,10 @@ declare interface VMScriptGMInfoScriptMeta {
 declare interface VMScriptGMInfoObject {
   /** Unique ID of the script. */
   uuid: string
+  /** The injection mode of current script. */
+  injectInto: VMScriptInjectInto
+  /** Contains structured fields from the *Metadata Block*. */
+  script: VMScriptGMInfoScriptMeta
   /** The meta block of the script. */
   scriptMetaStr: string
   /** Whether the script will be updated automatically. */
@@ -68,10 +83,14 @@ declare interface VMScriptGMInfoObject {
    * extension API (`browser.runtime.getPlatformInfo` and `getBrowserInfo`).
    */
   platform: VMScriptGMInfoPlatform
-  /** Contains structured fields from the *Metadata Block*. */
-  script: VMScriptGMInfoScriptMeta
-  /** The injection mode of current script. */
-  injectInto: VMScriptInjectInto
+  /**
+   * A copy of navigator.userAgentData from the content script of the extension.
+   * @since VM2.20.2 */
+  userAgentData?: {
+    brands: { brand: string; version: string }[]
+    mobile: boolean
+    platform: string
+  }
 }
 
 /**
@@ -84,10 +103,18 @@ declare function GM_log(...args: any): void
 
 /** Retrieves a value for current script from storage. */
 declare function GM_getValue<T>(name: string, defaultValue?: T): T
+/** @since VM2.19.1 */
+declare function GM_getValues(names: string[]): GenericObject
+/** @since VM2.19.1 */
+declare function GM_getValues(namesWithDefaults: GenericObject): GenericObject
 /** Sets a key / value pair for current script to storage. */
 declare function GM_setValue<T>(name: string, value: T): void
+/** @since VM2.19.1 */
+declare function GM_setValues(values: GenericObject): void
 /** Deletes an existing key / value pair for current script from storage. */
 declare function GM_deleteValue(name: string): void
+/** @since VM2.19.1 */
+declare function GM_deleteValues(names: string[]): void
 /** Returns an array of keys of all available values within this script. */
 declare function GM_listValues(): string[]
 
@@ -214,13 +241,25 @@ declare function GM_openInTab(
 
 /**
  * Registers a command in Violentmonkey popup menu.
+ * Returns the command's id since VM2.12.5, see description of the `id` parameter.
  * If you want to add a shortcut, please see `@violentmonkey/shortcut`.
  */
 declare function GM_registerMenuCommand(
   /** The name to show in the popup menu. */
   caption: string,
   /** Callback function when the command is clicked in the menu. */
-  onClick: (event: MouseEvent | KeyboardEvent) => void
+  onClick: (event: MouseEvent | KeyboardEvent) => void,
+  /** @since VM2.15.9 */
+  options?: {
+    /** Default: the `caption` parameter.
+     * In 2.15.9-2.16.1 the default was a randomly generated string. */
+    id?: string
+    /** A hint shown in the status bar when hovering the command. */
+    title?: string
+    /** Default: `true`.
+     * Whether to auto-close the popup after the user invoked the command. */
+    autoClose?: boolean
+  }
 ): string
 /** Unregisters a command which has been registered to Violentmonkey popup menu. */
 declare function GM_unregisterMenuCommand(
@@ -244,6 +283,30 @@ declare interface VMScriptGMNotificationOptions {
   title?: string
   /** URL of an image to show in the notification. */
   image?: string
+  /** No sounds/vibrations when showing the notification.
+   * @since VM2.15.2, Chrome 70. */
+  silent?: boolean
+  /**
+   * Unique name of the notification, e.g. 'abc', same as the web Notification API.
+   * Names are scoped to each userscript i.e. your tag won't clash with another script's tag.
+   * The purpose of a tagged notification is to replace an older notification with the same tag,
+   * even if it was shown in another tab (or before this tab was navigated elsewhere
+   * and your notification had `zombieTimeout`).
+   * @since VM2.15.4
+   */
+  tag?: string
+  /**
+   * Number of milliseconds to keep the notification after the userscript "dies",
+   * i.e. when its tab or frame is reloaded/closed/navigated. If not specified or invalid,
+   * the default behavior is to immediately remove the notifications.
+   * @since VM2.15.4
+   */
+  zombieTimeout?: number
+  /**
+   * URL to open when a zombie notification is clicked, see `zombieTimeout` for more info.
+   * @since VM2.16.1
+   */
+  zombieUrl?: string
   /** Callback when the notification is clicked by user. */
   onclick?: () => void
   /** Callback when the notification is closed, either by user or by system. */
@@ -408,10 +471,20 @@ declare interface VMScriptGMObjectVMExtensions {
   addElement: typeof GM_addElement
   addStyle: typeof GM_addStyle
   addValueChangeListener: typeof GM_addValueChangeListener
-  download: typeof GM_download
+  /** @since VM2.19.1 */
+  deleteValues: (names: string[]) => Promise<void>
+  download:
+    | ((options: VMScriptGMDownloadOptions) => Promise<Blob> | void)
+    | ((url: string, name: string) => Promise<Blob> | void)
   getResourceText: typeof GM_getResourceText
+  /** @since VM2.19.1 */
+  getValues:
+    | ((names: string[]) => Promise<GenericObject>)
+    | ((namesWithDefaults: GenericObject) => Promise<GenericObject>)
   log: typeof GM_log
   removeValueChangeListener: typeof GM_removeValueChangeListener
+  /** @since VM2.19.1 */
+  setValues: (values: GenericObject) => Promise<void>
   unregisterMenuCommand: typeof GM_unregisterMenuCommand
 }
 
@@ -428,7 +501,9 @@ declare interface VMScriptGMObject extends VMScriptGMObjectVMExtensions {
   notification: typeof GM_notification
   openInTab: typeof GM_openInTab
   setClipboard: typeof GM_setClipboard
-  xmlHttpRequest: typeof GM_xmlhttpRequest
+  xmlHttpRequest: <T = string | Blob | ArrayBuffer | Document | object>(
+    details: VMScriptGMXHRDetails<T>
+  ) => Promise<T> & VMScriptXHRControl
 }
 
 declare const GM: VMScriptGMObject

package/dist/index.cjs

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

package/dist/index.d.cts

@@ -1,187 +0,0 @@
-import { EsbuildTransformOptions, PluginOption } from 'vite';
-
-declare const GM: readonly ["setValue", "getValue", "deleteValue", "listValues", "setClipboard", "addStyle", "addElement", "addValueChangeListener", "removeValueChangeListener", "registerMenuCommand", "unregisterMenuCommand", "download", "getTab", "getTabs", "saveTab", "openInTab", "notification", "getResourceURL", "getResourceText", "xmlhttpRequest", "log", "info"];
-declare const GMwindow: readonly ["unsafeWindow", "window.onurlchange", "window.focus", "window.close"];
-
-type RunAt = 'document-start' | 'document-body' | 'document-end' | 'document-idle' | 'context-menu';
-type GMLiterals<T extends string> = [`GM_${T}` | `GM.${T}`];
-type GMWindow = typeof GMwindow[number];
-type Grants = GMWindow | GMLiterals<typeof GM[number]>[number];
-type HeaderConfig = {
-    [property: string]: any;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:name
-     */
-    name: string;
-    /**
-     * @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;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:description
-     */
-    description?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:icon
-     */
-    icon?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:icon
-     */
-    iconURL?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:icon
-     */
-    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[];
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:author
-     */
-    author?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
-     */
-    homepage?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
-     */
-    homepageURL?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
-     */
-    website?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:homepage
-     */
-    source?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.phpmeta:antifeature
-     */
-    antifeature?: [type: string, description: string][];
-    /**
-     * @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;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:match
-     * @see https://violentmonkey.github.io/api/metadata-block/#match--exclude-match
-     */
-    match: string[] | string;
-    /**
-     * @see https://violentmonkey.github.io/api/metadata-block/#match--exclude-match
-     */
-    'exclude-match'?: string[] | string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:exclude
-     */
-    exclude?: string[] | string;
-    /**
-     * @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;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:noframes
-     */
-    noframes?: boolean;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:updateURL
-     */
-    updateURL?: string;
-    /**
-     * @see https://www.tampermonkey.net/documentation.php#meta:downloadURL
-     */
-    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 {
-    /**
-     * {@link https://github.com/sindresorhus/get-port}
-     */
-    port?: number;
-    /**
-     * @default false
-     */
-    open?: boolean;
-}
-interface UserscriptPluginConfig {
-    /**
-     * Path of userscript entry.
-     */
-    entry: string;
-    /**
-     * Userscript file name.
-     */
-    fileName?: string;
-    /**
-     * Userscript header config.
-     *
-     * @see https://www.tampermonkey.net/documentation.php
-     */
-    header: HeaderConfig;
-    /**
-     * Server config.
-     */
-    server?: ServerConfig;
-    /**
-     * Override default esbuild transform options.
-     *
-     * @default
-     * ```json
-     * {
-     *   "minify": true,
-     *   "legalComments": "none"
-     * }
-     * ```
-     */
-    esbuildTransformOptions?: Omit<EsbuildTransformOptions, 'format' | 'target' | 'loader' | 'sourcemap'>;
-}
-
-declare function UserscriptPlugin(config: UserscriptPluginConfig): PluginOption;
-
-export { UserscriptPluginConfig, UserscriptPlugin as default };