vite-userscript-plugin 0.3.0 → 0.6.1

package/dist/index.cjs

@@ -0,0 +1,316 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  UserscriptPlugin: () => UserscriptPlugin,
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+var import_node_fs = require("fs");
+var import_node_http = require("http");
+var import_node_path = require("path");
+var import_node_url = require("url");
+var import_websocket = require("websocket");
+
+// src/banner.ts
+function banner(config) {
+  const metadata = [];
+  const configKeys = Object.keys(config);
+  const maxKeyLength = Math.max(...configKeys.map((key) => key.length)) + 1;
+  const addSpaces = (str) => {
+    return " ".repeat(maxKeyLength - str.length);
+  };
+  const addMetadata = (key, value) => {
+    const isBoolean = typeof value === "boolean";
+    if (isBoolean && !value)
+      return;
+    value = !isBoolean ? addSpaces(key) + value.toString() : "";
+    metadata.push(`// @${key}${value}`);
+  };
+  for (const [key, value] of Object.entries(config)) {
+    if (Array.isArray(value)) {
+      value.forEach((value2) => addMetadata(key, value2));
+    } else {
+      if (value === void 0)
+        continue;
+      addMetadata(key, value);
+    }
+  }
+  return [
+    "// ==UserScript==",
+    ...metadata,
+    "// ==/UserScript=="
+  ].join("\n");
+}
+
+// src/constants.ts
+var regexpScripts = new RegExp(/\.(tsx?|jsx?)$/);
+var regexpStyles = new RegExp(/\.(s?css|sass)$/);
+var template = `console.warn("__TEMPLATE__")`;
+var grants = [
+  "unsafeWindow",
+  "window.onurlchange",
+  "window.focus",
+  "window.close",
+  "GM_setValue",
+  "GM_getValue",
+  "GM_deleteValue",
+  "GM_listValues",
+  "GM_setClipboard",
+  "GM_addStyle",
+  "GM_addElement",
+  "GM_addValueChangeListener",
+  "GM_removeValueChangeListener",
+  "GM_registerMenuCommand",
+  "GM_unregisterMenuCommand",
+  "GM_download",
+  "GM_getTab",
+  "GM_getTabs",
+  "GM_saveTab",
+  "GM_openInTab",
+  "GM_notification",
+  "GM_getResourceURL",
+  "GM_getResourceText",
+  "GM_xmlhttpRequest",
+  "GM_webRequest",
+  "GM_log",
+  "GM_info"
+];
+
+// src/helpers.ts
+var import_vite = require("vite");
+function removeDuplicates(arr) {
+  return [...new Set(Array.isArray(arr) ? arr : arr ? [arr] : [])];
+}
+async function transform({
+  file,
+  name,
+  loader
+}) {
+  const { code } = await (0, import_vite.transformWithEsbuild)(file, name, {
+    loader,
+    minify: true
+  });
+  return code;
+}
+function defineGrants(code) {
+  const definedGrants = [];
+  for (const grant of grants) {
+    if (code.indexOf(grant) !== -1) {
+      definedGrants.push(grant);
+    }
+  }
+  return definedGrants;
+}
+
+// src/css.ts
+var CSS = class {
+  styles = /* @__PURE__ */ new Map();
+  add(entry, code, path) {
+    if (regexpStyles.test(path)) {
+      this.styles.set(path, code);
+      return {
+        code: ""
+      };
+    }
+    if (path.includes(entry)) {
+      return {
+        code: code + template
+      };
+    }
+    return null;
+  }
+  async minify(file, name) {
+    return await transform({
+      file,
+      name,
+      loader: "css"
+    });
+  }
+  inject() {
+    const styles = [...this.styles.values()].join("");
+    if (!styles)
+      return;
+    return `GM_addStyle(\`${styles}\`)`;
+  }
+  merge(modules) {
+    const styleModules = [];
+    for (const module2 of modules) {
+      const style = this.styles.get(module2);
+      if (!style)
+        continue;
+      styleModules.push([module2, style]);
+    }
+    this.styles.clear();
+    styleModules.forEach((value) => this.styles.set(...value));
+  }
+};
+var css_default = new CSS();
+
+// src/index.ts
+var import_meta = {};
+function UserscriptPlugin(config) {
+  var _a;
+  let pluginConfig;
+  let isBuildWatch;
+  let socketConnection = null;
+  const port = ((_a = config.server) == null ? void 0 : _a.port) || 8e3;
+  const httpServer = (0, import_node_http.createServer)();
+  httpServer.listen(port);
+  const WebSocketServer = import_websocket.server;
+  const ws = new WebSocketServer({ httpServer });
+  ws.on("request", (request) => {
+    socketConnection = request.accept(null, request.origin);
+  });
+  return {
+    name: "vite-userscript-plugin",
+    apply: "build",
+    config() {
+      return {
+        build: {
+          lib: {
+            entry: config.entry,
+            name: config.metadata.name,
+            formats: ["iife"],
+            fileName: () => `${config.metadata.name}.js`
+          },
+          rollupOptions: {
+            output: {
+              exports: "none",
+              extend: true
+            }
+          }
+        }
+      };
+    },
+    configResolved(cfg) {
+      pluginConfig = cfg;
+      isBuildWatch = cfg.build.watch ?? false;
+      const { match, require: require2, include, exclude, resource, connect } = config.metadata;
+      config.metadata.match = removeDuplicates(match);
+      config.metadata.require = removeDuplicates(require2);
+      config.metadata.include = removeDuplicates(include);
+      config.metadata.exclude = removeDuplicates(exclude);
+      config.metadata.resource = removeDuplicates(resource);
+      config.metadata.connect = removeDuplicates(connect);
+    },
+    async transform(code, path) {
+      const style = await css_default.minify(code, path);
+      return css_default.add(config.entry, style.replace("\n", ""), path);
+    },
+    generateBundle(_, bundle) {
+      for (const [_2, file] of Object.entries(bundle)) {
+        const styleModules = Object.keys(
+          file.modules
+        );
+        css_default.merge(styleModules);
+      }
+    },
+    async writeBundle(_, bundle) {
+      for (const [fileName] of Object.entries(bundle)) {
+        if (regexpScripts.test(fileName)) {
+          const rootDir = pluginConfig.root;
+          const outDir = pluginConfig.build.outDir || "dist";
+          const outPath = (0, import_node_path.resolve)(rootDir, outDir, fileName);
+          const hotReloadPath = (0, import_node_path.resolve)(
+            (0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(import_meta.url)),
+            "__hot-reload__.js"
+          );
+          const proxyFilePath = (0, import_node_path.resolve)(
+            rootDir,
+            outDir,
+            `${config.metadata.name}.proxy.user.js`
+          );
+          const userFilePath = (0, import_node_path.resolve)(
+            rootDir,
+            outDir,
+            `${config.metadata.name}.user.js`
+          );
+          try {
+            let source = (0, import_node_fs.readFileSync)(outPath, "utf8");
+            config.metadata.grant = removeDuplicates(
+              isBuildWatch ? grants : config.autoGrants ?? true ? defineGrants(source) : [...config.metadata.grant ?? [], "GM_addStyle", "GM_info"]
+            );
+            if (isBuildWatch) {
+              const hotReloadFile = (0, import_node_fs.readFileSync)(
+                (0, import_node_path.resolve)(
+                  (0, import_node_path.dirname)((0, import_node_url.fileURLToPath)(import_meta.url)),
+                  "hot-reload.js"
+                ),
+                "utf8"
+              );
+              const hotReloadScript = await transform({
+                file: hotReloadFile.replace("__PORT__", port.toString()),
+                name: hotReloadPath,
+                loader: "js"
+              });
+              (0, import_node_fs.writeFileSync)(hotReloadPath, hotReloadScript);
+              (0, import_node_fs.writeFileSync)(
+                proxyFilePath,
+                banner({
+                  ...config.metadata,
+                  require: [
+                    ...config.metadata.require,
+                    "file://" + hotReloadPath,
+                    "file://" + outPath
+                  ]
+                })
+              );
+            }
+            source = source.replace(template, `${css_default.inject()}`);
+            source = await transform({
+              file: source,
+              name: fileName,
+              loader: "js"
+            });
+            (0, import_node_fs.writeFileSync)(outPath, source);
+            (0, import_node_fs.writeFileSync)(
+              userFilePath,
+              `${banner(config.metadata)}
+
+${source}`
+            );
+          } catch (err) {
+            console.log(err);
+          }
+        }
+      }
+      if (!isBuildWatch) {
+        httpServer.close();
+        process.exit(0);
+      }
+    },
+    buildEnd() {
+      if (socketConnection) {
+        socketConnection.sendUTF(
+          JSON.stringify({
+            message: "reload"
+          })
+        );
+      }
+    }
+  };
+}
+var src_default = UserscriptPlugin;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  UserscriptPlugin
+});

