siyuan 1.1.4 → 1.1.6

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## v1.1.5
+## v1.1.6 2025-12-02
+
+* [Synchronize config, constants, and protyle](https://github.com/siyuan-note/petal/issues/42)
+* [Improve code block language selection](https://github.com/siyuan-note/siyuan/pull/15966)
+* [Add onDataChanged method to handle data changes in the plugin](https://github.com/siyuan-note/siyuan/pull/16244)
+
+## v1.1.5 2025-09-09
+
+* [Adjust imports to separate type and general](https://github.com/siyuan-note/petal/pull/41)
+* [Supplement missing attributes](https://github.com/siyuan-note/petal/issues/40)
+* [Add plugin function `expandDocTree`](https://github.com/siyuan-note/siyuan/issues/15639)
 
 ## v1.1.4 2025-09-02
 

package/package.json

@@ -12,7 +12,7 @@
         "README.md",
         "siyuan.d.ts"
     ],
-    "version": "1.1.4",
+    "version": "1.1.6",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/siyuan-note/petal.git"

package/siyuan.d.ts

@@ -1,26 +1,30 @@
-import {
+import type {
     IGetDocInfo,
     IGetTreeStat,
     IMenuBaseDetail,
-    Config,
-    Custom,
-    Dock,
     IMenu,
     IObject,
     IPosition,
     ISiyuan,
     IWebSocketData,
     IProtyle,
+    IProtyleOptions,
+    TProtyleAction,
+    IMenuItem,
+    IRefDefs,
+} from "./types";
+import {
+    Config,
+    Custom,
     Lute,
     Protyle,
     Toolbar,
-    IProtyleOptions,
-    TProtyleAction,
     subMenu,
     App,
     Files,
-    Tab, Model,
-    IMenuItem, IRefDefs, MobileCustom,
+    Tab,
+    Model,
+    MobileCustom,
 } from "./types";
 
 export * from "./types";
@@ -204,7 +208,7 @@ export interface IEventBusMap {
     "sync-fail": IWebSocketData;
     "mobile-keyboard-show": void;
     "mobile-keyboard-hide": void;
-    "code-language-update": { languages: string[] };
+    "code-language-update": { languages: string[], type: "init" | "match", listElement: HTMLElement, value: string };
     "code-language-change": {
         language: string,
         languageElements: HTMLElement[],
@@ -296,6 +300,11 @@ export function getActiveTab(wndActive?: boolean): Tab;
  */
 export function getActiveEditor(wndActive?: boolean): Protyle;
 
+export function expandDocTree(options: {
+    id: string,
+    isSetCurrent?: boolean
+}): void;
+
 export function openMobileFileById(app: App, id: string, action?: TProtyleAction[]): void;
 
 export function openTab(options: {
@@ -419,6 +428,8 @@ export abstract class Plugin {
 
     onload(): void;
 
+    onDataChanged(): void
+
     onunload(): void;
 
     uninstall(): void;

package/types/config.d.ts

@@ -67,7 +67,7 @@ export namespace Config {
          */
         openHelp: boolean;
         /**
-         * Publishing service
+         * Publish service
          * 发布服务
          */
         publish: IPublish;
@@ -263,6 +263,14 @@ export namespace Config {
          * The version number of the theme currently in use
          */
         themeVer: string;
+        statusBar: IAppearanceStatusBar;
+    }
+
+    export interface IAppearanceStatusBar {
+        msgTaskDatabaseIndexCommitDisabled: boolean;
+        msgTaskHistoryDatabaseIndexCommitDisabled: boolean;
+        msgTaskAssetDatabaseIndexCommitDisabled: boolean;
+        msgTaskHistoryGenerateFileDisabled: boolean;
     }
 
     /**
@@ -365,6 +373,14 @@ export namespace Config {
          * Whether the backlink contains children
          */
         backlinkContainChildren: boolean;
+        /**
+         * Backlink sort mode
+         */
+        backlinkSort: number;
+        /**
+         * Backmention sort mode
+         */
+        backmentionSort: number;
         /**
          * The maximum length of the dynamic anchor text for block references
          */
@@ -402,6 +418,13 @@ export namespace Config {
          * Whether the embedded block displays breadcrumbs
          */
         embedBlockBreadcrumb: boolean;
+        /**
+         * Heading embed mode for embedded blocks
+         * - `0`: Show title with blocks below (default)
+         * - `1`: Show only title
+         * - `2`: Show only blocks below title
+         */
+        headingEmbedMode: number;
         /**
          * Common emoji icons
          */
@@ -646,6 +669,14 @@ export namespace Config {
          * Whether to save the content of the .sy file as a single-line JSON object
          */
         useSingleLineSave: boolean;
+        /**
+         * The .sy and database .json files larger than this value will prompt a warning (unit: MB)
+         */
+        largeFileWarningSize: number;
+        /**
+         * Whether to create new documents at the top of the document tree
+         */
+        createDocAtTop: boolean;
     }
 
     /**
@@ -992,29 +1023,35 @@ export namespace Config {
      * SiYuan general shortcut keys
      */
     export interface IKeymapGeneral extends IKeys {
-        addToDatabase: IKey;
-        backlinks: IKey;
-        bookmark: IKey;
-        closeAll: IKey;
-        closeLeft: IKey;
-        closeOthers: IKey;
-        closeRight: IKey;
-        closeTab: IKey;
-        closeUnmodified: IKey;
+        mainMenu: IKey;
         commandPanel: IKey;
-        config: IKey;
-        dailyNote: IKey;
-        dataHistory: IKey;
         editReadonly: IKey;
-        enter: IKey;
+        syncNow: IKey;
         enterBack: IKey;
+        enter: IKey;
+        goForward: IKey;
+        goBack: IKey;
+        newFile: IKey;
+        search: IKey;
+        globalSearch: IKey;
+        stickSearch: IKey;
+        replace: IKey;
+        closeTab: IKey;
         fileTree: IKey;
+        outline: IKey;
+        bookmark: IKey;
+        tag: IKey;
+        dailyNote: IKey;
+        inbox: IKey;
+        backlinks: IKey;
+        graphView: IKey;
         globalGraph: IKey;
-        globalSearch: IKey;
-        goBack: IKey;
-        goForward: IKey;
-        goToEditTabNext: IKey;
-        goToEditTabPrev: IKey;
+        riffCard: IKey;
+        config: IKey;
+        dataHistory: IKey;
+        toggleWin: IKey;
+        lockScreen: IKey;
+        recentDocs: IKey;
         goToTab1: IKey;
         goToTab2: IKey;
         goToTab3: IKey;
@@ -1026,28 +1063,25 @@ export namespace Config {
         goToTab9: IKey;
         goToTabNext: IKey;
         goToTabPrev: IKey;
-        graphView: IKey;
-        inbox: IKey;
-        lockScreen: IKey;
-        mainMenu: IKey;
+        goToEditTabNext: IKey;
+        goToEditTabPrev: IKey;
+        recentClosed: IKey;
         move: IKey;
-        newFile: IKey;
-        outline: IKey;
-        recentDocs: IKey;
-        replace: IKey;
-        riffCard: IKey;
-        search: IKey;
         selectOpen1: IKey;
+        toggleDock: IKey;
         splitLR: IKey;
-        splitMoveB: IKey;
         splitMoveR: IKey;
         splitTB: IKey;
-        stickSearch: IKey;
-        syncNow: IKey;
+        splitMoveB: IKey;
+        closeOthers: IKey;
+        closeAll: IKey;
+        closeUnmodified: IKey;
+        closeLeft: IKey;
+        closeRight: IKey;
         tabToWindow: IKey;
-        tag: IKey;
-        toggleDock: IKey;
-        toggleWin: IKey;
+        addToDatabase: IKey;
+        unsplit: IKey;
+        unsplitAll: IKey;
     }
 
     /**
@@ -1077,29 +1111,29 @@ export namespace Config {
     export type TLogLevel = "off" | "trace" | "debug" | "info" | "warn" | "error" | "fatal";
 
     /**
-     * Publishing service
+     * Publish service
      */
     export interface IPublish {
         /**
-         * Whether to open the publishing service
+         * Whether to open the publish service
          */
         enable: boolean;
         /**
-         * The basic authentication settings of publishing service
+         * The basic authentication settings of publish service
          */
         auth: IPublishAuth;
         /**
-         * Port on which the publishing service listens
+         * Port on which the publish service listens
          */
         port: number;
     }
 
     /**
-     * Publishing service authentication settings
+     * Publish service authentication settings
      */
     export interface IPublishAuth {
         /**
-         * Whether to enable basic authentication for publishing services
+         * Whether to enable basic authentication for publish services
          */
         enable: boolean;
         /**

package/types/constants.ts

@@ -1,4 +1,4 @@
-import {IObject, Config} from "../siyuan";
+import type {IObject, Config} from "../siyuan";
 
 const altNumber = navigator.platform.toUpperCase().indexOf("MAC") > -1 ? "⌃" : "⌥";
 
@@ -150,6 +150,7 @@ export abstract class Constants {
     public static readonly LOCAL_IMAGES = "local-images";
     public static readonly LOCAL_EMOJIS = "local-emojis";
     public static readonly LOCAL_MOVE_PATH = "local-move-path";
+    public static readonly LOCAL_RECENT_DOCS = "local-recent-docs";
 
     // dialog
     public static readonly DIALOG_CONFIRM = "dialog-confirm";
@@ -209,6 +210,69 @@ export abstract class Constants {
     public static readonly DIALOG_OPENWORKSPACE = "dialog-openworkspace"; // 打开工作空间
     public static readonly DIALOG_SAVEWORKSPACE = "dialog-saveworkspace"; // 保存工作空间
 
+    // menu
+    public static readonly MENU_BAR_WORKSPACE = "barWorkspace"; // 顶栏主菜单
+    public static readonly MENU_BAR_PLUGIN = "topBarPlugin"; // 顶栏插件菜单
+    public static readonly MENU_BAR_ZOOM = "barZoom"; // 顶栏缩放菜单
+    public static readonly MENU_BAR_MODE = "barmode"; // 顶栏外观菜单
+    public static readonly MENU_BAR_MORE = "barmore"; // 顶栏更多菜单
+    public static readonly MENU_STATUS_HELP = "statusHelp"; // 状态栏帮助菜单
+    public static readonly MENU_STATUS_BACKGROUND_TASK = "statusBackgroundTask"; // 状态栏后台任务菜单
+    public static readonly MENU_DOCK_MOBILE = "dockMobileMenu"; // 移动端侧栏插件选项菜单
+
+    public static readonly MENU_BLOCK_SINGLE = "block-single"; // 单选块菜单
+    public static readonly MENU_BLOCK_MULTI = "block-multi"; // 多选块菜单
+    public static readonly MENU_TITLE = "titleMenu"; // 文档块菜单
+    public static readonly MENU_FROM_TITLE_PROTYLE = "title-protyle"; // 在 Protyle 触发的文档块菜单
+    public static readonly MENU_FROM_TITLE_BREADCRUMB = "title-breadcrumb"; // 在面包屑触发的文档块菜单
+    public static readonly MENU_BREADCRUMB_MORE = "breadcrumbMore"; // 面包屑更多菜单
+    public static readonly MENU_BREADCRUMB_MOBILE_PATH = "breadcrumb-mobile-path"; // 移动端面包屑菜单
+
+    public static readonly MENU_DOC_TREE_MORE = "docTreeMore"; // 侧栏文档树右键菜单
+    public static readonly MENU_FROM_DOC_TREE_MORE_NOTEBOOK = "tree-notebook"; // 侧栏文档树右键菜单，单个笔记本
+    public static readonly MENU_FROM_DOC_TREE_MORE_DOC = "tree-doc"; // 侧栏文档树右键菜单，单个文档
+    public static readonly MENU_FROM_DOC_TREE_MORE_ITEMS = "tree-items"; // 侧栏文档树右键菜单，多个文档或笔记本
+    public static readonly MENU_TAG = "tagMenu"; // 侧栏标签菜单
+    public static readonly MENU_BOOKMARK = "bookmarkMenu"; // 侧栏书签菜单
+    public static readonly MENU_OUTLINE_CONTEXT = "outline-context"; // 大纲标题右键菜单
+    public static readonly MENU_OUTLINE_EXPAND_LEVEL = "outline-expand-level"; // 大纲展开层级菜单
+
+    public static readonly MENU_AV_VIEW = "av-view"; // 数据库视图标题菜单
+    public static readonly MENU_AV_HEADER_CELL = "av-header-cell"; // 数据库字段标题菜单
+    public static readonly MENU_AV_HEADER_ADD = "av-header-add"; // 数据库添加字段菜单
+    public static readonly MENU_AV_ADD_FILTER = "av-add-filter"; // 数据库添加筛选条件菜单
+    public static readonly MENU_AV_ADD_SORT = "av-add-sort"; // 数据库添加排序条件菜单
+    public static readonly MENU_AV_COL_OPTION = "av-col-option"; // 数据库单选多选字段的选项编辑菜单
+    public static readonly MENU_AV_COL_FORMAT_NUMBER = "av-col-format-number"; // 数据库数字字段格式化菜单
+    public static readonly MENU_AV_GROUP_DATE = "avGroupDate"; // 数据库日期字段分组菜单的日期菜单
+    public static readonly MENU_AV_GROUP_SORT = "avGroupSort"; // 数据库日期字段分组菜单的排序菜单
+    public static readonly MENU_AV_ASSET_EDIT = "av-asset-edit"; // 数据库资源字段链接或资源文件菜单
+    public static readonly MENU_AV_CALC = "av-calc"; // 数据库计算菜单
+    public static readonly MENU_AV_PAGE_SIZE = "av-page-size"; // 数据库条目数菜单
+
+    public static readonly MENU_SEARCH_MORE = "searchMore"; // 搜索更多菜单
+    public static readonly MENU_SEARCH_METHOD = "searchMethod"; // 搜索方式菜单
+    public static readonly MENU_SEARCH_ASSET_MORE = "searchAssetMore"; // 资源文件搜索更多菜单
+    public static readonly MENU_SEARCH_ASSET_METHOD = "searchAssetMethod"; // 资源文件搜索方式菜单
+    public static readonly MENU_SEARCH_UNREF_MORE = "searchUnRefMore"; // 列出引用失效的块的更多菜单
+    public static readonly MENU_SEARCH_HISTORY = "search-history"; // 搜索历史菜单
+    public static readonly MENU_SEARCH_REPLACE_HISTORY = "search-replace-history"; // 替换历史菜单
+    public static readonly MENU_SEARCH_ASSET_HISTORY = "search-asset-history"; // 资源文件搜索历史菜单
+    public static readonly MENU_MOVE_PATH_HISTORY = "move-path-history"; // 移动文档窗口搜索历史菜单
+
+    public static readonly MENU_BACKGROUND_ASSET = "background-asset"; // 资源文件选择器菜单
+    public static readonly MENU_AI = "ai"; // 块 AI 菜单
+    public static readonly MENU_TAB = "tab"; // 页签右键菜单
+    public static readonly MENU_TAB_LIST = "tabList"; // 页签切换菜单
+
+    public static readonly MENU_INLINE_CONTEXT = "inline-context"; // 文本右键菜单
+    public static readonly MENU_INLINE_IMG = "inline-img"; // 图片元素菜单
+    public static readonly MENU_INLINE_FILE_ANNOTATION_REF = "inline-file-annotation-ref"; // PDF 标注元素菜单
+    public static readonly MENU_INLINE_REF = "inline-block-ref"; // 块引用元素菜单
+    public static readonly MENU_INLINE_A = "inline-a"; // 超链接元素菜单
+    public static readonly MENU_INLINE_TAG = "inline-tag"; // 行级标签元素菜单
+    public static readonly MENU_INLINE_MATH = "inline-math"; // 行级公式元素菜单
+
     // timeout
     public static readonly TIMEOUT_OPENDIALOG = 50;
     public static readonly TIMEOUT_DBLCLICK = 190;
@@ -408,6 +472,7 @@ export abstract class Constants {
             goToTabPrev: {default: "⇧⌘[", custom: "⇧⌘["},
             goToEditTabNext: {default: "⌃⇥", custom: "⌃⇥"},
             goToEditTabPrev: {default: "⌃⇧⇥", custom: "⌃⇧⇥"},
+            recentClosed: {default: "⇧⌘T", custom: "⇧⌘T"},
             move: {default: "", custom: ""},
             selectOpen1: {default: "", custom: ""},
             toggleDock: {default: "", custom: ""},
@@ -527,10 +592,10 @@ export abstract class Constants {
                 checkToggle: {default: "⌘↩", custom: "⌘↩"},
             },
             table: {
-                insertRowAbove: {default: "⇧⌘T", custom: "⇧⌘T"},
-                insertRowBelow: {default: "⇧⌘D", custom: "⇧⌘D"},
-                insertColumnLeft: {default: "⇧⌘L", custom: "⇧⌘L"},
-                insertColumnRight: {default: "⇧⌘R", custom: "⇧⌘R"},
+                insertRowAbove: {default: "", custom: ""},
+                insertRowBelow: {default: "", custom: ""},
+                insertColumnLeft: {default: "", custom: ""},
+                insertColumnRight: {default: "", custom: ""},
                 moveToUp: {default: "⌥⌘T", custom: "⌥⌘T"},
                 moveToDown: {default: "⌥⌘B", custom: "⌥⌘B"},
                 moveToLeft: {default: "⌥⌘L", custom: "⌥⌘L"},
@@ -715,7 +780,7 @@ export abstract class Constants {
 </svg>`;
 
     // assets
-    public static readonly SIYUAN_ASSETS_IMAGE: string[] = [".apng", ".ico", ".cur", ".jpg", ".jpe", ".jpeg", ".jfif", ".pjp", ".pjpeg", ".png", ".gif", ".webp", ".bmp", ".svg", ".avif"];
+    public static readonly SIYUAN_ASSETS_IMAGE: string[] = [".apng", ".ico", ".cur", ".jpg", ".jpe", ".jpeg", ".jfif", ".pjp", ".pjpeg", ".png", ".gif", ".webp", ".bmp", ".svg", ".avif", ".tiff", ".tif"];
     public static readonly SIYUAN_ASSETS_AUDIO: string[] = [".mp3", ".wav", ".ogg", ".m4a", ".aac", ".flac"];
     public static readonly SIYUAN_ASSETS_VIDEO: string[] = [".mov", ".weba", ".mkv", ".mp4", ".webm"];
     public static readonly SIYUAN_ASSETS_EXTS: string[] = [".pdf"].concat(Constants.SIYUAN_ASSETS_IMAGE).concat(Constants.SIYUAN_ASSETS_AUDIO).concat(Constants.SIYUAN_ASSETS_VIDEO);

package/types/index.d.ts

@@ -211,7 +211,7 @@ export interface ISiyuan {
         }[]
     },
     dragElement?: HTMLElement,
-    currentDragOverTabHeadersElement?: HTMLElement,
+    currentDragOverTabHeadersElement?: HTMLElement
     layout?: {
         layout?: Layout,
         centerLayout?: Layout,
@@ -240,6 +240,10 @@ export interface ISiyuan {
     blockPanels: BlockPanel[],
     dialogs: Dialog[],
     viewer?: Viewer
+    /**
+     * 是否在发布服务下访问
+     */
+    isPublish?: boolean;
 }
 
 export interface IMenu {

package/types/protyle.d.ts

@@ -5,217 +5,6 @@ import {
 } from "./../siyuan";
 import {Model} from "./layout/Model";
 
-type TTurnIntoOne = "BlocksMergeSuperBlock" | "Blocks2ULs" | "Blocks2OLs" | "Blocks2TLs" | "Blocks2Blockquote"
-
-type TTurnIntoOneSub = "row" | "col"
-
-type TTurnInto = "Blocks2Ps" | "Blocks2Hs"
-
-type THintSource = "search" | "av" | "hint";
-
-export type TProtyleAction = "cb-get-append" | // 向下滚动加载
-    "cb-get-before" | // 向上滚动加载
-    "cb-get-unchangeid" | // 上下滚动，定位时不修改 blockid
-    "cb-get-hl" | // 高亮
-    "cb-get-focus" | // 光标定位
-    "cb-get-focusfirst" | // 动态定位到第一个块
-    "cb-get-setid" | // 无折叠大纲点击 重置 blockid
-    "cb-get-outline" | // 大纲点击
-    "cb-get-all" | // 获取所有块
-    "cb-get-backlink" | // 悬浮窗为传递型需展示上下文
-    "cb-get-unundo" | // 不需要记录历史
-    "cb-get-scroll" | // 滚动到指定位置，用于直接打开文档，必有 rootID
-    "cb-get-context" | // 包含上下文
-    "cb-get-rootscroll" | // 如果为 rootID 就滚动到指定位置，必有 rootID
-    "cb-get-html" | // 直接渲染，不需要再 /api/block/getDocInfo，否则搜索表格无法定位
-    "cb-get-history" | // 历史渲染
-    "cb-get-opennew"  // 编辑器只读后新建文件需为临时解锁状态 & https://github.com/siyuan-note/siyuan/issues/12197
-
-export type TEditorMode = "preview" | "wysiwyg"
-
-interface ILuteNode {
-    TokensStr: () => string;
-    __internal_object__: {
-        Parent: {
-            Type: number,
-        },
-        HeadingLevel: string,
-    };
-}
-
-/** @link https://ld246.com/article/1549638745630#options-toolbar */
-interface IMenuItem {
-    /** 唯一标示 */
-    name: string;
-    /** 提示 */
-    tip?: string;
-    /** 语言 key */
-    lang?: string;
-    /** svg 图标 */
-    icon?: string;
-    /** 快捷键 */
-    hotkey?: string;
-    /** 提示的位置 */
-    tipPosition?: string;
-
-    click?(protyle: Protyle): void;
-}
-
-interface IBreadcrumb {
-    id: string,
-    name: string,
-    type: string,
-    subType: string,
-    children: []
-}
-
-interface IOperations {
-    doOperations: IOperation[],
-    undoOperations: IOperation[]
-}
-
-interface IHintData {
-    id?: string;
-    html: string;
-    value: string;
-    filter?: string[];
-    focus?: boolean;
-}
-
-export interface IProtyleOptions {
-    history?: {
-        created?: string
-        snapshot?: string
-    },
-    backlinkData?: {
-        blockPaths: IBreadcrumb[],
-        dom: string
-        expand: boolean
-    }[],
-    action?: TProtyleAction[],
-    mode?: TEditorMode,
-    blockId?: string
-    rootId?: string
-    originalRefBlockIDs?: IObject
-    key?: string
-    defId?: string
-    render?: {
-        background?: boolean
-        title?: boolean
-        gutter?: boolean
-        scroll?: boolean
-        breadcrumb?: boolean
-        breadcrumbDocName?: boolean
-    }
-    /** 内部调试时使用 */
-    _lutePath?: string;
-    /** 是否显示日志。默认值: false */
-    debugger?: boolean;
-    /** 是否启用打字机模式。默认值: false */
-    typewriterMode?: boolean;
-    /** 多语言。默认值: 'zh_CN' */
-    lang?: string;
-    /** @link https://ld246.com/article/1549638745630#options-toolbar */
-    toolbar?: Array<string | IMenuItem>;
-    /** @link https://ld246.com/article/1549638745630#options-classes */
-    classes?: {
-        preview?: string;
-    };
-    click?: {
-        /** 点击末尾是否阻止插入新块 */
-        preventInsetEmptyBlock?: boolean
-    }
-
-    handleEmptyContent?(): void
-
-    /** 编辑器异步渲染完成后的回调方法 */
-    after?(protyle: Protyle): void;
-}
-
-// REF: https://github.com/siyuan-note/siyuan/blob/dev/app/src/types/protyle.d.ts
-export interface IProtyle {
-    getInstance: () => Protyle,
-    observerLoad?: ResizeObserver,
-    observer?: ResizeObserver,
-    app: App,
-    transactionTime: number,
-    id: string,
-    query?: {
-        key: string,
-        method: number
-        types: Config.IUILayoutTabSearchConfigTypes
-    },
-    block: {
-        id?: string,
-        scroll?: boolean
-        parentID?: string,
-        parent2ID?: string,
-        rootID?: string,
-        showAll?: boolean
-        mode?: number
-        blockCount?: number
-        action?: string[]
-    },
-    disabled: boolean,
-    selectElement?: HTMLElement,
-    ws?: Model,
-    notebookId?: string
-    path?: string
-    model?: Editor,
-    updated: boolean;
-    element: HTMLElement;
-    scroll?: Scroll,
-    gutter?: Gutter,
-    breadcrumb?: Breadcrumb,
-    title?: Title,
-    background?: Background,
-    contentElement?: HTMLElement,
-    options: IProtyleOptions;
-    lute?: Lute;
-    toolbar?: Toolbar,
-    preview?: Preview;
-    hint?: Hint;
-    upload?: Upload;
-    undo?: Undo;
-    wysiwyg?: WYSIWYG
-}
-
-declare class Viz {
-    public static instance(): Promise<Viz>;
-
-    renderSVGElement: (code: string) => SVGElement;
-}
-
-declare class Viewer {
-    public destroyed: boolean;
-
-    constructor(element: Element, options: {
-        title: [number, (image: HTMLImageElement, imageData: IObject) => string],
-        button: boolean,
-        initialViewIndex?: number,
-        transition: boolean,
-        hidden: () => void,
-        toolbar: {
-            zoomIn: boolean,
-            zoomOut: boolean,
-            oneToOne: boolean,
-            reset: boolean,
-            prev: boolean,
-            play: boolean,
-            next: boolean,
-            rotateLeft: boolean,
-            rotateRight: boolean,
-            flipHorizontal: boolean,
-            flipVertical: boolean,
-            close: () => void
-        }
-    })
-
-    public destroy(): void
-
-    public show(): void
-}
-
 declare class Breadcrumb {
     element: HTMLElement;
 
@@ -342,6 +131,11 @@ declare class Preview {
     private processZHTable;
 }
 
+interface IOperations {
+    doOperations: IOperation[],
+    undoOperations: IOperation[]
+}
+
 declare class Undo {
     private hasUndo;
     redoStack: IOperations[];
@@ -431,36 +225,264 @@ export declare class Toolbar {
     public showContent(protyle: IProtyle, range: Range, nodeElement: Element): 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;
+export class Protyle {
 
-    public static EChartsMindmapStr(text: string): string;
+    public readonly version: string;
+    public protyle: IProtyle;
 
-    public static NewNodeID(): string;
+    constructor(app: App, element: HTMLElement, options?: IProtyleOptions)
 
-    public static Sanitize(html: string): string;
+    /** 聚焦到编辑器 */
+    public focus(): void
 
-    public static EscapeHTMLStr(str: string): string;
+    /** 上传是否还在进行中 */
+    public isUploading(): boolean
 
-    public static UnEscapeHTMLStr(str: string): string;
+    /** 清空 undo & redo 栈 */
+    public clearStack(): void
 
-    public static GetHeadingID(node: ILuteNode): string;
+    /** 销毁编辑器 */
+    public destroy(): void
 
-    public static BlockDOM2Content(html: string): string;
+    public resize(): void
 
-    private constructor();
+    public reload(focus: boolean): void
 
-    public BlockDOM2Content(text: string): string;
+    /**
+     * @param {boolean} [isBlock=false]
+     * @param {boolean} [useProtyleRange=false]
+     */
+    public insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
 
-    public BlockDOM2EscapeMarkerContent(text: string): string;
+    public transaction(doOperations: IOperation[], undoOperations?: IOperation[]): void;
 
-    public SetSpin(enable: boolean): void;
+    /**
+     * 多个块转换为一个块
+     * @param {TTurnIntoOneSub} [subType] type 为 "BlocksMergeSuperBlock" 时必传
+     */
+    public turnIntoOneTransaction(selectsElement: Element[], type: TTurnIntoOne, subType?: TTurnIntoOneSub): void
+
+    /**
+     * 多个块转换
+     * @param {Element} [nodeElement] 优先使用包含 protyle-wysiwyg--select 的块，否则使用 nodeElement 单块
+     * @param type
+     * @param {number} [subType] type 为 "Blocks2Hs" 时必传
+     */
+    public turnIntoTransaction(nodeElement: Element, type: TTurnInto, subType?: number): void
+
+    public updateTransaction(id: string, newHTML: string, html: string): void
+
+    public updateBatchTransaction(nodeElements: Element[], cb: (e: HTMLElement) => void): void
+
+    public getRange(element: Element): Range
+
+    public hasClosestBlock(element: Node): false | HTMLElement
+
+    /**
+     * @param {boolean} [toStart=true]
+     */
+    public focusBlock(element: Element, toStart?: boolean): false | Range
+
+    public disable(): void
+
+    public enable(): void
+
+    public renderAVAttribute(element: HTMLElement, id: string, cb?: (element: HTMLElement) => void): void
+}
+
+interface ILuteNode {
+    TokensStr: () => string;
+    __internal_object__: {
+        Parent: {
+            Type: number,
+        },
+        HeadingLevel: string,
+    };
+}
+
+type THintSource = "search" | "av" | "hint";
+
+type TTurnIntoOne = "BlocksMergeSuperBlock" | "Blocks2ULs" | "Blocks2OLs" | "Blocks2TLs" | "Blocks2Blockquote"
+
+type TTurnIntoOneSub = "row" | "col"
+
+type TTurnInto = "Blocks2Ps" | "Blocks2Hs"
+
+type TEditorMode = "preview" | "wysiwyg"
+
+type ILuteRenderCallback = (node: ILuteNode, entering: boolean) => [string, number];
+
+export type TProtyleAction = "cb-get-append" | // 向下滚动加载
+    "cb-get-before" | // 向上滚动加载
+    "cb-get-unchangeid" | // 上下滚动，定位时不修改 blockid
+    "cb-get-hl" | // 高亮
+    "cb-get-focus" | // 光标定位
+    "cb-get-focusfirst" | // 动态定位到第一个块
+    "cb-get-setid" | // 无折叠大纲点击 重置 blockid
+    "cb-get-outline" | // 大纲点击
+    "cb-get-all" | // 获取所有块
+    "cb-get-backlink" | // 悬浮窗为传递型需展示上下文
+    "cb-get-unundo" | // 不需要记录历史
+    "cb-get-scroll" | // 滚动到指定位置，用于直接打开文档，必有 rootID
+    "cb-get-context" | // 包含上下文
+    "cb-get-rootscroll" | // 如果为 rootID 就滚动到指定位置，必有 rootID
+    "cb-get-html" | // 直接渲染，不需要再 /api/block/getDocInfo，否则搜索表格无法定位
+    "cb-get-history" | // 历史渲染
+    "cb-get-opennew"  // 编辑器只读后新建文件需为临时解锁状态 & https://github.com/siyuan-note/siyuan/issues/12197
+
+/** @link https://ld246.com/article/1588412297062 */
+interface ILuteRender {
+    renderDocument?: ILuteRenderCallback;
+    renderParagraph?: ILuteRenderCallback;
+    renderText?: ILuteRenderCallback;
+    renderCodeBlock?: ILuteRenderCallback;
+    renderCodeBlockOpenMarker?: ILuteRenderCallback;
+    renderCodeBlockInfoMarker?: ILuteRenderCallback;
+    renderCodeBlockCode?: ILuteRenderCallback;
+    renderCodeBlockCloseMarker?: ILuteRenderCallback;
+    renderMathBlock?: ILuteRenderCallback;
+    renderMathBlockOpenMarker?: ILuteRenderCallback;
+    renderMathBlockContent?: ILuteRenderCallback;
+    renderMathBlockCloseMarker?: ILuteRenderCallback;
+    renderBlockquote?: ILuteRenderCallback;
+    renderBlockquoteMarker?: ILuteRenderCallback;
+    renderHeading?: ILuteRenderCallback;
+    renderHeadingC8hMarker?: ILuteRenderCallback;
+    renderList?: ILuteRenderCallback;
+    renderListItem?: ILuteRenderCallback;
+    renderTaskListItemMarker?: ILuteRenderCallback;
+    renderThematicBreak?: ILuteRenderCallback;
+    renderHTML?: ILuteRenderCallback;
+    renderTable?: ILuteRenderCallback;
+    renderTableHead?: ILuteRenderCallback;
+    renderTableRow?: ILuteRenderCallback;
+    renderTableCell?: ILuteRenderCallback;
+    renderCodeSpan?: ILuteRenderCallback;
+    renderCodeSpanOpenMarker?: ILuteRenderCallback;
+    renderCodeSpanContent?: ILuteRenderCallback;
+    renderCodeSpanCloseMarker?: ILuteRenderCallback;
+    renderInlineMath?: ILuteRenderCallback;
+    renderInlineMathOpenMarker?: ILuteRenderCallback;
+    renderInlineMathContent?: ILuteRenderCallback;
+    renderInlineMathCloseMarker?: ILuteRenderCallback;
+    renderEmphasis?: ILuteRenderCallback;
+    renderEmAsteriskOpenMarker?: ILuteRenderCallback;
+    renderEmAsteriskCloseMarker?: ILuteRenderCallback;
+    renderEmUnderscoreOpenMarker?: ILuteRenderCallback;
+    renderEmUnderscoreCloseMarker?: ILuteRenderCallback;
+    renderStrong?: ILuteRenderCallback;
+    renderStrongA6kOpenMarker?: ILuteRenderCallback;
+    renderStrongA6kCloseMarker?: ILuteRenderCallback;
+    renderStrongU8eOpenMarker?: ILuteRenderCallback;
+    renderStrongU8eCloseMarker?: ILuteRenderCallback;
+    renderStrikethrough?: ILuteRenderCallback;
+    renderStrikethrough1OpenMarker?: ILuteRenderCallback;
+    renderStrikethrough1CloseMarker?: ILuteRenderCallback;
+    renderStrikethrough2OpenMarker?: ILuteRenderCallback;
+    renderStrikethrough2CloseMarker?: ILuteRenderCallback;
+    renderHardBreak?: ILuteRenderCallback;
+    renderSoftBreak?: ILuteRenderCallback;
+    renderInlineHTML?: ILuteRenderCallback;
+    renderLink?: ILuteRenderCallback;
+    renderOpenBracket?: ILuteRenderCallback;
+    renderCloseBracket?: ILuteRenderCallback;
+    renderOpenParen?: ILuteRenderCallback;
+    renderCloseParen?: ILuteRenderCallback;
+    renderLinkText?: ILuteRenderCallback;
+    renderLinkSpace?: ILuteRenderCallback;
+    renderLinkDest?: ILuteRenderCallback;
+    renderLinkTitle?: ILuteRenderCallback;
+    renderImage?: ILuteRenderCallback;
+    renderBang?: ILuteRenderCallback;
+    renderEmoji?: ILuteRenderCallback;
+    renderEmojiUnicode?: ILuteRenderCallback;
+    renderEmojiImg?: ILuteRenderCallback;
+    renderEmojiAlias?: ILuteRenderCallback;
+    renderBackslash?: ILuteRenderCallback;
+    renderBackslashContent?: ILuteRenderCallback;
+}
+
+interface IBreadcrumb {
+    id: string,
+    name: string,
+    type: string,
+    subType: string,
+    children: []
+}
+
+interface ILuteOptions extends IMarkdownConfig {
+    emojis: IObject;
+    emojiSite: string;
+    headingAnchor: boolean;
+    lazyLoadImage?: string;
+}
+
+declare class Viz {
+    public static instance(): Promise<Viz>;
+
+    renderSVGElement: (code: string) => SVGElement;
+}
+
+declare class Viewer {
+    public destroyed: boolean;
+
+    constructor(element: Element, options: {
+        title: [number, (image: HTMLImageElement, imageData: IObject) => string],
+        button: boolean,
+        initialViewIndex?: number,
+        transition: boolean,
+        hidden: () => void,
+        toolbar: {
+            zoomIn: boolean,
+            zoomOut: boolean,
+            oneToOne: boolean,
+            reset: boolean,
+            prev: boolean,
+            play: boolean,
+            next: boolean,
+            rotateLeft: boolean,
+            rotateRight: boolean,
+            flipHorizontal: boolean,
+            flipVertical: boolean,
+            close: () => void
+        }
+    })
+
+    public destroy(): void
+
+    public show(): 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 SetSpin(enable: boolean): void;
 
     public SetTextMark(enable: boolean): void;
 
@@ -551,69 +573,268 @@ export class Lute {
     public HTML2Md(html: string): string;
 
     public HTML2BlockDOM(html: string): string;
-}
-
-export class Protyle {
-
-    public readonly version: string;
-    public protyle: IProtyle;
-
-    constructor(app: App, element: HTMLElement, options?: IProtyleOptions)
-
-    /** 聚焦到编辑器 */
-    public focus(): void
-
-    /** 上传是否还在进行中 */
-    public isUploading(): boolean
 
-    /** 清空 undo & redo 栈 */
-    public clearStack(): void
+    public SetUnorderedListMarker(marker: string): void;
+}
 
-    /** 销毁编辑器 */
-    public destroy(): void
+declare const webkitAudioContext: {
+    prototype: AudioContext
+    new(contextOptions?: AudioContextOptions): AudioContext,
+};
+
+/** @link https://ld246.com/article/1549638745630#options-upload */
+interface IUpload {
+    /** 上传 url */
+    url?: string;
+    /** 上传文件最大 Byte */
+    max?: number;
+    /** 剪切板中包含图片地址时，使用此 url 重新上传 */
+    linkToImgUrl?: string;
+    /** CORS 上传验证，头为 X-Upload-Token */
+    token?: string;
+    /** 文件上传类型，同 [input accept](https://www.w3schools.com/tags/att_input_accept.asp) */
+    accept?: string;
+    /** 跨站点访问控制。默认值: false */
+    withCredentials?: boolean;
+    /** 请求头设置 */
+    headers?: IObject;
+    /** 额外请求参数 */
+    extraData?: { [key: string]: string | Blob };
+    /** 上传字段名。默认值：file[] */
+    fieldName?: string;
+
+    /** 每次上传前都会重新设置请求头 */
+    setHeaders?(): IObject;
+
+    /** 上传成功回调 */
+    success?(editor: HTMLDivElement, msg: string): void;
+
+    /** 上传失败回调 */
+    error?(msg: string): void;
+
+    /** 文件名安全处理。 默认值: name => name.replace(/\W/g, '') */
+    filename?(name: string): string;
+
+    /** 校验，成功时返回 true 否则返回错误信息 */
+    validate?(files: File[]): string | boolean;
+
+    /** 自定义上传，当发生错误时返回错误信息 */
+    handler?(files: File[]): string | null;
+
+    /** 对服务端返回的数据进行转换，以满足内置的数据结构 */
+    format?(files: File[], responseText: string): string;
+
+    /** 将上传的文件处理后再返回  */
+    file?(files: File[]): File[];
+
+    /** 图片地址上传后的回调  */
+    linkToImgCallback?(responseText: string): void;
+}
 
-    public resize(): void
+interface IScrollAttr {
+    rootId: string,
+    startId: string,
+    endId: string
+    scrollTop: number,
+    focusId?: string,
+    focusStart?: number
+    focusEnd?: number
+    zoomInId?: string
+}
 
-    public reload(focus: boolean): void
+/** @link https://ld246.com/article/1549638745630#options-toolbar */
+interface IMenuItem {
+    /** 唯一标示 */
+    name: string;
+    /** 提示 */
+    tip?: string;
+    /** 语言 key */
+    lang?: string;
+    /** svg 图标 */
+    icon?: string;
+    /** 快捷键 */
+    hotkey?: string;
+    /** 提示的位置 */
+    tipPosition?: string;
 
-    /**
-     * @param {boolean} [isBlock=false]
-     * @param {boolean} [useProtyleRange=false]
-     */
-    public insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
+    click?(protyle: Protyle): void;
+}
 
-    public transaction(doOperations: IOperation[], undoOperations?: IOperation[]): void;
+/** @link https://ld246.com/article/1549638745630#options-preview-markdown */
+interface IMarkdownConfig {
+    /** 段落开头是否空两格。默认值: false */
+    paragraphBeginningSpace?: boolean;
+    /** 是否启用过滤 XSS。默认值: true */
+    sanitize?: boolean;
+    /** 为列表添加标记，以便[自定义列表样式](https://github.com/Vanessa219/vditor/issues/390) 默认值：false */
+    listStyle?: boolean;
+}
 
-    /**
-     * 多个块转换为一个块
-     * @param {TTurnIntoOneSub} [subType] type 为 "BlocksMergeSuperBlock" 时必传
-     */
-    public turnIntoOneTransaction(selectsElement: Element[], type: TTurnIntoOne, subType?: TTurnIntoOneSub): void
+/** @link https://ld246.com/article/1549638745630#options-preview */
+interface IPreview {
+    /** 预览 debounce 毫秒间隔。默认值: 1000 */
+    delay?: number;
+    /** 显示模式。默认值: 'both' */
+    mode?: "both" | "editor";
+    /** md 解析请求 */
+    url?: string;
+    /** @link https://ld246.com/article/1549638745630#options-preview-markdown */
+    markdown?: IMarkdownConfig;
+    /** @link https://ld246.com/article/1549638745630#options-preview-actions  */
+    actions?: Array<IPreviewAction | IPreviewActionCustom>;
+
+    /** 渲染之前回调 */
+    transform?(html: string): string;
+}
 
-    /**
-     * 多个块转换
-     * @param {Element} [nodeElement] 优先使用包含 protyle-wysiwyg--select 的块，否则使用 nodeElement 单块
-     * @param type
-     * @param {number} [subType] type 为 "Blocks2Hs" 时必传
-     */
-    public turnIntoTransaction(nodeElement: Element, type: TTurnInto, subType?: number): void
+type IPreviewAction = "desktop" | "tablet" | "mobile" | "mp-wechat" | "zhihu" | "yuque";
+
+interface IPreviewActionCustom {
+    /** 键名 */
+    key: string;
+    /** 按钮文本 */
+    text: string;
+    /** 按钮 className 值 */
+    className?: string;
+    /** 点击回调 */
+    click: (key: string) => void;
+}
 
-    public updateTransaction(id: string, newHTML: string, html: string): void
+interface IHintData {
+    id?: string;
+    html: string;
+    value: string;
+    filter?: string[];
+    focus?: boolean;
+}
 
-    public updateBatchTransaction(nodeElements: Element[], cb: (e: HTMLElement) => void): void
+interface IHintExtend {
+    key: string;
 
-    public getRange(element: Element): Range
+    hint?(value: string, protyle: IProtyle, source: THintSource): IHintData[];
+}
 
-    public hasClosestBlock(element: Node): false | HTMLElement
+/** @link https://ld246.com/article/1549638745630#options-hint */
+interface IHint {
+    /** 常用表情提示 HTML */
+    emojiTail?: string;
+    /** 提示 debounce 毫秒间隔。默认值: 200 */
+    delay?: number;
+    /** 默认表情，可从 [lute/emoji_map](https://github.com/88250/lute/blob/master/parse/emoji_map.go#L32) 中选取，也可自定义 */
+    emoji?: IObject;
+    emojiPath?: string;
+    extend?: IHintExtend[];
+}
 
-    /**
-     * @param {boolean} [toStart=true]
-     */
-    public focusBlock(element: Element, toStart?: boolean): false | Range
+/** @link https://ld246.com/article/1549638745630#options */
+export interface IProtyleOptions {
+    history?: {
+        created?: string
+        snapshot?: string
+    },
+    backlinkData?: {
+        blockPaths: IBreadcrumb[],
+        dom: string
+        expand: boolean
+    }[],
+    action?: TProtyleAction[],
+    scrollPosition?: ScrollLogicalPosition,
+    mode?: TEditorMode,
+    blockId?: string
+    rootId?: string
+    originalRefBlockIDs?: IObject
+    key?: string
+    defIds?: string[]
+    render?: {
+        background?: boolean
+        title?: boolean
+        titleShowTop?: boolean
+        gutter?: boolean
+        scroll?: boolean
+        breadcrumb?: boolean
+        breadcrumbDocName?: boolean
+        hideTitleOnZoom?: boolean
+    }
+    /** 内部调试时使用 */
+    _lutePath?: string;
+    /** 是否启用打字机模式。默认值: false */
+    typewriterMode?: boolean;
+    /** 多语言。默认值: 'zh_CN' */
+    lang?: string;
+    /** @link https://ld246.com/article/1549638745630#options-toolbar */
+    toolbar?: Array<string | IMenuItem>;
+    /** @link https://ld246.com/article/1549638745630#options-preview */
+    preview?: IPreview;
+    /** @link https://ld246.com/article/1549638745630#options-hint */
+    hint?: IHint;
+    /** @link https://ld246.com/article/1549638745630#options-upload */
+    upload?: IUpload;
+    /** @link https://ld246.com/article/1549638745630#options-classes */
+    classes?: {
+        preview?: string;
+    };
+    click?: {
+        /** 点击末尾是否阻止插入新块 */
+        preventInsetEmptyBlock?: boolean
+    }
 
-    public disable(): void
+    handleEmptyContent?(): void
 
-    public enable(): void
+    /** 编辑器异步渲染完成后的回调方法 */
+    after?(protyle: Protyle): void;
+}
 
-    public renderAVAttribute(element: HTMLElement, id: string, cb?: (element: HTMLElement) => void): void
+// REF: https://github.com/siyuan-note/siyuan/blob/dev/app/src/types/protyle.d.ts
+export interface IProtyle {
+    highlight: {
+        mark: Highlight
+        markHL: Highlight
+        ranges: Range[]
+        rangeIndex: number
+        styleElement: HTMLStyleElement
+    }
+    getInstance: () => Protyle,
+    observerLoad?: ResizeObserver,
+    observer?: ResizeObserver,
+    app: App,
+    transactionTime: number,
+    id: string,
+    query?: {
+        key: string,
+        method: number
+        types: Config.IUILayoutTabSearchConfigTypes
+    },
+    block: {
+        id?: string,
+        scroll?: boolean
+        parentID?: string,
+        parent2ID?: string,
+        rootID?: string,
+        showAll?: boolean
+        mode?: number
+        blockCount?: number
+        action?: string[]
+    },
+    disabled: boolean,
+    selectElement?: HTMLElement,
+    ws?: Model,
+    notebookId?: string
+    path?: string
+    model?: Editor,
+    updated: boolean;
+    element: HTMLElement;
+    scroll?: Scroll,
+    gutter?: Gutter,
+    breadcrumb?: Breadcrumb,
+    title?: Title,
+    background?: Background,
+    contentElement?: HTMLElement,
+    options: IProtyleOptions;
+    lute?: Lute;
+    toolbar?: Toolbar,
+    preview?: Preview;
+    hint?: Hint;
+    upload?: Upload;
+    undo?: Undo;
+    wysiwyg?: WYSIWYG
 }