@e-xi/xion 0.0.6

package/dist/main/window/window-manager.d.ts

@@ -0,0 +1,422 @@
+import type { XoAppAbstract } from '../app/xo-app-abstract';
+/**
+ * 窗口管理器
+ * @class WindowManager
+ */
+export declare class WindowManager {
+    /** Xion 应用 */
+    private readonly xoApp;
+    /** 窗口类型 */
+    private readonly types;
+    /** 窗口记录 */
+    private readonly records;
+    /** electron 窗口ID -> 窗口标识 */
+    private readonly identities;
+    /** 窗口生命周期 */
+    private readonly lifecycles;
+    /** 已完成渲染进程首屏渲染的窗口 */
+    private readonly rendererReadyWindows;
+    /** 等待渲染进程完成后显示的窗口 */
+    private readonly pendingShowWindows;
+    /**
+     * 构造函数
+     * @param {XoAppAbstract} xoApp Xion 应用
+     * @param {XoWindow.Type[]}  types    窗口类型
+     */
+    constructor(xoApp: XoAppAbstract, types?: XoWindow.Type[]);
+    /**
+     * 复用或创建窗口（如不存在先创建），不显示窗口，仅复用或创建
+     * @param {XoWindow.Identity} identity 窗口标识
+     * @param {XoWindow.Query}    query    URL 查询参数
+     * @returns {Promise<Electron.BrowserWindow>}
+     */
+    reuseOrCreate(identity: XoWindow.Identity, query?: XoWindow.Query): Promise<Electron.BrowserWindow>;
+    /**
+     * 创建窗口
+     * @param {XoWindow.Identity} identity 窗口标识
+     * @returns {Promise<Electron.BrowserWindow>}
+     */
+    private create;
+    /**
+     * 追加 URL 查询参数
+     * @param {string}         url   原始 URL
+     * @param {XoWindow.Query} query 查询参数
+     * @returns {string}
+     * @private
+     */
+    private withQuery;
+    /**
+     * 显示并聚焦窗口
+     * @param {XoWindow.RecordID} id 窗口ID
+     */
+    show(id: XoWindow.RecordID): void;
+    /**
+     * 显示并聚焦窗口
+     * @param {Electron.BrowserWindow} window 窗口对象
+     */
+    showByWindow(window?: Electron.BrowserWindow): void;
+    /**
+     * 标记渲染进程已完成首屏渲染，并执行此前暂存的显示请求
+     * @param {Electron.BrowserWindow} window 窗口
+     */
+    rendererReady(window?: Electron.BrowserWindow): void;
+    /**
+     * 首次渲染开始加载时保持窗口隐藏
+     * @param {Electron.BrowserWindow} window 窗口
+     * @private
+     */
+    private rendererLoading;
+    /**
+     * 是否等待 Renderer 渲染完成后再显示窗口
+     * @param {Electron.BrowserWindow} window 窗口
+     * @returns {boolean}
+     */
+    shouldShowAfterRendererReady(window?: Electron.BrowserWindow): boolean;
+    /**
+     * 隐藏窗口
+     * @param {XoWindow.RecordID} id 窗口ID
+     */
+    hide(id: XoWindow.RecordID): void;
+    /**
+     * 隐藏窗口
+     * @param {Electron.BrowserWindow} window 窗口对象
+     */
+    hideByWindow(window?: Electron.BrowserWindow): void;
+    /**
+     * 隐藏所有窗口
+     */
+    hideAll(): void;
+    /**
+     * 切换窗口置顶
+     * @param {XoWindow.RecordID} id 窗口ID
+     */
+    toggleAlwaysOnTop(id: XoWindow.RecordID): void;
+    /**
+     * 切换窗口置顶
+     * @param {Electron.BrowserWindow} window 窗口对象
+     */
+    toggleAlwaysOnTopByWindow(window?: Electron.BrowserWindow): void;
+    /**
+     * 设置全部窗口透明度
+     * @param {number} opacity 窗口透明度
+     */
+    setAllWindowOpacity(opacity: number): void;
+    /**
+     * 设置全部窗口材质，并实时更新窗口材质
+     * @param {XoApp.WindowMaterial} windowMaterial 窗口材质
+     */
+    setAllWindowMaterial(windowMaterial?: XoApp.WindowMaterial): void;
+    /**
+     * 切换侧边栏折叠
+     * @param {XoWindow.RecordID} id 窗口ID
+     */
+    toggleSidebarFold(id: XoWindow.RecordID): void;
+    /**
+     * 切换侧边栏折叠
+     * @param {Electron.BrowserWindow} window 窗口对象
+     */
+    toggleSidebarFoldByWindow(window?: Electron.BrowserWindow): void;
+    /**
+     * 关闭窗口
+     * @param {XoWindow.RecordID} id 窗口ID
+     */
+    close(id: XoWindow.RecordID): void;
+    /**
+     * 关闭窗口
+     * @param {Electron.BrowserWindow} window 窗口对象
+     */
+    closeByWindow(window?: Electron.BrowserWindow): void;
+    /**
+     * 销毁窗口
+     * @param {XoWindow.RecordID} id 窗口ID
+     */
+    destroy(id: XoWindow.RecordID): void;
+    /**
+     * 销毁窗口
+     * @param {BrowserWindow} window 窗口对象
+     */
+    destroyByWindow(window?: Electron.BrowserWindow): void;
+    /**
+     * 关闭所有窗口
+     */
+    closeAll(): void;
+    /**
+     * 重定向窗口路由
+     * @param {XoWindow.RouteRedirectRequest} request 路由重定向请求
+     * @returns {Promise<boolean>}
+     */
+    redirectRoute(request: XoWindow.RouteRedirectRequest): Promise<boolean>;
+    /**
+     * 注册窗口类型
+     * @param {XoWindow.Type} type 窗口类型
+     */
+    registerType(type: XoWindow.Type): void;
+    /**
+     * 注册多个窗口类型
+     * @param {XoWindow.Type[]} types 窗口类型
+     */
+    registerManyType(types?: XoWindow.Type[]): void;
+    /**
+     * 是否存在窗口类型
+     * @param {XoWindow.TypeName} name 窗口类型名称
+     * @returns {boolean} 是否存在窗口类型
+     */
+    hasType(name: XoWindow.TypeName): boolean;
+    /**
+     * 获取窗口类型
+     * @param {XoWindow.TypeName} name 窗口类型名称
+     * @returns {XoWindow.Type | undefined} 窗口类型
+     */
+    getType(name: XoWindow.TypeName): XoWindow.Type | undefined;
+    /**
+     * 获取所有窗口类型
+     * @returns {XoWindow.Type[]} 窗口类型
+     */
+    getTypes(): XoWindow.Type[];
+    /**
+     * 确保获取到窗口类型（如果类型不存在则抛出错误）
+     * @param {XoWindow.TypeName} name 窗口类型名称
+     * @returns {XoWindow.Type} 窗口类型
+     */
+    private ensureGetType;
+    /**
+     * 获取窗口实例
+     * @param {XoWindow.RecordID} id 窗口ID
+     * @returns {XoWindow.Record | undefined}
+     */
+    getRecord(id: XoWindow.RecordID): XoWindow.Record | undefined;
+    /**
+     * 获取所有窗口实例
+     * @returns {XoWindow.Record[]}
+     */
+    getRecords(): XoWindow.Record[];
+    /**
+     * 通过 electron 窗口ID获取窗口实例
+     * @param {number} browserWindowId electron 窗口ID
+     * @returns {XoWindow.Record | undefined}
+     */
+    getRecordByBrowserWindowId(browserWindowId: number): XoWindow.Record | undefined;
+    /**
+     * 添加窗口实例
+     * @param {XoWindow.Record} record 窗口实例
+     */
+    private addRecord;
+    /**
+     * 移除窗口实例
+     * @param {XoWindow.Record} record 窗口实例
+     */
+    private removeRecord;
+    /**
+     * 确保窗口实例不存在，如果窗口实例存在则报错
+     * @param {XoWindow.RecordID} id 窗口ID
+     * @private
+     */
+    private ensureRecordNotExist;
+    /**
+     * 确保单例窗口不存在，如果单例窗口存在则报错
+     * @param {XoWindow.Type} type 窗口类型
+     * @private
+     */
+    private ensureSingleInstanceNotExist;
+    /**
+     * 获取 electron 窗口对象
+     * @param {XoWindow.RecordID} id 窗口ID
+     * @returns {Electron.BrowserWindow | undefined}
+     */
+    getBrowserWindow(id: XoWindow.RecordID): Electron.BrowserWindow | undefined;
+    /**
+     * 获取指定窗口类型的 electron 窗口对象（如果有多个，也仅返回第1个）
+     * @param {XoWindow.TypeName} typeName 窗口类型名称
+     * @returns {Electron.BrowserWindow | undefined}
+     */
+    getFirstBrowserWindowByType(typeName: XoWindow.TypeName): Electron.BrowserWindow | undefined;
+    /**
+     * 获取所有 electron 窗口对象
+     * @returns {Electron.BrowserWindow[]}
+     */
+    getAllBrowserWindow(): Electron.BrowserWindow[];
+    /**
+     * 获取窗口状态
+     * @param {Electron.BrowserWindow} window 窗口对象
+     * @returns {XoWindow.State}
+     */
+    getWindowState(window?: Electron.BrowserWindow | null): XoWindow.State;
+    /**
+     * 通知窗口状态
+     * @param {XoWindow.Record} record 窗口实例
+     */
+    notifyWindowState(record: XoWindow.Record): void;
+    /**
+     * 解析窗口选项
+     * @param {XoWindow.Type} type 窗口类型
+     * @returns {Promise<Electron.BrowserWindowConstructorOptions>}
+     * @private
+     */
+    private resolveWindowOptions;
+    /**
+     * 是否需要透明窗口背景
+     * @param {Electron.BrowserWindowConstructorOptions} options 窗口选项
+     * @returns {boolean}
+     * @private
+     */
+    private needsTransparentBackground;
+    /**
+     * 解析快捷窗口材质
+     * @param {XoWindow.Type}                              type              窗口类型
+     * @param {Electron.BrowserWindowConstructorOptions}   options           窗口选项
+     * @param {XoApp.WindowMaterial | undefined}           appWindowMaterial APP 级窗口材质
+     * @returns {XoApp.WindowMaterial | undefined}
+     * @private
+     */
+    private resolveWindowMaterial;
+    /**
+     * 获取 APP 级快捷窗口材质
+     * @returns {XoApp.WindowMaterial | undefined}
+     * @private
+     */
+    private getAppWindowMaterial;
+    /**
+     * 利用快捷窗口材质更新窗口材质相关选项
+     * @param {Electron.BrowserWindowConstructorOptions} options        窗口选项
+     * @param {XoApp.WindowMaterial}                     windowMaterial 窗口材质
+     * @private
+     */
+    private applyWindowMaterialToOptions;
+    /**
+     * 确保窗口有足够区域在屏幕可视范围内
+     * @param {Electron.BrowserWindow} window          窗口对象
+     * @param {Electron.BrowserWindow} referenceWindow 参考窗口
+     */
+    ensureWindowRectangleVisible(window?: Electron.BrowserWindow, referenceWindow?: Electron.BrowserWindow): void;
+    /**
+     * 恢复窗口位置和尺寸
+     * @param {Electron.BrowserWindowConstructorOptions} options   窗口选项
+     * @param {Electron.Rectangle}                       rectangle 窗口位置和大小
+     * @private
+     */
+    private restoreWindowRectangle;
+    /**
+     * 窗口是否有足够区域在屏幕可视范围内
+     * @param {Electron.Rectangle} rectangle 窗口位置和大小
+     * @returns {boolean}
+     * @private
+     */
+    private isWindowRectangleVisible;
+    /**
+     * 窗口是否有足够区域在指定屏幕可视范围内
+     * @param {Electron.Rectangle} rectangle 窗口位置和大小
+     * @param {Electron.Display}   display   屏幕
+     * @returns {boolean}
+     * @private
+     */
+    private isWindowRectangleVisibleInDisplay;
+    /**
+     * 解析居中目标屏幕
+     * @param {Electron.Rectangle} rectangle 窗口位置和大小
+     * @returns {Electron.Display}
+     * @private
+     */
+    private resolveCenterDisplay;
+    /**
+     * 坐标点是否在任一屏幕范围内
+     * @param {Electron.Point} point 坐标点
+     * @returns {boolean}
+     * @private
+     */
+    private isPointInAnyDisplay;
+    /**
+     * 将窗口居中到指定屏幕
+     * @param {Electron.BrowserWindow} window  窗口对象
+     * @param {Electron.Display}       display 屏幕
+     * @private
+     */
+    private centerWindow;
+    /**
+     * 将窗口选项居中到指定屏幕
+     * @param {Electron.BrowserWindowConstructorOptions} options 窗口选项
+     * @param {Electron.Display}                         display 屏幕
+     * @private
+     */
+    private centerWindowOptions;
+    /**
+     * 添加窗口标识
+     * @param {number}            browserWindowId electron 窗口ID
+     * @param {XoWindow.Identity} identity        窗口标识
+     * @private
+     */
+    private addIdentity;
+    /**
+     * 移除窗口标识
+     * @param {number | undefined} browserWindowId electron 窗口ID
+     * @private
+     */
+    private removeIdentity;
+    /**
+     * 通过 electron 窗口ID获取窗口标识
+     * @param {number} browserWindowId electron 窗口ID
+     * @returns {XoWindow.Identity | undefined}
+     */
+    getIdentityByBrowserWindowId(browserWindowId: number): XoWindow.Identity | undefined;
+    /**
+     * 获取当前已打开窗口标识
+     * @returns {XoWindow.Identity[]}
+     */
+    getOpenedWindowIdentities(): XoWindow.Identity[];
+    /**
+     * 获取窗口生命周期
+     * @param {XoWindow.Type} type 窗口类型
+     * @returns {WindowLifecycleAbstract | undefined} 窗口生命周期
+     * @private
+     */
+    private getLifecycleByType;
+    /**
+     * 绑定窗口生命周期
+     * @param {XoWindow.Record} record 窗口记录
+     */
+    private bindLifecycle;
+    /**
+     * 绑定新窗口打开拦截
+     * @param {Electron.BrowserWindow} window 窗口对象
+     * @private
+     */
+    private bindWindowOpenHandler;
+    /**
+     * 是否应使用系统浏览器打开
+     * @param {string} targetURL  目标地址
+     * @param {string} currentURL 当前地址
+     * @returns {boolean}
+     * @private
+     */
+    private shouldOpenExternal;
+    /**
+     * 是否命中链接跳转白名单
+     * @param {string} url 链接
+     * @returns {boolean}
+     * @private
+     */
+    private isLinkNavigationWhiteListed;
+    /**
+     * 解析 URL
+     * @param {string} value URL
+     * @returns {URL | undefined}
+     * @private
+     */
+    private parseURL;
+    /**
+     * 事件错误捕捉器
+     * @param {string}                       source 事件来源
+     * @param {XoWindow.Record}              record 窗口实例
+     * @param {() => (Promise<void> | void)} runner 事件处理器
+     * @private
+     */
+    private catcher;
+    /**
+     * 分发错误
+     * @param {string}                      source 来源
+     * @param {XoWindow.Record | undefined} record 窗口实例
+     * @param {unknown}                     error  错误对象
+     * @returns {Promise<void>}
+     * @private
+     */
+    private dispatchError;
+}

