@e-xi/xion 0.0.6

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

@@ -0,0 +1,81 @@
+import type {XoAppAbstract}         from '../../app/xo-app-abstract'
+import {TrayAnimationNamePrefix}    from '../consts/tray-animation-name'
+import {TrayIconNamePrefix}         from '../consts/tray-icon-name'
+import type {TrayLifecycleAbstract} from '../tray-lifecycle-abstract'
+
+declare global {
+
+    // 托盘
+    namespace XoTray {
+
+        // 内置托盘图标名称
+        //   focus   - 聚焦
+        //   blur    - 失焦
+        //   success - 成功
+        //   error   - 错误
+        //   online  - 在线
+        //   offline - 离线
+        //   none    - 空图标
+        type BuiltInIconName = 'focus' | 'blur' | 'success' | 'error' | 'online' | 'offline' | 'none'
+
+        // 托盘图标名称
+        type IconName = BuiltInIconName | (`${typeof TrayIconNamePrefix}${string}` & {})
+
+        // 托盘图标映射
+        type IconMap = Partial<Record<BuiltInIconName, Icon>> & Record<`${typeof TrayIconNamePrefix}${string}`, Icon>
+
+        // 内置托盘动画名称
+        //   blink      - 闪烁
+        //   connecting - 连接中
+        type BuiltInAnimationName = 'blink' | 'connecting'
+
+        // 托盘动画名称
+        type AnimationName = BuiltInAnimationName | (`${TrayAnimationNamePrefix}${string}` & {})
+
+        // 托盘动画映射
+        type AnimationMap =
+            Partial<Record<BuiltInAnimationName, Animation>>
+            & Record<`${TrayAnimationNamePrefix}${string}`, Animation>
+
+        // 托盘图标
+        type Icon = string | Electron.NativeImage
+
+        // 托盘动画
+        interface Animation {
+            // 动画帧间隔（毫秒）
+            interval?: number
+            // 动画帧图标名称序列
+            icons?: IconName[]
+        }
+
+        // 托盘配置
+        interface Config {
+            // 是否启用托盘
+            enabled?: boolean
+            // 托盘提示文本
+            tooltip?: string
+            // 失焦时的托盘提示文本
+            blurTooltip?: string
+            // 默认图标名称
+            iconName?: IconName
+            // 托盘图标集合（包含 16x16 24x24 32x32 48x48 256x256 的ico格式图标）
+            icons?: IconMap
+            // 托盘动画键值表
+            animations?: AnimationMap
+            // 托盘生命周期管理器
+            lifecycle?: new (xoApp: XoAppAbstract, tray: Electron.Tray) => TrayLifecycleAbstract
+            // 是否开启调试位置
+            debugPosition?: boolean
+        }
+
+        // 托盘生命周期错误
+        interface LifecycleError {
+            // 错误来源
+            source: string
+            // 错误对象
+            error: unknown
+        }
+    }
+}
+
+export {}

package/dist/main/updater/dev-app-update.yml

@@ -0,0 +1,5 @@
+provider: generic
+channel: latest
+url: http://127.0.0.1:8080
+useMultipleRangeRequest: true
+timeout: 120000

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

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

package/dist/main/updater/index.js

@@ -0,0 +1,20 @@
+import {
+  UpdaterManager,
+  UpdaterManagerAbstract
+} from "../../chunk-files/chunk-LFHJJQW3.js";
+import "../../chunk-files/chunk-LQ67F6EY.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-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 {
+  UpdaterManager,
+  UpdaterManagerAbstract
+};

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

