@xysfe/vite-plugin-dev-proxy 1.0.2 → 1.0.4

package/dist/index.d.cts

@@ -1,17 +1,191 @@
 import { Plugin } from 'vite';
 
+/**
+ * 代理插件配置选项
+ * @interface ProxyOptions
+ */
 interface ProxyOptions {
+    /** 是否使用HTTPS协议，默认true */
     https?: boolean;
+    /** 代理目标主机地址（必填），如：'example.com' */
     appHost?: string;
-    isLib?: boolean;
+    /** 本地HTML文件路径，默认'' */
     localIndexHtml?: string;
+    /** 静态资源路径前缀，默认为空字符串 */
     staticPrefix?: string;
-    bypassPrefixes?: string[];
+    /** 远程资源路径前缀规则，支持字符串、数组、函数、正则，默认['/static/component'] */
+    remotePrefixes?: string | string[] | Function | RegExp;
+    /** 清除脚本/CSS的前缀规则，支持字符串、数组、函数、正则 */
     clearScriptCssPrefixes?: string | string[] | Function | RegExp;
+    /** 开发代理占位符，用于替换为入口脚本 */
     developmentAgentOccupancy?: string;
-    entry?: string;
+    /** 入口文件路径，支持单个或多个入口，默认'/src/main.js' */
+    entry?: string | string[];
+    /** 是否开启调试模式，开启后会输出详细日志，默认false */
     debug?: boolean;
 }
+/**
+ * HTTP请求消息对象
+ * @interface IncomingMessage
+ */
+interface IncomingMessage {
+    /** 请求URL */
+    url?: string;
+    /** 请求头 */
+    headers: {
+        [key: string]: string | string[] | undefined;
+    };
+    /** 请求方法 */
+    method?: string;
+    /** 主机地址 */
+    host?: string;
+    /** Accept头 */
+    accept?: string;
+}
+/**
+ * 代理响应对象
+ * @interface ProxyResponse
+ */
+interface ProxyResponse {
+    /** HTTP状态码 */
+    statusCode: number;
+    /** 响应头 */
+    headers: {
+        [key: string]: string | string[] | undefined;
+    };
+    /** 监听事件 */
+    on: (event: string, callback: (chunk?: Buffer) => void) => void;
+    /** 管道传输 */
+    pipe: (destination: any) => void;
+}
+/**
+ * HTTP响应对象
+ * @interface ServerResponse
+ */
+interface ServerResponse {
+    /** 写入响应头 */
+    writeHead: (statusCode: number, headers?: {
+        [key: string]: string | string[] | undefined;
+    }) => void;
+    /** 结束响应 */
+    end: (data?: string) => void;
+    /** 响应头是否已发送 */
+    headersSent?: boolean;
+}
+
+/**
+ * Vite开发代理插件
+ *
+ * 用于在开发环境下代理远程服务器，同时支持本地模块热更新。
+ * 主要特性：
+ * - 自动代理远程服务器的HTML、API等请求
+ * - 自动注入本地入口脚本到远程HTML
+ * - 支持清除远程HTML中的脚本和样式标签
+ * - 处理Cookie、重定向等，确保本地开发体验
+ * - 支持多入口配置
+ * - 支持库模式，使用本地HTML文件
+ *
+ * @param {ProxyOptions} options - 插件配置选项
+ * @returns {Plugin} Vite插件对象
+ *
+ * @example
+ * // vite.config.js
+ * import viteDevProxy from 'vite-plugin-dev-proxy';
+ *
+ * export default {
+ *   plugins: [
+ *     viteDevProxy({
+ *       appHost: 'example.com',
+ *       https: true,
+ *       entry: '/src/main.js',
+ *       staticPrefix: '',
+ *       remotePrefixes: ['/static'],
+ *       clearScriptCssPrefixes: '/static',
+ *       debug: true
+ *     })
+ *   ]
+ * }
+ */
 declare function viteDevProxy(options?: ProxyOptions): Plugin;
 
