@e-xi/xion 0.0.6

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

@@ -0,0 +1,273 @@
+import type { XoAppAbstract } from '../app/xo-app-abstract';
+/**
+ * 菜单管理器抽象类
+ * @class MenuManagerAbstract
+ */
+export declare abstract class MenuManagerAbstract {
+    /**
+     * Xion 应用
+     * @type {XoAppAbstract}
+     */
+    readonly xoApp: XoAppAbstract;
+    /**
+     * 上下文菜单缓存过期时间
+     * @type {number}
+     * @protected
+     */
+    protected readonly contextMenuTTL: number;
+    /**
+     * 上下文菜单请求序号
+     * @type {number}
+     * @private
+     */
+    private contextMenuSeq;
+    /**
+     * 上下文菜单缓存
+     * @type {Map<string, XoMenu.ContextMenuRecord>}
+     * @private
+     */
+    private readonly contextMenuRecords;
+    /**
+     * 渲染进程图片地址缓存
+     * @type {Map<string, string>}
+     * @private
+     */
+    private readonly rendererImageUrlCache;
+    /**
+     * 菜单命令处理器
+     * @type {Map<XoMenu.Command, XoMenu.CommandHandler>}
+     * @private
+     */
+    private readonly commandHandlers;
+    /**
+     * 构造函数
+     * @param {XoAppAbstract} xoApp Xion 应用
+     */
+    constructor(xoApp: XoAppAbstract);
+    /**
+     * 安装应用菜单
+     */
+    installAppMenu(): void;
+    /**
+     * 获取应用菜单
+     * @returns {Electron.Menu}
+     */
+    getApplicationMenu(): Electron.Menu;
+    /**
+     * 获取托盘菜单
+     * @returns {Electron.Menu}
+     */
+    getTrayMenu(): Electron.Menu;
+    /**
+     * 按上下文获取菜单
+     * @param {Electron.ContextMenuParams} params 上下文菜单参数
+     * @returns {Electron.Menu}
+     */
+    getContextMenu(params?: Electron.ContextMenuParams): Electron.Menu;
+    /**
+     * 弹出上下文菜单（主进程中）
+     * @param {Electron.ContextMenuParams} params 上下文菜单参数
+     * @param {Electron.BrowserWindow}     window 生效窗口
+     */
+    popupContextMenu(params?: Electron.ContextMenuParams, window?: Electron.BrowserWindow): void;
+    /**
+     * 解析上下文菜单（渲染进程）
+     * @param {Electron.ContextMenuParams} params 上下文菜单参数
+     * @param {Electron.BrowserWindow}     window 生效窗口
+     * @returns {XoMenu.ContextMenuRequest}
+     */
+    resolveContextMenu(params: Electron.ContextMenuParams, window: Electron.BrowserWindow): XoMenu.ContextMenuRequest;
+    /**
+     * 生成上下文菜单请求 ID
+     * @returns {string}
+     * @protected
+     */
+    protected nextContextMenuRequestId(): string;
+    /**
+     * 转换为渲染进程菜单项
+     * @param {XoMenu.Item[]} items 菜单项
+     * @returns {XoMenu.RendererItem[]}
+     * @protected
+     */
+    protected toRendererItems(items: XoMenu.Item[]): XoMenu.RendererItem[];
+    /**
+     * 内置 electron 菜单 role 与命令名的映射
+     * @returns {XoMenu.RoleCommandMap}
+     * @protected
+     */
+    protected builtInRoleCommands(): XoMenu.RoleCommandMap;
+    /**
+     * 转换渲染进程快捷键文本
+     * @param {Electron.Accelerator | undefined} accelerator Electron 快捷键
+     * @returns {string | null}
+     * @protected
+     */
+    protected rendererAccelerator(accelerator?: Electron.Accelerator): string | null;
+    /**
+     * 转换渲染进程快捷键按键文本
+     * @param {string} key 按键
+     * @returns {string}
+     * @protected
+     */
+    protected rendererAcceleratorKey(key: string): string;
+    /**
+     * 转换渲染进程菜单图标
+     * @param {XoMenu.Icon | undefined} icon 菜单图标
+     * @returns {XoMenu.Icon | null}
+     * @protected
+     */
+    protected rendererIcon(icon?: XoMenu.Icon): XoMenu.Icon | null;
+    /**
+     * 转换渲染进程图片地址
+     * @param {string} value 图片地址或本地路径
+     * @returns {string}
+     * @protected
+     */
+    protected rendererImageUrl(value: string): string;
+    /**
+     * 获取本地图片路径
+     * @param {string} value 图片地址或本地路径
+     * @returns {string | null}
+     * @protected
+     */
+    protected localImageFile(value: string): string | null;
+    /**
+     * 获取图片 MIME 类型
+     * @param {string} file 图片路径
+     * @returns {string}
+     * @protected
+     */
+    protected imageMimeType(file: string): string;
+    /**
+     * 业务命令
+     * @returns {XoMenu.CommandHandlerMap}
+     */
+    abstract commands(): XoMenu.CommandHandlerMap;
+    /**
+     * 内置命令
+     * @returns {XoMenu.CommandHandlerMap}
+     * @protected
+     */
+    protected builtInCommands(): XoMenu.CommandHandlerMap;
+    /**
+     * 菜单项转命令处理器
+     * @param {(record: XoMenu.ContextMenuRecord, payload: any) => XoMenu.Item} item 菜单项
+     * @returns {XoMenu.CommandHandler}
+     * @protected
+     */
+    protected toCommandHandler(item: (record: XoMenu.ContextMenuRecord, payload: any) => XoMenu.Item): XoMenu.CommandHandler;
+    /**
+     * 执行菜单项点击事件
+     * @param {XoMenu.Item}              item   菜单项
+     * @param {XoMenu.ContextMenuRecord} record 上下文菜单缓存
+     * @returns {Promise<void>}
+     * @protected
+     */
+    protected executeClick(item: XoMenu.Item, record: XoMenu.ContextMenuRecord): Promise<void>;
+    /**
+     * 注册菜单命令
+     * @param {XoMenu.Command}        command 命令
+     * @param {XoMenu.CommandHandler} handler 处理器
+     */
+    registerCommand(command: XoMenu.Command, handler: XoMenu.CommandHandler): void;
+    /**
+     * 批量注册菜单命令
+     * @protected
+     */
+    private registerCommands;
+    /**
+     * 执行菜单命令
+     * @param {XoMenu.ExecuteCommandRequest} request 请求
+     * @returns {Promise<boolean>}
+     */
+    executeCommand(request: XoMenu.ExecuteCommandRequest): Promise<boolean>;
+    /**
+     * 删除上下文菜单缓存
+     * @param {string} requestId 请求 ID
+     * @protected
+     */
+    protected deleteContextMenuRecord(requestId: string): void;
+    /**
+     * 解析上下文菜单类型
+     * @param {Electron.ContextMenuParams} params 上下文菜单参数
+     * @returns {XoMenu.Type}
+     */
+    protected contextType(params?: Electron.ContextMenuParams): XoMenu.Type;
+    /**
+     * 解析上下文菜单状态
+     * @param {Electron.ContextMenuParams} params 上下文菜单参数
+     * @returns {XoMenu.ContextState}
+     */
+    protected contextState(params?: Electron.ContextMenuParams): XoMenu.ContextState;
+    /**
+     * 菜单项去重键
+     * @param {XoMenu.Item} item 菜单项
+     * @returns {string | undefined}
+     */
+    protected menuItemKey(item: XoMenu.Item): string | undefined;
+    /**
+     * 创建菜单
+     * @param {XoMenu.Item[]} items 菜单项
+     * @returns {Electron.Menu}
+     */
+    protected buildMenu(items: XoMenu.Item[]): Electron.Menu;
+    /**
+     * 默认窗口菜单项
+     * @param {XoMenu.ContextState} state 上下文状态
+     * @returns {XoMenu.Item[]}
+     */
+    protected defaultMenuItems(state: XoMenu.ContextState): XoMenu.Item[];
+    /**
+     * 获取页面基于内容的菜单项
+     * @param {XoMenu.ContextState} state 上下文状态
+     * @returns {XoMenu.Item[]}
+     */
+    protected contentMenuItems(state: XoMenu.ContextState): XoMenu.Item[];
+    /**
+     * 获取应用菜单项
+     * @returns {XoMenu.Item[]}
+     */
+    protected applicationMenuItems(): XoMenu.Item[];
+    /**
+     * 获取托盘菜单项
+     * @returns {XoMenu.Item[]}
+     */
+    protected trayMenuItems(): XoMenu.Item[];
+    /**
+     * 获取链接菜单项
+     * @param {XoMenu.ContextState} state 上下文状态
+     * @returns {XoMenu.Item[]}
+     */
+    protected linkMenuItems(state: XoMenu.ContextState): XoMenu.Item[];
+    /**
+     * 获取图片菜单项
+     * @param {XoMenu.ContextState} state 上下文状态
+     * @returns {XoMenu.Item[]}
+     */
+    protected imageMenuItems(state: XoMenu.ContextState): XoMenu.Item[];
+    /**
+     * 获取编辑菜单项
+     * @param {XoMenu.ContextState} state 上下文状态
+     * @returns {XoMenu.Item[]}
+     */
+    protected editableMenuItems(state: XoMenu.ContextState): XoMenu.Item[];
+    /**
+     * 获取选区菜单项
+     * @param {XoMenu.ContextState} state 上下文状态
+     * @returns {XoMenu.Item[]}
+     */
+    protected selectionMenuItems(state: XoMenu.ContextState): XoMenu.Item[];
+    /**
+     * 按上下文获取菜单项
+     * @param {XoMenu.Type}         type  菜单类型
+     * @param {XoMenu.ContextState} state 上下文状态
+     * @returns {XoMenu.Item[]}
+     */
+    protected contextMenuItems(type: XoMenu.Type, state: XoMenu.ContextState): XoMenu.Item[];
+    /**
+     * 自动添加分割线
+     * @param {XoMenu.Item[][]} groups 菜单分组
+     * @returns {XoMenu.Item[]}
+     */
+    protected autoSeparator(...groups: XoMenu.Item[][]): XoMenu.Item[];
+}

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

