@lynker-desktop/electron-window-manager 0.0.9-alpha.3 → 0.0.9-alpha.5

package/esm/main/index.d.ts

@@ -14,6 +14,8 @@ export declare class WindowsManager {
     preloadedBV: BVItem | null;
     preloading: boolean;
     webviewDomainWhiteList: string[];
+    private createQueue;
+    private isCreating;
     /**
      * webview 域名白名单
      * 传入格式示例：
@@ -31,17 +33,41 @@ export declare class WindowsManager {
      *   - 'localhost'、'127.0.0.1'、'::1' 以及局域网 IP（如 192.168.x.x、10.x.x.x、172.16.x.x~172.31.x.x）都视为本地白名单。
      */
     constructor(preload?: string, loadingViewUrl?: string, errorViewUrl?: string, preloadWebContentsUrl?: string, webviewDomainWhiteList?: string[]);
+    /**
+     * 设置预加载的webContents的url
+     * @param preloadWebContentsUrl 预加载的webContents的url
+     */
     setPreloadWebContentsUrl(preloadWebContentsUrl: string): void;
+    /**
+     * 预加载实例
+     */
     private _preloadInstances;
+    /**
+     * 创建预加载的窗口
+     * @param options 窗口选项
+     * @returns 预加载的窗口
+     */
     private _createPreloadBW;
+    /**
+     * 创建预加载的浏览器视图
+     * @returns 预加载的浏览器视图
+     */
     private _createPreloadBV;
     create(options: Omit<ElectronWindowsManagerOptions, 'type'> & {
         type?: 'BW';
-    }): BWItem;
+    }): Promise<BWItem>;
     create(options: ElectronWindowsManagerOptions & {
         type: 'BV';
-    }): BVItem;
-    create(options: ElectronWindowsManagerOptions): BWItem | BVItem;
+    }): Promise<BVItem>;
+    create(options: ElectronWindowsManagerOptions): Promise<BVItem | BWItem>;
+    /**
+     * 处理创建队列
+     */
+    private processCreateQueue;
+    /**
+     * 实际的窗口创建逻辑
+     */
+    private _createWindow;
     _setLoadingView(window: BWItem, createOptions: ElectronWindowsManagerOptions): void;
     get(idOrName: string | number): BWItem | BVItem | undefined;
     getAll(type: 'BW'): Map<number, BWItem>;

