siyuan 0.8.4 → 0.8.5

package/CHANGELOG.md

@@ -1,6 +1,10 @@
 # Changelog
 
-## 0.8.5 2023-09
+## 0.8.6 2023-10
+
+## 0.8.5 2023-10-10
+
+* [Add plugin event bus `open-menu-doctree`](https://github.com/siyuan-note/siyuan/issues/9351)
 
 ## 0.8.4 2023-09-19
 

package/package.json

@@ -12,6 +12,6 @@
         "README.md",
         "siyuan.d.ts"
     ],
-    "version": "0.8.4",
+    "version": "0.8.5",
     "repository": "https://github.com/siyuan-note/petal"
 }

package/siyuan.d.ts

@@ -1,5 +1,6 @@
-import type * as types from "./types";
-import {IProtyle} from "./types/protyle";
+import {IProtyle, Lute, Protyle, Toolbar} from "./types/protyle";
+import {IMenuBaseDetail} from "./types/events";
+import {IGetDocInfo, IGetTreeStat} from "./types/response";
 
 declare global {
     interface Window extends Global {
@@ -75,26 +76,75 @@ interface Global {
 }
 
 interface IEventBusMap {
-    "click-blockicon": types.events.IClickBlockIconDetail;
-    "click-editorcontent": types.events.IClickEditorContentDetail;
-    "click-editortitleicon": types.events.IClickEditorTitleIconDetail;
-    "click-pdf": types.events.IClickPdfDetail;
-    "destroy-protyle": types.events.IDestroyProtyleDetail;
-    "input-search": types.events.IInputSearchDetail;
-    "loaded-protyle-dynamic": types.events.ILoadedProtyleDynamicDetail;
-    "loaded-protyle": types.events.ILoadedProtyleDetail;
-    "open-menu-av": any;
-    "open-menu-blockref": types.events.IOpenMenuBlockRefDetail;
-    "open-menu-breadcrumbmore": types.events.IOpenMenuBreadcrumbMoreDetail;
-    "open-menu-content": types.events.IOpenMenuContentDetail;
-    "open-menu-fileannotationref": types.events.IOpenMenuFileAnnotationRefDetail;
-    "open-menu-image": types.events.IOpenMenuImageDetail;
-    "open-menu-link": types.events.IOpenMenuLinkDetail;
-    "open-menu-tag": types.events.IOpenMenuTagDetail;
-    "open-noneditableblock": types.events.IOpenNonEditableBlockDetail;
-    "open-siyuan-url-block": types.events.IOpenSiyuanUrlBlockDetail;
-    "open-siyuan-url-plugin": types.events.IOpenSiyuanUrlPluginDetail;
-    "ws-main": types.events.IWebSocketMainDetail;
+    "click-blockicon": {
+        protyle: IProtyle,
+        blockElements: HTMLElement[]
+    };
+    "click-editorcontent": {
+        protyle: IProtyle,
+        event: MouseEvent
+    };
+    "click-editortitleicon": {
+        protyle: IProtyle,
+        data: IGetDocInfo,
+    };
+    "click-pdf": {
+        event: MouseEvent
+    };
+    "destroy-protyle": {
+        protyle: IProtyle
+    };
+    "input-search": {
+        protyle: Protyle,
+        config: ISearchOption,
+        searchElement: HTMLInputElement,
+    };
+    "loaded-protyle-dynamic": {
+        protyle: IProtyle,
+        positon: "afterend" | "beforebegin"
+    };
+    "loaded-protyle": {
+        protyle: IProtyle,
+    };
+    "open-menu-av": IMenuBaseDetail;
+    "open-menu-blockref": IMenuBaseDetail;
+    "open-menu-breadcrumbmore": {
+        menu: EventMenu,
+        protyle: IProtyle,
+        data: IGetTreeStat,
+    };
+    "open-menu-content": IMenuBaseDetail & { range: Range };
+    "open-menu-fileannotationref": IMenuBaseDetail
+    "open-menu-image": IMenuBaseDetail
+    "open-menu-link": IMenuBaseDetail
+    "open-menu-tag": IMenuBaseDetail
+    "open-menu-doctree": {
+        menu: EventMenu,
+        elements: NodeListOf<Element>,
+        type: "doc" | "docs" | "notebook"
+    };
+    "open-noneditableblock": {
+        protyle: IProtyle,
+        toolbar: Toolbar
+    };
+    "open-siyuan-url-block": {
+        url: string,
+        id: string,
+        focus: boolean,
+        exist: boolean,
+    };
+    "open-siyuan-url-plugin": {
+        url: string
+    }
+    "ws-main": IWebSocketData;
+}
+
+interface IPosition {
+    x: number,
+    y: number,
+    w?: number,
+    h?: number,
+    isLeft?: boolean
 }
 
 interface ITab {
@@ -164,6 +214,9 @@ interface ILuteNode {
 
 interface ISearchOption {
     page?: number
+    removed?: boolean  // 移除后需记录搜索内容 https://github.com/siyuan-note/siyuan/issues/7745
+    name?: string
+    sort?: number,  //  0：按块类型（默认），1：按创建时间升序，2：按创建时间降序，3：按更新时间升序，4：按更新时间降序，5：按内容顺序（仅在按文档分组时），6：按相关度升序，7：按相关度降序
     group?: number,  // 0：不分组，1：按文档分组
     hasReplace?: boolean,
     method?: number //  0：文本，1：查询语法，2：SQL，3：正则表达式
@@ -184,6 +237,7 @@ interface ISearchOption {
         codeBlock: boolean
         htmlBlock: boolean
         embedBlock: boolean
+        databaseBlock: boolean
     }
 }
 
@@ -207,8 +261,9 @@ interface IPluginDockTab {
 }
 
 interface IMenuItemOption {
+    iconClass?: string,
     label?: string,
-    click?: (element: HTMLElement) => void,
+    click?: (element: HTMLElement, event: MouseEvent) => boolean | void | Promise<boolean | void>
     type?: "separator" | "submenu" | "readonly",
     accelerator?: string,
     action?: string,
@@ -460,29 +515,6 @@ export abstract class Plugin {
     }): void
 }
 
-export class Protyle {
-
-    public protyle: any;
-
-    constructor(app: App, element: HTMLElement, options?: IProtyleOption)
-
-    isUploading(): boolean
-
-    destroy(): void
-
-    resize(): void
-
-    reload(focus: boolean): void
-
-    /**
-     * @param {boolean} [isBlock=false]
-     * @param {boolean} [useProtyleRange=false]
-     */
-    insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
-
-    transaction(doOperations: IOperation[], undoOperations?: IOperation[]): void;
-}
-
 export class Setting {
     constructor(options: {
         height?: string,
@@ -564,108 +596,12 @@ export class Menu {
     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;
+export class EventMenu {
+    public menus: IMenuItemOption[];
 
-    public IsValidLinkDest(text: string): boolean;
+    constructor()
 
-    public BlockDOM2InlineBlockDOM(html: string): string;
+    public addSeparator(index?: number): void
 
-    public BlockDOM2HTML(html: string): string;
+    public addItem(menu: IMenuItemOption): void
 }

package/types/events.d.ts

@@ -1,237 +1,8 @@
-import type { IProtyle } from "./protyle";
-import {Menu} from "./../siyuan";
+import type {IProtyle} from "./protyle";
+import {EventMenu} from "./../siyuan";
 
-//#region click-block-icon
-interface IBlockIconDetail {
-    menu: InstanceType<typeof Menu>;
-    protyle: IProtyle;
-    data?: IDocumentData;
-    blockElements?: HTMLElement[];
-}
-
-interface IDocumentData {
-    id: string;
-    ial: Record<string, string>;
-    icon: string;
-    name: string;
-    rootID: string;
-    refIDs: string[];
-    refCount: number;
-    subFileCount: number;
-}
-
-/**
- * `click-blockicon`
- */
-export interface IClickBlockIconDetail extends IBlockIconDetail {
-    blockElements: HTMLElement[];
-}
-
-/**
- * `click-editortitleicon`
- */
-export interface IClickEditorTitleIconDetail extends IBlockIconDetail {
-    data: IDocumentData;
-}
-//#endregion click-block-icon
-
-//#region click-editor-content
-/**
- * `click-editorcontent`
- */
-export interface IClickEditorContentDetail {
-    event: PointerEvent;
-    protyle: IProtyle;
-}
-//#endregion click-editor-content
-
-//#region click-pdf
-/**
- * `click-pdf`
- */
-export interface IClickPdfDetail {
-    event: PointerEvent;
-}
-//#endregion click-pdf
-
-//#region protyle
-/**
- * `loaded-protyle`
- */
-export interface ILoadedProtyleDetail extends IProtyle {
-}
-
-/**
- * `loaded-protyle-dynamic`
- */
-export interface ILoadedProtyleDynamicDetail {
-    protyle: IProtyle;
-    positon: string;
-}
-
-/**
- * `destroy-protyle`
- */
-export interface IDestroyProtyleDetail {
-    protyle: IProtyle;
-}
-//#endregion protyle
-
-//#region input-search
-interface IInputSearchConfig {
-    removed: boolean;
-    k: string;
-    r: string;
-    hasReplace: boolean;
-    method: number;
-    hPath: string;
-    idPath: string[];
-    group: number;
-    sort: number;
-    types: {
-        blockquote: boolean;
-        codeBlock: boolean;
-        document: boolean;
-        embedBlock: boolean;
-        heading: boolean;
-        htmlBlock: boolean;
-        list: boolean;
-        listItem: boolean;
-        mathBlock: boolean;
-        paragraph: boolean;
-        superBlock: boolean;
-        table: boolean;
-    };
-    page: number;
-}
-
-interface IInputSearchProtyle {
-    protyle: IProtyle;
-}
-
-/**
- * `input-search`
- */
-export interface IInputSearchDetail {
-    config: IInputSearchConfig;
-    protyle: IInputSearchProtyle;
-    searchElement: HTMLInputElement;
-}
-//#endregion input-search
-
-//#region open-menu
 interface IMenuBaseDetail {
-    menu: InstanceType<typeof Menu>;
-    protyle: IProtyle;
-}
-
-interface IMenuInlineDetail extends IMenuBaseDetail {
-    element: HTMLSpanElement,
-}
-
-interface IBreadcrumbData {
-    imageCount: number;
-    linkCount: number;
-    refCount: number;
-    runeCount: number;
-    wordCount: number;
-}
-
-/**
- * `open-menu-breadcrumbmore`
- */
-export interface IOpenMenuBreadcrumbMoreDetail extends IMenuBaseDetail {
-    data: IBreadcrumbData;
-}
-
-/**
- * `open-menu-content`
- */
-export interface IOpenMenuContentDetail extends IMenuBaseDetail {
-    element: HTMLDivElement,
-    range: Range;
-}
-
-/**
- * `open-menu-blockref`
- */
-export interface IOpenMenuBlockRefDetail extends IMenuInlineDetail {
-}
-
-/**
- * `open-menu-fileannotationref`
- */
-export interface IOpenMenuFileAnnotationRefDetail extends IMenuInlineDetail {
-}
-
-/**
- * `open-menu-image`
- */
-export interface IOpenMenuImageDetail extends IMenuInlineDetail {
-}
-
-/**
- * `open-menu-link`
- */
-export interface IOpenMenuLinkDetail extends IMenuInlineDetail {
-}
-
-/**
- * `open-menu-tag`
- */
-export interface IOpenMenuTagDetail extends IMenuInlineDetail {
-}
-//#endregion open-menu
-
-//#region open-noneditableblock
-interface INonEditableBlockToolbar {
-    element: HTMLDivElement;
-    range: Range;
-    subElement: HTMLDivElement;
-    subElementCloseCB: () => any;
-    toolbarHeight: number;
-}
-
-/**
- * `open-noneditableblock`
- */
-export interface IOpenNonEditableBlockDetail {
-    protyle: IProtyle;
-    toolbar: INonEditableBlockToolbar;
-}
-//#endregion open-noneditableblock
-
-//#region open-siyuan-url
-interface IOpenSiyuanUrlDetail {
-    url: string;
-}
-
-/**
- * `open-siyuan-url-block`
- */
-export interface IOpenSiyuanUrlBlockDetail extends IOpenSiyuanUrlDetail {
-    id: string;
-    focus: boolean;
-    exist: boolean;
-}
-
-/**
- * `open-siyuan-url-plugin`
-*/
-export interface IOpenSiyuanUrlPluginDetail extends IOpenSiyuanUrlDetail {
-}
-//#endregion open-siyuan-url
-
-//#region ws-main
-/**
- * `ws-main`
- */
-export interface IWebSocketMainDetail {
-    cmd?: string
-    callback?: string
-    data?: any
-    msg: string
-    code: number
-    sid?: string
+    menu: EventMenu,
+    protyle: IProtyle,
+    element: HTMLElement,
 }
-//#endregion ws-main

package/types/protyle.d.ts

@@ -1,4 +1,4 @@
-import {App, Lute} from "./../siyuan";
+import {App, ILuteNode, IObject, IOperation, IPosition, IProtyleOption} from "./../siyuan";
 
 // REF: https://github.com/siyuan-note/siyuan/blob/dev/app/src/types/protyle.d.ts
 export interface IProtyle {
@@ -52,3 +52,162 @@ export interface IProtyle {
     undo?: any;
     wysiwyg?: any;
 }
+
+export class Protyle {
+
+    public protyle: IProtyle;
+
+    constructor(app: App, element: HTMLElement, options?: IProtyleOption)
+
+    isUploading(): boolean
+
+    destroy(): void
+
+    resize(): void
+
+    reload(focus: boolean): void
+
+    /**
+     * @param {boolean} [isBlock=false]
+     * @param {boolean} [useProtyleRange=false]
+     */
+    insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
+
+    transaction(doOperations: IOperation[], undoOperations?: IOperation[]): void;
+}
+
+export class Toolbar {
+    public element: HTMLElement;
+    public subElement: HTMLElement;
+    public subElementCloseCB: () => void;
+    public range: Range;
+
+    constructor(protyle: IProtyle)
+
+    public render(protyle: IProtyle, range: Range, event?: KeyboardEvent)
+
+    public showContent(protyle: IProtyle, range: Range, nodeElement: Element)
+
+    public showWidget(protyle: IProtyle, nodeElement: HTMLElement, range: Range)
+
+    public showTpl(protyle: IProtyle, nodeElement: HTMLElement, range: Range)
+
+    public showCodeLanguage(protyle: IProtyle, languageElement: HTMLElement)
+
+    public showRender(protyle: IProtyle, renderElement: Element, updateElements?: Element[], oldHTML?: string)
+
+    public setInlineMark(protyle: IProtyle, type: string, action: "range" | "toolbar", textObj?: {
+        color?: string,
+        type: string
+    })
+
+    public getCurrentType(range: Range): string[]
+
+    public showAssets(protyle: IProtyle, position: IPosition, avCB?: (url: string) => 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;
+}

package/types/response.d.ts

@@ -0,0 +1,20 @@
+import {IObject} from "../siyuan";
+
+interface IGetDocInfo {
+    ial: IObject
+    icon: number
+    id: number
+    name: number
+    refCount: number
+    refIDs: string[]
+    rootID: string
+    subFileCount: number
+}
+
+interface IGetTreeStat {
+    imageCount: number;
+    linkCount: number;
+    refCount: number;
+    runeCount: number;
+    wordCount: number;
+}

package/types/index.d.ts

@@ -1,2 +0,0 @@
-export * as events from "./events";
-export * as protyle from "./protyle";