@@ -0,0 +1,12 @@
+import { MenuManagerAbstract } from './menu-manager-abstract';
+/**
+ * Xion 默认菜单管理器
+ * @class MenuManager
+ */
+export declare class MenuManager extends MenuManagerAbstract {
+    /**
+     * 业务命令
+     * @returns {XoMenu.CommandHandlerMap}
+     */
+    commands(): XoMenu.CommandHandlerMap;
+}

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

@@ -0,0 +1,101 @@
+import type {MenuTypePrefix} from '../consts/menu-type'
+
+declare global {
+
+    // 菜单
+    namespace XoMenu {
+
+        // 菜单类型
+        type Type =
+            'default'
+            | 'editable'
+            | 'input'
+            | 'selection'
+            | 'link'
+            | 'image'
+            | 'tray'
+            | 'app'
+            | 'all'
+            | (`${typeof MenuTypePrefix}${string}` & {})
+
+        // 菜单项
+        type Item<T = any> = Electron.MenuItemConstructorOptions & {
+            // 渲染进程菜单图标
+            rendererIcon?: Icon
+            // 渲染进程菜单命令
+            command?: Command
+            // 渲染进程菜单命令参数
+            payload?: T
+            // 子菜单
+            submenu?: SubMenus
+        }
+
+        // 子菜单
+        type SubMenus = Item[] | Electron.Menu
+
+        // 菜单角色命令映射
+        type RoleCommandMap = Partial<Record<NonNullable<Electron.MenuItemConstructorOptions['role']>, Command>>
+
+        // 上下文菜单缓存记录
+        interface ContextMenuRecord {
+            // 请求 ID
+            requestId: string
+            // 窗口
+            window: Electron.BrowserWindow
+            // 上下文菜单参数
+            params: Electron.ContextMenuParams
+            // 上下文状态
+            state: ContextState
+            // 过期定时器
+            timer: ReturnType<typeof setTimeout>
+        }
+
+        // 菜单命令处理器
+        type CommandHandler<T = any> = (record: ContextMenuRecord, payload: T) => Promise<void> | void
+
+        // 菜单命令处理器映射
+        type CommandHandlerMap = Record<Command, CommandHandler>
+
+        // 上下文菜单状态
+        interface ContextState {
+            // 是否可撤销
+            canUndo?: boolean
+            // 是否可重做
+            canRedo?: boolean
+            // 是否存在选中内容
+            hasSelection?: boolean
+            // 是否存在剪贴板内容
+            hasClipboard?: boolean
+            // 是否是密码输入框
+            isPassword?: boolean
+            // 是否可剪切
+            canCut?: boolean
+            // 是否可复制
+            canCopy?: boolean
+            // 是否可粘贴
+            canPaste?: boolean
+            // 是否可删除
+            canDelete?: boolean
+            // 是否可全选
+            canSelectAll?: boolean
+            // 是否可编辑富文本
+            canEditRichly?: boolean
+            // 链接地址
+            linkURL?: string
+            // 资源地址
+            srcURL?: string
+            // 建议文件名
+            suggestedFilename?: string
+            // 媒体类型
+            mediaType?: Electron.ContextMenuParams['mediaType']
+            // 是否存在图片内容
+            hasImageContents?: boolean
+            // 上下文菜单 X 坐标
+            x?: number
+            // 上下文菜单 Y 坐标
+            y?: number
+        }
+    }
+}
+
+export {}