package/esm/main/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/main/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,WAAW,EAAkE,MAAM,UAAU,CAAA;AAIvI,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE/E,eAAO,MAAM,gBAAgB,wBAQzB,CAAC;AAUL,eAAO,MAAM,MAAM,QAAS,WAAW,SAEtC,CAAA;AAoBD,qBAAa,cAAc;IACzB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IACtC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAQ;IAClC,gCAAgC,EAAE,MAAM,GAAG,IAAI,CAAQ;IACvD,8BAA8B,EAAE,MAAM,GAAG,IAAI,CAAQ;IACrD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAQ;IAClC,UAAU,EAAE,OAAO,CAAS;IAC5B,sBAAsB,EAAE,MAAM,EAAE,CAAM;IACtC;;;;;;;;;;;;;;;OAeG;gBACS,OAAO,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,sBAAsB,CAAC,EAAE,MAAM,EAAE;IAe/I,wBAAwB,CAAC,qBAAqB,EAAE,MAAM;YAgBxC,iBAAiB;IAwB/B,OAAO,CAAC,gBAAgB;IA2CxB,OAAO,CAAC,gBAAgB;IAyCxB,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,MAAM;IACtF,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG;QAAE,IAAI,EAAE,IAAI,CAAA;KAAE,GAAG,MAAM;IACvE,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG,MAAM,GAAG,MAAM;IAsX/D,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,6BAA6B;IAmF5E,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IA6B3D,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IACvC,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IACvC,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAyBtC,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAqC/B,QAAQ;IA0BR,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM;IAqCjD,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IAgB9E,UAAU;IAKV,OAAO,CAAC,0BAA0B;IAoBlC,OAAO,CAAC,wBAAwB;IAiB1B,wBAAwB,CAAC,GAAG,EAAE,MAAM;CAqB3C;AAID,eAAO,IAAI,aAAa,SAAQ,CAAC;AAEjC,eAAO,MAAM,UAAU,aAAc,MAAM,mBAAmB,MAAM,iBAAiB,MAAM,0BAA0B,MAAM,2BAA2B,MAAM,EAAE,KAAG,cA4QhK,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/main/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAmC,WAAW,EAAkE,MAAM,UAAU,CAAA;AAIvI,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAE/E,eAAO,MAAM,gBAAgB,wBAQzB,CAAC;AAUL,eAAO,MAAM,MAAM,QAAS,WAAW,SAEtC,CAAA;AAoBD,qBAAa,cAAc;IACzB,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC;IAEtC,WAAW,EAAE,MAAM,GAAG,IAAI,CAAQ;IAElC,gCAAgC,EAAE,MAAM,GAAG,IAAI,CAAQ;IAEvD,8BAA8B,EAAE,MAAM,GAAG,IAAI,CAAQ;IAErD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAQ;IAClC,UAAU,EAAE,OAAO,CAAS;IAC5B,sBAAsB,EAAE,MAAM,EAAE,CAAM;IAEtC,OAAO,CAAC,WAAW,CAIX;IACR,OAAO,CAAC,UAAU,CAAkB;IACpC;;;;;;;;;;;;;;;OAeG;gBACS,OAAO,CAAC,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,EAAE,YAAY,CAAC,EAAE,MAAM,EAAE,qBAAqB,CAAC,EAAE,MAAM,EAAE,sBAAsB,CAAC,EAAE,MAAM,EAAE;IAiB/I;;;OAGG;IACH,wBAAwB,CAAC,qBAAqB,EAAE,MAAM;IAgBtD;;OAEG;YACW,iBAAiB;IA4B/B;;;;OAIG;IACH,OAAO,CAAC,gBAAgB;IA2CxB;;;OAGG;IACH,OAAO,CAAC,gBAAgB;IAyCxB,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,6BAA6B,EAAE,MAAM,CAAC,GAAG;QAAE,IAAI,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAC/F,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG;QAAE,IAAI,EAAE,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC;IAChF,MAAM,CAAC,OAAO,EAAE,6BAA6B,GAAG,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC;IAcxE;;OAEG;YACW,kBAAkB;IAsBhC;;OAEG;YACW,aAAa;IAqZ3B,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,6BAA6B;IAmF5E,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IA6B3D,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IACvC,MAAM,CAAC,IAAI,EAAE,IAAI,GAAG,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC;IACvC,MAAM,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IAyBtC,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM;IAqC/B,QAAQ;IA0BR,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,MAAM;IAqCjD,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS;IAgB9E,UAAU;IAKV,OAAO,CAAC,0BAA0B;IAoBlC,OAAO,CAAC,wBAAwB;IAiB1B,wBAAwB,CAAC,GAAG,EAAE,MAAM;CAqB3C;AAID,eAAO,IAAI,aAAa,SAAQ,CAAC;AAEjC,eAAO,MAAM,UAAU,aAAc,MAAM,mBAAmB,MAAM,iBAAiB,MAAM,0BAA0B,MAAM,2BAA2B,MAAM,EAAE,KAAG,cA4QhK,CAAA"}

package/esm/main/index.js

