@e-xi/xion 0.0.6

package/dist/renderer/utils/keyboard-util.d.ts

@@ -0,0 +1,86 @@
+/**
+ * 键盘工具
+ */
+export declare class KeyboardUtil {
+    /**
+     * 按键按下处理器
+     * @param {KeyboardEvent} event 按键事件
+     * @param {string[]}      keys  当前按键
+     * @returns {string[]}
+     */
+    static keydown(event: KeyboardEvent, keys: string[]): string[];
+    /**
+     * 按键弹起处理器
+     * @param {KeyboardEvent} event 按键事件
+     * @param {string[]}      keys  当前按键
+     * @returns {string[]}
+     */
+    static keyup(event: KeyboardEvent, keys: string[]): string[];
+    /**
+     * 获取有效组合键
+     * @param {string[]} keys 按键组合
+     * @returns {string[]}
+     */
+    static getCombinationKeys(keys: string[]): string[];
+    /**
+     * 将按键解析为友好展示
+     * @param {string[]} keys      按键组合
+     * @param {string}   delimiter 分隔符
+     * @returns {string}
+     */
+    static parseFriendly(keys: string[], delimiter?: string): string;
+    /**
+     * 将单个按键解析为友好展示
+     * @param {string} key 按键
+     * @returns {string}
+     */
+    static parseFriendlyKey(key: string): string;
+    /**
+     * 获取修饰键
+     * @param {string} key 按键
+     * @returns {ModifierKey | undefined}
+     */
+    private static getModifierKey;
+    /**
+     * 是否为 Electron 支持的按键
+     * @param {string} key 按键
+     * @returns {boolean}
+     */
+    private static isSupportedKey;
+    /**
+     * 是否为 Electron 支持的普通按键
+     * @param {string} key 按键
+     * @returns {boolean}
+     */
+    private static isSupportedNormalKey;
+    /**
+     * 是否为修饰键
+     * @param {string} key 按键
+     * @returns {boolean}
+     */
+    private static isModifierKey;
+    /**
+     * 是否为媒体键
+     * @param {string} key 按键
+     * @returns {boolean}
+     */
+    private static isMediaKey;
+    /**
+     * 是否为 Electron 支持的功能键
+     * @param {string} key 按键
+     * @returns {boolean}
+     */
+    private static isFunctionKey;
+    /**
+     * 组合键排序
+     * @param {string[]} keys 按键组合
+     * @returns {string[]}
+     */
+    private static sortKeys;
+    /**
+     * 首字母大写
+     * @param {string} value 字符串
+     * @returns {string}
+     */
+    private static upperFirst;
+}

package/dist/renderer/utils/message-util.d.ts

