@e-xi/xion 0.0.6

package/dist/main/utils/menu-util.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 菜单工具
+ * @class MenuUtil
+ */
+export declare class MenuUtil {
+    /**
+     * 创建菜单类型
+     * @param {string} name 菜单类型名
+     * @returns {XoMenu.Type}
+     */
+    static type(name: string): XoMenu.Type;
+}

package/dist/main/utils/protocol-util.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 协议工具
+ * @class ProtocolUtil
+ */
+export declare class ProtocolUtil {
+    /**
+     * 是否为默认 Electron 应用启动模式
+     * @returns {boolean}
+     */
+    static isDefaultApp(): boolean;
+    /**
+     * 是否为有效的协议名
+     * @param {string} protocol 协议名
+     * @returns {boolean}
+     */
+    static isValidProtocol(protocol: string): boolean;
+    /**
+     * 获取运行时协议
+     * @param {readonly string[]} protocols 协议
+     * @returns {string[]}
+     */
+    static getRuntimeProtocols(protocols?: readonly string[]): string[];
+    /**
+     * 获取 URL 中的协议名称
+     * @param {URL} url 协议 URL
+     * @returns {string}
+     */
+    static getProtocolName(url: URL): string;
+    /**
+     * 启动参数中是否包含运行时协议 URL
+     * @param {readonly string[]} argv      启动参数
+     * @param {readonly string[]} protocols 协议
+     * @returns {boolean}
+     */
+    static hasProtocolUrl(argv: readonly string[], protocols?: readonly string[]): boolean;
+    /**
+     * 定义协议处理器键
+     * @template T 协议处理器键类型
+     * @param {T} key 协议处理器键
+     * @returns {T}
+     */
+    static key<const T extends XoProtocol.Key>(key: T): T;
+    /**
+     * 获取协议处理器键
+     * @param {URL} url 协议 URL
+     * @returns {XoProtocol.Key | undefined}
+     */
+    static getKey(url: URL): XoProtocol.Key | undefined;
+}

package/dist/main/utils/runtime-config-util.d.ts

@@ -0,0 +1,75 @@
+/**
+ * 运行时配置工具
+ * @class RuntimeConfigUtil
+ */
+export declare class RuntimeConfigUtil {
+    /**
+     * 运行时配置文件路径
+     * @type {string}
+     */
+    private static readonly filePath;
+    /**
+     * 配置缓存
+     * @type {XoRuntime.Config | null}
+     * @private
+     */
+    private static cache;
+    /**
+     * 运行模式
+     * @returns {XoMode.Mode | undefined}
+     */
+    static get appMode(): XoMode.Mode | undefined;
+    /**
+     * 主进程构建发布目录
+     * @returns {string | undefined}
+     */
+    static get mainOutDir(): string | undefined;
+    /**
+     * 预加载进程构建发布目录
+     * @returns {string | undefined}
+     */
+    static get preloadOutDir(): string | undefined;
+    /**
+     * 渲染进程构建发布目录
+     * @returns {string | undefined}
+     */
+    static get rendererOutDir(): string | undefined;
+    /**
+     * 获取运行时配置
+     * @returns {XoRuntime.Config}
+     */
+    static getConfig(): XoRuntime.Config;
+    /**
+     * 获取运行时配置文件候选路径
+     * @returns {string[]}
+     */
+    static configFiles(): string[];
+    /**
+     * 加载运行时配置
+     * @returns {XoRuntime.Config}
+     * @private
+     */
+    private static loadConfig;
+    /**
+     * 通过 package.json main 推导入口目录
+     * @param {string} rootDir 项目根目录
+     * @returns {string | undefined}
+     * @private
+     */
+    private static resolvePackageMainDir;
+    /**
+     * 判断子路径是否位于父路径内
+     * @param {string} parent 父路径
+     * @param {string} child  子路径
+     * @returns {boolean}
+     * @private
+     */
+    private static isInside;
+    /**
+     * 标准化运行时配置
+     * @param {unknown} value 配置值
+     * @returns {XoRuntime.Config}
+     * @private
+     */
+    private static normalize;
+}

