vite-userscript-plugin 1.10.0 → 2.0.0

package/package.json

@@ -1,31 +1,18 @@
 {
   "name": "vite-userscript-plugin",
-  "version": "1.10.0",
   "type": "module",
-  "types": "./dist/index.d.ts",
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "exports": {
-    "require": "./dist/index.cjs",
-    "import": "./dist/index.js"
-  },
-  "files": [
-    "dist",
-    "types"
-  ],
-  "scripts": {
-    "dev": "tsup --watch",
-    "build": "tsup",
-    "test": "vitest",
-    "test:ui": "vitest --ui --watch",
-    "dev:examples": "turbo run dev --filter='./examples/*'",
-    "build:examples": "turbo run build --filter='./examples/*'",
-    "format": "prettier --write --ignore-unknown **",
-    "prepublishOnly": "pnpm build"
+  "version": "2.0.0",
+  "author": {
+    "name": "Vitalij Ryndin",
+    "url": "https://github.com/crashmax-dev"
   },
+  "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/crashmax-dev/vite-userscript-plugin.git"
+    "url": "git+https://github.com/greasify/vite-userscript-plugin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/greasify/vite-userscript-plugin/issues"
   },
   "keywords": [
     "vite",
@@ -35,37 +22,56 @@
     "greasemonkey",
     "violentmonkey"
   ],
-  "author": {
-    "name": "Vitalij Ryndin",
-    "email": "sys@crashmax.ru",
-    "url": "https://crashmax.ru"
+  "exports": {
+    ".": "./dist/index.js",
+    "./virtual": "./virtual.d.ts",
+    "./types/tampermonkey": "./types/tampermonkey.d.ts",
+    "./types/greasemonkey": "./types/greasemonkey.d.ts",
+    "./types/violentmonkey": "./types/violentmonkey.d.ts"
   },
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/crashmax-dev/vite-userscript-plugin/issues"
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "types/*.d.ts",
+    "virtual.d.ts"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "peerDependencies": {
+    "vite": "^8.0.0"
   },
   "dependencies": {
-    "get-port": "7.0.0",
-    "open": "9.1.0",
-    "picocolors": "1.0.0",
-    "serve-handler": "6.1.5",
-    "websocket": "1.0.34"
+    "open": "11.0.1"
   },
   "devDependencies": {
-    "@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.33.0",
-    "tsup": "7.1.0",
-    "turbo": "1.10.7",
-    "typescript": "5.1.6",
-    "vite": "4.4.2",
-    "vite-plugin-dts": "3.1.1",
-    "vitest": "0.33.0"
+    "@antfu/eslint-config": "7.2.0",
+    "@sveltejs/vite-plugin-svelte": "7.3.0",
+    "@types/node": "22.20.1",
+    "@typescript/native": "npm:typescript@7.0.2",
+    "@vitejs/plugin-vue": "6.0.8",
+    "@vitest/ui": "4.1.11",
+    "eslint": "9.39.2",
+    "eslint-plugin-format": "2.0.1",
+    "prettier-plugin-css-order": "2.2.0",
+    "svelte": "5.56.10",
+    "tsdown": "0.22.14",
+    "turbo": "2.10.11",
+    "typescript": "npm:@typescript/typescript6@6.0.2",
+    "vite": "8.2.2",
+    "vitest": "4.1.11",
+    "vue": "3.5.41"
   },
-  "peerDependencies": {
-    "vite": ">=3.0.0"
+  "scripts": {
+    "dev": "tsdown --watch",
+    "dev:examples": "turbo run dev --filter=./examples/*",
+    "build": "tsdown",
+    "build:examples": "turbo run build --filter=./examples/*",
+    "test": "vitest",
+    "test:ui": "vitest --ui --watch",
+    "type-check": "tsc --noEmit -p tsconfig.json && tsc --noEmit -p scripts/tsconfig.json && turbo run type-check --filter=./examples/*",
+    "sync-types": "node scripts/sync-types.ts",
+    "lint": "eslint . --cache",
+    "lint:fix": "eslint . --fix --cache"
   }
-}
+}

package/types/greasemonkey.d.ts

@@ -1,246 +1,305 @@
-// Type definitions for Greasemonkey 3.x
-// Project: http://www.greasespot.net/
-// Definitions by: Kota Saito <https://github.com/kotas>
-// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// synced from @types/greasemonkey@4.0.7
+// do not edit; run pnpm sync-types
 
-// This definition is based on the API reference of Greasemonkey.
-// http://wiki.greasespot.net/Greasemonkey_Manual:API
+// This definition is based on the API reference of Greasemonkey
+// https://wiki.greasespot.net/Greasemonkey_Manual:API
+// TypeScript Version: 3.2
 
-////////////////
-// Global variable
-////////////////
+declare namespace GM {
+    interface ScriptInfo {
+        /** Possibly empty string. */
+        description: string;
+        excludes: string[];
+        includes: string[];
+        matches: string[];
+        name: string;
+        /** Possibly empty string. */
+        namespace: string;
+        /**
+         * An object keyed by resource name.
+         * Each value is an object with keys `name` and `mimetype` and `url`
+         * with string values.
+         */
+        resources: {
+            [resourceName: string]: {
+                name: string;
+                mimetype: string;
+                url: string;
+            };
+        };
+        /** @default 'end' */
+        runAt: "start" | "end" | "idle";
+        uuid: string;
+        /** Possibly empty string. */
+        version: string;
+    }
 
-/**
- * Window object of the content page where the user script is running on.
- * @see {@link http://wiki.greasespot.net/UnsafeWindow}
- */
-declare var unsafeWindow: Window
+    type Value = string | boolean | number;
 
-/**
- * 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
-    namespace: string
-    resources: Object
-    'run-at': string
-    unwrap: boolean
-    version: string
-  }
-  scriptMetaStr: string
-  scriptWillUpdate: boolean
-  version: string
-}
+    interface Response<TContext> {
+        readonly responseHeaders: string;
+        readonly finalUrl: string;
+        /** The same object passed into the original request */
+        readonly context?: TContext | undefined;
 
-////////////////
-// Values
-////////////////
+        readonly readyState: 1 | 2 | 3 | 4;
+        readonly response: any;
+        readonly responseText: string;
+        readonly responseXML: Document | false;
+        readonly status: number;
+        readonly statusText: string;
+    }
 
-/**
- * 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 ProgressResponse<TContext> extends Response<TContext> {
+        lengthComputable: boolean;
+        loaded: number;
+        total: number;
+    }
 
-/**
- * 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
+    interface Request<TContext = any> {
+        // Fields
 
-/**
- * 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[]
+        /**
+         * 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;
 
-/**
- * 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
+        // Event handlers
 
-////////////////
-// Resources
-////////////////
+        /** 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;
+    }
+}
 
 /**
- * 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}
+ * Window object of the content page where the user script is running on.
+ * @see {@link http://wiki.greasespot.net/UnsafeWindow}
  */
-declare function GM_getResourceText(resourceName: string): string
+declare var unsafeWindow: Window;
 
-/**
- * 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
+declare var GM: {
+    // Headers
 
-////////////////
-// Utilities
-////////////////
+    /**
+     * 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;
+    };
 
-/**
- * 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
+    // Values
 
-/**
- * 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
+    /**
+     * 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>;
 
-/**
- * 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
+    /**
+     * 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>;
 
-/**
- * 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
+    /**
+     * 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>;
 
-/**
- * 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
+    /**
+     * 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[]>;
 
-////////////////
-// XMLHttpRequest
-////////////////
+    // Resources
 
-/**
- * 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
-}
+    /**
+     * 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>;
 
-/**
- * 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
-}
+    // Other
 
-/**
- * Response object for onprogress event of {@link GM_xmlhttpRequest}.
- */
-interface GMXMLHttpRequestProgressResponse extends GMXMLHttpRequestResponse {
-  lengthComputable: boolean
-  loaded: number
-  total: number
-}
+    /**
+     * 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;
 
-/**
- * Returned object by {@link GM_xmlhttpRequest} in asynchronous mode.
- */
-interface GMXMLHttpRequestAsyncResult {
-  abort(): void
-}
+    /**
+     * Opens the specified URL in a new tab.
+     * @see {@link https://wiki.greasespot.net/GM.openInTab}
+     * @param url The URL to navigate the new tab to
+     * @param openInBackground Force tab to/to not open in a background tab.
+     * Default (unspecified) behavior honors Firefox configuration.
+     */
+    openInTab(url: string, openInBackground?: boolean): void;
 
-/**
- * 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
-}
+    /**
+     * 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}.
- * @see  {@link http://wiki.greasespot.net/GM_xmlhttpRequest#Returns}
- */
-interface GMXMLHttpRequestResult
-  extends GMXMLHttpRequestAsyncResult,
-    GMXMLHttpRequestSyncResult {}
+    /**
+     * Sets the current contents of the operating system's clipboard
+     * @see {@link https://wiki.greasespot.net/GM.setClipboard}
+     */
+    setClipboard(text: string): 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
+    /**
+     * 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;
+};