-export { viteDevProxy as default };
+/**
+ * 代理配置对象
+ * @interface ProxyConfig
+ */
+interface ProxyConfig {
+    /** 代理目标地址 */
+    target: string;
+    /** 是否改变origin头 */
+    changeOrigin: boolean;
+    /** 是否验证SSL证书 */
+    secure: boolean;
+    /** Cookie域名重写配置 */
+    cookieDomainRewrite: {
+        [key: string]: string;
+    };
+    /** 是否自行处理响应 */
+    selfHandleResponse: boolean;
+    ws?: boolean;
+    /** 代理请求钩子 */
+    onProxyReq?: (proxyReq: any, req: IncomingMessage, res: ServerResponse) => void;
+    /** 代理错误钩子 */
+    onError?: (err: Error, req: IncomingMessage, res: ServerResponse) => void;
+    /** 代理响应钩子 */
+    onProxyRes?: (proxyRes: ProxyResponse, req: IncomingMessage, res: ServerResponse) => void;
+    /** 请求绕过函数，返回url则使用本地资源 */
+    bypass?: (req: IncomingMessage) => string | null | undefined;
+}
+/**
+ * Vue CLI配置对象
+ * @interface VueCliConfig
+ */
+interface VueCliConfig {
+    devServer?: {
+        proxy?: Record<string, ProxyConfig>;
+    };
+}
+/**
+ * 创建Vue CLI开发服务器代理配置
+ *
+ * @param {ProxyOptions} options - 代理配置选项
+ * @returns {Record<string, ProxyConfig>} 返回代理配置对象
+ * @throws {Error} 当 appHost 未提供或 remotePrefixes 不是数组时抛出错误
+ */
+declare function createVueCliProxyConfig(options: ProxyOptions): Record<string, ProxyConfig>;
+/**
+ * Vue CLI开发代理插件
+ *
+ * 用于在开发环境下代理远程服务器，同时支持本地模块热更新。
+ * 主要特性：
+ * - 自动代理远程服务器的HTML、API等请求
+ * - 自动注入本地入口脚本到远程HTML
+ * - 支持清除远程HTML中的脚本和样式标签
+ * - 处理Cookie、重定向等，确保本地开发体验
+ * - 支持多入口配置
+ * - 支持库模式，使用本地HTML文件
+ *
+ * @param {ProxyOptions} options - 插件配置选项
+ * @returns {VueCliConfig} Vue CLI配置对象
+ *
+ * @example
+ * // vue.config.js
+ * const vueCliDevProxy = require('vite-plugin-dev-proxy/vue-cli');
+ *
+ * module.exports = vueCliDevProxy({
+ *   appHost: 'example.com',
+ *   https: true,
+ *   entry: '/src/main.js',
+ *   staticPrefix: '',
+ *   remotePrefixes: ['/static'],
+ *   clearScriptCssPrefixes: '/static',
+ *   debug: true
+ * });
+ */
+declare function vueCliDevProxy(options?: ProxyOptions): VueCliConfig;
+
+declare const _default: {
+    VitePluginDevProxy: typeof viteDevProxy;
+    VueCliPluginDevProxy: typeof vueCliDevProxy;
+};
+
+export { viteDevProxy as VitePluginDevProxy, vueCliDevProxy as VueCliPluginDevProxy, createVueCliProxyConfig, _default as default };

package/dist/index.d.mts

@@ -1,17 +1,191 @@
 import { Plugin } from 'vite';
 
+/**
+ * 代理插件配置选项
+ * @interface ProxyOptions
+ */
 interface ProxyOptions {
+    /** 是否使用HTTPS协议，默认true */
     https?: boolean;
+    /** 代理目标主机地址（必填），如：'example.com' */
     appHost?: string;
-    isLib?: boolean;
+    /** 本地HTML文件路径，默认'' */
     localIndexHtml?: string;
+    /** 静态资源路径前缀，默认为空字符串 */
     staticPrefix?: string;
-    bypassPrefixes?: string[];
+    /** 远程资源路径前缀规则，支持字符串、数组、函数、正则，默认['/static/component'] */
+    remotePrefixes?: string | string[] | Function | RegExp;
+    /** 清除脚本/CSS的前缀规则，支持字符串、数组、函数、正则 */
     clearScriptCssPrefixes?: string | string[] | Function | RegExp;
+    /** 开发代理占位符，用于替换为入口脚本 */
     developmentAgentOccupancy?: string;
-    entry?: string;
+    /** 入口文件路径，支持单个或多个入口，默认'/src/main.js' */
+    entry?: string | string[];
+    /** 是否开启调试模式，开启后会输出详细日志，默认false */
     debug?: boolean;
 }