package/dist/preload/bridge/bridge-abstract.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 桥接抽象类
+ * @class BridgeAbstract
+ */
+export declare abstract class BridgeAbstract {
+    /**
+     * 接口映射
+     * @returns {XoBridge.ApiMap}
+     */
+    abstract apiMap(): XoBridge.ApiMap;
+}

package/dist/preload/bridge/bridge.d.ts

@@ -0,0 +1,35 @@
+import type { BridgeAbstract } from './bridge-abstract';
+/**
+ * 桥接管理器
+ * <p>如果需要自定义桥接器：</p>
+ * <p>可以在项目中的 preload 脚本里通过 Bridge.install([IpcBridge, CustomBridge]) 安装</p>
+ * <p>然后设置 XoWindow.Config.browserOptions.webPreferences.preload 为自定义 preload 脚本</p>
+ * @class Bridge
+ */
+export declare class Bridge {
+    /**
+     * 是否已安装（window.xion）
+     * @type {boolean}
+     * @private
+     */
+    private static installed;
+    /**
+     * 已安装接口名称
+     * @type {Set<string>}
+     * @private
+     */
+    private static installedApiKeys;
+    /**
+     * 安装桥接器（接口挂载到 window.xion 上）
+     * <p>仅允许执行一次</p>
+     * @param {(new () => BridgeAbstract)[]} bridges 桥接器实现列表
+     */
+    static install(bridges?: (new () => BridgeAbstract)[]): void;
+    /**
+     * 自定义安装（接口挂载到 window.[apiKey] 上）
+     * <p>可以多次执行，但同一 apiKey 仅能安装一次</p>
+     * @param {string}                       apiKey  接口名称
+     * @param {(new () => BridgeAbstract)[]} bridges 桥接器实现列表
+     */
+    static customInstall(apiKey: string, bridges?: (new () => BridgeAbstract)[]): void;
+}

