@lynker-desktop/electron-window-manager 0.0.8-alpha.8 → 0.0.9-alpha.1

package/renderer/index.d.ts

@@ -1,8 +1,34 @@
+/**
+ * Electron 窗口管理器 - 渲染进程模块
+ * 提供窗口创建、管理、查询等功能
+ *
+ * @author Lynker Desktop Team
+ * @version 1.0.0
+ */
 import { BVItem, BWItem, ElectronWindowsManagerOptions } from '../common';
 /**
  * 创建窗口
- * @param options
- * @returns
+ * 支持创建 BrowserWindow 和 BrowserView
+ *
+ * @param options - 窗口创建选项
+ * @returns Promise<BWItem | BVItem> 创建的窗口实例
+ *
+ * @example
+ * ```typescript
+ * // 创建 BrowserWindow
+ * const window = await create({
+ *   type: 'BW',
+ *   name: 'main-window',
+ *   url: 'https://example.com'
+ * });
+ *
+ * // 创建 BrowserView
+ * const view = await create({
+ *   type: 'BV',
+ *   name: 'sidebar-view',
+ *   url: 'https://example.com/sidebar'
+ * });
+ * ```
  */
 export declare function create(options: Omit<ElectronWindowsManagerOptions, 'type'> & {
     type?: 'BW';
@@ -13,41 +39,95 @@ export declare function create(options: ElectronWindowsManagerOptions & {
 export declare function create(options: ElectronWindowsManagerOptions): Promise<BWItem | BVItem>;
 /**
  * 获取当前窗口实例
+ *
+ * @returns Promise<BWItem | BVItem | undefined> 当前窗口实例
  */
 export declare const getCurrentWindow: () => Promise<BWItem | BVItem | undefined>;
 /**
- * 获取窗口
- * @param idOrName id或者名字
- * @returns
+ * 根据 ID 或名称获取窗口
+ *
+ * @param idOrName - 窗口 ID 或名称
+ * @returns Promise<BWItem | BVItem | undefined> 窗口实例
+ *
+ * @example
+ * ```typescript
+ * // 通过 ID 获取
+ * const window = await get(1);
+ *
+ * // 通过名称获取
+ * const window = await get('main-window');
+ * ```
  */
 export declare const get: (idOrName: string | number) => Promise<BWItem | BVItem | undefined>;
 /**
  * 获取所有窗口
- * @returns
+ * 支持按类型过滤
+ *
+ * @param type - 窗口类型过滤 ('BW' | 'BV')
+ * @returns Promise<Map<number, BWItem | BVItem>> 窗口映射表
+ *
+ * @example
+ * ```typescript
+ * // 获取所有窗口
+ * const allWindows = await getAll();
+ *
+ * // 只获取 BrowserWindow
+ * const browserWindows = await getAll('BW');
+ *
+ * // 只获取 BrowserView
+ * const browserViews = await getAll('BV');
+ * ```
  */
 export declare function getAll(type: 'BW'): Promise<Map<number, BWItem>>;
 export declare function getAll(type: 'BV'): Promise<Map<number, BVItem>>;
 export declare function getAll(): Promise<Map<number, BWItem | BVItem>>;
 /**
- * 关闭窗口
- * @param name
- * @returns
+ * 关闭指定窗口
+ *
+ * @param idOrName - 窗口 ID 或名称
+ * @returns Promise<boolean> 操作是否成功
  */
 export declare const close: (idOrName: string | number) => Promise<boolean>;
+/**
+ * 关闭所有窗口
+ *
+ * @returns Promise<boolean> 操作是否成功
+ */
 export declare const closeAll: () => Promise<boolean>;
 /**
- * 用webContentIds查找到window
-*/
+ * 根据 WebContents ID 查找对应的窗口
+ *
+ * @param webContentId - WebContents ID
+ * @returns Promise<BWItem | BVItem | undefined> 窗口实例
+ */
 export declare const getWindowForWebContentId: (webContentId: number) => Promise<BWItem | BVItem | undefined>;
+/**
+ * 重命名窗口
+ *
+ * @param idOrName - 窗口 ID 或名称
+ * @param newName - 新名称
+ * @returns Promise<BWItem | BVItem | undefined> 重命名后的窗口实例
+ */
 export declare const rename: (idOrName: string | number, newName: string) => Promise<BWItem | BVItem | undefined>;
 /**
- * 设置预加载webContentUrl
- * @param preloadWebContentsUrl
+ * 重置窗口初始化URL
+ *
+ * @param idOrName - 窗口 ID 或名称
+ * @param url - 新URL
+ * @returns Promise<BWItem | BVItem | undefined> 重置后的窗口实例
+ */
+export declare const reInitUrl: (idOrName: string | number, url: string) => Promise<BWItem | BVItem | undefined>;
+/**
+ * 设置预加载 WebContents URL
+ *
+ * @param preloadWebContentsUrl - 预加载 URL
  */
 export declare const setPreloadWebContentsUrl: (preloadWebContentsUrl: string) => Promise<void>;
 /**
- * 获取 preload
- * @returns
+ * 获取预加载脚本路径
+ * 使用缓存机制避免重复请求
+ *
+ * @returns Promise<string | undefined> 预加载脚本路径
  */
 export declare const getPreload: () => Promise<string | undefined>;
 //# sourceMappingURL=index.d.ts.map

package/renderer/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/renderer/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAsE1E;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAChH,wBAAgB,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AACjG,wBAAgB,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAsBzF;;GAEG;AACH,eAAO,MAAM,gBAAgB,4CAK5B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,GAAG,aAAoB,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAmBxF,CAAA;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACjE,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACjE,wBAAgB,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;AA0DhE;;;;GAIG;AACH,eAAO,MAAM,KAAK,aAAoB,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,OAAO,CAGtE,CAAA;AAED,eAAO,MAAM,QAAQ,QAAa,OAAO,CAAC,OAAO,CAGhD,CAAA;AAED;;EAEE;AACF,eAAO,MAAM,wBAAwB,iBAAwB,MAAM,yCAGlE,CAAA;AAED,eAAO,MAAM,MAAM,aAAoB,MAAM,GAAG,MAAM,WAAW,MAAM,yCAGtE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,wBAAwB,0BAAiC,MAAM,kBAE3E,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,UAAU,QAEH,OAAO,CAAC,MAAM,GAAG,SAAS,CAc1C,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/renderer/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAKH,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,6BAA6B,EAAE,MAAM,WAAW,CAAC;AAiK1E;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,GAAG;IAAE,IAAI,CAAC,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AAChH,wBAAgB,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;AACjG,wBAAgB,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AA+BzF;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,QAAa,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAI5E,CAAA;AAED;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,GAAG,aAAoB,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CA2BxF,CAAA;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACjE,wBAAgB,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AACjE,wBAAgB,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;AAwEhE;;;;;GAKG;AACH,eAAO,MAAM,KAAK,aAAoB,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,OAAO,CAMtE,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,QAAQ,QAAa,OAAO,CAAC,OAAO,CAMhD,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,iBAAwB,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAMxG,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,MAAM,aAAoB,MAAM,GAAG,MAAM,WAAW,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAM5G,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,SAAS,aAAoB,MAAM,GAAG,MAAM,OAAO,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,MAAM,GAAG,SAAS,CAM3G,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,0BAAiC,MAAM,KAAG,OAAO,CAAC,IAAI,CAK1F,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAGJ,OAAO,CAAC,MAAM,GAAG,SAAS,CAmBzC,CAAC"}