+/**
+ * HTTP请求消息对象
+ * @interface IncomingMessage
+ */
+interface IncomingMessage {
+    /** 请求URL */
+    url?: string;
+    /** 请求头 */
+    headers: {
+        [key: string]: string | string[] | undefined;
+    };
+    /** 请求方法 */
+    method?: string;
+    /** 主机地址 */
+    host?: string;
+    /** Accept头 */
+    accept?: string;
+}
+/**
+ * 代理响应对象
+ * @interface ProxyResponse
+ */
+interface ProxyResponse {
+    /** HTTP状态码 */
+    statusCode: number;
+    /** 响应头 */
+    headers: {
+        [key: string]: string | string[] | undefined;
+    };
+    /** 监听事件 */
+    on: (event: string, callback: (chunk?: Buffer) => void) => void;
+    /** 管道传输 */
+    pipe: (destination: any) => void;
+}
+/**
+ * HTTP响应对象
+ * @interface ServerResponse
+ */
+interface ServerResponse {
+    /** 写入响应头 */
+    writeHead: (statusCode: number, headers?: {
+        [key: string]: string | string[] | undefined;
+    }) => void;
+    /** 结束响应 */
+    end: (data?: string) => void;
+    /** 响应头是否已发送 */
+    headersSent?: boolean;
+}
+
+/**
+ * Vite开发代理插件
+ *
+ * 用于在开发环境下代理远程服务器，同时支持本地模块热更新。
+ * 主要特性：
+ * - 自动代理远程服务器的HTML、API等请求
+ * - 自动注入本地入口脚本到远程HTML
+ * - 支持清除远程HTML中的脚本和样式标签
+ * - 处理Cookie、重定向等，确保本地开发体验
+ * - 支持多入口配置
+ * - 支持库模式，使用本地HTML文件
+ *
+ * @param {ProxyOptions} options - 插件配置选项
+ * @returns {Plugin} Vite插件对象
+ *
+ * @example
+ * // vite.config.js
+ * import viteDevProxy from 'vite-plugin-dev-proxy';
+ *
+ * export default {
+ *   plugins: [
+ *     viteDevProxy({
+ *       appHost: 'example.com',
+ *       https: true,
+ *       entry: '/src/main.js',
+ *       staticPrefix: '',
+ *       remotePrefixes: ['/static'],
+ *       clearScriptCssPrefixes: '/static',
+ *       debug: true
+ *     })
+ *   ]
+ * }
+ */
 declare function viteDevProxy(options?: ProxyOptions): Plugin;
 
-export { viteDevProxy as default };
+/**
+ * 代理配置对象
+ * @interface ProxyConfig
+ */
+interface ProxyConfig {
+    /** 代理目标地址 */
+    target: string;
+    /** 是否改变origin头 */
+    changeOrigin: boolean;
+    /** 是否验证SSL证书 */
+    secure: boolean;
+    /** Cookie域名重写配置 */
+    cookieDomainRewrite: {
+        [key: string]: string;
+    };
+    /** 是否自行处理响应 */
+    selfHandleResponse: boolean;
+    ws?: boolean;
+    /** 代理请求钩子 */
+    onProxyReq?: (proxyReq: any, req: IncomingMessage, res: ServerResponse) => void;
+    /** 代理错误钩子 */
+    onError?: (err: Error, req: IncomingMessage, res: ServerResponse) => void;
+    /** 代理响应钩子 */
+    onProxyRes?: (proxyRes: ProxyResponse, req: IncomingMessage, res: ServerResponse) => void;
+    /** 请求绕过函数，返回url则使用本地资源 */
+    bypass?: (req: IncomingMessage) => string | null | undefined;
+}
+/**
+ * Vue CLI配置对象
+ * @interface VueCliConfig
+ */
+interface VueCliConfig {
+    devServer?: {
+        proxy?: Record<string, ProxyConfig>;
+    };
+}
+/**
+ * 创建Vue CLI开发服务器代理配置
+ *
+ * @param {ProxyOptions} options - 代理配置选项
+ * @returns {Record<string, ProxyConfig>} 返回代理配置对象
+ * @throws {Error} 当 appHost 未提供或 remotePrefixes 不是数组时抛出错误
+ */
+declare function createVueCliProxyConfig(options: ProxyOptions): Record<string, ProxyConfig>;
+/**
+ * Vue CLI开发代理插件
+ *
+ * 用于在开发环境下代理远程服务器，同时支持本地模块热更新。
+ * 主要特性：
+ * - 自动代理远程服务器的HTML、API等请求
+ * - 自动注入本地入口脚本到远程HTML
+ * - 支持清除远程HTML中的脚本和样式标签
+ * - 处理Cookie、重定向等，确保本地开发体验
+ * - 支持多入口配置
+ * - 支持库模式，使用本地HTML文件
+ *
+ * @param {ProxyOptions} options - 插件配置选项
+ * @returns {VueCliConfig} Vue CLI配置对象
+ *
+ * @example
+ * // vue.config.js
+ * const vueCliDevProxy = require('vite-plugin-dev-proxy/vue-cli');
+ *
+ * module.exports = vueCliDevProxy({
+ *   appHost: 'example.com',
+ *   https: true,
+ *   entry: '/src/main.js',
+ *   staticPrefix: '',
+ *   remotePrefixes: ['/static'],
+ *   clearScriptCssPrefixes: '/static',
+ *   debug: true
+ * });
+ */
+declare function vueCliDevProxy(options?: ProxyOptions): VueCliConfig;
+
+declare const _default: {
+    VitePluginDevProxy: typeof viteDevProxy;
+    VueCliPluginDevProxy: typeof vueCliDevProxy;
+};
+
+export { viteDevProxy as VitePluginDevProxy, vueCliDevProxy as VueCliPluginDevProxy, createVueCliProxyConfig, _default as default };