package/dist/main/mode/app-mode.d.ts

@@ -0,0 +1,32 @@
+/**
+ * App运行时模式
+ * @class AppMode
+ */
+export declare class AppMode {
+    /**
+     * 为生产环境或预发布环境
+     * @returns {boolean}
+     */
+    static likeProd(): boolean;
+    /**
+     * 是否为生产环境（运行时）
+     * @returns {boolean}
+     */
+    static isProd(): boolean;
+    /**
+     * 是否为预发布环境（运行时）
+     * @returns {boolean}
+     */
+    static isStaging(): boolean;
+    /**
+     * 是否为开发环境（运行时）
+     * @returns {boolean}
+     */
+    static isDev(): boolean;
+    /**
+     * 解析模式
+     * @returns {XoMode.Mode}
+     * @private
+     */
+    static getMode(): XoMode.Mode;
+}

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

@@ -0,0 +1,5 @@
+/**
+ * @file Automatically generated by scripts/gen-exports.ts
+ */
+export * from './app-mode';
+export type * from './types/mode';

package/dist/main/mode/index.js

@@ -0,0 +1,9 @@
+import "../../chunk-files/chunk-6X74EPRM.js";
+import {
+  AppMode
+} from "../../chunk-files/chunk-GN2FNR3Z.js";
+import "../../chunk-files/chunk-3RVKOFMP.js";
+import "../../chunk-files/chunk-FMQTZ3QV.js";
+export {
+  AppMode
+};

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

