@lynker-desktop/electron-sdk 0.0.9-alpha.6 → 0.0.9-alpha.61

package/main/resource-cache.d.ts

@@ -0,0 +1,215 @@
+/**
+ * 资源缓存配置项
+ */
+export interface ResourceCacheOptions {
+    /** 缓存目录，必填 */
+    cacheDir: string;
+    /** 缓存有效期（毫秒），默认24小时 */
+    cacheTTL?: number;
+    /** 匹配需要缓存的资源，支持正则或函数 */
+    match?: RegExp | ((url: string) => boolean);
+    /** 允许缓存的资源来源，支持null/数组/函数 */
+    allowedOrigins?: null | string[] | ((url: string) => boolean);
+}
+/**
+ * 下载进度回调函数类型
+ */
+export type DownloadProgressCallback = (progress: {
+    url: string;
+    downloaded: number;
+    total: number;
+    percentage: number;
+    speed: number;
+}) => void;
+/**
+ * 缓存进度回调函数类型
+ */
+export type CacheProgressCallback = (progress: {
+    current: number;
+    total: number;
+    url: string;
+    success: boolean;
+    result?: {
+        filePath?: string;
+        hostPath?: string;
+        mimeType?: string;
+        size?: number;
+        error?: string;
+    };
+    percentage: number;
+    downloadProgress?: {
+        downloaded: number;
+        total: number;
+        percentage: number;
+        speed: number;
+    };
+}) => void;
+/**
+ * 资源缓存类：拦截并缓存静态资源，提升加载性能
+ */
+export declare class ResourceCache {
+    static scheme: string;
+    private cacheHost;
+    /** Electron session 实例 */
+    private session;
+    /** 缓存配置 */
+    private options;
+    /** 缓存的匹配函数（避免重复创建） */
+    private _cachedMatchFunction?;
+    /** 缓存的来源校验函数（避免重复创建） */
+    private _cachedOriginFunction?;
+    /** 正在下载的 URL 和对应的下载信息（避免重复下载，允许多个请求等待同一个下载任务） */
+    private _downloadingUrls;
+    /**
+     * 构造函数
+     * @param session Electron session
+     * @param options 缓存配置
+     */
+    constructor(session: Electron.Session, options: ResourceCacheOptions);
+    /**
+     * 获取缓存统计信息（异步版本，性能更好）
+     */
+    getCacheStats(): Promise<{
+        size: number;
+        totalSize: number;
+    }>;
+    /**
+     * 获取资源匹配函数（带缓存，避免重复创建）
+     */
+    private _getMatchFunction;
+    /**
+     * 获取来源校验函数（带缓存，避免重复创建）
+     */
+    private _getOriginAllowFunction;
+    /**
+     * 获取缓存文件路径
+     * @param url 资源URL
+     * @param customExt 自定义文件扩展名（可选，用于 base64 URL）
+     */
+    getCachedPath(url: string, customExt?: string): {
+        filePath: string;
+        hostPath: string;
+    };
+    /**
+     * 判断缓存是否有效（同步版本，用于拦截器）
+     * @param filePath 缓存文件路径
+     */
+    isCacheValid(filePath: string): boolean;
+    /**
+     * 判断缓存是否有效（异步版本，性能更好）
+     * @param filePath 缓存文件路径
+     */
+    isCacheValidAsync(filePath: string): Promise<boolean>;
+    /**
+     * 下载资源到本地缓存（异步版本，返回 Promise）
+     * @param url 资源URL
+     * @param filePath 本地缓存路径
+     * @param redirectCount 当前重定向次数（内部使用）
+     * @param onProgress 下载进度回调函数（可选）
+     * @returns Promise<void> 下载完成或失败
+     */
+    downloadResourceAsync(url: string, filePath: string, redirectCount?: number, onProgress?: DownloadProgressCallback): Promise<void>;
+    /**
+     * 下载资源到本地缓存（同步版本，不返回 Promise，用于拦截器）
+     * @param url 资源URL
+     * @param filePath 本地缓存路径
+     */
+    downloadResource(url: string, filePath: string): void;
+    /**
+     * 从文件扩展名获取 MIME 类型
+     * @param ext 文件扩展名（带或不带点）
+     * @returns MIME 类型
+     */
+    private _getMimeTypeFromExt;
+    /**
+     * 检测并处理 base64 data URL
+     * @param url 资源URL
+     * @returns 如果是 base64 URL，返回 true、文件扩展名、MIME 类型和数据；否则返回 false
+     */
+    private _isBase64DataUrl;
+    /**
+     * 保存 base64 数据到文件
+     * @param base64Data base64 编码的数据
+     * @param filePath 目标文件路径
+     */
+    private _saveBase64ToFile;
+    /**
+     * 手动缓存指定 URL 的资源
+     * @param url 要缓存的资源 URL（支持普通 URL 和 base64 data URL）
+     * @param force 是否强制重新下载，即使缓存有效（默认 false）
+     * @param ignoreOrigin 是否忽略来源检查（默认 false）
+     * @param onDownloadProgress 下载进度回调函数（可选）
+     * @returns Promise<{ filePath: string, hostPath: string, mimeType: string, size: number }> 返回缓存文件路径、主机路径、MIME 类型和文件大小
+     * @throws 如果 URL 不匹配缓存规则或来源不允许，会抛出错误
+     */
+    cacheUrl(url: string, force?: boolean, ignoreOrigin?: boolean, onDownloadProgress?: DownloadProgressCallback): Promise<{
+        filePath: string;
+        hostPath: string;
+        mimeType: string;
+        size: number;
+    }>;
+    /**
+     * 批量缓存多个 URL 的资源
+     * @param urls 要缓存的资源 URL 数组
+     * @param force 是否强制重新下载，即使缓存有效（默认 false）
+     * @param ignoreOrigin 是否忽略来源检查（默认 false）
+     * @param onProgress 进度回调函数（可选）
+     * @returns Promise<Array<{ url: string, success: boolean, filePath?: string, hostPath?: string, mimeType?: string, size?: number, error?: string }>> 返回每个 URL 的缓存结果
+     */
+    addCacheUrls(urls: string[], force?: boolean, ignoreOrigin?: boolean, onProgress?: CacheProgressCallback): Promise<Array<{
+        url: string;
+        success: boolean;
+        filePath?: string;
+        hostPath?: string;
+        mimeType?: string;
+        size?: number;
+        error?: string;
+    }>>;
+    /**
+     * 删除多个 URL 的资源
+     * @param urls 要删除的资源 URL 数组
+     * @returns Promise<Array<{ url: string, success: boolean, error?: string }>> 返回每个 URL 的删除结果
+     */
+    deleteCacheUrls(urls: string[]): Promise<Array<{
+        url: string;
+        success: boolean;
+        error?: string;
+    }>>;
+    /**
+     * 删除单个 URL 的资源（异步版本，性能更好）
+     * @param url 要删除的资源 URL
+     * @returns Promise<{ url: string, success: boolean, error?: string }> 返回删除结果
+     */
+    deleteUrl(url: string): Promise<{
+        url: string;
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * 删除单个 URL 的资源（别名，保持向后兼容）
+     * @deprecated 使用 deleteUrl 代替
+     */
+    deleteCache(url: string): Promise<{
+        url: string;
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * 清理过期缓存文件（异步并行处理，性能更好）
+     */
+    private _cleanOldCache;
+    /**
+     * 清理所有缓存文件（完全异步版本，性能更好）
+     * @returns Promise<{ success: number, failed: number, totalSize: number }> 返回清理统计信息
+     */
+    clearCache(): Promise<{
+        success: number;
+        failed: number;
+        totalSize: number;
+    }>;
+    /**
+     * 注册 Electron 请求拦截器，实现资源缓存
+     */
+    private _registerInterceptor;
+}
+//# sourceMappingURL=resource-cache.d.ts.map

package/main/resource-cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resource-cache.d.ts","sourceRoot":"","sources":["../src/main/resource-cache.ts"],"names":[],"mappings":"AAsBA;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,cAAc;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,uBAAuB;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC;IAC5C,6BAA6B;IAC7B,cAAc,CAAC,EAAE,IAAI,GAAG,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,CAAC;CAC/D;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,QAAQ,EAAE;IAChD,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;CACf,KAAK,IAAI,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,CAAC,QAAQ,EAAE;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE;QACjB,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;QACnB,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;CACH,KAAK,IAAI,CAAC;AAoBX;;GAEG;AACH,qBAAa,aAAa;IACxB,MAAM,CAAC,MAAM,SAAe;IAC5B,OAAO,CAAC,SAAS,CAAyC;IAC1D,0BAA0B;IAC1B,OAAO,CAAC,OAAO,CAAmB;IAClC,WAAW;IACX,OAAO,CAAC,OAAO,CAAiC;IAChD,sBAAsB;IACtB,OAAO,CAAC,oBAAoB,CAAC,CAA2B;IACxD,wBAAwB;IACxB,OAAO,CAAC,qBAAqB,CAAC,CAA2B;IACzD,iDAAiD;IACjD,OAAO,CAAC,gBAAgB,CAA+E;IAEvG;;;;OAIG;gBACS,OAAO,EAAE,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,oBAAoB;IAqEpE;;OAEG;IACU,aAAa,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAkC1E;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAiBzB;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAyB/B;;;;OAIG;IACI,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE;IAwB7F;;;OAGG;IACI,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO;IAU9C;;;OAGG;IACU,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASlE;;;;;;;OAOG;IACI,qBAAqB,CAC1B,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,aAAa,GAAE,MAAU,EACzB,UAAU,CAAC,EAAE,wBAAwB,GACpC,OAAO,CAAC,IAAI,CAAC;IA8HhB;;;;OAIG;IACI,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI;IAY5D;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAM3B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IAyCxB;;;;OAIG;YACW,iBAAiB;IAa/B;;;;;;;;OAQG;IACU,QAAQ,CACnB,GAAG,EAAE,MAAM,EACX,KAAK,GAAE,OAAe,EACtB,YAAY,GAAE,OAAe,EAC7B,kBAAkB,CAAC,EAAE,wBAAwB,GAC5C,OAAO,CAAC;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IA+ElF;;;;;;;OAOG;IACU,YAAY,CACvB,IAAI,EAAE,MAAM,EAAE,EACd,KAAK,GAAE,OAAe,EACtB,YAAY,GAAE,OAAe,EAC7B,UAAU,CAAC,EAAE,qBAAqB,GACjC,OAAO,CAAC,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAgH5I;;;;OAIG;IACU,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAc/G;;;;OAIG;IACU,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAqB/F;;;OAGG;IACU,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAIjG;;OAEG;YACW,cAAc;IA0B5B;;;OAGG;IACU,UAAU,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAkD1F;;OAEG;IACH,OAAO,CAAC,oBAAoB;CAuB7B"}