@@ -0,0 +1,161 @@
+import type { ElMessageBoxOptions, MessageHandler, MessageOptions, MessageType, NotificationHandle, NotificationOptions } from 'element-plus';
+export type XoMessageContent = MessageOptions['message'];
+export type XoMessageOptions = Omit<MessageOptions, 'message' | 'type'>;
+export type XoMessageBoxContent = ElMessageBoxOptions['message'];
+export type XoMessageBoxOptions = Omit<ElMessageBoxOptions, 'message' | 'title' | 'boxType' | 'callback' | 'distinguishCancelAndClose'>;
+/**
+ * 消息工具类
+ * @class MessageUtil
+ * @author e-xi 136066669@qq.com
+ */
+export declare class MessageUtil {
+    /**
+     * 默认消息配置
+     * @type {XoMessageOptions}
+     * @private
+     */
+    private static readonly defaultOptions;
+    /**
+     * 打开消息
+     * @param {MessageOptions} options 消息配置
+     * @returns {MessageHandler}
+     */
+    static open(options: MessageOptions): MessageHandler;
+    /**
+     * 显示指定类型消息
+     * @param {MessageType}      type    消息类型
+     * @param {XoMessageContent} message 消息内容
+     * @param {XoMessageOptions} options 消息配置
+     * @returns {MessageHandler}
+     * @private
+     */
+    private static show;
+    /**
+     * 成功消息
+     * @param {XoMessageContent} message 消息内容
+     * @param {XoMessageOptions} options 消息配置
+     * @returns {MessageHandler}
+     */
+    static success(message: XoMessageContent, options?: XoMessageOptions): MessageHandler;
+    /**
+     * 主要消息
+     * @param {XoMessageContent} message 消息内容
+     * @param {XoMessageOptions} options 消息配置
+     * @returns {MessageHandler}
+     */
+    static primary(message: XoMessageContent, options?: XoMessageOptions): MessageHandler;
+    /**
+     * 信息消息
+     * @param {XoMessageContent} message 消息内容
+     * @param {XoMessageOptions} options 消息配置
+     * @returns {MessageHandler}
+     */
+    static info(message: XoMessageContent, options?: XoMessageOptions): MessageHandler;
+    /**
+     * 警告消息
+     * @param {XoMessageContent} message 消息内容
+     * @param {XoMessageOptions} options 消息配置
+     * @returns {MessageHandler}
+     */
+    static warning(message: XoMessageContent, options?: XoMessageOptions): MessageHandler;
+    /**
+     * 错误消息
+     * @param {unknown}                    error           错误
+     * @param {string | XoMessageOptions}  fallbackOptions 兜底消息或消息配置
+     * @param {XoMessageOptions}           options         消息配置
+     * @returns {MessageHandler}
+     */
+    static error(error: unknown, fallbackOptions?: string | XoMessageOptions, options?: XoMessageOptions): MessageHandler;
+    /**
+     * 关闭全部消息
+     * @param {MessageType} type 消息类型
+     */
+    static closeAll(type?: MessageType): void;
+    /**
+     * 解析错误消息
+     * @param {unknown} error    错误
+     * @param {string}  fallback 兜底消息
+     * @returns {string}
+     * @private
+     */
+    private static parseErrorMessage;
+    /**
+     * 判断是否为包含 message 的对象
+     * @param {unknown} value 值
+     * @returns {value is {message: string}}
+     * @private
+     */
+    private static isMessageObject;
+    /**
+     * 打开通知
+     * @param {NotificationOptions} options 通知配置
+     * @returns {NotificationHandle}
+     */
+    static notify(options: NotificationOptions): NotificationHandle;
+    /**
+     * 关闭全部通知
+     */
+    static closeAllNotifications(): void;
+    /**
+     * 默认消息弹窗配置
+     * @type {XoMessageBoxOptions}
+     * @private
+     */
+    private static readonly defaultBoxOptions;
+    /**
+     * 警告弹窗
+     * @param {XoMessageBoxContent} message 消息内容
+     * @param {XoMessageBoxOptions} options 消息弹窗配置
+     * @returns {Promise<void>}
+     */
+    static alert(message: XoMessageBoxContent, options?: XoMessageBoxOptions): Promise<void>;
+    /**
+     * 警告弹窗
+     * @param {XoMessageBoxContent} message 消息内容
+     * @param {string}              title   标题
+     * @param {XoMessageBoxOptions} options 消息弹窗配置
+     * @returns {Promise<void>}
+     */
+    static alert(message: XoMessageBoxContent, title: string, options?: XoMessageBoxOptions): Promise<void>;
+    /**
+     * 确认弹窗
+     * @param {XoMessageBoxContent} message 消息内容
+     * @param {XoMessageBoxOptions} options 消息弹窗配置
+     * @returns {Promise<boolean>} 是否确认
+     */
+    static confirm(message: XoMessageBoxContent, options?: XoMessageBoxOptions): Promise<boolean>;
+    /**
+     * 确认弹窗
+     * @param {XoMessageBoxContent} message 消息内容
+     * @param {string}              title   标题
+     * @param {XoMessageBoxOptions} options 消息弹窗配置
+     * @returns {Promise<boolean>} 是否确认
+     */
+    static confirm(message: XoMessageBoxContent, title: string, options?: XoMessageBoxOptions): Promise<boolean>;
+    /**
+     * 输入弹窗
+     * @param {XoMessageBoxContent} message 消息内容
+     * @param {XoMessageBoxOptions} options 消息弹窗配置
+     * @returns {Promise<string | undefined>} 输入值，取消或关闭时返回 undefined
+     */
+    static prompt(message: XoMessageBoxContent, options?: XoMessageBoxOptions): Promise<string | undefined>;
+    /**
+     * 输入弹窗
+     * @param {XoMessageBoxContent} message 消息内容
+     * @param {string}              title   标题
+     * @param {XoMessageBoxOptions} options 消息弹窗配置
+     * @returns {Promise<string | undefined>} 输入值，取消或关闭时返回 undefined
+     */
+    static prompt(message: XoMessageBoxContent, title: string, options?: XoMessageBoxOptions): Promise<string | undefined>;
+    /**
+     * 关闭当前消息弹窗
+     */
+    static closeBox(): void;
+    /**
+     * 判断消息弹窗是否被取消或关闭
+     * @param {unknown} reason Promise 拒绝原因
+     * @returns {boolean}
+     * @private
+     */
+    private static isBoxDismissed;
+}