package/dist/main/utils/shortcut-util.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 快捷键工具
+ */
+export declare class ShortcutUtil {
+    /**
+     * KeyboardEvent.code 组合键转换为 Electron Accelerator（如：Ctrl+Shift+S）
+     * <p>用于全局快捷键</p>
+     * @param {string[]} keys KeyboardEvent.code 组合键
+     * @returns {Electron.Accelerator | undefined}
+     */
+    static toAccelerator(keys: string[]): Electron.Accelerator | undefined;
+    /**
+     * 比对应用内快捷键
+     * <p>用于应用快捷键</p>
+     * @param {string[]}       keys  KeyboardEvent.code 组合键
+     * @param {Electron.Input} input Electron 输入信息
+     * @returns {boolean}
+     */
+    static matchInput(keys: string[], input: Electron.Input): boolean;
+    /**
+     * 标准化 KeyboardEvent.code 组合键
+     * @param {string[]} keys KeyboardEvent.code 组合键
+     * @returns {string[]}
+     */
+    static normalizeKeys(keys: string[]): string[];
+    /**
+     * KeyboardEvent.code 转换为 Electron Accelerator 按键（单个按键码）
+     * @param {string} code KeyboardEvent.code
+     * @returns {string | undefined}
+     */
+    private static toAcceleratorKey;
+    /**
+     * 获取修饰键类型
+     * @param {string} code KeyboardEvent.code
+     * @returns {ModifierKey | undefined}
+     */
+    private static getModifierKey;
+}

package/dist/main/utils/tray-util.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 托盘辅助类
+ * @class TrayUtil
+ */
+export declare class TrayUtil {
+    /**
+     * 创建托盘图标名称
+     * @param {string} name 图标名称
+     * @returns {XoTray.IconName}
+     */
+    static iconName(name: string): XoTray.IconName;
+    /**
+     * 创建托盘动画名称
+     * @param {string} name 动画名称
+     * @returns {XoTray.AnimationName}
+     */
+    static animationName(name: string): XoTray.AnimationName;
+}

package/dist/main/utils/window-util.d.ts

@@ -0,0 +1,55 @@
+import type { XoAppAbstract } from '../app/xo-app-abstract';
+import type { WindowManager } from '../window/window-manager';
+/**
+ * 窗口辅助类
+ * @class WindowUtil
+ */
+export declare class WindowUtil {
+    /**
+     * 窗口记录转窗口标识
+     * @param {XoWindow.Record} record 窗口记录
+     * @returns {XoWindow.Identity}
+     */
+    static recordToIdentity(record: XoWindow.Record): XoWindow.Identity;
+    /**
+     * 从窗口记录获取唯一ID
+     * @param {XoWindow.Record} record 窗口记录
+     * @returns {string}
+     */
+    static recordToUID(record: XoWindow.Record): string;
+    /**
+     * 从窗口获取唯一ID
+     * @param {WindowManager}          windowManager 窗口管理器
+     * @param {Electron.BrowserWindow} window        窗口记录
+     * @returns {string}
+     */
+    static windowToUID(windowManager: WindowManager, window: Electron.BrowserWindow): string;
+    /**
+     * 从窗口标识获取唯一ID
+     * @param {XoWindow.Identity} identity 窗口标识
+     * @returns {string}
+     */
+    static identityToUID(identity: XoWindow.Identity): string;
+    /**
+     * 开发环境加载首页
+     * @param {XoAppAbstract}   xoApp  XionApp
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    static loadUrl(xoApp: XoAppAbstract, record: XoWindow.Record): Promise<void>;
+    /**
+     * 使用自定义协议加载生产环境首页
+     * @param {XoAppAbstract}   xoApp   XionApp
+     * @param {XoWindow.Record} record  窗口实例
+     * @param {string}          entryUrl 渲染进程入口地址
+     * @returns {Promise<void>}
+     */
+    static loadProtocol(xoApp: XoAppAbstract, record: XoWindow.Record, entryUrl: string): Promise<void>;
+    /**
+     * 生产环境加载首页
+     * @param {XoAppAbstract}   xoApp  XionApp
+     * @param {XoWindow.Record} record 窗口实例
+     * @returns {Promise<void>}
+     */
+    static loadFile(xoApp: XoAppAbstract, record: XoWindow.Record): Promise<void>;
+}