package/dist/index.d.ts

@@ -1,17 +1,191 @@
 import { Plugin } from 'vite';
 
+/**
+ * 代理插件配置选项
+ * @interface ProxyOptions
+ */
 interface ProxyOptions {
+    /** 是否使用HTTPS协议，默认true */
     https?: boolean;
+    /** 代理目标主机地址（必填），如：'example.com' */
     appHost?: string;
-    isLib?: boolean;
+    /** 本地HTML文件路径，默认'' */
     localIndexHtml?: string;
+    /** 静态资源路径前缀，默认为空字符串 */
     staticPrefix?: string;
-    bypassPrefixes?: string[];
+    /** 远程资源路径前缀规则，支持字符串、数组、函数、正则，默认['/static/component'] */
+    remotePrefixes?: string | string[] | Function | RegExp;
+    /** 清除脚本/CSS的前缀规则，支持字符串、数组、函数、正则 */
     clearScriptCssPrefixes?: string | string[] | Function | RegExp;
+    /** 开发代理占位符，用于替换为入口脚本 */
     developmentAgentOccupancy?: string;
-    entry?: string;
+    /** 入口文件路径，支持单个或多个入口，默认'/src/main.js' */
+    entry?: string | string[];
+    /** 是否开启调试模式，开启后会输出详细日志，默认false */
     debug?: boolean;
 }
+/**
+ * HTTP请求消息对象
+ * @interface IncomingMessage
+ */
+interface IncomingMessage {
+    /** 请求URL */
+    url?: string;
+    /** 请求头 */
+    headers: {
+        [key: string]: string | string[] | undefined;
+    };
+    /** 请求方法 */
+    method?: string;
+    /** 主机地址 */
+    host?: string;
+    /** Accept头 */
+    accept?: string;
+}
+/**
+ * 代理响应对象
+ * @interface ProxyResponse
+ */
+interface ProxyResponse {
+    /** HTTP状态码 */
+    statusCode: number;
+    /** 响应头 */
+    headers: {
+        [key: string]: string | string[] | undefined;
+    };
+    /** 监听事件 */
+    on: (event: string, callback: (chunk?: Buffer) => void) => void;
+    /** 管道传输 */
+    pipe: (destination: any) => void;
+}
+/**
+ * HTTP响应对象
+ * @interface ServerResponse
+ */
+interface ServerResponse {
+    /** 写入响应头 */
+    writeHead: (statusCode: number, headers?: {
+        [key: string]: string | string[] | undefined;
+    }) => void;
+    /** 结束响应 */
+    end: (data?: string) => void;
+    /** 响应头是否已发送 */
+    headersSent?: boolean;
+}
+
+/**
+ * Vite开发代理插件
+ *
+ * 用于在开发环境下代理远程服务器，同时支持本地模块热更新。
+ * 主要特性：
+ * - 自动代理远程服务器的HTML、API等请求
+ * - 自动注入本地入口脚本到远程HTML
+ * - 支持清除远程HTML中的脚本和样式标签
+ * - 处理Cookie、重定向等，确保本地开发体验
+ * - 支持多入口配置
+ * - 支持库模式，使用本地HTML文件
+ *
+ * @param {ProxyOptions} options - 插件配置选项
+ * @returns {Plugin} Vite插件对象
+ *
+ * @example
+ * // vite.config.js
+ * import viteDevProxy from 'vite-plugin-dev-proxy';
+ *
+ * export default {
+ *   plugins: [
+ *     viteDevProxy({
+ *       appHost: 'example.com',
+ *       https: true,
+ *       entry: '/src/main.js',
+ *       staticPrefix: '',
+ *       remotePrefixes: ['/static'],
+ *       clearScriptCssPrefixes: '/static',
+ *       debug: true
+ *     })
+ *   ]
+ * }
+ */
 declare function viteDevProxy(options?: ProxyOptions): Plugin;
 