package/dist/renderer/utils/renderer-log-util.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 渲染进程日志工具
+ * <p>在 renderer world 中先标准化 Error，避免跨 contextBridge 时丢失完整调用栈。</p>
+ * @class RendererLogUtil
+ */
+export declare class RendererLogUtil {
+    /**
+     * 写入 debug 日志
+     * @param {string}    message 日志消息
+     * @param {unknown[]} data    附加数据
+     * @returns {Promise<void>}
+     */
+    static debug(message: string, ...data: unknown[]): Promise<void>;
+    /**
+     * 写入 info 日志
+     * @param {string}    message 日志消息
+     * @param {unknown[]} data    附加数据
+     * @returns {Promise<void>}
+     */
+    static info(message: string, ...data: unknown[]): Promise<void>;
+    /**
+     * 写入 warn 日志
+     * @param {string}    message 日志消息
+     * @param {unknown[]} data    附加数据
+     * @returns {Promise<void>}
+     */
+    static warn(message: string, ...data: unknown[]): Promise<void>;
+    /**
+     * 写入 error 日志
+     * @param {string}    message 日志消息
+     * @param {unknown[]} data    附加数据
+     * @returns {Promise<void>}
+     */
+    static error(message: string, ...data: unknown[]): Promise<void>;
+    /**
+     * 标准化并写入日志
+     * @param {XoIpcLogger.Level} level   日志等级
+     * @param {string}            message 日志消息
+     * @param {unknown[]}         data    附加数据
+     * @returns {Promise<void>}
+     * @private
+     */
+    private static write;
+}

package/dist/renderer/utils/renderer-util.d.ts

@@ -0,0 +1,37 @@
+import { type Slots } from 'vue';
+/**
+ * 渲染进程工具类
+ * @class RendererUtil
+ * @author e-xi 136066669@qq.com
+ */
+export declare class RendererUtil {
+    /**
+     * 将字符串转换为 CSS 文本
+     * @param {string | undefined} value 字符串值
+     * @returns {string}
+     */
+    static toCssText(value: string | undefined): string | undefined;
+    /**
+     * 将数字转换为 CSS 尺寸
+     * @param {number | string | undefined} value 尺寸值
+     * @returns {string}
+     */
+    static toCssSize(value: number | string | undefined): string | undefined;
+    /**
+     * 判断插槽是否有内容
+     * @param {Slots}  slots 插槽对象
+     * @param {string} name  插槽名称
+     * @returns {boolean}
+     */
+    static hasSlot(slots: Slots, name: string): boolean;
+    /**
+     * 判断 VNode 是否有内容
+     * @param {VNode[]} nodes VNode 数组
+     * @returns {boolean}
+     */
+    private static hasVNodeContent;
+    /**
+     * 获取 Vue Proxy 的原始对象
+     */
+    static toRaw<T>(value: T): T;
+}

package/dist/renderer/utils/router-util.d.ts