@@ -0,0 +1,167 @@
+import type {ProgressInfo, UpdateDownloadedEvent, UpdateInfo} from 'electron-updater'
+
+declare global {
+
+    // 更新器
+    namespace XoUpdater {
+
+        // 更新器状态
+        type Status =
+            | 'idle'
+            | 'checking'
+            | 'available'
+            | 'not-available'
+            | 'downloading'
+            | 'cancelling'
+            | 'downloaded'
+            | 'error'
+
+        // 可序列化错误信息
+        interface ErrorInfo {
+            // 错误名称
+            name: string
+            // 错误代码
+            code?: string
+            // HTTP 状态码
+            statusCode?: number
+            // 用户可读错误消息
+            message: string
+            // 原始错误详情
+            detail: string
+            // 错误堆栈
+            stack?: string
+            // 原始错误原因
+            cause?: ErrorInfo
+        }
+
+        // 更新器配置
+        // 修改时需要同步检查修改 UserSettings、EffectiveSettings
+        interface Config {
+            // 是否启用更新器模块，'checkOnStart' 启动时检查更新
+            // 用户设置 UserSettings 可覆盖
+            enable?: XoApp.UpdateMode
+            // 自动检查更新延迟时间（毫秒）
+            // 用户设置 UserSettings 可覆盖
+            autoCheckDelay?: number
+            // 是否在发现新版本后自动下载
+            // 用户设置 UserSettings 可覆盖
+            autoDownload?: boolean
+            // 是否在应用退出时自动安装已下载的更新
+            // 用户设置 UserSettings 可覆盖
+            autoInstallOnAppQuit?: boolean
+            // 是否允许检查预发布版本
+            allowPrerelease?: boolean
+            // 是否允许降级安装
+            allowDowngrade?: boolean
+            // 是否禁用差分下载
+            // 用户设置 UserSettings 可覆盖
+            disableDifferentialDownload?: boolean
+            // 是否允许用户自定义更新地址
+            allowUserFeedUrl?: boolean
+        }
+
+        // 用户更新器设置
+        // 修改时需要同步修改 Config、EffectiveSettings
+        interface UserSettings {
+            // 是否启用更新器模块，'checkOnStart' 启动时检查更新
+            enable?: XoApp.UpdateMode
+            // 自动检查更新延迟时间（毫秒）
+            autoCheckDelay?: number
+            // 是否在发现新版本后自动下载
+            autoDownload?: boolean
+            // 是否在应用退出时自动安装已下载的更新
+            autoInstallOnAppQuit?: boolean
+            // 自定义更新地址
+            feedUrl?: string
+            // 是否静默安装
+            isSilent?: boolean
+            // 安装后是否强制启动
+            isForceRunAfter?: boolean
+            // 是否禁用差分下载
+            disableDifferentialDownload?: boolean
+        }
+
+        // 实际生效的更新器设置
+        // 修改时需要同步修改 Config、UserSettings
+        interface EffectiveSettings {
+            // 自定义更新地址
+            feedUrl?: string
+            // 是否启用更新器模块，'checkOnStart' 启动时检查更新
+            enable: XoApp.UpdateMode
+            // 自动检查更新延迟时间（毫秒）
+            autoCheckDelay: number
+            // 是否在发现新版本后自动下载
+            autoDownload: boolean
+            // 是否在应用退出时自动安装已下载的更新
+            autoInstallOnAppQuit: boolean
+            // 是否允许检查预发布版本
+            allowPrerelease: boolean
+            // 是否允许降级安装
+            allowDowngrade: boolean
+            // 是否禁用差分下载
+            disableDifferentialDownload: boolean
+            // 是否允许用户自定义更新地址
+            allowUserFeedUrl: boolean
+            // 是否静默安装
+            isSilent: boolean
+            // 安装后是否强制启动
+            isForceRunAfter: boolean
+        }
+
+        // 下载进度
+        interface DownloadProgress extends ProgressInfo {
+            // 剩余大小 e.g. 100
+            remaining: number
+            // 预计剩余秒数，null 表示暂时无法估算 e.g. 10
+            remainingSeconds: number | null
+            // 已耗时秒数 e.g. 10
+            elapsedSeconds: number
+        }
+
+        // 格式化下载进度
+        interface FormattedDownloadProgress {
+            // 总计大小 e.g. 100 MB
+            total: string
+            // 剩余大小 e.g. 100 MB
+            remaining: string
+            // 本轮新增大小 e.g. 10 MB
+            delta: string
+            // 已传输大小 e.g. 10 MB
+            transferred: string
+            // 已传输百分比 e.g. 10%
+            percent: string
+            // 每秒传输大小 e.g. 10 MB/s
+            bytesPerSecond: string
+            // 预计剩余时间 e.g. 10s
+            remainingTime: string
+            // 已耗时时间 e.g. 10s
+            elapsedTime: string
+        }
+
+        // 更新器状态
+        interface State {
+            // 当前状态
+            status: Status
+            // 本次运行期间下载取消次数
+            downloadCancellationCount: number
+            // 是否禁用更新器直至应用重启
+            disabledUntilRestart: boolean
+            // 更新信息
+            updateInfo?: UpdateInfo | UpdateDownloadedEvent
+            // 下载进度
+            progress?: DownloadProgress
+            // 格式化下载进度
+            formattedProgress?: FormattedDownloadProgress
+            // 错误信息
+            error?: ErrorInfo
+        }
+
+        // 更新监听器
+        type UpdatedListener = (state: State) => void
+
+        // 更新器设置监听器
+        type SettingsUpdatedListener = (settings: EffectiveSettings) => void
+    }
+}
+
+export {}