package/dist/main/utils/xo-app-root-util.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 业务端项目根目录工具
+ * @class XoAppRootUtil
+ */
+export declare class XoAppRootUtil {
+    /**
+     * 获取业务端项目根目录
+     * @returns {string}
+     */
+    static resolve(): string;
+    /**
+     * 查找业务端项目根目录
+     * @returns {string | undefined}
+     */
+    static find(): string | undefined;
+    /**
+     * 判断是否是业务端项目根目录
+     * @param {string} dir 目录路径
+     * @returns {boolean}
+     * @private
+     */
+    private static isRoot;
+    /**
+     * 从指定路径向上找 package.json 所在目录
+     * @param {string} startPath 开始路径
+     * @returns {string | undefined}
+     * @private
+     */
+    private static findPackageRoot;
+}

package/dist/main/utils/xo-app-util.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 业务端项目工具
+ * @class XoAppUtil
+ */
+export declare class XoAppUtil {
+    /**
+     * 解析业务端项目内 preload 文件路径
+     * @param {string} file 文件路径
+     * @returns {string}
+     */
+    static preloadFile(file?: string): string;
+    /**
+     * 解析业务端项目内文件路径
+     * @param {string} file    文件路径
+     * @param {string} rootDir 业务端项目根目录（留空就自动查找）
+     * @returns {string}
+     */
+    static resolveFile(file: string, rootDir?: string): string;
+    /**
+     * 获取业务端项目根目录
+     * @returns {string}
+     */
+    static rootDir(): string;
+}

package/dist/main/utils/xo-path-util.d.ts

@@ -0,0 +1,59 @@
+/**
+ * 路径工具
+ * @class XoPathUtil
+ */
+export declare class XoPathUtil {
+    /**
+     * 获取用户数据目录
+     * @returns {string}
+     */
+    static userData(): string;
+    /**
+     * 获取会话数据目录
+     * @returns {string}
+     */
+    static sessionData(): string;
+    /**
+     * 获取 Electron 日志目录
+     * @returns {string}
+     */
+    static logs(): string;
+    /**
+     * 获取崩溃转储目录
+     * @returns {string}
+     */
+    static crashDumps(): string;
+    /**
+     * 获取临时目录
+     * @returns {string}
+     */
+    static temp(): string;
+    /**
+     * 获取下载目录
+     * @returns {string}
+     */
+    static downloads(): string;
+    /**
+     * 获取更新器缓存目录
+     * @returns {string}
+     */
+    static updaterCacheDir(): string;
+    /**
+     * 获取更新器配置文件路径
+     * @returns {string}
+     * @private
+     */
+    private static updaterConfigFile;
+    /**
+     * 获取更新器缓存目录名称
+     * @returns {string}
+     * @private
+     */
+    private static updaterCacheDirName;
+    /**
+     * 获取更新器缓存根目录
+     * @returns {string}
+     * @private
+     */
+    private static updaterCacheRootDir;
+}

package/dist/main/utils/xo-util.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Xion 框架工具
+ * @class XoUtil
+ */
+export declare class XoUtil {
+    /**
+     * 解析框架包根目录
+     * @returns {string}
+     */
+    static rootDir(): string;
+    /**
+     * 解析框架包内文件路径
+     * @param {string} file 文件路径
+     * @returns {string}
+     */
+    static resolveFile(file: string): string;
+}

package/dist/main/window/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @file Automatically generated by scripts/gen-exports.ts
+ */
+export * from './main/main-window-lifecycle';
+export * from './main/main-window-type';
+export * from './setting/setting-window-lifecycle';
+export * from './setting/setting-window-type';
+export * from './window-lifecycle-abstract';
+export * from './window-manager';
+export type * from './types/window';

package/dist/main/window/index.js

@@ -0,0 +1,36 @@
+import {
+  MainWindowLifecycle,
+  MainWindowType,
+  SettingWindowLifecycle,
+  SettingWindowType,
+  WindowLifecycleAbstract,
+  WindowManager
+} from "../../chunk-files/chunk-DRMV3M5V.js";
+import "../../chunk-files/chunk-YZOJOLFL.js";
+import "../../chunk-files/chunk-F7YTK2MY.js";
+import "../../chunk-files/chunk-3S5OTD47.js";
+import "../../chunk-files/chunk-6X74EPRM.js";
+import "../../chunk-files/chunk-VGDNICVG.js";
+import "../../chunk-files/chunk-KFV4GXVE.js";
+import "../../chunk-files/chunk-BFD2LHLK.js";
+import "../../chunk-files/chunk-PVWRRUOK.js";
+import "../../chunk-files/chunk-OUFO3LM4.js";
+import "../../chunk-files/chunk-6FDO72PN.js";
+import "../../chunk-files/chunk-U4XEWVBH.js";
+import "../../chunk-files/chunk-BMOLIJ3W.js";
+import "../../chunk-files/chunk-6BOPFOZD.js";
+import "../../chunk-files/chunk-ID3YDA2K.js";
+import "../../chunk-files/chunk-KFK47PDH.js";
+import "../../chunk-files/chunk-FPN7JYR4.js";
+import "../../chunk-files/chunk-RODB64YF.js";
+import "../../chunk-files/chunk-GN2FNR3Z.js";
+import "../../chunk-files/chunk-3RVKOFMP.js";
+import "../../chunk-files/chunk-FMQTZ3QV.js";
+export {
+  MainWindowLifecycle,
+  MainWindowType,
+  SettingWindowLifecycle,
+  SettingWindowType,
+  WindowLifecycleAbstract,
+  WindowManager
+};

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