@@ -0,0 +1,186 @@
+import type { XoComponentSidebarMenuRouteName } from '../components/types/sidebar-menu';
+import { type ComputedRef } from 'vue';
+import type { LocationQuery, LocationQueryRaw, RouteLocationMatched, RouteLocationRaw, RouteMeta, RouteParamsGeneric, Router, RouteRecordName, RouteRecordNameGeneric } from 'vue-router';
+/**
+ * 路由工具
+ * @class RouterUtil
+ * @author e-xi 136066669@qq.com
+ */
+export declare class RouterUtil {
+    /**
+     * 路由实例
+     * @type {Router | undefined}
+     * @private
+     */
+    private static router;
+    /**
+     * 路由重定向监听移除方法
+     * @type {(() => void) | undefined}
+     * @private
+     */
+    private static offRouteRedirect;
+    /**
+     * 安装路由实例
+     * @param {Router} router 路由实例
+     */
+    static install(router: Router): void;
+    /**
+     * 获取路由实例
+     * @returns {Router}
+     * @private
+     */
+    static getRouter(): Router;
+    /**
+     * 绑定路由重定向监听
+     * @private
+     */
+    private static bindRouteRedirect;
+    /**
+     * 重定向路由
+     * @param {XoWindow.RouteRedirectRequest} request 路由重定向请求
+     * @private
+     */
+    private static redirectRoute;
+    /**
+     * 获取父路由
+     * @returns {RouteLocationMatched | null}
+     */
+    static getParentRoute(): RouteLocationMatched | null;
+    /**
+     * 获取父路由名称
+     * @returns {string}
+     */
+    static getParentRouteName(): string;
+    /**
+     * 获取当前路由名称
+     * @returns {ComputedRef<string | symbol | undefined>}
+     */
+    static getCurrentRouteName(): ComputedRef<RouteRecordName | null | undefined>;
+    /**
+     * 判断路由是否激活
+     * @param {XoComponentSidebarMenuRouteName}   routeName    路由名称
+     * @param {XoComponentSidebarMenuRouteName[]} activeRoutes 用于判断是否激活的路由名称数组，如果为空就使用 route 比对
+     * @returns {boolean}
+     */
+    static isRouteActive(routeName: XoComponentSidebarMenuRouteName, activeRoutes?: XoComponentSidebarMenuRouteName[]): boolean;
+    /**
+     * Router push by name
+     * @param {RouteRecordName} name 路由名称
+     * @param {LocationQueryRaw} query 请求参数
+     */
+    static push(name: RouteRecordName, query?: LocationQueryRaw): void;
+    /**
+     * Router push
+     * @param {RouteLocationRaw} to 路由目标
+     */
+    static pushTo(to: RouteLocationRaw): void;
+    /**
+     * Router replace by name
+     * @param {RouteRecordName} name 路由名称
+     * @param {LocationQueryRaw} query 请求参数
+     */
+    static replace(name: RouteRecordName, query?: LocationQueryRaw): void;
+    /**
+     * Router replace by name
+     * @param {RouteLocationRaw} to 路由目标
+     */
+    static replaceTo(to: RouteLocationRaw): void;
+    /**
+     * 路由会退
+     */
+    static back(): void;
+    /**
+     * 路由前进
+     */
+    static forward(): void;
+    /**
+     * 路由历史跳转
+     * @param {number} delta 跳转步数
+     */
+    static go(delta: number): void;
+    /**
+     * 获取路由名称
+     * @returns {RouteRecordNameGeneric}
+     */
+    static getName(): RouteRecordNameGeneric;
+    /**
+     * 获取路由路径
+     * @returns {string}
+     */
+    static getPath(): string;
+    /**
+     * 获取路由完整路径
+     * @returns {string}
+     */
+    static getFullPath(): string;
+    /**
+     * 获取路由元信息
+     * @returns {RouteMeta}
+     */
+    static getMeta(): RouteMeta;
+    /**
+     * 获取路由参数
+     * @returns {RouteParamsGeneric}
+     */
+    static getParams(): RouteParamsGeneric;
+    /**
+     * 获取当前路由指定路径参数的值
+     *
+     * 路由参数由路径中的动态片段产生，例如 /user/:id 的 id
+     * 当参数为数组时，返回数组中的第一个值。
+     *
+     * @param {string} key      参数名
+     * @param {string} defaults 参数不存在时返回的默认值
+     * @returns {string}
+     */
+    static getParam(key: string, defaults?: string): string;
+    /**
+     * 获取当前路由指定路径参数的值数组
+     *
+     * 字符串参数会转换为单元素数组，重复路径参数会完整返回
+     *
+     * @param {string}   key      参数名
+     * @param {string[]} defaults 参数不存在时返回的默认值
+     * @returns {string[]}
+     */
+    static getParamArray(key: string, defaults?: string[]): string[];
+    /**
+     * 获取请求参数映射
+     * @returns {LocationQuery}
+     */
+    static getQueryMap(): LocationQuery;
+    /**
+     * 获取请求参数的值的数组，单个结果也按数组返回
+     * @param {string}   key      参数名
+     * @param {string[]} defaults 默认值
+     * @returns {string[]}
+     */
+    static getQueryArray(key: string, defaults?: string[]): string[];
+    /**
+     * 获取请求参数的值，如果值是数组，取第一个值返回
+     * @param {string} key      参数名
+     * @param {string} defaults 默认值
+     * @returns {string}
+     */
+    static getQuery(key: string, defaults?: string): string;
+    /**
+     * location 重定向
+     * @param {string} url 重定向地址
+     */
+    static locationRedirect(url: string): void;
+    /**
+     * location 刷新
+     */
+    static locationReload(): void;
+    /**
+     * 获取当前页面 href 路径
+     * @returns {string}
+     */
+    static getLocationHref(): string;
+    /**
+     * 拨打电话链接
+     * @param {string} tel 电话号码
+     * @returns {string}
+     */
+    static tel(tel: string): string;
+}

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