@@ -0,0 +1,25 @@
+declare global {
+
+    // 模式
+    namespace XoMode {
+
+        // Vite 命令
+        type Command = 'build'
+                       | 'serve'
+
+        // 支持的模式
+        type Mode = 'production'
+                    | 'staging'
+                    | 'development'
+
+        // Vite 配置环境信息
+        interface ViteConfigEnv {
+            // 命令
+            command?: Command
+            // 模式
+            mode?: string
+        }
+    }
+}
+
+export {}

package/dist/main/protocol/consts/protocol-keys.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 协议处理器键
+ * @class ProtocolKeys
+ */
+export declare class ProtocolKeys {
+    /** 打开主窗口 */
+    static readonly openMainWindow: "app/v1/main/open";
+    /** 打开设置窗口 */
+    static readonly openSettingWindow: "app/v1/settings/open";
+}

package/dist/main/protocol/handlers/app-protocol-handlers.d.ts

@@ -0,0 +1,12 @@
+import { ProtocolHandlersAbstract } from '../protocol-handlers-abstract';
+/**
+ * 应用协议处理器（内置）
+ * @class AppProtocolHandlers
+ */
+export declare class AppProtocolHandlers extends ProtocolHandlersAbstract {
+    /**
+     * 处理器映射
+     * @returns {XoProtocol.HandlerMap}
+     */
+    handlerMap(): XoProtocol.HandlerMap;
+}

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

@@ -0,0 +1,9 @@
+/**
+ * @file Automatically generated by scripts/gen-exports.ts
+ */
+export * from './consts/protocol-keys';
+export * from './handlers/app-protocol-handlers';
+export * from './protocol-handlers-abstract';
+export * from './protocol-manager-abstract';
+export * from './protocol-manager';
+export type * from './types/protocol';

package/dist/main/protocol/index.js

@@ -0,0 +1,15 @@
+import {
+  AppProtocolHandlers,
+  ProtocolHandlersAbstract,
+  ProtocolKeys,
+  ProtocolManager,
+  ProtocolManagerAbstract
+} from "../../chunk-files/chunk-IMGYTSWY.js";
+import "../../chunk-files/chunk-KFK47PDH.js";
+export {
+  AppProtocolHandlers,
+  ProtocolHandlersAbstract,
+  ProtocolKeys,
+  ProtocolManager,
+  ProtocolManagerAbstract
+};

package/dist/main/protocol/protocol-handlers-abstract.d.ts

@@ -0,0 +1,23 @@
+import type { XoAppAbstract } from '../app/xo-app-abstract';
+/**
+ * 协议处理器抽象类
+ * @class ProtocolHandlersAbstract
+ */
+export declare abstract class ProtocolHandlersAbstract {
+    /**
+     * Xion 应用
+     * @type {XoAppAbstract}
+     * @protected
+     */
+    protected readonly xoApp: XoAppAbstract;
+    /**
+     * 构造函数
+     * @param {XoAppAbstract} xoApp Xion 应用
+     */
+    constructor(xoApp: XoAppAbstract);
+    /**
+     * 处理器映射
+     * @returns {XoProtocol.HandlerMap}
+     */
+    abstract handlerMap(): XoProtocol.HandlerMap;
+}

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

