deepsky 2.35.0 → 2.35.2

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as vue from 'vue';
 import { Ref, Reactive, ShallowReactive, ShallowRef, ComputedRef } from 'vue';
-import { HotkeysEvent } from 'hotkeys-js';
+import { HotkeysEvent, KeyHandler } from 'hotkeys-js';
 import { IMath, DragList } from 'cook-web';
 import { KatexOptions } from 'katex';
 import { Token, Tokens, Marked, TokensList } from 'marked';
@@ -2436,9 +2436,10 @@ declare function get_cmds(instance: object): Map<ICommandCube.Names, string>;
 
 declare function cube(name: INote.Cubes): (cls: any) => void;
 
+declare function get_receiver_type(cls: Function): INote.Cubes | undefined;
+
 /** Marks a Receiver class with the cube type it will serve. */
 declare function receiver(type: INote.Cubes): (cls: any) => void;
-declare function get_receiver_type(cls: Function): INote.Cubes | undefined;
 
 declare class DialogBase extends NoteBase {
     protected _show: vue.Ref<boolean, boolean>;
@@ -3163,7 +3164,7 @@ declare class FloatNodeFill extends FloatBase {
     open(e: MouseEvent, cube: MapNodeBase): void;
     close(): void;
     update_pos(e: MouseEvent): void;
-    apply_fill(item: INoteMenu.MenuNodeFill): void;
+    apply_fill(item: ICubesMenu.MenuNodeFill): void;
 }
 
 declare class FloatNodeMaxWidth extends FloatBase {
@@ -4036,8 +4037,71 @@ declare class CubeStatusBase<T extends ICubeBase.Data> {
     cover(origin: Record<string, any>, val: Record<string, any>): void;
 }
 
+/**
+ * Cube 实例级的本地快捷键控制器。
+ *
+ * 子类只维护同一份 ICubesHotkeys.Item 定义：它既用于注册快捷键，也用于向右键菜单贡献菜单项。
+ */
+declare class HotkeyBase<TCube extends CubeBase = CubeBase> {
+    protected readonly cube: TCube;
+    protected _dom: HTMLElement | undefined;
+    protected readonly handlers: Map<string, KeyHandler>;
+    constructor(cube: TCube);
+    protected get items(): ICubesHotkeys.Item[];
+    get menus(): ICubesMenu.MenuItem[];
+    register(dom: HTMLElement): void;
+    unregister(): void;
+    protected execution(id: string, event: KeyboardEvent, hotkeyEvent: HotkeysEvent): boolean | void;
+}
+
+declare class HotkeyDetailList extends HotkeyBase<CubeDetailList> {
+    protected get items(): ICubesHotkeys.Item[];
+    protected execution(id: string, event: KeyboardEvent, hotkeyEvent: HotkeysEvent): boolean | void;
+    private item;
+    private add;
+}
+
+declare class HotkeyList extends HotkeyBase<CubeList> {
+    protected get items(): ICubesHotkeys.Item[];
+    protected execution(id: string, event: KeyboardEvent, hotkeyEvent: HotkeysEvent): boolean | void;
+    private item;
+    private add;
+    private indent;
+    private get_item;
+    private get_selected_items;
+}
+
+declare class HotkeyListOrdered extends HotkeyBase<CubeListOrdered> {
+    protected get items(): ICubesHotkeys.Item[];
+    protected execution(id: string, event: KeyboardEvent, hotkeyEvent: HotkeysEvent): boolean | void;
+    private item;
+    private add;
+    private indent;
+    private get_item;
+    private get_selected_items;
+}
+
+declare class HotkeyTodo extends HotkeyBase<CubeTodo> {
+    protected get items(): ICubesHotkeys.Item[];
+    protected execution(id: string, event: KeyboardEvent, hotkeyEvent: HotkeysEvent): boolean | void;
+    private item;
+    private add;
+    private indent;
+    private get_item;
+    private get_selected_items;
+}
+
+declare class HotkeysCubeRegistry {
+    protected readonly hotkeys: Map<INote.Cubes, ICubesHotkeys.Constructor>;
+    constructor();
+    create(cube: CubeBase): HotkeyBase;
+    register(type: INote.Cubes, hotkey: ICubesHotkeys.Constructor): ICubesHotkeys.Constructor;
+}
+declare const HotkeysCube: HotkeysCubeRegistry;
+
 declare abstract class CubeBase<T extends ICubeBase.Data = any> {
     protected _receiver: ReceiverBase;
+    protected _hotkey: HotkeyBase | undefined;
     protected _note: Note;
     abstract data: T;
     abstract get id(): string;
@@ -4048,6 +4112,7 @@ declare abstract class CubeBase<T extends ICubeBase.Data = any> {
     abstract get status(): CubeStatusBase<T>;
     abstract get adapter(): CubeAdapterBase;
     get receiver(): ReceiverBase;
+    get hotkey(): HotkeyBase;
     protected create_receiver(): ReceiverBase;
     protected abstract build_child(data: T): any;
     constructor(note: Note);
@@ -5790,7 +5855,7 @@ declare namespace INoteApi {
     type GetBackground = () => Promise<IUiTheme.BackgroundItem[]>;
 }
 
-declare namespace INoteMenu {
+declare namespace ICubesMenu {
     interface MenuStatus {
         point: IMath.Point;
         css: Record<string, string>;
@@ -5837,6 +5902,7 @@ declare namespace INoteMenu {
         menus: MenuItem[];
     }
     interface MenuItem {
+        id?: string;
         usable: boolean;
         title: string | number;
         icon: string[];
@@ -5863,6 +5929,19 @@ declare namespace IMenuNode {
     }
 }
 
+declare namespace ICubesHotkeys {
+    interface Item extends ICubesMenu.MenuItem {
+        id: string;
+        show?: boolean;
+    }
+    interface Controller {
+        readonly menus: ICubesMenu.MenuItem[];
+        register(dom: HTMLElement): void;
+        unregister(): void;
+    }
+    type Constructor = new (cube: any) => Controller;
+}
+
 declare namespace INoteConvertor {
     interface ImportMdResult {
         cubedata: ICubeBase.Data[];
@@ -6252,12 +6331,132 @@ declare class CommandTodo {
 
 type ReceiverConstructor = new (cube: CubeBase) => ReceiverBase;
 declare class ReceiverRegistry {
-    protected readonly constructors: Map<INote.Cubes, ReceiverConstructor>;
     create(cube: CubeBase, fallback?: new (cube: any) => ReceiverBase): ReceiverBase;
-    register_receiver(type: INote.Cubes, receiver: ReceiverConstructor): ReceiverConstructor;
+    register_receiver(type: INote.Cubes, receiver: ReceiverConstructor): new (cube: any) => ReceiverBase;
 }
 declare const ReceiverCubes: ReceiverRegistry;
 
+/** 类型级菜单单例的基类；不得在实例字段中保存当前 cube。 */
+declare abstract class MenuBase<TCube extends CubeBase = CubeBase> {
+    abstract get_menus(cube: TCube): ICubesMenu.NoteMenu;
+}
+
+declare class MenusCubeRegistry {
+    protected readonly menus: Map<INote.Cubes, MenuBase<CubeBase<any>>>;
+    readonly dialog: Reactive<ICubesMenu.MenuDialog>;
+    constructor();
+    get(cube: CubeBase): MenuBase | undefined;
+    get_menus(cube: CubeBase): ICubesMenu.NoteMenu | undefined;
+    show_dialog(data: Record<string, string>, submit: ICubesMenu.DialogSubmit, options?: ICubesMenu.DialogOptions): void;
+    close_dialog(): void;
+    register(type: INote.Cubes, menu: MenuBase): MenuBase<CubeBase<any>>;
+}
+declare const MenusCube: MenusCubeRegistry;
+
+declare function get_menu_base(cube: CubeChild, fullscreen?: boolean): ICubesMenu.MenuItem[];
+
+declare function show_menu(e: MouseEvent, cube: INote.NoteChild): Promise<void>;
+declare function has_pcube_menu(cube: CubeChild | undefined): boolean;
+declare function get_cube_menu(cube: INote.NoteChild): ICubesMenu.NoteMenu | undefined;
+declare function move_rect(area: IMath.Rect, move: IMath.Rect, target: IMath.Rect, gap?: number): IMath.Point;
+
+declare const menu_status: Reactive<ICubesMenu.MenuStatus>;
+
+declare function show_code_file_dialog(callback: (name: string, lang: ICode.Langs) => void): void;
+declare function get_menu_code(cube: CubeCode): ICubesMenu.NoteMenu;
+
+declare class MenuApi extends MenuBase<CubeApi> {
+    get_menus(cube: CubeApi): ICubesMenu.NoteMenu;
+}
+
+declare class MenuBox extends MenuBase<CubeBox> {
+    get_menus(cube: CubeBox): ICubesMenu.NoteMenu;
+}
+
+declare class MenuBoxColumns extends MenuBase<CubeBoxColumns> {
+    get_menus(cube: CubeBoxColumns): ICubesMenu.NoteMenu;
+}
+
+declare class MenuBoxFolder extends MenuBase<CubeBoxFolder> {
+    get_menus(cube: CubeBoxFolder): ICubesMenu.NoteMenu;
+}
+
+declare class MenuBoxRoot extends MenuBase<CubeBoxRoot> {
+    get_menus(cube: CubeBoxRoot): ICubesMenu.NoteMenu;
+}
+
+declare class MenuCode extends MenuBase<CubeCode> {
+    get_menus(cube: CubeCode): ICubesMenu.NoteMenu;
+}
+
+declare class MenuDetailList extends MenuBase<CubeDetailList> {
+    get_menus(cube: CubeDetailList): {
+        menus: ICubesMenu.MenuItem[];
+        type?: "menus";
+        title: string;
+        layout?: "list" | "grid";
+        is_cube_menu: boolean;
+        cube: INote.NoteCube;
+        active: any[];
+    };
+}
+
+declare class MenuImg extends MenuBase<CubeImg> {
+    get_menus(cube: CubeImg): ICubesMenu.NoteMenu;
+}
+
+declare class MenuList extends MenuBase<CubeList> {
+    get_menus(cube: CubeList): {
+        menus: ICubesMenu.MenuItem[];
+        type?: "menus";
+        title: string;
+        layout?: "list" | "grid";
+        is_cube_menu: boolean;
+        cube: INote.NoteCube;
+        active: any[];
+    };
+}
+
+declare class MenuListOrdered extends MenuBase<CubeListOrdered> {
+    get_menus(cube: CubeListOrdered): {
+        menus: ICubesMenu.MenuItem[];
+        type?: "menus";
+        title: string;
+        layout?: "list" | "grid";
+        is_cube_menu: boolean;
+        cube: INote.NoteCube;
+        active: any[];
+    };
+}
+
+declare class MenuNode extends MenuBase<CubeNode> {
+    get_menus(cube: CubeNode): ICubesMenu.NoteMenu;
+}
+
+declare class MenuSubmap extends MenuBase<CubeSubMap> {
+    get_menus(cube: CubeSubMap): ICubesMenu.NoteMenu;
+}
+
+declare class MenuTable extends MenuBase<CubeTable> {
+    get_menus(cube: CubeTable): ICubesMenu.NoteMenu;
+}
+
+declare class MenuTip extends MenuBase<CubeTip> {
+    get_menus(cube: CubeTip): ICubesMenu.NoteMenu;
+}
+
+declare class MenuTodo extends MenuBase<CubeTodo> {
+    get_menus(cube: CubeTodo): {
+        menus: ICubesMenu.MenuItem[];
+        type?: "menus";
+        title: string;
+        layout?: "list" | "grid";
+        is_cube_menu: boolean;
+        cube: INote.NoteCube;
+        active: any[];
+    };
+}
+
 declare class LayoutChecker {
     static check_allow(upstream: MapNodeBase | undefined, downstream_layout_type: INodeBase.Layout, nullable?: boolean): boolean;
     static get left(): INodeBase.Layout[];
@@ -6354,4 +6553,4 @@ declare class NoteTools {
     static check_mouse_key(e: MouseEvent, key: _PointKey): boolean;
 }
 
-export { AdapterApi, AdapterBaseUi, AdapterBox, AdapterBoxColumns, AdapterBoxFolder, AdapterBoxRoot, AdapterCode, AdapterCubes, AdapterDetailList, AdapterDoc, AdapterFormula, AdapterImg, AdapterLine, AdapterLinker, AdapterList, AdapterListOrdered, AdapterLost, AdapterMap, AdapterNode, AdapterPostil, AdapterRt, AdapterSubmap, AdapterTable, AdapterText, AdapterTextLink, AdapterTip, AdapterTodo, AdapterUi, AdapterUiAi, AdapterUiCatalogue, AdapterUiConfig, AdapterUiDialog, AdapterUiDialogCubeList, AdapterUiDict, AdapterUiFloat, AdapterUiMenubar, AdapterUiPreset, AdapterUiSearch, AdapterUiSidebar, AdapterUiStatusbar, AdapterUiTheme, AdapterUiTips, AdapterUiToolbar, ApiStatus, BoxFolderStatus, BoxRootStatus, BoxStatus, CodeStatus, CommandApi, CommandBoxFolder, CommandBoxRoot, CommandCode, CommandCube, CommandCursor, CommandDetailList, CommandFormula, CommandLinker, CommandList, CommandListOrdered, CommandMap, CommandNode, CommandRt, CommandTable, CommandText, CommandTextLink, CommandTodo, ConstColors, ConvertorMd, CubeAdapterBase, CubeApi, CubeBase, CubeBox, CubeBoxColumns, CubeBoxFolder, CubeBoxRoot, CubeChild, CubeCode, CubeDetailList, CubeDoc, CubeFormula, CubeImg, CubeLine, CubeLinker, CubeList, CubeListOrdered, CubeListenerBase, CubeLost, CubeMap, CubeNode, CubePostil, CubeRoot, CubeRt, CubeStatusBase, CubeStatusBaseRoot, CubeSubMap, CubeTable, CubeText, CubeTextLink, CubeTip, CubeTodo, DetailListStatus, DocStatus, EventBubble, FormulaStatus, IApi, IBox, ICode, ICommandApi, ICommandCode, ICommandCube, ICommandCursor, ICommandDetailList, ICommandDoc, ICommandFormula, ICommandLinker, ICommandList, ICommandListOrdered, ICommandMap, ICommandNode, ICommandRt, ICommandTable, ICommandText, ICommandTextLink, ICommandTodo, ICubeBase, ICubeBaseChild, ICubeBoxColumns, ICubeBoxFolder, ICubeBoxRoot, ICubeHandler, ICubeRootBase, IDetailList, IDoc, IFormula, IImg, ILine, ILinker, IList, IListOrdered, ILost, IMap, IMapBase, IMapInteraction, IMapTools, IMenuNode, IMiniMap, IMisc, INode, INodeBase, INodeBaseEnv, INodeDrag, INote, INoteApi, INoteClipboard, INoteConvertor, INoteCourier, INoteCursor, INoteEvent, INoteFlag, INoteFloat, INoteHistory, INoteInteraction, INoteMenu, INoteMod, INoteScope, INoteTools, IPostil, IRt, ISubMap, ITable, IText, ITextLink, ITip, ITodo, IUi, IUiAi, IUiCatalogue, IUiConfig, IUiDialog, IUiDialogCubeList, IUiDict, IUiFloat, IUiMenubar, IUiPreset, IUiSidebar, IUiStatusbar, IUiTheme, IUiTips, IUiToolbar, ImgStatus, LayoutChecker, LineStatus, LinkerLine, LinkerPoint, ListOrderedStatus, ListStatus, LostStatus, Map2D, MapCanvas, MapChild, MapHotkeys, MapInteraction, MapNodeBase, MapNodeLayoutEnv, MapStatus, MapTools, Matrix2D, NodeBase2D, NodeLayout, NodeLayoutInvert, NodeLayoutMeter, NodeObserver, NodeShape, NodeStatus, NodeStatusBase, Note, NoteAction, NoteApi, NoteBase, NoteClipBoard, NoteConvertor, NoteCourier, NoteCubes, NoteCursor, NoteEvent, NoteEventListenerBase, NoteEventListeners, NoteFlag, NoteHistory, NoteHotkeyBase, NoteInteraction, NoteListener, NoteMod, NotePainter, NoteScope, NoteScopes, NoteTools, PostilStatus, ReceiverApi, ReceiverBase, ReceiverBox, ReceiverBoxColumns, ReceiverBoxFolder, ReceiverBoxRoot, ReceiverChild, ReceiverCode, ReceiverCubes, ReceiverDetailList, ReceiverDoc, ReceiverFormula, ReceiverImg, ReceiverLine, ReceiverLinker, ReceiverList, ReceiverListOrdered, ReceiverLost, ReceiverMap, ReceiverMapChild, ReceiverNode, ReceiverPostil, ReceiverRegistry, ReceiverRoot, ReceiverRt, ReceiverSubMap, ReceiverTable, ReceiverText, ReceiverTextLink, ReceiverTip, ReceiverTodo, Recorder, RtStatus, SubmapStatus, TableStatus, TextLinkStatus, TextStatus, TipStatus, TodoStatus, ToolBase, UI, UICatalogue, UIDict, UISearch, UIStatusbar, UITheme, UIToolbar, UiBase, UiConfig, UiFloat, UiMenubar, UiPreset, UiSidebar, UiTips, Waiter, type _CubeTextAnnotation, type _CubeTodoItem, type _CubeTodoItemData, type _FigScale, type _Map, type _MapCubes, _MapGroup, type _MapPlaceholderLinker, _PlayStatus, type _PointFig, type _PointKey, type _PointView, type _SDKMeta, cmd, copy_event_listener, cube, cut_event_listener, define_cmd, get_cmds, get_receiver_type, hotkey, node_observer, paste_event_listener, receiver, waiter_map_svg };
+export { AdapterApi, AdapterBaseUi, AdapterBox, AdapterBoxColumns, AdapterBoxFolder, AdapterBoxRoot, AdapterCode, AdapterCubes, AdapterDetailList, AdapterDoc, AdapterFormula, AdapterImg, AdapterLine, AdapterLinker, AdapterList, AdapterListOrdered, AdapterLost, AdapterMap, AdapterNode, AdapterPostil, AdapterRt, AdapterSubmap, AdapterTable, AdapterText, AdapterTextLink, AdapterTip, AdapterTodo, AdapterUi, AdapterUiAi, AdapterUiCatalogue, AdapterUiConfig, AdapterUiDialog, AdapterUiDialogCubeList, AdapterUiDict, AdapterUiFloat, AdapterUiMenubar, AdapterUiPreset, AdapterUiSearch, AdapterUiSidebar, AdapterUiStatusbar, AdapterUiTheme, AdapterUiTips, AdapterUiToolbar, ApiStatus, BoxFolderStatus, BoxRootStatus, BoxStatus, CodeStatus, CommandApi, CommandBoxFolder, CommandBoxRoot, CommandCode, CommandCube, CommandCursor, CommandDetailList, CommandFormula, CommandLinker, CommandList, CommandListOrdered, CommandMap, CommandNode, CommandRt, CommandTable, CommandText, CommandTextLink, CommandTodo, ConstColors, ConvertorMd, CubeAdapterBase, CubeApi, CubeBase, CubeBox, CubeBoxColumns, CubeBoxFolder, CubeBoxRoot, CubeChild, CubeCode, CubeDetailList, CubeDoc, CubeFormula, CubeImg, CubeLine, CubeLinker, CubeList, CubeListOrdered, CubeListenerBase, CubeLost, CubeMap, CubeNode, CubePostil, CubeRoot, CubeRt, CubeStatusBase, CubeStatusBaseRoot, CubeSubMap, CubeTable, CubeText, CubeTextLink, CubeTip, CubeTodo, DetailListStatus, DocStatus, EventBubble, FormulaStatus, HotkeyBase, HotkeyDetailList, HotkeyList, HotkeyListOrdered, HotkeyTodo, HotkeysCube, HotkeysCubeRegistry, IApi, IBox, ICode, ICommandApi, ICommandCode, ICommandCube, ICommandCursor, ICommandDetailList, ICommandDoc, ICommandFormula, ICommandLinker, ICommandList, ICommandListOrdered, ICommandMap, ICommandNode, ICommandRt, ICommandTable, ICommandText, ICommandTextLink, ICommandTodo, ICubeBase, ICubeBaseChild, ICubeBoxColumns, ICubeBoxFolder, ICubeBoxRoot, ICubeHandler, ICubeRootBase, ICubesHotkeys, ICubesMenu, IDetailList, IDoc, IFormula, IImg, ILine, ILinker, IList, IListOrdered, ILost, IMap, IMapBase, IMapInteraction, IMapTools, IMenuNode, IMiniMap, IMisc, INode, INodeBase, INodeBaseEnv, INodeDrag, INote, INoteApi, INoteClipboard, INoteConvertor, INoteCourier, INoteCursor, INoteEvent, INoteFlag, INoteFloat, INoteHistory, INoteInteraction, INoteMod, INoteScope, INoteTools, IPostil, IRt, ISubMap, ITable, IText, ITextLink, ITip, ITodo, IUi, IUiAi, IUiCatalogue, IUiConfig, IUiDialog, IUiDialogCubeList, IUiDict, IUiFloat, IUiMenubar, IUiPreset, IUiSidebar, IUiStatusbar, IUiTheme, IUiTips, IUiToolbar, ImgStatus, LayoutChecker, LineStatus, LinkerLine, LinkerPoint, ListOrderedStatus, ListStatus, LostStatus, Map2D, MapCanvas, MapChild, MapHotkeys, MapInteraction, MapNodeBase, MapNodeLayoutEnv, MapStatus, MapTools, Matrix2D, MenuApi, MenuBase, MenuBox, MenuBoxColumns, MenuBoxFolder, MenuBoxRoot, MenuCode, MenuDetailList, MenuImg, MenuList, MenuListOrdered, MenuNode, MenuSubmap, MenuTable, MenuTip, MenuTodo, MenusCube, MenusCubeRegistry, NodeBase2D, NodeLayout, NodeLayoutInvert, NodeLayoutMeter, NodeObserver, NodeShape, NodeStatus, NodeStatusBase, Note, NoteAction, NoteApi, NoteBase, NoteClipBoard, NoteConvertor, NoteCourier, NoteCubes, NoteCursor, NoteEvent, NoteEventListenerBase, NoteEventListeners, NoteFlag, NoteHistory, NoteHotkeyBase, NoteInteraction, NoteListener, NoteMod, NotePainter, NoteScope, NoteScopes, NoteTools, PostilStatus, ReceiverApi, ReceiverBase, ReceiverBox, ReceiverBoxColumns, ReceiverBoxFolder, ReceiverBoxRoot, ReceiverChild, ReceiverCode, ReceiverCubes, ReceiverDetailList, ReceiverDoc, ReceiverFormula, ReceiverImg, ReceiverLine, ReceiverLinker, ReceiverList, ReceiverListOrdered, ReceiverLost, ReceiverMap, ReceiverMapChild, ReceiverNode, ReceiverPostil, ReceiverRegistry, ReceiverRoot, ReceiverRt, ReceiverSubMap, ReceiverTable, ReceiverText, ReceiverTextLink, ReceiverTip, ReceiverTodo, Recorder, RtStatus, SubmapStatus, TableStatus, TextLinkStatus, TextStatus, TipStatus, TodoStatus, ToolBase, UI, UICatalogue, UIDict, UISearch, UIStatusbar, UITheme, UIToolbar, UiBase, UiConfig, UiFloat, UiMenubar, UiPreset, UiSidebar, UiTips, Waiter, type _CubeTextAnnotation, type _CubeTodoItem, type _CubeTodoItemData, type _FigScale, type _Map, type _MapCubes, _MapGroup, type _MapPlaceholderLinker, _PlayStatus, type _PointFig, type _PointKey, type _PointView, type _SDKMeta, cmd, copy_event_listener, cube, cut_event_listener, define_cmd, get_cmds, get_cube_menu, get_menu_base, get_menu_code, get_receiver_type, has_pcube_menu, hotkey, menu_status, move_rect, node_observer, paste_event_listener, receiver, show_code_file_dialog, show_menu, waiter_map_svg };