siyuan 0.7.1 → 0.7.3

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# Changelog
+
+## v0.7.2
+1. 更换为 SiYuan 官方 API
+
+## v0.7.0
+1. 添加版本自动判断
+2. 添加插件系统内置配置页面支持插件注入
+3. 修复export classes
+
+## v0.5.0
+1. 插件系统国际化
+2. 插件支持卸载
+3. 插件商店预览功能
+
+## v0.4.0
+1. 插件系统已支持浏览器使用，需思源2.8.1及以上版本。 **注意：大量插件目前对web的支持并不好，需要等待插件开发者进行适配。建议还是在桌面端使用。**
+2. 升级过程中将原版代码挂件loader迁移到挂件版路径，但不会下载挂件。
+3. 挂件版用户记得更新到最新版本挂件
+
+## v0.3.21
++ 挂件版本不进行自动升级，即使勾选了自动升级功能
+
+## v0.3.20
++ 新增功能：命令面板
++ 重构：修改vite构建脚本，移除dist
+
+## v0.3.19
++ 修改图标
++ eslint重构代码
+
+## v0.3.13
++ 增加插件商店，并可配置插件商店地址
++ 暴露PluginSystem及Ioc容器到window对象
+
+## v0.3.12
++ 重构API接口，支持自动化导出api类型声明
+
+## v0.3.11
++ 增加通过Plugin继承调用registerCommand，实现插件快捷键注册。未来将通过此方式开发命令面板。
+
+## v0.3.10
++ 修复没有plugins时初次安装遇到的问题
+
+## v0.3.9
++ 适配思源2.7.7，调整配置界面布局

package/README.md

@@ -1,3 +1,3 @@
-# Siyuan Plugin API
+# SiYuan Plugin API
 
-This is Siyuan Plugin System API. Only types declaration here.
+Here is the API declaration of SiYuan Plugin System, usages please refer to  [SiYuan plugin sample](https://github.com/siyuan-note/plugin-sample).

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "siyuan",
-    "author": "zuoez02",
+    "contributors": ["zuoez02", "Vanessa"],
     "types": "siyuan.d.ts",
-    "version": "0.7.1",
-    "repository": "https://github.com/siyuan-note/petal/type"
+    "version": "0.7.3",
+    "repository": "https://github.com/siyuan-note/petal"
 }

package/siyuan.d.ts