package/dist/index.d.ts

@@ -1,6 +1,219 @@
 import { PluginOption } from 'vite';
-import type { UserscriptPluginConfig } from './types.js';
+
+declare const grants: readonly ["unsafeWindow", "window.onurlchange", "window.focus", "window.close", "GM_setValue", "GM_getValue", "GM_deleteValue", "GM_listValues", "GM_setClipboard", "GM_addStyle", "GM_addElement", "GM_addValueChangeListener", "GM_removeValueChangeListener", "GM_registerMenuCommand", "GM_unregisterMenuCommand", "GM_download", "GM_getTab", "GM_getTabs", "GM_saveTab", "GM_openInTab", "GM_notification", "GM_getResourceURL", "GM_getResourceText", "GM_xmlhttpRequest", "GM_webRequest", "GM_log", "GM_info"];
+
+declare type RunAt = 'document-start' | 'document-body' | 'document-end' | 'document-idle' | 'context-menu';
+declare type Grants = typeof grants[number];
+declare type MetadataConfig = {
+    [property: string]: string | boolean | number | string[] | undefined;
+    /**
+     * The name of the script.
+     * Internationalization is done by adding an appendix naming the locale.
+     */
+    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.
+     */
+    version: string;
+    /**
+     * A brief summary to describe the script.
+     */
+    description?: string;
+    /**
+     * The scripts author.
+     */
+    author?: string;
+    /**
+     * The script license.
+     */
+    license?: 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 ('').
+     */
+    namespace?: string;
+    /**
+     * 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.
+     */
+    homepage?: string;
+    /**
+     * An update URL for the userscript.
+     * Note:
+     * - a `@version` tag is required to make update checks work.
+     */
+    updateURL?: 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.
+     */
+    downloadURL?: string;
+    /**
+     * Defines the URL where the user can report issues and get personal support.
+     */
+    supportURL?: 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.
+     */
+    icon?: string;
+    icon64?: 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/
+     */
+    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*://`.
+     */
+    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!
+     */
+    require?: string[] | string;
+    /**
+     * Preloads resources that can by accessed
+     * via `GM_getResourceURL` and `GM_getResourceText` by the script.
+     */
+    resource?: 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.
+     */
+    connect?: string[] | string;
+    /**
+     * This tag makes the script running on the main pages, but not at iframes.
+     * @default false
+     */
+    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.
+     */
+    grant?: Exclude<Grants, 'GM_addStyle' | 'GM_info'>[];
+    /**
+     * 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'
+     */
+    'run-at'?: RunAt;
+};
+interface ServerConfig {
+    /**
+     * Server port.
+     * @default 8000
+     */
+    port?: number;
+}
+interface UserscriptPluginConfig {
+    /**
+     * Path of userscript entry.
+     */
+    entry: string;
+    /**
+     * Userscript header config.
+     */
+    metadata: MetadataConfig;
+    /**
+     * Import all `@grant` in development mode.
+     * @default true
+     */
+    autoGrants?: boolean;
+    /**
+     * Server config (used in development mode for hot reloading).
+     */
+    server?: ServerConfig;
+}
+
 declare function UserscriptPlugin(config: UserscriptPluginConfig): PluginOption;
-export { UserscriptPlugin };
-export default UserscriptPlugin;
-export type { UserscriptPluginConfig };
+
+export { UserscriptPlugin, UserscriptPluginConfig, UserscriptPlugin as default };