@@ -0,0 +1,7 @@
+import { WindowLifecycleAbstract } from '../window-lifecycle-abstract';
+/**
+ * 主窗口生命周期
+ * @class MainWindowLifecycle
+ */
+export declare class MainWindowLifecycle extends WindowLifecycleAbstract {
+}

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

@@ -0,0 +1,5 @@
+/**
+ * 主窗口类型
+ * @class MainWindowType
+ */
+export declare const MainWindowType: XoWindow.Type;

package/dist/main/window/setting/setting-window-lifecycle.d.ts

@@ -0,0 +1,7 @@
+import { WindowLifecycleAbstract } from '../window-lifecycle-abstract';
+/**
+ * "设置窗口"生命周期
+ * @class SettingWindowLifecycle
+ */
+export declare class SettingWindowLifecycle extends WindowLifecycleAbstract {
+}

package/dist/main/window/setting/setting-window-type.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 主窗口类型
+ * @class SettingWindowType
+ */
+export declare const SettingWindowType: XoWindow.Type;

package/dist/main/window/types/window.d.ts

@@ -0,0 +1,86 @@
+import type {XoAppAbstract}           from '../../app/xo-app-abstract'
+import type {WindowLifecycleAbstract} from '../window-lifecycle-abstract'
+import {WindowRecordIDPrefix}         from '../../../shared/window/consts/window-record-id'
+import {WindowTypeNamePrefix}         from '../../../shared/window/consts/window-type-name'
+
+declare global {
+
+    // 窗口
+    namespace XoWindow {
+
+        // 窗口类型名称
+        type TypeName = `${typeof WindowTypeNamePrefix}${string}`
+
+        // 窗口实例记录名称
+        type RecordID = `${typeof WindowRecordIDPrefix}${string}`
+
+        // 窗口 URL 查询参数值
+        type QueryValue = string | number | boolean | null | undefined
+
+        // 窗口 URL 查询参数
+        type Query = {
+            [K in string]: QueryValue | QueryValue[]
+        }
+
+        // 窗口标识
+        type Identity = {
+            // 窗口记录ID
+            recordId: RecordID
+            // 窗口类型名称
+            typeName: TypeName
+            // 窗口加载路径
+            url: string
+        }
+
+        // 窗口类型
+        interface Type {
+            // 窗口类型名称
+            name: TypeName
+            // 是否单例
+            singleInstance?: boolean
+            // 窗口选项
+            windowConfig?: Config
+            // 窗口生命周期
+            lifecycle?: new (xoApp: XoAppAbstract) => WindowLifecycleAbstract
+        }
+
+        // 窗口管理器记录
+        // 也可以看作 窗口实例的包装器
+        interface Record {
+            // 窗口记录ID
+            id: RecordID
+            // 窗口类型
+            type: Type
+            // 窗口加载路径（来自 XoWindow.Identity）
+            url: string
+            // electron 窗口对象
+            window: Electron.BrowserWindow
+        }
+
+        // 窗口生命周期错误
+        interface LifecycleError {
+            // 错误来源
+            source: string
+            // 错误对象
+            error: unknown
+        }
+
+        // 窗口加载失败载荷
+        interface DidFailLoadPayload {
+            // 错误码
+            errorCode: number
+            // 错误描述
+            errorDescription: string
+            // 验证后的 URL
+            validatedURL: string
+            // 是否为主框架
+            isMainFrame: boolean
+            // 框架进程ID
+            frameProcessId: number
+            // 框架路由ID
+            frameRoutingId: number
+        }
+    }
+}
+
+export {}