package/dist/main/updater/updater-manager-abstract.d.ts

@@ -0,0 +1,237 @@
+import type { XoAppAbstract } from '../app/xo-app-abstract';
+import type { AppUpdater, UpdateCheckResult } from 'electron-updater';
+declare const autoUpdater: AppUpdater;
+type UpdaterRuntimeState = Omit<XoUpdater.State, 'downloadCancellationCount' | 'disabledUntilRestart'>;
+/**
+ * 更新器管理器抽象类
+ * @class UpdaterManagerAbstract
+ */
+export declare abstract class UpdaterManagerAbstract {
+    /** Xion 应用 */
+    protected readonly xoApp: XoAppAbstract;
+    /** 是否已绑定事件 */
+    private bound;
+    /** 是否已执行启动检查  */
+    private checkedOnStart;
+    /** 当前检查任务 */
+    private checkOperation?;
+    /** 当前下载任务 */
+    private downloadOperation?;
+    /** 当前下载取消令牌 */
+    private downloadCancellationToken?;
+    /** 下载开始时间 */
+    private downloadStartedAt?;
+    /** 本次运行期间下载取消次数 */
+    private downloadCancellationCount;
+    /** 是否禁用更新器直至应用重启 */
+    private disabledUntilRestart;
+    /** 更新状态 */
+    private state;
+    /**
+     * 构造函数
+     * @param {XoAppAbstract} xoApp Xion 应用
+     */
+    constructor(xoApp: XoAppAbstract);
+    /**
+     * 获取更新器配置
+     * @returns {XoUpdater.Config}
+     * @protected
+     */
+    protected config(): XoUpdater.Config;
+    /**
+     * 获取更新器用户设置
+     * @returns {XoUpdater.UserSettings}
+     */
+    private getUserSettings;
+    /**
+     * 获取更新器设置
+     * @returns {XoUpdater.EffectiveSettings}
+     */
+    getSettings(): XoUpdater.EffectiveSettings;
+    /**
+     * 设置更新器用户设置
+     * @param {XoUpdater.UserSettings} settings 更新器用户设置
+     */
+    setSettings(settings: XoUpdater.UserSettings): void;
+    /**
+     * 重置更新器用户设置
+     */
+    resetSettings(): void;
+    /**
+     * 是否启用更新器模块
+     * @returns {boolean}
+     */
+    enabled(): boolean;
+    /**
+     * 是否启动时检查更新
+     * @returns {boolean}
+     */
+    checkOnStart(): boolean;
+    /**
+     * 更新 electron-updater 配置
+     * @private
+     */
+    private applyConfig;
+    /**
+     * 初始化更新器模块
+     * @returns {boolean}
+     */
+    initialize(): boolean;
+    /**
+     * 绑定更新器事件
+     * @private
+     */
+    private bind;
+    /**
+     * 检查更新
+     * @returns {Promise<UpdateCheckResult | null>}
+     */
+    checkForUpdates(): Promise<UpdateCheckResult | null>;
+    /**
+     * 下载更新
+     * @returns {Promise<string[]>}
+     */
+    downloadUpdate(): Promise<string[]>;
+    /**
+     * 取消下载更新
+     * @returns {boolean} 是否已发起取消
+     */
+    cancelDownload(): boolean;
+    /**
+     * 获取更新状态
+     * @returns {XoUpdater.State}
+     */
+    getState(): XoUpdater.State;
+    /**
+     * 获取 electron-updater 实例
+     * @returns {typeof autoUpdater}
+     */
+    getAutoUpdater(): typeof autoUpdater;
+    /**
+     * 退出并安装更新
+     */
+    quitAndInstall(): void;
+    /**
+     * 通知到窗口并尝试自动检查更新
+     * @param {Electron.BrowserWindow} window 窗口
+     */
+    syncToWindowAndCheckForUpdates(window: Electron.BrowserWindow): void;
+    /**
+     * 更新状态
+     * @param {XoUpdater.State} state 状态
+     * @protected
+     */
+    protected updateState(state: UpdaterRuntimeState): void;
+    /**
+     * 通知到渲染进程
+     * @protected
+     */
+    syncToAllWindows(): void;
+    /**
+     * 通知到渲染进程
+     * @param {Electron.BrowserWindow} window 窗口
+     * @protected
+     */
+    syncToWindow(window: Electron.BrowserWindow): void;
+    /**
+     * 通知更新器设置到全部渲染进程
+     */
+    syncSettingsToAllWindows(): void;
+    /**
+     * 通知更新器设置到渲染进程
+     * @param {Electron.BrowserWindow} window 窗口
+     */
+    syncSettingsToWindow(window: Electron.BrowserWindow): void;
+    /**
+     * 应用可立即生效的用户设置
+     * @private
+     */
+    private applyRuntimeSettings;
+    /**
+     * 验证更新器用户设置
+     * @param {XoUpdater.UserSettings} settings 更新器用户设置
+     * @private
+     */
+    private validateUserSettings;
+    /**
+     * 解析用户更新地址
+     * @param {string} feedUrl 用户更新地址
+     * @returns {string | undefined}
+     * @private
+     */
+    private resolveUserFeedUrl;
+    /**
+     * 验证用户更新地址
+     * @param {string} feedUrl 用户更新地址
+     * @returns {string}
+     * @private
+     */
+    private validateUserFeedUrl;
+    /**
+     * 执行检查更新
+     * @returns {Promise<UpdateCheckResult | null>}
+     * @private
+     */
+    private executeCheckForUpdates;
+    /**
+     * 转换为自定义下载进度
+     * @param {ProgressInfo} progress          进度信息
+     * @param {number}       downloadStartedAt 下载开始时间
+     * @returns {XoUpdater.DownloadProgress}
+     * @private
+     */
+    private toDownloadProgress;
+    /**
+     * 处理下载任务
+     * @param {Promise<string[]>} downloadPromise 下载任务
+     * @param cancellationToken 取消令牌
+     * @returns {Promise<string[]>}
+     * @private
+     */
+    private handleDownloadPromise;
+    /**
+     * 格式化错误信息
+     * @param {unknown} error 错误
+     * @returns {XoUpdater.ErrorInfo}
+     * @protected
+     */
+    protected formatError(error: unknown): XoUpdater.ErrorInfo;
+    /**
+     * 获取 HTTP 状态码
+     * @param {string | undefined} code 错误代码
+     * @returns {number | undefined}
+     * @private
+     */
+    private getHttpStatusCode;
+    /**
+     * 获取用户可读的更新错误消息
+     * @param {string | undefined} code       错误代码
+     * @param {number | undefined} statusCode HTTP 状态码
+     * @param {string}             name       错误名称
+     * @param {string}             detail     原始错误详情
+     * @returns {string}
+     * @private
+     */
+    private getUpdaterErrorMessage;
+    /**
+     * 格式化日志错误并保留堆栈
+     * @param {unknown} error 错误
+     * @returns {unknown}
+     * @private
+     */
+    private formatLogError;
+    /**
+     * 确保开发环境更新器配置存在
+     * <p>electron-updater 开发环境只读取业务应用目录下的 dev-app-update.yml。</p>
+     * <p>业务端已创建时使用业务端配置，未创建时复制框架默认配置。</p>
+     * @protected
+     */
+    protected ensureDevUpdateConfig(): void;
+    /**
+     * 获取框架默认开发更新器配置路径
+     * @returns {string | undefined}
+     * @protected
+     */
+    protected frameworkDevUpdateConfigPath(): string | undefined;
+}
+export {};

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

