@gylautorun/dev-proxy-cookie 1.0.0-beta.1

package/dist/index.d.mts

@@ -0,0 +1,264 @@
+import * as net from 'net';
+import { IncomingMessage, ServerResponse } from 'http';
+import { ViteDevServer, Plugin } from 'vite';
+
+type ErrorCallback = (err: Error, req: IncomingMessage, res: ServerResponse | net.Socket) => void;
+interface ProxyHooks {
+    onProxyReq?: (proxyReq: any, req: IncomingMessage, res: ServerResponse) => void;
+    onProxyRes?: (proxyRes: any, req: IncomingMessage, res: ServerResponse) => void;
+    onError?: ErrorCallback;
+    onWsError?: (err: Error, req: IncomingMessage, socket: net.Socket) => void;
+}
+interface AutoProxyCookieOptions {
+    cookieFile: string;
+    target: string;
+    debug?: boolean;
+    autoRestart?: boolean;
+    restartMarkerFile?: string;
+    proxyMap?: Record<string, string>;
+    ignorePaths?: string[];
+    ws?: boolean;
+    changeOrigin?: boolean;
+    secure?: boolean;
+    followRedirects?: boolean;
+    autoRewrite?: boolean;
+    protocolRewrite?: string;
+    logLevel?: 'debug' | 'info' | 'warn' | 'error';
+    cookieDomainRewrite?: false | string | {
+        [oldDomain: string]: string;
+    };
+    cookiePathRewrite?: false | string | {
+        [oldPath: string]: string;
+    };
+    headers?: {
+        [header: string]: string;
+    };
+    hooks?: ProxyHooks;
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare class AutoProxyCookie {
+    private options;
+    private currentCookie;
+    private server;
+    private proxyServer;
+    private watcher;
+    private cookieReader;
+    constructor(options: AutoProxyCookieOptions);
+    private handleCookieChange;
+    private getProxyUrl;
+    private isIgnoredPath;
+    private log;
+    private createProxyOptions;
+    private handleOnProxyReq;
+    private handleOnProxyRes;
+    private handleOnError;
+    private handleOnWsError;
+    setup(server: ViteDevServer): Promise<void>;
+    private startFileWatch;
+    stop(): void;
+    getCurrentCookie(): string;
+}
+declare function createAutoProxyCookie(options: AutoProxyCookieOptions): AutoProxyCookie;
+
+interface ViteAutoProxyCookiePluginOptions extends AutoProxyCookieOptions {
+    name?: string;
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare function viteAutoProxyCookie(options: ViteAutoProxyCookiePluginOptions): Plugin;
+
+interface ViteDevProxyCookieOptions {
+    cookieFile: string;
+    debug?: boolean;
+    onCookieChange?: (cookie: string) => void;
+    /**
+     * 是否监听文件变化
+     * - true: 始终监听
+     * - false: 从不监听
+     * - 'auto': 根据环境自动判断（默认）
+     * @default 'auto'
+     */
+    watch?: boolean | 'auto';
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare function viteDevProxyCookie(options: ViteDevProxyCookieOptions): Plugin;
+
+/** Options for {@link createFileCookieGetter}. */
+interface CreateFileCookieGetterOptions {
+    /**
+     * 是否监听文件变化
+     * - true: 始终监听
+     * - false: 从不监听
+     * - 'auto': 根据环境自动判断（默认）
+     *
+     * Cookie 值每次代理请求时都会从磁盘读取，因此即使 watch 为 false，
+     * 修改 cookie 文件后也不需要重启开发服务器。
+     * @default 'auto'
+     */
+    watch?: boolean | 'auto';
+    /** Log when the cookie file changes (only if `watch` is true). @default false */
+    debug?: boolean;
+    /**
+     * 自定义生产环境变量名称列表，用于判断是否禁用监听
+     * 例如: ['MY_APP_ENV', 'BUILD_TYPE']
+     */
+    productionEnvs?: string[];
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+interface VueProxyConfigOptions {
+    getCookie?: () => string;
+    debug?: boolean;
+    headers?: Record<string, string>;
+    ws?: boolean;
+    changeOrigin?: boolean;
+    secure?: boolean;
+    onError?: (err: Error) => void;
+}
+interface ProxyConfig {
+    ws: boolean;
+    target: string;
+    changeOrigin: boolean;
+    secure: boolean;
+    onProxyReq: (proxyReq: any, req: IncomingMessage) => void;
+    onProxyRes?: (proxyRes: any, req: IncomingMessage) => void;
+    onError: (err: Error) => void;
+    headers?: Record<string, string>;
+}
+declare function createVueProxyConfig(target: string, options?: VueProxyConfigOptions): ProxyConfig;
+declare function createFileCookieGetter(cookieFile: string, options?: CreateFileCookieGetterOptions): () => string;
+interface AutoProxyConfigOptions extends VueProxyConfigOptions {
+    target: string;
+    ignorePaths?: string[];
+    includePaths?: string[];
+    additionalProxies?: Record<string, string>;
+}
+declare function createAutoProxyConfig(options: AutoProxyConfigOptions): Record<string, ProxyConfig>;
+
+interface UnifiedProxyCookieOptions {
+    cookieFile: string;
+    target?: string;
+    debug?: boolean;
+    autoRestart?: boolean;
+    restartMarkerFile?: string;
+    proxyMap?: Record<string, string>;
+    ignorePaths?: string[];
+    includePaths?: string[];
+    onCookieChange?: (cookie: string) => void;
+    mode?: 'auto' | 'proxy' | 'cookie';
+    /**
+     * 是否监听文件变化
+     * - true: 始终监听
+     * - false: 从不监听
+     * - 'auto': 根据环境自动判断（默认）
+     * @default 'auto'
+     */
+    watch?: boolean | 'auto';
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare function createDevProxyCookie(options: UnifiedProxyCookieOptions): Plugin;
+declare function getViteVersion(): string | null;
+declare function getViteMajorVersion(): number;
+
+interface CookieReaderOptions {
+    cookieFile: string;
+    encoding?: BufferEncoding;
+}
+declare class CookieReader {
+    protected options: CookieReaderOptions;
+    constructor(options: CookieReaderOptions);
+    readCookie(): string;
+    ensureCookieFile(): void;
+}
+declare function createCookieGetter(cookieFile: string): () => string;
+
+interface CookieWatcherOptions {
+    cookieFile: string;
+    onCookieChange: (cookie: string) => void;
+    onError?: (error: Error) => void;
+    autoCreateFile?: boolean;
+}
+declare class CookieWatcher {
+    private watcher;
+    private options;
+    private cookieReader;
+    private lastContent;
+    constructor(options: CookieWatcherOptions);
+    private handleChange;
+    start(): void;
+    stop(): void;
+    getCurrentCookie(): string;
+}
+declare function watchCookieFile(cookieFile: string, onCookieChange: (cookie: string) => void, onError?: (error: Error) => void): CookieWatcher;
+
+/**
+ * 环境检测工具函数
+ * 用于智能判断当前是否为生产构建环境
+ */
+/**
+ * 判断环境变量值是否表示生产环境
+ */
+declare function isProductionValue(value: string): boolean;
+/**
+ * 智能检测当前是否为生产构建环境
+ * 通过多种方式综合判断，避免依赖单一环境变量
+ *
+ * @param customEnvs 用户自定义的环境变量名称列表
+ * @param debug 是否输出调试日志
+ * @param loggerPrefix 日志前缀，用于区分不同模块
+ * @returns 是否为生产环境
+ */
+declare function detectProductionEnvironment(customEnvs?: string[], debug?: boolean, loggerPrefix?: string): boolean;
+/**
+ * 判断是否应该启用文件监听
+ *
+ * 注意：此函数仅在 isDev 参数未设置时调用，用于智能判断环境
+ * 如果用户已通过 isDev 参数明确指定环境，则不会调用此函数
+ *
+ * @param watch 用户设置的 watch 选项
+ * @param customEnvs 用户自定义的环境变量列表
+ * @param debug 是否输出调试日志
+ * @param loggerPrefix 日志前缀
+ * @returns 是否应该启用监听
+ */
+declare function shouldEnableWatch(watch: boolean | 'auto', customEnvs?: string[], debug?: boolean, loggerPrefix?: string): boolean;
+
+export { type AutoProxyConfigOptions, AutoProxyCookie, type AutoProxyCookieOptions, CookieReader, type CookieReaderOptions, CookieWatcher, type CookieWatcherOptions, type CreateFileCookieGetterOptions, type ErrorCallback, type ProxyConfig, type ProxyHooks, type UnifiedProxyCookieOptions, type ViteAutoProxyCookiePluginOptions, type ViteDevProxyCookieOptions, type VueProxyConfigOptions, createAutoProxyConfig, createAutoProxyCookie, createCookieGetter, createDevProxyCookie, createFileCookieGetter, createVueProxyConfig, detectProductionEnvironment, getViteMajorVersion, getViteVersion, isProductionValue, shouldEnableWatch, viteAutoProxyCookie, viteDevProxyCookie, watchCookieFile };

package/dist/index.d.ts

@@ -0,0 +1,264 @@
+import * as net from 'net';
+import { IncomingMessage, ServerResponse } from 'http';
+import { ViteDevServer, Plugin } from 'vite';
+
+type ErrorCallback = (err: Error, req: IncomingMessage, res: ServerResponse | net.Socket) => void;
+interface ProxyHooks {
+    onProxyReq?: (proxyReq: any, req: IncomingMessage, res: ServerResponse) => void;
+    onProxyRes?: (proxyRes: any, req: IncomingMessage, res: ServerResponse) => void;
+    onError?: ErrorCallback;
+    onWsError?: (err: Error, req: IncomingMessage, socket: net.Socket) => void;
+}
+interface AutoProxyCookieOptions {
+    cookieFile: string;
+    target: string;
+    debug?: boolean;
+    autoRestart?: boolean;
+    restartMarkerFile?: string;
+    proxyMap?: Record<string, string>;
+    ignorePaths?: string[];
+    ws?: boolean;
+    changeOrigin?: boolean;
+    secure?: boolean;
+    followRedirects?: boolean;
+    autoRewrite?: boolean;
+    protocolRewrite?: string;
+    logLevel?: 'debug' | 'info' | 'warn' | 'error';
+    cookieDomainRewrite?: false | string | {
+        [oldDomain: string]: string;
+    };
+    cookiePathRewrite?: false | string | {
+        [oldPath: string]: string;
+    };
+    headers?: {
+        [header: string]: string;
+    };
+    hooks?: ProxyHooks;
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare class AutoProxyCookie {
+    private options;
+    private currentCookie;
+    private server;
+    private proxyServer;
+    private watcher;
+    private cookieReader;
+    constructor(options: AutoProxyCookieOptions);
+    private handleCookieChange;
+    private getProxyUrl;
+    private isIgnoredPath;
+    private log;
+    private createProxyOptions;
+    private handleOnProxyReq;
+    private handleOnProxyRes;
+    private handleOnError;
+    private handleOnWsError;
+    setup(server: ViteDevServer): Promise<void>;
+    private startFileWatch;
+    stop(): void;
+    getCurrentCookie(): string;
+}
+declare function createAutoProxyCookie(options: AutoProxyCookieOptions): AutoProxyCookie;
+
+interface ViteAutoProxyCookiePluginOptions extends AutoProxyCookieOptions {
+    name?: string;
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare function viteAutoProxyCookie(options: ViteAutoProxyCookiePluginOptions): Plugin;
+
+interface ViteDevProxyCookieOptions {
+    cookieFile: string;
+    debug?: boolean;
+    onCookieChange?: (cookie: string) => void;
+    /**
+     * 是否监听文件变化
+     * - true: 始终监听
+     * - false: 从不监听
+     * - 'auto': 根据环境自动判断（默认）
+     * @default 'auto'
+     */
+    watch?: boolean | 'auto';
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare function viteDevProxyCookie(options: ViteDevProxyCookieOptions): Plugin;
+
+/** Options for {@link createFileCookieGetter}. */
+interface CreateFileCookieGetterOptions {
+    /**
+     * 是否监听文件变化
+     * - true: 始终监听
+     * - false: 从不监听
+     * - 'auto': 根据环境自动判断（默认）
+     *
+     * Cookie 值每次代理请求时都会从磁盘读取，因此即使 watch 为 false，
+     * 修改 cookie 文件后也不需要重启开发服务器。
+     * @default 'auto'
+     */
+    watch?: boolean | 'auto';
+    /** Log when the cookie file changes (only if `watch` is true). @default false */
+    debug?: boolean;
+    /**
+     * 自定义生产环境变量名称列表，用于判断是否禁用监听
+     * 例如: ['MY_APP_ENV', 'BUILD_TYPE']
+     */
+    productionEnvs?: string[];
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+interface VueProxyConfigOptions {
+    getCookie?: () => string;
+    debug?: boolean;
+    headers?: Record<string, string>;
+    ws?: boolean;
+    changeOrigin?: boolean;
+    secure?: boolean;
+    onError?: (err: Error) => void;
+}
+interface ProxyConfig {
+    ws: boolean;
+    target: string;
+    changeOrigin: boolean;
+    secure: boolean;
+    onProxyReq: (proxyReq: any, req: IncomingMessage) => void;
+    onProxyRes?: (proxyRes: any, req: IncomingMessage) => void;
+    onError: (err: Error) => void;
+    headers?: Record<string, string>;
+}
+declare function createVueProxyConfig(target: string, options?: VueProxyConfigOptions): ProxyConfig;
+declare function createFileCookieGetter(cookieFile: string, options?: CreateFileCookieGetterOptions): () => string;
+interface AutoProxyConfigOptions extends VueProxyConfigOptions {
+    target: string;
+    ignorePaths?: string[];
+    includePaths?: string[];
+    additionalProxies?: Record<string, string>;
+}
+declare function createAutoProxyConfig(options: AutoProxyConfigOptions): Record<string, ProxyConfig>;
+
+interface UnifiedProxyCookieOptions {
+    cookieFile: string;
+    target?: string;
+    debug?: boolean;
+    autoRestart?: boolean;
+    restartMarkerFile?: string;
+    proxyMap?: Record<string, string>;
+    ignorePaths?: string[];
+    includePaths?: string[];
+    onCookieChange?: (cookie: string) => void;
+    mode?: 'auto' | 'proxy' | 'cookie';
+    /**
+     * 是否监听文件变化
+     * - true: 始终监听
+     * - false: 从不监听
+     * - 'auto': 根据环境自动判断（默认）
+     * @default 'auto'
+     */
+    watch?: boolean | 'auto';
+    /**
+     * 是否为开发环境（优先级最高）
+     * 设置此参数后，将直接决定是否启用文件监听：
+     * - true: 启用监听（开发模式）
+     * - false: 禁用监听（生产模式）
+     *
+     * 使用示例: isDev: process.env.NODE_ENV === 'development'
+     */
+    isDev?: boolean;
+}
+declare function createDevProxyCookie(options: UnifiedProxyCookieOptions): Plugin;
+declare function getViteVersion(): string | null;
+declare function getViteMajorVersion(): number;
+
+interface CookieReaderOptions {
+    cookieFile: string;
+    encoding?: BufferEncoding;
+}
+declare class CookieReader {
+    protected options: CookieReaderOptions;
+    constructor(options: CookieReaderOptions);
+    readCookie(): string;
+    ensureCookieFile(): void;
+}
+declare function createCookieGetter(cookieFile: string): () => string;
+
+interface CookieWatcherOptions {
+    cookieFile: string;
+    onCookieChange: (cookie: string) => void;
+    onError?: (error: Error) => void;
+    autoCreateFile?: boolean;
+}
+declare class CookieWatcher {
+    private watcher;
+    private options;
+    private cookieReader;
+    private lastContent;
+    constructor(options: CookieWatcherOptions);
+    private handleChange;
+    start(): void;
+    stop(): void;
+    getCurrentCookie(): string;
+}
+declare function watchCookieFile(cookieFile: string, onCookieChange: (cookie: string) => void, onError?: (error: Error) => void): CookieWatcher;
+
+/**
+ * 环境检测工具函数
+ * 用于智能判断当前是否为生产构建环境
+ */
+/**
+ * 判断环境变量值是否表示生产环境
+ */
+declare function isProductionValue(value: string): boolean;
+/**
+ * 智能检测当前是否为生产构建环境
+ * 通过多种方式综合判断，避免依赖单一环境变量
+ *
+ * @param customEnvs 用户自定义的环境变量名称列表
+ * @param debug 是否输出调试日志
+ * @param loggerPrefix 日志前缀，用于区分不同模块
+ * @returns 是否为生产环境
+ */
+declare function detectProductionEnvironment(customEnvs?: string[], debug?: boolean, loggerPrefix?: string): boolean;
+/**
+ * 判断是否应该启用文件监听
+ *
+ * 注意：此函数仅在 isDev 参数未设置时调用，用于智能判断环境
+ * 如果用户已通过 isDev 参数明确指定环境，则不会调用此函数
+ *
+ * @param watch 用户设置的 watch 选项
+ * @param customEnvs 用户自定义的环境变量列表
+ * @param debug 是否输出调试日志
+ * @param loggerPrefix 日志前缀
+ * @returns 是否应该启用监听
+ */
+declare function shouldEnableWatch(watch: boolean | 'auto', customEnvs?: string[], debug?: boolean, loggerPrefix?: string): boolean;
+
+export { type AutoProxyConfigOptions, AutoProxyCookie, type AutoProxyCookieOptions, CookieReader, type CookieReaderOptions, CookieWatcher, type CookieWatcherOptions, type CreateFileCookieGetterOptions, type ErrorCallback, type ProxyConfig, type ProxyHooks, type UnifiedProxyCookieOptions, type ViteAutoProxyCookiePluginOptions, type ViteDevProxyCookieOptions, type VueProxyConfigOptions, createAutoProxyConfig, createAutoProxyCookie, createCookieGetter, createDevProxyCookie, createFileCookieGetter, createVueProxyConfig, detectProductionEnvironment, getViteMajorVersion, getViteVersion, isProductionValue, shouldEnableWatch, viteAutoProxyCookie, viteDevProxyCookie, watchCookieFile };