@@ -0,0 +1,85 @@
+import type { XoAppAbstract } from '../app/xo-app-abstract';
+/**
+ * 协议管理器抽象类
+ * @class ProtocolManagerAbstract
+ */
+export declare abstract class ProtocolManagerAbstract {
+    /** 是否已初始化 */
+    private initialized;
+    /** 是否可以处理协议 URL */
+    private ready;
+    /** 协议处理队列 */
+    private readonly pendingUrls;
+    /** 协议处理任务队列 */
+    private processingPromise;
+    /** 已注册处理器类 */
+    private readonly registeredHandlerClasses;
+    /** 已注册处理器键 */
+    private readonly registeredHandlerKeys;
+    /** 协议处理器映射 */
+    private readonly handlerMap;
+    /**
+     * Xion 应用
+     * @type {XoAppAbstract}
+     * @protected
+     */
+    protected readonly xoApp: XoAppAbstract;
+    /**
+     * 构造函数
+     * @param {XoAppAbstract} xoApp Xion 应用
+     */
+    constructor(xoApp: XoAppAbstract);
+    /**
+     * 初始化协议处理器
+     * @returns {boolean}
+     */
+    initialize(): boolean;
+    /**
+     * 注册默认协议客户端
+     */
+    registerClients(): void;
+    /**
+     * 协议处理就绪
+     * @returns {Promise<void>}
+     */
+    setReady(): Promise<void>;
+    /**
+     * 处理启动参数
+     * 参数仅如 'eassistant://app/v1/main/open?id=123' 格式时处理
+     * @param {readonly string[]} argv 启动参数
+     * @returns {Promise<boolean>} 是否处理了协议 URL
+     */
+    handleArgv(argv: readonly string[]): Promise<boolean>;
+    /**
+     * 处理协议 URL
+     * @param {string} value 外部输入
+     * @returns {Promise<boolean>}
+     */
+    handleUrl(value: string): Promise<boolean>;
+    /**
+     * 解析应用协议 URL
+     * @param {string} value 外部输入
+     * @returns {URL | undefined}
+     * @private
+     */
+    private parseUrl;
+    /**
+     * 处理当前等待队列
+     * @returns {Promise<void>}
+     * @private
+     */
+    private processPendingUrls;
+    /**
+     * 分发协议 URL
+     * @param {string} rawUrl 原始协议 URL
+     * @returns {Promise<void>}
+     * @private
+     */
+    private dispatch;
+    /**
+     * 创建自定义处理器列表
+     * @returns {XoProtocol.HandlersConstructor[]}
+     * @protected
+     */
+    protected abstract handlers(): XoProtocol.HandlersConstructor[];
+}

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

@@ -0,0 +1,13 @@
+import { ProtocolManagerAbstract } from './protocol-manager-abstract';
+/**
+ * 协议管理器
+ * @class ProtocolManager
+ */
+export declare class ProtocolManager extends ProtocolManagerAbstract {
+    /**
+     * 自定义处理器列表
+     * @returns {XoProtocol.HandlersConstructor[]}
+     * @protected
+     */
+    protected handlers(): XoProtocol.HandlersConstructor[];
+}

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

@@ -0,0 +1,33 @@
+import type {XoAppAbstract}            from '../../app/xo-app-abstract'
+import type {ProtocolHandlersAbstract} from '../protocol-handlers-abstract'
+
+declare global {
+
+    // 协议
+    namespace XoProtocol {
+
+        // 协议处理器键
+        type Key = `${string}/${string}`
+
+        // 协议处理上下文
+        interface Context {
+            // 原始协议 URL
+            rawUrl: string
+            // 协议 URL
+            url: URL
+            // 协议处理器键
+            key: Key
+        }
+
+        // 协议处理器
+        type Handler = (context: Context) => Promise<void> | void
+
+        // 协议处理器映射
+        type HandlerMap = Partial<Record<Key, Handler>>
+
+        // 协议处理器构造函数
+        type HandlersConstructor = new (xoApp: XoAppAbstract) => ProtocolHandlersAbstract
+    }
+}
+
+export {}

package/dist/main/remote-service/consts/remote-service-methods.d.ts

@@ -0,0 +1,5 @@
+/**
+ * 支持通过 IPC 调用的远程服务请求方法
+ * @type {Set<string>}
+ */
+export declare const RemoteServiceAllowedRequestMethods: ReadonlySet<XoRemoteService.Method>;

package/dist/main/remote-service/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @file Automatically generated by scripts/gen-exports.ts
+ */
+export * from './consts/remote-service-methods';
+export * from './remote-service-manager-abstract';
+export * from './remote-service-manager';
+export type * from './types/remote-service';