-export { viteDevProxy as default };
+/**
+ * 代理配置对象
+ * @interface ProxyConfig
+ */
+interface ProxyConfig {
+    /** 代理目标地址 */
+    target: string;
+    /** 是否改变origin头 */
+    changeOrigin: boolean;
+    /** 是否验证SSL证书 */
+    secure: boolean;
+    /** Cookie域名重写配置 */
+    cookieDomainRewrite: {
+        [key: string]: string;
+    };
+    /** 是否自行处理响应 */
+    selfHandleResponse: boolean;
+    ws?: boolean;
+    /** 代理请求钩子 */
+    onProxyReq?: (proxyReq: any, req: IncomingMessage, res: ServerResponse) => void;
+    /** 代理错误钩子 */
+    onError?: (err: Error, req: IncomingMessage, res: ServerResponse) => void;
+    /** 代理响应钩子 */
+    onProxyRes?: (proxyRes: ProxyResponse, req: IncomingMessage, res: ServerResponse) => void;
+    /** 请求绕过函数，返回url则使用本地资源 */
+    bypass?: (req: IncomingMessage) => string | null | undefined;
+}
+/**
+ * Vue CLI配置对象
+ * @interface VueCliConfig
+ */
+interface VueCliConfig {
+    devServer?: {
+        proxy?: Record<string, ProxyConfig>;
+    };
+}
+/**
+ * 创建Vue CLI开发服务器代理配置
+ *
+ * @param {ProxyOptions} options - 代理配置选项
+ * @returns {Record<string, ProxyConfig>} 返回代理配置对象
+ * @throws {Error} 当 appHost 未提供或 remotePrefixes 不是数组时抛出错误
+ */
+declare function createVueCliProxyConfig(options: ProxyOptions): Record<string, ProxyConfig>;
+/**
+ * Vue CLI开发代理插件
+ *
+ * 用于在开发环境下代理远程服务器，同时支持本地模块热更新。
+ * 主要特性：
+ * - 自动代理远程服务器的HTML、API等请求
+ * - 自动注入本地入口脚本到远程HTML
+ * - 支持清除远程HTML中的脚本和样式标签
+ * - 处理Cookie、重定向等，确保本地开发体验
+ * - 支持多入口配置
+ * - 支持库模式，使用本地HTML文件
+ *
+ * @param {ProxyOptions} options - 插件配置选项
+ * @returns {VueCliConfig} Vue CLI配置对象
+ *
+ * @example
+ * // vue.config.js
+ * const vueCliDevProxy = require('vite-plugin-dev-proxy/vue-cli');
+ *
+ * module.exports = vueCliDevProxy({
+ *   appHost: 'example.com',
+ *   https: true,
+ *   entry: '/src/main.js',
+ *   staticPrefix: '',
+ *   remotePrefixes: ['/static'],
+ *   clearScriptCssPrefixes: '/static',
+ *   debug: true
+ * });
+ */
+declare function vueCliDevProxy(options?: ProxyOptions): VueCliConfig;
+
+declare const _default: {
+    VitePluginDevProxy: typeof viteDevProxy;
+    VueCliPluginDevProxy: typeof vueCliDevProxy;
+};
+
+export { viteDevProxy as VitePluginDevProxy, vueCliDevProxy as VueCliPluginDevProxy, createVueCliProxyConfig, _default as default };