package/dist/preload/bridge/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Automatically generated by scripts/gen-exports.ts
+ */
+export * from './bridge-abstract';
+export * from './bridge';
+export type * from './types/bridge';

package/dist/preload/bridge/index.js

@@ -0,0 +1,117 @@
+import {
+  AppBridge,
+  AuthBridge,
+  BridgeAbstract,
+  ClipboardBridge,
+  ContextMenuBridge,
+  DialogBridge,
+  FileBridge,
+  IpcBridge,
+  LogBridge,
+  RemoteServiceBridge,
+  ShellBridge,
+  ThemeBridge,
+  UpdaterBridge,
+  WindowBridge
+} from "../../chunk-files/chunk-FULHNQ4O.js";
+import "../../chunk-files/chunk-PL5KNBCY.js";
+import "../../chunk-files/chunk-WGYOMA43.js";
+import {
+  XionName
+} from "../../chunk-files/chunk-YLZRRUY7.js";
+import "../../chunk-files/chunk-RAVPJRBA.js";
+import "../../chunk-files/chunk-LQ67F6EY.js";
+import "../../chunk-files/chunk-BFD2LHLK.js";
+import "../../chunk-files/chunk-BMOLIJ3W.js";
+import "../../chunk-files/chunk-RN7AI33H.js";
+import "../../chunk-files/chunk-UIJUY7QZ.js";
+import "../../chunk-files/chunk-T3QCAOCO.js";
+import "../../chunk-files/chunk-ID3YDA2K.js";
+
+// src/preload/bridge/bridge.ts
+import { contextBridge } from "electron";
+var Bridge = class _Bridge {
+  /**
+   * 是否已安装（window.xion）
+   * @type {boolean}
+   * @private
+   */
+  static installed = false;
+  /**
+   * 已安装接口名称
+   * @type {Set<string>}
+   * @private
+   */
+  static installedApiKeys = /* @__PURE__ */ new Set();
+  /**
+   * 安装桥接器（接口挂载到 window.xion 上）
+   * <p>仅允许执行一次</p>
+   * @param {(new () => BridgeAbstract)[]} bridges 桥接器实现列表
+   */
+  static install(bridges) {
+    if (_Bridge.installed) {
+      throw new Error("Bridge \u91CD\u590D\u5B89\u88C5");
+    }
+    _Bridge.installed = true;
+    _Bridge.customInstall(XionName.toLowerCase(), bridges);
+  }
+  /**
+   * 自定义安装（接口挂载到 window.[apiKey] 上）
+   * <p>可以多次执行，但同一 apiKey 仅能安装一次</p>
+   * @param {string}                       apiKey  接口名称
+   * @param {(new () => BridgeAbstract)[]} bridges 桥接器实现列表
+   */
+  static customInstall(apiKey, bridges) {
+    if (_Bridge.installedApiKeys.has(apiKey)) {
+      throw new Error(`Bridge \u63A5\u53E3\u91CD\u590D\u5B89\u88C5: ${apiKey}`);
+    }
+    const builtInBridges = apiKey === XionName.toLowerCase() ? [
+      // APP 桥接器
+      AppBridge,
+      // JWT 认证桥接器
+      AuthBridge,
+      // 对话框桥接器
+      DialogBridge,
+      // 剪切板桥接器
+      ClipboardBridge,
+      // 文件桥接器
+      FileBridge,
+      // 主题桥接器
+      ThemeBridge,
+      // Shell 桥接器
+      ShellBridge,
+      // IPC 桥接器
+      IpcBridge,
+      // 日志桥接器
+      LogBridge,
+      // 上下文菜单桥接器
+      ContextMenuBridge,
+      // 窗口桥接器
+      WindowBridge,
+      // 更新器桥接器
+      UpdaterBridge,
+      // 远程服务桥接器
+      RemoteServiceBridge
+    ] : [];
+    const bridgeList = [
+      // 内置桥接器
+      ...builtInBridges,
+      // 自定义桥接器
+      ...bridges ?? []
+    ];
+    const apis = {};
+    for (let bridge of bridgeList) {
+      const apiBridge = new bridge();
+      const apiMap = apiBridge.apiMap();
+      for (let key in apiMap) {
+        apis[key] = apiMap[key];
+      }
+    }
+    contextBridge.exposeInMainWorld(apiKey, apis);
+    _Bridge.installedApiKeys.add(apiKey);
+  }
+};
+export {
+  Bridge,
+  BridgeAbstract
+};