@henrikvilhelmberglund/vite-plugin-monkey 4.0.4

package/dist/node/index.d.ts

@@ -0,0 +1,845 @@
+import { Plugin } from 'vite';
+import { InlinePreset } from 'unimport';
+
+/**
+ * format userscript comment
+ */
+type Format = {
+    /**
+     * @description note font_width/font_family, suggest fixed-width font
+     * @default 2, true
+     */
+    align?: number | boolean | AlignFunc;
+    /**
+     * custom generate userscript comment
+     *
+     * if you want add other comments after userscript or modify userscript
+     */
+    generate?: (uOptions: {
+        userscript: string;
+        mode: `serve` | `build` | `meta`;
+    }) => IPromise<string>;
+};
+/**
+ * @example
+ * // input/output
+ * [
+ *   [ 'name', 'example' ],
+ *   [ 'name:ja', 'hentai' ],
+ *   [ 'name:zh', '测试_' ],
+ *   [ 'namespace', 'https://github.com/lisonge' ],
+ *   [ 'version', '1.0.1' ],
+ *   [ 'author', 'lisonge' ],
+ *   [ 'description', 'default description zh' ],
+ *   [ 'description:zh', '描述' ],
+ *   [ 'description:en', 'description' ],
+ *   [ 'description:ja', '説明z' ],
+ *   [ 'description:zh-CN', '描述' ],
+ *   [ 'license', 'MIT' ],
+ *   [ 'icon', 'https://vitejs.dev/logo.svg' ],
+ *   [
+ *     'homepage',
+ *     'https://github.com/lisonge/vite-plugin-monkey#readme'
+ *   ],
+ *   [
+ *     'homepageURL',
+ *     'https://github.com/lisonge/vite-plugin-monkey#readme'
+ *   ],
+ *   [ 'source', 'https://github.com/lisonge/vite-plugin-monkey.git' ],
+ *   [
+ *     'supportURL',
+ *     'https://github.com/lisonge/vite-plugin-monkey/issues'
+ *   ],
+ *   [ 'match', 'https://songe.li/' ],
+ *   [ 'require', 'https://cdn.jsdelivr.net/npm/blueimp-md5@2.19.0' ],
+ *   [
+ *     'require',
+ *     'https://cdn.jsdelivr.net/npm/prettier@2.7.1/standalone.js'
+ *   ],
+ *   [
+ *     'require',
+ *     'https://cdn.jsdelivr.net/npm/prettier@2.7.1/parser-babel.js'
+ *   ],
+ *   [ 'grant', 'GM_addElement' ],
+ *   [ 'grant', 'GM_cookie' ],
+ *   [ 'grant', 'unsafeWindow' ]
+ * ]
+ */
+type AlignFunc = (p0: [string, ...string[]][]) => IPromise<[string, ...string[]][]>;
+
+type GreaseRunAt = 'document-start' | 'document-end' | 'document-idle';
+type GreaseGrant = 'GM.info' | 'GM.deleteValue' | 'GM.getValue' | 'GM.listValues' | 'GM.setValue' | 'GM.getResourceUrl' | 'GM.notification' | 'GM.openInTab' | 'GM.registerMenuCommand' | 'GM.setClipboard' | 'GM.xmlHttpRequest' | 'unsafeWindow';
+/**
+ * @see https://wiki.greasespot.net/Metadata_Block
+ */
+interface GreasemonkeyUserScript {
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40name
+     *
+     */
+    name?: string | LocaleType<string>;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40namespace
+     */
+    namespace?: string;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40version
+     *
+     */
+    version?: string;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40description
+     *
+     */
+    description?: string | LocaleType<string>;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40icon
+     */
+    icon?: string;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40include
+     */
+    include?: IArray<string | RegExp>;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40match
+     */
+    match?: IArray<string | RegExp>;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40exclude
+     */
+    exclude?: IArray<string | RegExp>;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40require
+     */
+    require?: IArray<string>;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40resource
+     */
+    resource?: Record<string, string>;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40noframes
+     */
+    noframes?: boolean;
+}
+
+type WebRequestRule = {
+    selector: string | {
+        include?: string | string[];
+        match?: string | string[];
+        exclude?: string | string[];
+    };
+    action: 'cancel' | {
+        cancel?: boolean;
+        redirect?: string | {
+            from: string;
+            to: string;
+        };
+    };
+};
+
+type TamperRunAt = 'document-start' | 'document-body' | 'document-end' | 'document-idle' | 'context-menu';
+type TamperGrant = 'unsafeWindow' | 'window.close' | 'window.focus' | 'window.onurlchange' | 'GM_addStyle' | 'GM_addElement' | 'GM_deleteValue' | 'GM_listValues' | 'GM_addValueChangeListener' | 'GM_removeValueChangeListener' | 'GM_setValue' | 'GM_getValue' | 'GM_log' | 'GM_getResourceText' | 'GM_getResourceURL' | 'GM_registerMenuCommand' | 'GM_unregisterMenuCommand' | 'GM_openInTab' | 'GM_xmlhttpRequest' | 'GM_download' | 'GM_getTab' | 'GM_saveTab' | 'GM_getTabs' | 'GM_notification' | 'GM_setClipboard' | 'GM_info' | 'GM_cookie' | 'GM_webRequest';
+type AntifeatureType = {
+    tag?: string;
+    type: 'ads' | 'tracking' | 'miner';
+    description: string;
+};
+/**
+ * @see https://www.tampermonkey.net/documentation.php
+ */
+interface TampermonkeyUserScript {
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:name
+     *
+     */
+    name?: string | LocaleType<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:author
+     *
+     */
+    author?: string;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:description
+     *
+     */
+    description?: string | LocaleType<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.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: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:include
+     */
+    include?: IArray<string | RegExp>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:match
+     */
+    match?: IArray<string | RegExp>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:exclude
+     */
+    exclude?: IArray<string | RegExp>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:require
+     */
+    require?: IArray<string>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:resource
+     */
+    resource?: Record<string, string>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:connect
+     */
+    connect?: IArray<string>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:sandbox
+     */
+    sandbox?: 'raw' | 'JavaScript' | 'DOM';
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:antifeature
+     */
+    antifeature?: IArray<AntifeatureType>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:noframes
+     */
+    noframes?: boolean;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:webRequest
+     */
+    webRequest?: IArray<WebRequestRule>;
+    /**
+     * @see https://www.tampermonkey.net/documentation.php#meta:unwrap
+     */
+    unwrap?: boolean;
+}
+
+type ViolentRunAt = 'document-end' | 'document-start' | 'document-idle';
+type ViolentInjectInto = 'page' | 'content' | 'auto';
+type ViolentGrant = 'window.close' | 'window.focus' | 'GM_info' | 'GM_getValue' | 'GM_setValue' | 'GM_deleteValue' | 'GM_listValues' | 'GM_addValueChangeListener' | 'GM_removeValueChangeListener' | 'GM_getResourceText' | 'GM_getResourceURL' | 'GM_addElement' | 'GM_addStyle' | 'GM_openInTab' | 'GM_registerMenuCommand' | 'GM_unregisterMenuCommand' | 'GM_notification' | 'GM_setClipboard' | 'GM_xmlhttpRequest' | 'GM_download' | 'GM.addStyle' | 'GM.addElement' | 'GM.registerMenuCommand' | 'GM.deleteValue' | 'GM.getResourceUrl' | 'GM.getValue' | 'GM.info' | 'GM.listValues' | 'GM.notification' | 'GM.openInTab' | 'GM.setClipboard' | 'GM.setValue' | 'GM.xmlHttpRequest';
+/**
+ * @see https://violentmonkey.github.io/api/metadata-block/
+ */
+interface ViolentmonkeyUserScript {
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#name
+     *
+     */
+    name?: string | LocaleType<string>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#namespace
+     */
+    namespace?: string;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#version
+     *
+     */
+    version?: string;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#description
+     *
+     */
+    description?: string | LocaleType<string>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#icon
+     */
+    icon?: string;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#downloadurl
+     */
+    downloadURL?: string;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#supporturl
+     */
+    supportURL?: string;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#homepageurl
+     *
+     */
+    homepageURL?: string;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#include--exclude
+     * @see https://violentmonkey.github.io/api/matching/#include--exclude
+     */
+    include?: IArray<string | RegExp>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#match--exclude-match
+     * @see https://violentmonkey.github.io/api/matching/#match--exclude-match
+     */
+    match?: IArray<string | RegExp>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#match--exclude-match
+     * @see https://violentmonkey.github.io/api/matching/#match--exclude-match
+     */
+    'exclude-match'?: IArray<string | RegExp>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#include--exclude
+     * @see https://violentmonkey.github.io/api/matching/#include--exclude
+     */
+    exclude?: IArray<string | RegExp>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#require
+     */
+    require?: IArray<string>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#resource
+     */
+    resource?: Record<string, string>;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#noframes
+     */
+    noframes?: boolean;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#inject-into
+     */
+    'inject-into'?: ViolentInjectInto;
+    /**
+     * @see https://violentmonkey.github.io/api/metadata-block/#unwrap
+     */
+    unwrap?: boolean;
+}
+
+/**
+ * @see https://greasyfork.org/help/meta-keys
+ */
+type GreasyforkUserScript = {
+    /**
+     * @see https://greasyfork.org/help/meta-keys
+     * @default package.json.license
+     */
+    license?: string;
+    /**
+     * @see https://greasyfork.org/help/meta-keys
+     */
+    contributionURL?: string;
+    /**
+     * @see https://greasyfork.org/help/meta-keys
+     */
+    contributionAmount?: string;
+    /**
+     * @see https://greasyfork.org/help/meta-keys
+     */
+    compatible?: string;
+    /**
+     * @see https://greasyfork.org/help/meta-keys
+     */
+    incompatible?: string;
+};
+type MergemonkeyUserScript = {
+    /**
+     * @default package.json.name??'monkey'
+     * @default {...{'':package.json.name??'monkey'},...name} // if name is object
+     */
+    name?: string | LocaleType<string>;
+    /**
+     * @default 'vite-plugin-monkey'
+     */
+    namespace?: string;
+    /**
+     * @default package.json.version??'1.0.0'
+     */
+    version?: string;
+    /**
+     * @default package.json.description
+     * @default {...{'':package.json.description},...description} // if description is object
+     */
+    description?: string | LocaleType<string>;
+    /**
+     * @default package.json.author??'monkey'
+     */
+    author?: string;
+    /**
+     * @default package.json.homepage
+     */
+    homepage?: string;
+    /**
+     * @default package.json.homepage
+     */
+    homepageURL?: string;
+    /**
+     * @default package.json.repository
+     */
+    source?: string;
+    /**
+     * @default package.json.bugs
+     */
+    supportURL?: string;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40run-at
+     *
+     * @see https://www.tampermonkey.net/documentation.php#meta:run_at
+     *
+     * @see https://violentmonkey.github.io/api/metadata-block/#run-at
+     *
+     */
+    'run-at'?: GreaseRunAt | TamperRunAt | ViolentRunAt;
+    /**
+     * @see https://wiki.greasespot.net/Metadata_Block#.40grant
+     *
+     * @see https://www.tampermonkey.net/documentation.php#meta:grant
+     *
+     * @see https://violentmonkey.github.io/api/metadata-block/#grant
+     *
+     * if set '\*', will add all GM_* to UserScript
+     */
+    grant?: IArray<GreaseGrant | TamperGrant | ViolentGrant> | 'none' | '*';
+    /**
+     * custom extra meta
+     * @example
+     * [['antifeature', ['miner', 'hello233']]]
+     * // -->
+     * // \@antifeature  miner     hello233
+     */
+    $extra?: [string, IArray<string>][] | Record<string, IArray<string>>;
+};
+/**
+ * UserScript, merge metadata from Greasemonkey, Tampermonkey, Violentmonkey, Greasyfork
+ */
+type MonkeyUserScript = GreasemonkeyUserScript & TampermonkeyUserScript & ViolentmonkeyUserScript & GreasyforkUserScript & MergemonkeyUserScript;
+
+type IPromise<T> = T | Promise<T>;
+type IArray<T = unknown> = T | T[];
+/**
+ * key is language code or ''
+ * @see https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
+ * @example
+ * {
+ *   '':'default_name',
+ *   'zh-CN':'名字',
+ *   ja: '名前'
+ * }
+ */
+type LocaleType<T = unknown> = Record<string, T>;
+type PkgOptions = {
+    name: string;
+    version: string;
+    importName: string;
+    resolveName: string;
+    resourceUrl: string;
+    resourceName: string;
+};
+type Pkg2UrlFn = (pkg: {
+    name: string;
+    version: string;
+    importName: string;
+    resolveName: string;
+}) => IPromise<string>;
+/**
+ * @param importName 'name/subname' in example
+ * @returns url or exportVarName
+ * @example
+ * const mod = await import('name/subname')
+ */
+type Mod2UrlFn = (version: string, name: string, importName: string) => IPromise<string>;
+type ModuleToUrlFc = (version: string, name: string, importName?: string, resolveName?: string) => string;
+type ExternalGlobals = Record<string, IArray<string | Mod2UrlFn>> | [string, IArray<string | Mod2UrlFn>][];
+type ExternalResource = Record<string, string | Pkg2UrlFn | {
+    resourceUrl: Pkg2UrlFn | string;
+    /**
+     * @default importName
+     */
+    resourceName?: Pkg2UrlFn | string;
+    loader?: (pkgOptions: PkgOptions) => unknown;
+    nodeLoader?: string | ((pkgOptions: PkgOptions) => IPromise<string>);
+} | Array<string | ((version: string, name: string, importName: string, resolveName: string) => IPromise<string>)>>;
+type MonkeyOption = {
+    /**
+     * userscript entry file path
+     */
+    entry: string;
+    userscript?: MonkeyUserScript;
+    format?: Format;
+    /**
+     * alias of vite-plugin-monkey/dist/client
+     * @default '$'
+     * @example
+     * // vite-env.d.ts for type hint
+     *
+     * // if you use default value `$`
+     * /// <reference types="vite-plugin-monkey/client" />
+     *
+     * // if you use other_alias
+     * declare module other_alias {
+     *   export * from 'vite-plugin-monkey/dist/client';
+     * }
+     */
+    clientAlias?: string;
+    server?: {
+        /**
+         * auto open install url in default browser when userscript comment change
+         *
+         * and set `viteConfig.server.open ??= monkeyConfig.server.open`
+         * @default
+         * process.platform == 'win32' || process.platform == 'darwin' // if platform is Win/Mac
+         */
+        open?: boolean;
+        /**
+         * name prefix, distinguish server.user.js and build.user.js in monkey extension install list, if you not want prefix, set false
+         * @default 'server:'
+         */
+        prefix?: string | ((name: string) => string) | false;
+        /**
+         * close the preview server automatically after 3000ms
+         * @default false
+         */
+        closePreviewAutomatically?: boolean;
+        /**
+         * mount GM_api to unsafeWindow, not recommend it, you should use GM_api by ESM import, or use [unplugin-auto-import](https://github.com/antfu/unplugin-auto-import)
+         * @default false
+         * @example
+         * // if set true, you can use `vite-plugin-monkey/global` for type hint
+         * // vite-env.d.ts
+         * /// <reference types="vite-plugin-monkey/global" />
+         */
+        mountGmApi?: boolean;
+    };
+    build?: {
+        /**
+         * build bundle userscript file name
+         *
+         * it should end with '.user.js'
+         * @default (package.json.name??'monkey')+'.user.js'
+         */
+        fileName?: string;
+        /**
+         * build bundle userscript comment file name, this file is only include comment
+         *
+         * it can be used by userscript.updateURL, when checking for updates, just download this small file instead of downloading the entire script
+         *
+         * it should end with '.meta.js', if set false, will not generate this file
+         *
+         * if set true, will equal to fileName.replace(/\\.user\\.js$/,'.meta.js')
+         *
+         * @default false
+         */
+        metaFileName?: string | boolean | ((fileName: string) => string);
+        /**
+         * this config can be array or object, array=Object.entries(object)
+         *
+         * if value is string or function, it or its return value is exportVarName
+         *
+         * if value is Array, the first [item or its return value] is exportVarName, the items after it all are url that is [require url]
+         *
+         * if module is unimported, plugin will not add require url to userscript
+         *
+         * @example
+         * { // map structure
+         *  vue:'Vue',
+         *  // if set this
+         *  // you need manually set userscript.require = ['https://unpkg.com/vue@3.0.0/dist/vue.global.js'], when `vite build`
+         *
+         *  vuex:['Vuex', (version, name)=>`https://unpkg.com/${name}@${version}/dist/vuex.global.js`],
+         *  // plugin will auto add this url to userscript.require
+         *
+         *  'prettier/parser-babel': [
+         *    'prettierPlugins.babel',
+         *    (version, name, importName) => {
+         *      // name == `prettier`
+         *      // importName == `prettier/parser-babel`
+         *      const subpath = `${importName.split('/').at(-1)}.js`;
+         *      return `https://cdn.jsdelivr.net/npm/${name}@${version}/${subpath}`;
+         *    },
+         *  ],
+         *  // sometimes importName deffers from package name
+         * }
+         * @example
+         * [ // array structure, this example come from [playground/ex-vue-demi](https://github.com/lisonge/vite-plugin-monkey/tree/main/playground/ex-vue-demi)
+         *   [
+         *     'vue',
+         *     cdn
+         *       .jsdelivr('Vue', 'dist/vue.global.prod.js')
+         *       .concat('https://unpkg.com/vue-demi@latest/lib/index.iife.js')
+         *       .concat(
+         *         await util.fn2dataUrl(() => {
+         *           window.Vue = Vue;
+         *         }),
+         *       ),
+         *   ],
+         *   ['pinia', cdn.jsdelivr('Pinia', 'dist/pinia.iife.prod.js')],
+         *   [
+         *     'element-plus',
+         *     cdn.jsdelivr('ElementPlus', 'dist/index.full.min.js'),
+         *   ],
+         * ]
+         */
+        externalGlobals?: ExternalGlobals;
+        /**
+         * according to final code bundle, auto inject GM_* or GM.* to userscript comment grant
+         *
+         * tree shaking code, then if code.includes('GM_xxx'), add \@grant GM_xxx to userscript
+         * @default true
+         */
+        autoGrant?: boolean;
+        /**
+         * @deprecated use [viteConfig.build.cssMinify](https://vitejs.dev/config/build-options.html#build-cssminify) in vite>=4.2.0
+         *
+         * now minifyCss will not work
+         */
+        minifyCss?: boolean;
+        /**
+         * @example
+         * {  // resourceName default value is pkg.importName
+         *   'element-plus/dist/index.css': pkg=>`https://unpkg.com/${pkg.name}@${pkg.version}/${pkg.resolveName}`,
+         *   'element-plus/dist/index.css': {
+         *     resourceName: pkg=>pkg.importName,
+         *     resourceUrl: pkg=>`https://unpkg.com/${pkg.name}@${pkg.version}/${pkg.resolveName}`,
+         *     loader: pkg=>{ // there are default loaders that support [css, json, the assets that vite support, ?url, ?raw] file/name suffix
+         *        const css = GM_getResourceText(pkg.resourceName);
+         *        GM_addStyle(css);
+         *        return css;
+         *     },
+         *     nodeLoader: pkg=>{
+         *        return [
+         *          `export default (()=>{`,
+         *          `const css = GM_getResourceText(${JSON.stringify(pkg.resourceName)});`,
+         *          `GM_addStyle(css);`,
+         *          `return css;`,
+         *          `})();`
+         *        ].join('');
+         *     },
+         *   },
+         *   'element-plus/dist/index.css': [
+         *      (version, name, importName, resolveName)=>importName,
+         *      (version, name, importName, resolveName)=>`https://unpkg.com/${name}@${version}/${resolveName}`,
+         *       // for compat externalGlobals cdn function, if (version/name/importName/resolveName) == '', plugin will use their own default values
+         *   ],
+         *   'element-plus/dist/index.css': cdn.jsdelivr(),
+         * }
+         */
+        externalResource?: ExternalResource;
+        /**
+         * when use dynamic-import, plugin will use systemjs build your code
+         *
+         * `cdn.jsdelivr()[1]` example -> [dynamic-import.user.js](https://github.com/lisonge/vite-plugin-monkey/blob/7645b185605faf9b48c43116db5ea01726188e03/playground/dynamic-import/dist/dynamic-import.user.js)
+         *
+         * `'inline'` exmple -> [test-v3.user.js](https://github.com/lisonge/vite-plugin-monkey/blob/7645b185605faf9b48c43116db5ea01726188e03/playground/test-v3/dist/test-v3.user.js)
+         *
+         * @default
+         * cdn.jsdelivr()[1]
+         */
+        systemjs?: 'inline' | ModuleToUrlFc;
+        /**
+         * @default
+         * const defaultFc = () => {
+         *   return (e: string) => {
+         *     if (typeof GM_addStyle == 'function') {
+         *       GM_addStyle(e);
+         *       return;
+         *     }
+         *     const o = document.createElement('style');
+         *     o.textContent = e;
+         *     document.head.append(o);
+         *   };
+         * };
+         * @example
+         * const defaultFc1 = () => {
+         *   return (e: string) => {
+         *     const o = document.createElement('style');
+         *     o.textContent = e;
+         *     document.head.append(o);
+         *   };
+         * };
+         * const defaultFc2 = (css:string)=>{
+         *   const t = JSON.stringify(css)
+         *   return `(e=>{const o=document.createElement("style");o.textContent=e,document.head.append(o)})(${t})`
+         * }
+         */
+        cssSideEffects?: (css: string) => IPromise<string | ((css: string) => void)>;
+    };
+};
+
+/**
+ * `https://cdn.jsdelivr.net/npm/${name}@${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @param pathname jsdelivr support file combine, normally you don't need set pathname
+ * @see https://www.jsdelivr.com/features
+ */
+declare const jsdelivr: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://fastly.jsdelivr.net/npm/${name}@${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @param pathname jsdelivr support file combine, normally you don't need set pathname
+ * @see https://www.jsdelivr.com/features
+ */
+declare const jsdelivrFastly: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://unpkg.com/${name}@${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @see https://unpkg.com/
+ */
+declare const unpkg: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://lf9-cdn-tos.bytecdntp.com/cdn/expire-10-y/${name}/${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @see https://cdn.bytedance.com/
+ */
+declare const bytecdntp: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://cdn.jsdelivr.net/npm/${name}@${version}/${pathname}`
+ * @deprecated bootcdn will return virus-infected code. Please stop using it and switch to other sources
+ */
+declare const bootcdn: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://lib.baomitu.com/${name}/${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @see https://cdn.baomitu.com/
+ */
+declare const baomitu: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://cdn.staticfile.org/${name}/${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @see https://staticfile.org/
+ */
+declare const staticfile: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://cdnjs.cloudflare.com/ajax/libs/${name}/${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @see https://cdnjs.com/libraries
+ */
+declare const cdnjs: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://unpkg.zhimg.com/${name}/${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ * @link https://unpkg.zhimg.com/
+ */
+declare const zhimg: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://npm.elemecdn.com/${name}@${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ */
+declare const elemecdn: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://code.bdstatic.com/npm/${name}@${version}/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ */
+declare const bdstatic: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+/**
+ * `https://registry.npmmirror.com/${name}/${version}/files/${pathname}`
+ * @param exportVarName cdn-exportVarName or resourceName
+ */
+declare const npmmirror: (exportVarName?: string, pathname?: string) => [string, ModuleToUrlFc];
+
+declare const cdn_baomitu: typeof baomitu;
+declare const cdn_bdstatic: typeof bdstatic;
+declare const cdn_bootcdn: typeof bootcdn;
+declare const cdn_bytecdntp: typeof bytecdntp;
+declare const cdn_cdnjs: typeof cdnjs;
+declare const cdn_elemecdn: typeof elemecdn;
+declare const cdn_jsdelivr: typeof jsdelivr;
+declare const cdn_jsdelivrFastly: typeof jsdelivrFastly;
+declare const cdn_npmmirror: typeof npmmirror;
+declare const cdn_staticfile: typeof staticfile;
+declare const cdn_unpkg: typeof unpkg;
+declare const cdn_zhimg: typeof zhimg;
+declare namespace cdn {
+  export { cdn_baomitu as baomitu, cdn_bdstatic as bdstatic, cdn_bootcdn as bootcdn, cdn_bytecdntp as bytecdntp, cdn_cdnjs as cdnjs, cdn_elemecdn as elemecdn, cdn_jsdelivr as jsdelivr, cdn_jsdelivrFastly as jsdelivrFastly, cdn_npmmirror as npmmirror, cdn_staticfile as staticfile, cdn_unpkg as unpkg, cdn_zhimg as zhimg };
+}
+
+/**
+ * transform function and parameter to iife code then mini code then transform code to data url string
+ *
+ * this tool function is used to make umd-cdn and iife-cdn work normally, such as element-plus and vue
+ *
+ * @example
+ * // this example comes form https://github.com/lisonge/vite-plugin-monkey/blob/main/playground/ex-vue-demi/vite.config.ts
+ * const externalGlobals = [
+ *   [
+ *     'vue',
+ *     cdn
+ *       .jsdelivr('Vue', 'dist/vue.global.prod.js')
+ *       .concat('https://unpkg.com/vue-demi@latest/lib/index.iife.js')
+ *       .concat(
+ *         await util.fn2dataUrl(() => {
+ *           // \@ts-ignore
+ *           window.Vue = Vue; // work with element-plus
+ *         }),
+ *       ),
+ *   ],
+ *   ['pinia', cdn.jsdelivr('Pinia', 'dist/pinia.iife.prod.js')],
+ *   ['element-plus', cdn.jsdelivr('ElementPlus', 'dist/index.full.min.js')],
+ * ];
+ */
+declare const fn2dataUrl: <T extends (...args: any[]) => any>(fn: T, ...args: Parameters<T>) => Promise<string>;
+/**
+ * string -> javascript data url
+ */
+declare function dataUrl(code: string): string;
+/**
+ * function and it parameters -> iife -> mini_iife -> javascript data url
+ */
+declare function dataUrl<T extends (...args: any[]) => any>(fn: T, ...args: Parameters<T>): Promise<string>;
+/**
+ * GM api preset when you use unimport/unplugin-auto-import
+ *
+ * Note, there is not comment in unimport.d.ts/auto-imports.d.ts file
+ */
+declare const unimportPreset: InlinePreset;
+
+declare const util_dataUrl: typeof dataUrl;
+declare const util_fn2dataUrl: typeof fn2dataUrl;
+declare const util_unimportPreset: typeof unimportPreset;
+declare namespace util {
+  export { util_dataUrl as dataUrl, util_fn2dataUrl as fn2dataUrl, util_unimportPreset as unimportPreset };
+}
+
+declare const _default: (pluginOption: MonkeyOption) => Plugin[];
+
+export { type Format, type GreasemonkeyUserScript, type MonkeyOption, type MonkeyUserScript, type TampermonkeyUserScript, type ViolentmonkeyUserScript, cdn, _default as default, util };