@@ -0,0 +1,20 @@
+/**
+ * 快捷键工具
+ * @class ShortcutUtil
+ */
+export declare class ShortcutUtil {
+    /**
+     * 创建全局快捷键
+     * @param {XoShortcut.ID} id   快捷键ID
+     * @param {string[]}      keys 按键组合
+     * @returns {XoShortcut.Key}
+     */
+    static globalKey(id: XoShortcut.ID, keys: string[]): XoShortcut.Key;
+    /**
+     * 创建应用级快捷键
+     * @param {XoShortcut.ID} id   快捷键ID
+     * @param {string[]}      keys 按键组合
+     * @returns {XoShortcut.Key}
+     */
+    static appKey(id: XoShortcut.ID, keys: string[]): XoShortcut.Key;
+}

package/dist/renderer/utils/storage-util.d.ts

@@ -0,0 +1,85 @@
+/**
+ * 存储工具类
+ * <p>数据保存在 localStorage，支持可选有效期</p>
+ * <p>请勿保存密码、访问令牌等敏感信息</p>
+ * @class StorageUtil
+ * @author e-xi 136066669@qq.com
+ */
+export declare class StorageUtil {
+    /**
+     * 保存数据
+     * @template T 数据类型
+     * @param {string} key       键
+     * @param {T}      value     值
+     * @param {number} expiresIn 可选有效期，单位毫秒，不传表示永不过期
+     * @returns {void}
+     * @throws {RangeError} 有效期不是大于 0 的有限数字时抛出
+     * @example
+     *   // 不过期保存
+     *   StorageUtil.save('login.authType', 'totp')
+     *
+     *   // 24 小时后过期
+     *   StorageUtil.save('login.authType', 'totp', 24 * 60 * 60 * 1000)
+     */
+    static save<T>(key: string, value: T, expiresIn?: number): void;
+    /**
+     * 获取数据
+     * <p>数据不存在、过期或内容无效时返回 null</p>
+     * @template T 数据类型
+     * @param {string} key 键
+     * @returns {T | null} 缓存数据
+     * @example
+     *   // 获取数据，过期后返回 null 并自动删除
+     *   const value = StorageUtil.get<T>('key')
+     */
+    static get<T = unknown>(key: string): T | null;
+    /**
+     * 判断数据是否存在且未过期
+     * @param {string} key 键
+     * @returns {boolean} 数据是否存在且未过期
+     * @example
+     *   // 判断是否存在且未过期
+     *   const exists = StorageUtil.has('key')
+     */
+    static has(key: string): boolean;
+    /**
+     * 删除数据
+     * @param {string} key 键
+     * @returns {void}
+     * @example
+     *   // 删除指定缓存
+     *   StorageUtil.remove('key')
+     */
+    static remove(key: string): void;
+    /**
+     * 清理全部由 StorageUtil 保存且已经过期的数据
+     * <p>不会删除普通 localStorage 数据和旧版未包装数据</p>
+     * @returns {number} 删除的数据数量
+     * @example
+     *   // 清理全部由 StorageUtil 保存且已过期的数据
+     *   const count = StorageUtil.clearExpired()
+     */
+    static clearExpired(): number;
+    /**
+     * 读取并校验存储数据
+     * @template T 数据类型
+     * @param {string} key 键
+     * @returns {{value: T} | null} 有效数据，不存在或无效时返回 null
+     * @private
+     */
+    private static read;
+    /**
+     * 判断数据是否为 StorageUtil 包装结构
+     * @param {unknown} value 待判断数据
+     * @returns {value is Entry<unknown>} 是否为 StorageUtil 包装结构
+     * @private
+     */
+    private static isStorageEntry;
+    /**
+     * 判断存储数据是否已经过期
+     * @param {Entry<unknown>} entry 存储数据
+     * @returns {boolean} 是否已经过期
+     * @private
+     */
+    private static isExpired;
+}