@@ -57,12 +57,19 @@ class WindowsManager {
      *   - 'localhost'、'127.0.0.1'、'::1' 以及局域网 IP（如 192.168.x.x、10.x.x.x、172.16.x.x~172.31.x.x）都视为本地白名单。
      */
     constructor(preload, loadingViewUrl, errorViewUrl, preloadWebContentsUrl, webviewDomainWhiteList) {
+        // 预加载的窗口
         this.preloadedBW = null;
+        // 预加载的窗口（无边框，有按钮）
         this.preloadedBW_FramelessWithButtons = null;
+        // 预加载的窗口（无边框，无按钮）
         this.preloadedBW_FramelessNoButtons = null;
+        // 预加载的浏览器视图
         this.preloadedBV = null;
         this.preloading = false;
         this.webviewDomainWhiteList = [];
+        // 创建队列相关属性
+        this.createQueue = [];
+        this.isCreating = false;
         this.preload = preload;
         this.windows = new Map();
         this.loadingViewUrl = `${loadingViewUrl ?? ''}`;
@@ -72,10 +79,16 @@ class WindowsManager {
         log('log', 'preloadWebContentsUrl: ', this.preloadWebContentsUrl);
         if (this.preloadWebContentsUrl) {
             app.on('ready', () => {
-                this._preloadInstances();
+                if (this.preloadWebContentsUrl) {
+                    this.setPreloadWebContentsUrl(this.preloadWebContentsUrl);
+                }
             });
         }
     }
+    /**
+     * 设置预加载的webContents的url
+     * @param preloadWebContentsUrl 预加载的webContents的url
+     */
     setPreloadWebContentsUrl(preloadWebContentsUrl) {
         try {
             this.preloadWebContentsUrl = preloadWebContentsUrl;
@@ -93,23 +106,30 @@ class WindowsManager {
             log('error', 'setPreloadWebContentsUrl error:', error);
         }
     }
+    /**
+     * 预加载实例
+     */
     async _preloadInstances() {
         if (this.preloading)
             return;
         this.preloading = true;
         try {
             if (this.preloadWebContentsUrl) {
+                // 预加载的窗口
                 this.preloadedBW = this.preloadedBW || await this._createPreloadBW({});
+                // 预加载的窗口（无边框，有按钮）
                 this.preloadedBW_FramelessWithButtons = this.preloadedBW_FramelessWithButtons || await this._createPreloadBW({
                     frame: false,
                     transparent: true,
                     titleBarStyle: 'hidden',
                 });
+                // 预加载的窗口（无边框，无按钮）
                 this.preloadedBW_FramelessNoButtons = this.preloadedBW_FramelessNoButtons || await this._createPreloadBW({
                     frame: false,
                     transparent: true,
                     titleBarStyle: 'customButtonsOnHover',
                 });
+                // 预加载的BV
                 this.preloadedBV = this.preloadedBV || await this._createPreloadBV();
             }
         }
@@ -118,15 +138,21 @@ class WindowsManager {
         }
         this.preloading = false;
     }
+    /**
+     * 创建预加载的窗口
+     * @param options 窗口选项
+     * @returns 预加载的窗口
+     */
     _createPreloadBW(options = {}) {
         return new Promise((resolve) => {
             const preload = this.preload;
             const url = this.preloadWebContentsUrl;
             if (this.preloadWebContentsUrl) {
                 const instance = new BrowserWindow({
-                    show: false,
                     ...options,
+                    show: false,
                     webPreferences: {
+                        ...(options.webPreferences || {}),
                         webviewTag: true,
                         plugins: true,
                         nodeIntegration: true,
@@ -134,7 +160,6 @@ class WindowsManager {
                         backgroundThrottling: false,
                         webSecurity: false,
                         preload: preload,
-                        ...(options.webPreferences || {}),
                     }
                 });
                 try {
@@ -158,10 +183,14 @@ class WindowsManager {
                 instance.webContents.once('did-fail-load', () => {
                     resolve(instance);
                 });
-                instance.loadURL(url || 'about:blank');
+                instance.loadURL(url ? `${url}` : 'about:blank');
             }
         });
     }
+    /**
+     * 创建预加载的浏览器视图
+     * @returns 预加载的浏览器视图
+     */
     _createPreloadBV() {
         return new Promise((resolve) => {
             const preload = this.preload;
@@ -204,6 +233,40 @@ class WindowsManager {
         });
     }
     create(options) {
+        return new Promise((resolve, reject) => {
+            // 将创建请求添加到队列
+            this.createQueue.push({ options, resolve, reject });
+            // 如果当前没有在创建，则开始处理队列
+            if (!this.isCreating) {
+                this.processCreateQueue();
+            }
+        });
+    }
+    /**
+     * 处理创建队列
+     */
+    async processCreateQueue() {
+        if (this.isCreating || this.createQueue.length === 0) {
+            return;
+        }
+        this.isCreating = true;
+        while (this.createQueue.length > 0) {
+            const { options, resolve, reject } = this.createQueue.shift();
+            try {
+                const window = await this._createWindow(options);
+                resolve(window);
+            }
+            catch (error) {
+                log('error', 'create window failed:', error);
+                reject(error);
+            }
+        }
+        this.isCreating = false;
+    }
+    /**
+     * 实际的窗口创建逻辑
+     */
+    async _createWindow(options) {
         let window;
         const { usePreload = true, type = 'BW', name = 'anonymous', url, loadingView = { url: undefined }, errorView = { url: undefined }, browserWindow: browserWindowOptions, openDevTools = false, preventOriginClose = false, } = options;
         options.type = type;
@@ -211,37 +274,46 @@ class WindowsManager {
         let preloadWin = null;
         if (type === 'BW' && usePreload && this.preloadWebContentsUrl) {
             const bwOptions = browserWindowOptions || {};
+            console.log(11111, bwOptions);
             if (bwOptions.frame === false && bwOptions.titleBarStyle === 'hidden') {
-                preloadWin = this.preloadedBW_FramelessWithButtons;
-                this.preloadedBW_FramelessWithButtons = null;
-                setTimeout(() => this._createPreloadBW({ frame: false, transparent: true, titleBarStyle: 'hidden' }), 0);
+                if (this.preloadedBW_FramelessWithButtons) {
+                    preloadWin = this.preloadedBW_FramelessWithButtons;
+                    this.preloadedBW_FramelessWithButtons = null;
+                    setTimeout(async () => this.preloadedBW_FramelessWithButtons = await this._createPreloadBW({ frame: false, transparent: true, titleBarStyle: 'hidden' }), 0);
+                }
             }
             else if (bwOptions.frame === false && bwOptions.titleBarStyle === 'customButtonsOnHover') {
-                preloadWin = this.preloadedBW_FramelessNoButtons;
-                this.preloadedBW_FramelessNoButtons = null;
-                setTimeout(() => this._createPreloadBW({ frame: false, transparent: true, titleBarStyle: 'customButtonsOnHover' }), 0);
+                if (this.preloadedBW_FramelessNoButtons) {
+                    preloadWin = this.preloadedBW_FramelessNoButtons;
+                    this.preloadedBW_FramelessNoButtons = null;
+                    setTimeout(async () => this.preloadedBW_FramelessNoButtons = await this._createPreloadBW({ frame: false, transparent: true, titleBarStyle: 'customButtonsOnHover' }), 0);
+                }
             }
             else {
-                preloadWin = this.preloadedBW;
-                this.preloadedBW = null;
-                setTimeout(() => this._createPreloadBW({}), 0);
+                if (this.preloadedBW) {
+                    preloadWin = this.preloadedBW;
+                    this.preloadedBW = null;
+                    setTimeout(async () => this.preloadedBW = await this._createPreloadBW({}), 0);
+                }
             }
         }
         if (type === 'BV' && usePreload && this.preloadWebContentsUrl) {
-            preloadWin = this.preloadedBV;
-            this.preloadedBV = null;
-            setTimeout(() => this._createPreloadBV(), 0);
+            if (this.preloadedBV) {
+                preloadWin = this.preloadedBV;
+                this.preloadedBV = null;
+                setTimeout(async () => this.preloadedBV = await this._createPreloadBV(), 0);
+            }
         }
         if (preloadWin) {
             const win = preloadWin;
-            log('log', `${name} 使用预加载窗口`, win._id);
+            log('log', `${name} 使用预加载窗口(${type})`, win._id);
             win._type = 'BW';
             win._name = options.name || 'anonymous';
             win._extraData = `${options?.extraData || ''}`;
             win._initUrl = `${options?.url || ''}`;
             // @ts-ignore
-            win?.removeAllListeners && win?.removeAllListeners?.();
-            win.webContents.removeAllListeners && win.webContents.removeAllListeners();
+            // win?.removeAllListeners && win?.removeAllListeners?.();
+            // win.webContents.removeAllListeners && win.webContents.removeAllListeners();
             if (type === 'BW') {
                 // @ts-ignore
                 this._applyBrowserWindowOptions(win, options);
@@ -351,7 +423,7 @@ class WindowsManager {
             if (errorView?.url) {
                 if (type === 'BW') {
                     const showErrorView = lodash.debounce(() => {
-                        const _url = window?.webContents?.getURL?.() || url;
+                        const _url = window._initUrl;
                         /**
                          * 判断是否是错误视图
                          */
@@ -365,16 +437,37 @@ class WindowsManager {
                 sessionStorage.setItem(key, "${_url}");
               `);
                         }
-                    }, 300);
+                    }, 1000);
                     // @ts-ignore
                     window.webContents.on('did-fail-load', (event, errorCode, errorDescription, validatedURL, isMainFrame) => {
                         if (isMainFrame) {
                             showErrorView();
                         }
                     });
+                    // 当开始加载时取消错误视图
                     window.webContents.on('did-start-loading', () => {
                         showErrorView.cancel();
                     });
+                    // 当导航开始时取消错误视图
+                    window.webContents.on('did-start-navigation', () => {
+                        showErrorView.cancel();
+                    });
+                    // 当页面重新加载时取消错误视图
+                    window.webContents.on('did-navigate', () => {
+                        showErrorView.cancel();
+                    });
+                    // 当页面完成加载时取消错误视图
+                    window.webContents.on('did-finish-load', () => {
+                        showErrorView.cancel();
+                    });
+                    // 当窗口关闭时取消错误视图
+                    window.webContents.on('close', () => {
+                        showErrorView.cancel();
+                    });
+                    // 当窗口销毁时取消错误视图
+                    window.webContents.on('destroyed', () => {
+                        showErrorView.cancel();
+                    });
                 }
             }
             window.webContents.on('did-attach-webview', (_event, webContents) => {
@@ -456,10 +549,6 @@ class WindowsManager {
                 parentWin?.addBrowserView(window);
                 log('log', 'create - addBrowserView');
             }
-            // @ts-ignore
-            window.loadURL ? window.loadURL(options.url) : window.webContents.loadURL(options.url);
-            // @ts-ignore
-            window.focus ? window.focus() : window.webContents.focus();
             this.windows.set(window.id || window._id || window.webContents.id, window);
             log('log', 'create', this.windows.keys());
             // 初始化值
@@ -552,6 +641,13 @@ class WindowsManager {
                     log('error', 'focus', error);
                 }
             }
+            console.log('message xxxx', options.url);
+            if (options.url) {
+                // @ts-ignore
+                window.loadURL ? window.loadURL(options.url) : window.webContents.loadURL(options.url);
+                // @ts-ignore
+                window.focus ? window.focus() : window.webContents.focus();
+            }
         }
         catch (error) {
             log('error', 'create', error);
@@ -835,7 +931,7 @@ class WindowsManager {
     // 生成一个bv 做为预加载资源窗口，加载完成后销毁
     async createPreloadWebContents(url) {
         return new Promise(async (resolve, reject) => {
-            let bv = this.create({
+            let bv = await this.create({
                 type: 'BV',
                 url,
                 name: `preload-web-contents-${md5(url)}`,
@@ -890,7 +986,7 @@ const initialize = (preload, loadingViewUrl, errorViewUrl, preloadWebContentsUrl
                     winInitUrl: `${findWin?._initUrl || ''}`,
                 };
             }
-            const res = wm.create(opt.data);
+            const res = await wm.create(opt.data);
             return {
                 winId: Number(`${res.id || res._id || -1}`),
                 winName: `${res?._name || ''}`,