@@ -1,344 +1,444 @@
-// Generated by dts-bundle v0.7.3
-
-declare module 'siyuan' {
-    import * as serverApi from 'siyuan/api/server-api';
-    import * as clientApi from 'siyuan/api/client-api';
-    import { Menu, MenuItem, MenuSeparator } from 'siyuan/internal/classes/menu';
-    import { Dialog } from 'siyuan/internal/classes/dialog';
-    import { Notification } from 'siyuan/internal/classes/notification';
-    import { Plugin } from 'siyuan/api/plugin';
-    export { clientApi, serverApi, Menu, MenuItem, MenuSeparator, Notification, Dialog, Plugin };
-    const _default: {
-        clientApi: typeof clientApi;
-        serverApi: typeof serverApi;
-        Plugin: typeof Plugin;
-        Menu: typeof Menu;
-        MenuItem: typeof MenuItem;
-        MenuSeparator: typeof MenuSeparator;
-        Notification: typeof Notification;
-        Dialog: typeof Dialog;
-    };
-    export default _default;
+type TEventBus = "ws-main" | "click-blockicon" | "click-editorcontent" | "click-pdf" |
+    "click-editortitleicon" | "open-noneditableblock" | "loaded-protyle"
+
+type TCardType = "doc" | "notebook" | "all"
+
+declare global {
+    interface Window {
+        Lute: Lute
+    }
 }
 
-declare module 'siyuan/api/server-api' {
-    export function request(url: any, data: any): Promise<any>;
-    export function parseBody(response: any): Promise<any>;
-    export function transactions(protyle: any, transactions?: any[]): Promise<any>;
-    export function sql(sql: any): Promise<any>;
-    export function lsNotebooks(sql: any): Promise<any>;
-    export function getAnchor(anchorText: any, name: any): Promise<string>;
-    export function openNotebook(notebookId: any): Promise<any>;
-    export function closeNotebook(notebookId: any): Promise<any>;
-    export function renameNotebook(notebookId: any, notebookNewName: any): Promise<any>;
-    export function createNotebook(notebookName: any): Promise<any>;
-    export function removeNotebook(notebookId: any): Promise<any>;
-    export function getNotebookConf(notebookId: any): Promise<any>;
-    export function setNotebookConf(notebookId: any): Promise<any>;
-    export function renameDoc(notebookId: any, path: any, title: any): Promise<any>;
-    export function removeDoc(notebookId: any, path: any): Promise<any>;
-    export function moveDoc(srcNotebookId: any, srcPath: any, targetNotebookId: any, targetPath: any): Promise<any>;
-    export function getHPathByPath(notebookId: any, path: any): Promise<any>;
-    export function getHPathByID(ID: any): Promise<any>;
-    export function getBlockAttrs(blockId: any): Promise<any>;
-    export function getBlockByID(blockId: any): Promise<any>;
-    export function getBlockKramdown(blockId: any): Promise<any>;
-    export function getBlockBreadcrumb(ID: any): Promise<any>;
-    export function setBlockAttrs(blockId: any, attrs: any): Promise<any>;
-    export function exportMdContent(docId: any): Promise<any>;
-    export function getDocOutline(docId: any): Promise<any>;
-    export function listDocsByPath(path: any): Promise<any>;
-    export function getBacklink(id: any): Promise<any>;
-    export function searchEmbedBlock(excludeIds: any, sql: any): Promise<any>;
-    export function getDoc(id: any): Promise<any>;
-    export function getFocusedDoc(id: any): Promise<any>;
-    export function getTag(): Promise<any>;
-    export function getLocalGraph(k: any, id: any, conf: any, reqId: any): Promise<any>;
-    export function getGraph(k: any, conf: any, reqId: any): Promise<any>;
-    export function searchDocs(k: any): Promise<any>;
-    export function searchBlock(query: any): Promise<any>;
-    export function searchTemplate(k: any): Promise<any>;
-    export function createDocWithMd(notebook: any, path: any, markdown: any): Promise<any>;
-    export function docSaveAsTemplate(id: any, overwrite?: boolean): Promise<any>;
-    export function render(data: any): Promise<any>;
-    export function insertBlock(previousID: any, dataType: any, data: any): Promise<any>;
-    export function prependBlock(parentID: any, dataType: any, data: any): Promise<any>;
-    export function appendBlock(parentID: any, dataType: any, data: any): Promise<any>;
-    export function updateBlock(id: any, dataType: any, data: any): Promise<any>;
-    export function deleteBlock(id: any): Promise<any>;
-    export function moveBlock(id: string, previousID: string, parentID: string): Promise<any>;
-    export function getSysFonts(): Promise<any>;
-    export function getFile(path: string, type?: 'json' | 'text'): Promise<any>;
-    export function putFile(path: any, filedata: any, isDir?: boolean, modTime?: number): Promise<any>;
-    export function readDir(path: string): Promise<any>;
-    export function removeFile(path: any): Promise<any>;
-    export function pushMsg(message?: any, text?: any, timeout?: number): Promise<any>;
-    export function pushErrMsg(message?: any, text?: any, timeout?: number): Promise<any>;
-    export function setStorageVal(key: string, val: any): Promise<any>;
-    export function getLocalStorage(): Promise<any>;
-    export function renderSprig(sprig: string): Promise<any>;
-    export function getBazzarWidget(): Promise<any>;
+interface ITab {
+    id: string;
+    headElement: HTMLElement;
+    panelElement: HTMLElement;
+    model: IModel;
+    title: string;
+    icon: string;
+    docIcon: string;
+    updateTitle: (title: string) => void;
+    pin: () => void;
+    unpin: () => void;
+    setDocIcon: (icon: string) => void;
+    close: () => void;
 }
 
-declare module 'siyuan/api/client-api' {
-    export function addToolbarLeft(el: Element): void;
-    export function addToolbarRight(el: Element): void;
-    export const createLogger: (name: string) => import("zhi-log").DefaultLogger;
+interface IModel {
+    element: Element;
+    tab: ITab;
+    data: any;
+    type: string;
 }
 
-declare module 'siyuan/internal/classes/menu' {
-    export interface IMenuItemOption {
-        label?: string;
-        click?: (element: HTMLElement) => void;
-        type?: 'separator' | 'submenu' | 'readonly';
-        accelerator?: string;
-        action?: string;
-        id?: string;
-        submenu?: IMenuItemOption[];
-        disabled?: boolean;
-        icon?: string;
-        iconHTML?: string;
-        current?: boolean;
-        bind?: (element: HTMLElement) => void;
-    }
-    export class Menu {
-        menu: any;
-        constructor(id: string);
-        addItem(item: MenuItem): this;
-        addSeparator(): this;
-        showAtMouseEvent(event: MouseEvent): this;
-        showAtPosition(position: {
-            x: number;
-            y: number;
-        }): this;
-        close(): void;
+interface IObject {
+    [key: string]: string;
+}
+
+interface ILuteNode {
+    TokensStr: () => string;
+    __internal_object__: {
+        Parent: {
+            Type: number,
+        },
+        HeadingLevel: string,
+    };
+}
+
+interface ISearchOption {
+    page?: number
+    group?: number,  // 0：不分组，1：按文档分组
+    hasReplace?: boolean,
+    method?: number //  0：文本，1：查询语法，2：SQL，3：正则表达式
+    hPath?: string
+    idPath?: string[]
+    k: string
+    r?: string
+    types?: {
+        mathBlock: boolean
+        table: boolean
+        blockquote: boolean
+        superBlock: boolean
+        paragraph: boolean
+        document: boolean
+        heading: boolean
+        list: boolean
+        listItem: boolean
+        codeBlock: boolean
+        htmlBlock: boolean
+        embedBlock: boolean
     }
+}
+
+interface IWebSocketData {
+    cmd: string
+    callback?: string
+    data: any
+    msg: string
+    code: number
+    sid: string
+}
+
+interface IPluginDockTab {
+    position: "LeftTop" | "LeftBottom" | "RightTop" | "RightBottom" | "BottomLeft" | "BottomRight",
+    size: { width: number, height: number },
+    icon: string,
+    hotkey?: string,
+    title: string,
+    index?: number,
+    show?: boolean
+}
+
+interface IMenuItemOption {
+    label?: string,
+    click?: (element: HTMLElement) => void,
+    type?: "separator" | "submenu" | "readonly",
+    accelerator?: string,
+    action?: string,
+    id?: string,
+    submenu?: IMenuItemOption[]
+    disabled?: boolean
+    icon?: string
+    iconHTML?: string
+    current?: boolean
+    bind?: (element: HTMLElement) => void
+    index?: number
+    element?: HTMLElement
+}
+
+interface ICommandOption {
+    langKey: string, // 多语言 key
     /**
-      * Copy from siyuan source code
-      */
-    export class MenuItem {
-        element: HTMLElement;
-        constructor(options: IMenuItemOption);
-    }
-    export class MenuSeparator {
-    }
+     * 目前需使用 MacOS 符号标识，顺序按照 ⌥⇧⌘，入 ⌥⇧⌘A
+     * "Ctrl": "⌘",
+     * "Shift": "⇧",
+     * "Alt": "⌥",
+     * "Tab": "⇥",
+     * "Backspace": "⌫",
+     * "Delete": "⌦",
+     * "Enter": "↩",
+     */
+    hotkey: string,
+    customHotkey?: string,
+    callback?: () => void
+    fileTreeCallback?: (file: any) => void
+    editorCallback?: (protyle: any) => void
+    dockCallback?: (element: HTMLElement) => void
 }
 
-declare module 'siyuan/internal/classes/dialog' {
-    export class Dialog {
-        element: HTMLElement;
-        constructor(options: {
-            title?: string;
-            transparent?: boolean;
-            content: string;
-            width?: string;
-            height?: string;
-            destroyCallback?: () => void;
-            disableClose?: boolean;
-            disableAnimation?: boolean;
-        });
-        static destroyAll(): void;
-        destroy(): void;
-        bindInput(inputElement: HTMLInputElement | HTMLTextAreaElement, enterEvent?: () => void): void;
+export function fetchPost(url: string, data?: any, callback?: (response: IWebSocketData) => void, headers?: IObject): void;
+
+export function fetchSyncPost(url: string, data?: any): Promise<IWebSocketData>;
+
+export function fetchGet(url: string, callback: (response: IWebSocketData) => void): void;
+
+export function openTab(options: {
+    app: App,
+    doc?: {
+        id: string,     // 块 id
+        action?: string [] // cb-get-all：获取所有内容；cb-get-focus：打开后光标定位在 id 所在的块；cb-get-hl: 打开后 id 块高亮
+        zoomIn?: boolean // 是否缩放
+    },
+    pdf?: {
+        path: string,
+        page?: number,  // pdf 页码
+        id?: string,    // File Annotation id
+    },
+    asset?: {
+        path: string,
+    },
+    search?: ISearchOption
+    card?: {
+        type: TCardType,
+        id?: string, //  cardType 为 all 时不传，否则传文档或笔记本 id
+        title?: string //  cardType 为 all 时不传，否则传文档或笔记本名称
+    },
+    custom?: {
+        title: string,
+        icon: string,
+        data?: any
+        fn?: () => IModel,
     }
+    position?: "right" | "bottom",
+    keepCursor?: boolean // 是否跳转到新 tab 上
+    removeCurrentTab?: boolean // 在当前页签打开时需移除原有页签
+    afterOpen?: () => void // 打开后回调
+}): ITab
+
+export function getFrontend(): "desktop" | "desktop-window" | "mobile" | "browser-desktop" | "browser-mobile";
+
+export function getBackend(): "windows" | "linux" | "darwin" | "docker" | "android" | "ios"
+
+export function adaptHotkey(hotkey: string): string;
+
+export function confirm(title: string, text: string, confirmCallback?: () => void, cancelCallback?: () => void): void;
+
+/**
+ * @param timeout - ms. 0: manual close；-1: always show; 6000: default
+ * @param {string} [type=info]
+ */
+export function showMessage(text: string, timeout?: number, type?: "info" | "error", id?: string): void;
+
+export class App {
+    plugins: Plugin[];
 }
 
-declare module 'siyuan/internal/classes/notification' {
-    import { INoticationOption, INotification } from 'siyuan/types';
-    export class Notification implements INotification {
-        constructor(option: INoticationOption);
-        show(): void;
-    }
+export abstract class Plugin {
+    eventBus: EventBus;
+    i18n: IObject;
+    data: any;
+    name: string;
+    app: App;
+    commands: ICommandOption[];
+    setting: Setting;
+
+    constructor(options: {
+        app: App,
+        name: string,
+        i18n: IObject
+    })
+
+    onload(): void;
+
+    onunload(): void;
+
+    onLayoutReady(): void;
+
+    /**
+     * Must be executed before the synchronous function.
+     * @param {string} [options.position=right]
+     * @param {string} options.icon - Support svg id or svg tag.
+     */
+    addTopBar(options: {
+        icon: string,
+        title: string,
+        callback: (event: MouseEvent) => void
+        position?: "right" | "left"
+    }): HTMLElement;
+
+    /**
+     * Must be executed before the synchronous function.
+     * @param {string} [options.position=right]
+     */
+    addStatusBar(options: {
+        element: HTMLElement,
+        position?: "right" | "left"
+    }): HTMLElement
+
+    openSetting(): void
+
+    loadData(storageName: string): Promise<any>;
+
+    saveData(storageName: string, content: any): Promise<void>;
+
+    removeData(storageName: string): Promise<any>;
+
+    addIcons(svg: string): void;
+
+    /**
+     * Must be executed before the synchronous function.
+     */
+    addTab(options: {
+        type: string,
+        destroy?: () => void,
+        resize?: () => void,
+        update?: () => void,
+        init: () => void
+    }): () => IModel
+
+    /**
+     * Must be executed before the synchronous function.
+     */
+    addDock(options: {
+        config: IPluginDockTab,
+        data: any,
+        type: string,
+        destroy?: () => void,
+        resize?: () => void,
+        update?: () => void,
+        init: () => void
+    }): { config: IPluginDockTab, model: IModel }
+
+    addCommand(options: ICommandOption): void
+
+    addFloatLayer(options: {
+        ids: string[],
+        defIds?: string[],
+        x?: number,
+        y?: number,
+        targetElement?: HTMLElement
+    }): void
 }
 
-declare module 'siyuan/api/plugin' {
-    import { IPlugin, IPluginCommand, SettingRender } from 'siyuan/types';
-    export class Plugin implements IPlugin {
-        _id: string;
-        onload(): void;
-        onunload(): void;
-        registerCommand(command: IPluginCommand): void;
-        registerSettingRender(settingRender: SettingRender): void;
-        loadStorage(filename: string): Promise<any>;
-        writeStorage(filename: string, content: any): Promise<void>;
-    }
+export class Setting {
+    constructor(options: {
+        height?: string,
+        width?: string,
+        destroyCallback?: () => void
+        confirmCallback?: () => void
+    })
+
+    addItem(options: {
+        title: string
+        description?: string
+        actionElement?: HTMLElement
+        createActionElement?(): HTMLElement
+    }): void;
+
+    open(name: string): void;
 }
 
-declare module 'siyuan/types' {
-    export interface IPlugin {
-        onload(): void;
-        onunload(): void;
-        registerCommand(command: IPluginCommand): any;
-        registerSettingRender(settingRender: SettingRender): any;
-        loadStorage(filename: string): Promise<Response>;
-        writeStorage(filename: string, content: any): Promise<void>;
-    }
-    export interface PluginConstructor {
-        new (): IPlugin;
-    }
-    export interface StorePluginManifest {
-        key: string;
-        name: string;
-        description: string;
-        author: string;
-        version: string;
-        url: string;
-    }
-    export interface StorePluginStatus extends StorePluginManifest {
-        isExist: boolean;
-        needUpgrade: boolean;
-    }
-    export interface PluginManifest {
-        key: string;
-        name: string;
-        version: string;
-        script?: string;
-        enabled?: boolean;
-        hidden?: boolean;
-        description?: string;
-        url?: string;
-        author?: string;
-        plugin?: new (...args: any) => IPlugin;
-    }
-    export interface IStorageManager {
-        get(key: keyof PluginConfig): any;
-        set(key: string, val: any): Promise<void>;
-        initStorage(): Promise<IStorageManager>;
-        getPlugins(): PluginManifest[];
-        getInternalPlugins(): PluginManifest[];
-        getThirdPartyPlugins(): PluginManifest[];
-        getPluginByKey(key: string): PluginManifest | undefined;
-        setPluginEnabled(key: string, enabled: boolean): Promise<void>;
-        savePluginsEnabled(): Promise<void>;
-        setSafeModeEnabled(enabled: boolean): Promise<void>;
-        setPluginStorage(pluginKey: string, filename: string, content: any): Promise<void>;
-        getPluginStorage(pluginKey: string, filename: string): Promise<Response>;
-        uninstallPlugin(key: string): Promise<void>;
-    }
-    export interface ISystemManager {
-        saveToLocal(p: string, content: string): Promise<void>;
-        localCacheInit(): Promise<void>;
-        delayAutoUpgrade(): void;
-        tryUpgrade(): Promise<void>;
-        getOnlineVersion(): Promise<string>;
-        upgrade(): Promise<void>;
-    }
-    export interface IPluginSystem {
-        init(): Promise<IPluginSystem>;
-        loadPlugin(key: string): Promise<void>;
-        unloadPlugin(key: string): Promise<void>;
-        turnOffSafeMode(): Promise<void>;
-        turnOnSafeMode(): Promise<void>;
-    }
-    export interface IPluginLoader {
-        loadEnabledPlugins(plugins: PluginManifest[]): Promise<void>;
-        loadAllInternalPlugins(): Promise<void>;
-        loadAllLocalPlugins(): Promise<void>;
-        loadPlugin(plugin: PluginManifest): Promise<void>;
-        unloadPlugin(key: string): Promise<void>;
-        generateRequiredModules(): void;
-        unloadThirdPartyPlugins(plugins: PluginManifest[]): Promise<void>;
-        loadThirdPartyEnabledPlugins(plugins: PluginManifest[]): Promise<void>;
-    }
-    export interface IPluginFileManager {
-        scanPlugins(pluginFolder: string): Promise<string[]>;
-        getFileContent(f: string): Promise<string>;
-        getManifest(f: string): Promise<any>;
-        getScript(f: string): Promise<string>;
-        getAllPlugins(): Promise<PluginManifest[]>;
-    }
-    export interface ISettingTab {
-        key: string;
-        name: string;
-        settings: ISetting[];
-    }
-    export interface ISetting<T extends ISettingType = any> {
-        key: string;
-        name: string;
-        type: T;
-        value: T extends 'boolean' ? boolean : T extends 'string' ? string : T extends 'array' ? Array<any> : T extends 'number' ? number : any;
-    }
-    export enum ISettingType {
-        BOOLEAN = "boolean",
-        STRING = "string",
-        ARRAY = "array",
-        NUMBER = "number"
-    }
-    export interface PluginEnableConfig {
-        key: string;
-        enabled: boolean;
-    }
-    export interface PluginConfig {
-        PLUGIN_SYSTEM_SAFE_MODE_ENABLED: boolean;
-        PLUGIN_SYSTEM_AUTO_UPDATE: boolean;
-        PLUGIN_SYSTEM_PLUGIN: Array<PluginEnableConfig>;
-        PLUGIN_SYSTEM_THIRD_PARTY_PLUGIN: Array<PluginEnableConfig>;
-        PLUGIN_STORE_URL: string;
-    }
-    export type Listener = (...args: any) => void;
-    export interface IEventBus {
-        on(eventName: string, callback: Listener): () => void;
-        off(eventName: string, callback?: Listener): void;
-        emit(eventName: string, ...args: any): void;
-        destroy(): void;
-    }
-    export interface Command {
-        plugin: string;
-        pluginName: string;
-        command: string;
-        shortcut?: string;
-        description?: string;
-        callback: (...args: any[]) => any;
-    }
-    export interface IPluginCommand {
-        command: string;
-        shortcut?: string;
-        description?: string;
-        callback: (...args: any[]) => any;
-    }
-    export interface ICommandManager {
-        registerCommand(command: Command): any;
-        unregisterCommand(command: Command): any;
-        unregisterCommandByPlugin(plugin: string): any;
-        getCommands(): Command[];
-    }
-    export interface IShortcut {
-        registerKeyboardEvent(shortcut: string, callback: (e: KeyboardEvent) => void): any;
-        unregisterKeyboardEvent(shortcut: string): any;
-        registerKeyboardEventFromPlugin(command: Command): any;
-        unregisterKeyboardEventFromPlugin(command: Command): any;
-    }
-    export interface INotification {
-        show(): void;
-    }
-    export interface INoticationOption {
-        type: 'error' | 'info';
-        message: string;
-        timeout?: number;
-    }
-    export interface IStore {
-        init(): Promise<void>;
-        getStoreUrl(): string;
-        getPlugins(): StorePluginManifest[];
-        loadPlugins(): Promise<StorePluginManifest[]>;
-        getPluginsWithStatus(): StorePluginManifest[];
-        loadPluginsFromUrl(): Promise<void>;
-        getPluginByUrl(url: string): Promise<{
-            manifest: string;
-            mainJs: string;
-        }>;
-        getPluginManifest(url: string): Promise<PluginManifest>;
-        getPluginReadme(url: string): Promise<string>;
-        downloadPlugin(key: string): Promise<any>;
-    }
-    export type SettingRender = (element: HTMLElement) => void;
-    export interface ISettingManager {
-        registerSetting(key: string, settingRender: SettingRender): void;
-        unregisterSetting(key: string): void;
-        getSettingRenders(): Array<{
-            key: string;
-            value: SettingRender;
-        }>;
-    }
+export class EventBus {
+    on(type: TEventBus, listener: (event: CustomEvent<any>) => void): void;
+
+    once(type: TEventBus, listener: (event: CustomEvent<any>) => void): void;
+
+    off(type: TEventBus, listener: (event: CustomEvent<any>) => void): void;
+
+    emit(type: TEventBus, detail?: any): boolean;
+}
+
+export class Dialog {
+
+    element: HTMLElement;
+
+    constructor(options: {
+        title?: string,
+        transparent?: boolean,
+        content: string,
+        width?: string
+        height?: string,
+        destroyCallback?: (options?: IObject) => void
+        disableClose?: boolean
+        disableAnimation?: boolean
+    });
+
+    destroy(options?: IObject): void;
+
+    bindInput(inputElement: HTMLInputElement | HTMLTextAreaElement, enterEvent?: () => void): void;
+}
+
+export class Menu {
+    constructor(id?: string, closeCallback?: () => void);
+
+    showSubMenu(subMenuElement: HTMLElement): void;
+
+    addItem(options: IMenuItemOption): HTMLElement;
+
+    addSeparator(index?: number): void;
+
+    open(options: { x: number, y: number, h?: number, w?: number, isLeft?: boolean }): void;
+
+    /**
+     * @param {string} [position=all]
+     */
+    fullscreen(position?: "bottom" | "all"): void;
+
+    close(): void;
 }
 
+export class Lute {
+    public static WalkStop: number;
+    public static WalkSkipChildren: number;
+    public static WalkContinue: number;
+    public static Version: string;
+    public static Caret: string;
+
+    public static New(): Lute;
+
+    public static EChartsMindmapStr(text: string): string;
+
+    public static NewNodeID(): string;
+
+    public static Sanitize(html: string): string;
+
+    public static EscapeHTMLStr(str: string): string;
+
+    public static UnEscapeHTMLStr(str: string): string;
+
+    public static GetHeadingID(node: ILuteNode): string;
+
+    public static BlockDOM2Content(html: string): string;
+
+    private constructor();
+
+    public BlockDOM2Content(text: string): string;
+
+    public BlockDOM2EscapeMarkerContent(text: string): string;
+
+    public SetTextMark(enable: boolean): void;
+
+    public SetHeadingID(enable: boolean): void;
+
+    public SetProtyleMarkNetImg(enable: boolean): void;
+
+    public SetSpellcheck(enable: boolean): void;
+
+    public SetFileAnnotationRef(enable: boolean): void;
+
+    public SetSetext(enable: boolean): void;
+
+    public SetYamlFrontMatter(enable: boolean): void;
+
+    public SetChineseParagraphBeginningSpace(enable: boolean): void;
+
+    public SetRenderListStyle(enable: boolean): void;
+
+    public SetImgPathAllowSpace(enable: boolean): void;
+
+    public SetKramdownIAL(enable: boolean): void;
+
+    public BlockDOM2Md(html: string): string;
+
+    public BlockDOM2StdMd(html: string): string;
+
+    public SetGitConflict(enable: boolean): void;
+
+    public SetSuperBlock(enable: boolean): void;
+
+    public SetTag(enable: boolean): void;
+
+    public SetMark(enable: boolean): void;
+
+    public SetSub(enable: boolean): void;
+
+    public SetSup(enable: boolean): void;
+
+    public SetBlockRef(enable: boolean): void;
+
+    public SetSanitize(enable: boolean): void;
+
+    public SetHeadingAnchor(enable: boolean): void;
+
+    public SetImageLazyLoading(imagePath: string): void;
+
+    public SetInlineMathAllowDigitAfterOpenMarker(enable: boolean): void;
+
+    public SetToC(enable: boolean): void;
+
+    public SetIndentCodeBlock(enable: boolean): void;
+
+    public SetParagraphBeginningSpace(enable: boolean): void;
+
+    public SetFootnotes(enable: boolean): void;
+
+    public SetLinkRef(enalbe: boolean): void;
+
+    public SetEmojiSite(emojiSite: string): void;
+
+    public PutEmojis(emojis: IObject): void;
+
+    public SpinBlockDOM(html: string): string;
+
+    public Md2BlockDOM(html: string): string;
+
+    public SetProtyleWYSIWYG(wysiwyg: boolean): void;
+
+    public MarkdownStr(name: string, md: string): string;
+
+    public IsValidLinkDest(text: string): boolean;
+
+    public BlockDOM2InlineBlockDOM(html: string): string;
+
+    public BlockDOM2HTML(html: string): string;
+}