@@ -0,0 +1,7 @@
+import { UpdaterManagerAbstract } from './updater-manager-abstract';
+/**
+ * 更新器管理器
+ * @class UpdaterManager
+ */
+export declare class UpdaterManager extends UpdaterManagerAbstract {
+}

package/dist/main/utils/file-association-util.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 文件关联工具
+ * @class FileAssociationUtil
+ */
+export declare class FileAssociationUtil {
+    /**
+     * 格式化文件扩展名
+     * @param {string} extension 文件扩展名
+     * @returns {string}
+     */
+    static normalizeExtension(extension: string): string;
+    /**
+     * 是否为有效的文件扩展名
+     * @param {string} extension 文件扩展名
+     * @returns {boolean}
+     */
+    static isValidExtension(extension: string): boolean;
+    /**
+     * 获取运行时文件扩展名
+     * @param {readonly string[]} extensions 文件扩展名
+     * @returns {string[]}
+     */
+    static getRuntimeExtensions(extensions?: readonly string[]): string[];
+    /**
+     * 获取文件扩展名
+     * @param {string} filePath 文件路径
+     * @returns {string}
+     */
+    static getExtension(filePath: string): string;
+    /**
+     * 启动参数中是否包含关联文件
+     * @param {readonly string[]} argv       启动参数
+     * @param {readonly string[]} extensions 文件扩展名
+     * @returns {boolean}
+     */
+    static hasAssociatedFile(argv: readonly string[], extensions?: readonly string[]): boolean;
+    /**
+     * 解析存在的绝对文件路径
+     * @param {string} value 文件路径
+     * @returns {string | undefined}
+     */
+    static resolveFilePath(value: string): string | undefined;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * @file Automatically generated by scripts/gen-exports.ts
+ */
+export * from './file-association-util';
+export * from './menu-util';
+export * from './protocol-util';
+export * from './runtime-config-util';
+export * from './shortcut-util';
+export * from './tray-util';
+export * from './window-util';
+export * from './xo-app-root-util';
+export * from './xo-app-util';
+export * from './xo-path-util';
+export * from './xo-util';

package/dist/main/utils/index.js

@@ -0,0 +1,105 @@
+import {
+  TrayAnimationNamePrefix,
+  TrayIconNamePrefix
+} from "../../chunk-files/chunk-3R6EJDYR.js";
+import {
+  MenuTypePrefix
+} from "../../chunk-files/chunk-HT5V5A7S.js";
+import {
+  WindowUtil
+} from "../../chunk-files/chunk-YZOJOLFL.js";
+import {
+  ShortcutUtil
+} from "../../chunk-files/chunk-GROGDGEL.js";
+import {
+  XoUtil
+} from "../../chunk-files/chunk-3S5OTD47.js";
+import {
+  FileAssociationUtil
+} from "../../chunk-files/chunk-VGDNICVG.js";
+import {
+  XoPathUtil
+} from "../../chunk-files/chunk-BPTFUGTP.js";
+import {
+  ProtocolUtil
+} from "../../chunk-files/chunk-KFK47PDH.js";
+import {
+  RuntimeConfigUtil,
+  XoAppRootUtil
+} from "../../chunk-files/chunk-GN2FNR3Z.js";
+import "../../chunk-files/chunk-3RVKOFMP.js";
+import "../../chunk-files/chunk-FMQTZ3QV.js";
+
+// src/main/utils/menu-util.ts
+var MenuUtil = class {
+  /**
+   * 创建菜单类型
+   * @param {string} name 菜单类型名
+   * @returns {XoMenu.Type}
+   */
+  static type(name) {
+    return `${MenuTypePrefix}${name}`;
+  }
+};
+
+// src/main/utils/tray-util.ts
+var TrayUtil = class {
+  /**
+   * 创建托盘图标名称
+   * @param {string} name 图标名称
+   * @returns {XoTray.IconName}
+   */
+  static iconName(name) {
+    return `${TrayIconNamePrefix}${name}`;
+  }
+  /**
+   * 创建托盘动画名称
+   * @param {string} name 动画名称
+   * @returns {XoTray.AnimationName}
+   */
+  static animationName(name) {
+    return `${TrayAnimationNamePrefix}${name}`;
+  }
+};
+
+// src/main/utils/xo-app-util.ts
+import path from "node:path";
+var XoAppUtil = class {
+  /**
+   * 解析业务端项目内 preload 文件路径
+   * @param {string} file 文件路径
+   * @returns {string}
+   */
+  static preloadFile(file) {
+    return path.resolve(this.rootDir(), RuntimeConfigUtil.preloadOutDir ?? "out/preload", file ?? "index.cjs");
+  }
+  /**
+   * 解析业务端项目内文件路径
+   * @param {string} file    文件路径
+   * @param {string} rootDir 业务端项目根目录（留空就自动查找）
+   * @returns {string}
+   */
+  static resolveFile(file, rootDir) {
+    return path.resolve(rootDir ?? this.rootDir(), file);
+  }
+  /**
+   * 获取业务端项目根目录
+   * @returns {string}
+   */
+  static rootDir() {
+    return XoAppRootUtil.resolve();
+  }
+};
+export {
+  FileAssociationUtil,
+  MenuUtil,
+  ProtocolUtil,
+  RuntimeConfigUtil,
+  ShortcutUtil,
+  TrayUtil,
+  WindowUtil,
+  XoAppRootUtil,
+  XoAppUtil,
+  XoPathUtil,
+  XoUtil
+};