package/dist/renderer/utils/types/vue-router.d.ts

@@ -0,0 +1,17 @@
+import 'vue-router'
+
+declare module 'vue-router' {
+
+    // 路由元信息
+    interface RouteMeta {
+
+        /**
+         * 是否跳过登录验证
+         * <p>设置 true 时跳过登录验证</p>
+         * <p>未设置或设置为 false 时需要验证登录状态</p>
+         */
+        ignoreAuth?: boolean
+    }
+}
+
+export {}

package/dist/shared/app/consts/app-launch-mode.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 应用启动模式
+ * <p>此配置仅与启动时是否展示窗口和托盘状态有关。</p>
+ */
+export declare const AppLaunchMode: readonly ["window", "silent"];
+/**
+ * 应用启动模式选项
+ */
+export declare const AppLaunchModeOptions: XoRenderer.RadioOptions<XoApp.AppLaunchMode>;

package/dist/shared/app/consts/update-mode.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 更新器更新模式
+ */
+export declare const UpdateMode: readonly [true, false, "checkOnStart"];
+/**
+ * 更新器更新模式选项
+ */
+export declare const UpdateModeOptions: XoRenderer.RadioOptions<XoApp.UpdateMode>;

package/dist/shared/app/consts/window-close-behavior.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 窗口关闭时行为
+ */
+export declare const WindowCloseBehavior: readonly ["minimize", "quit"];
+/**
+ * 窗口关闭时行为选项
+ */
+export declare const WindowCloseBehaviorOptions: XoRenderer.RadioOptions<XoApp.WindowCloseBehavior>;

package/dist/shared/app/consts/window-material.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 窗口材质
+ */
+export declare const WindowMaterials: readonly ["transparent", "mica", "acrylic", "tabbed", "none"];
+/**
+ * 窗口材质选项
+ */
+export declare const WindowMaterialsOptions: XoRenderer.RadioOptions<XoApp.WindowMaterial>;

package/dist/shared/app/consts/xion-name.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 框架名称
+ * @type {string}
+ */
+export declare const XionName: string;

package/dist/shared/app/electron-app-config.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 默认 electron 应用构建配置
+ * @returns {XoVite.ElectronAppOptions}
+ */
+export declare const defaultElectronAppConfig: () => XoVite.ElectronAppOptions;