siyuan 0.8.3 → 0.8.5

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## 0.8.4 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
+
+* [Improve `Menu`](https://github.com/siyuan-note/petal/pull/16)
+* [Add plugin function `transaction`](https://github.com/siyuan-note/siyuan/issues/9172)
+* [Add `CustomEvent` type definition](https://github.com/siyuan-note/petal/pull/15)
 
 ## 0.8.3 2023-09-05
 

package/package.json

@@ -1,7 +1,17 @@
 {
     "name": "siyuan",
-    "contributors": ["zuoez02", "Vanessa"],
+    "contributors": [
+        "zuoez02",
+        "Vanessa"
+    ],
     "types": "siyuan.d.ts",
-    "version": "0.8.3",
+    "files": [
+        "types",
+        "CHANGELOG.md",
+        "package.json",
+        "README.md",
+        "siyuan.d.ts"
+    ],
+    "version": "0.8.5",
     "repository": "https://github.com/siyuan-note/petal"
 }

package/siyuan.d.ts

@@ -1,12 +1,13 @@
-type TEventBus = "ws-main" |
-    "click-blockicon" | "click-editorcontent" | "click-pdf" | "click-editortitleicon" |
-    "open-noneditableblock" |
-    "open-menu-blockref" | "open-menu-fileannotationref" | "open-menu-tag" | "open-menu-link" | "open-menu-image" |
-    "open-menu-av" | "open-menu-content" | "open-menu-breadcrumbmore" |
-    "open-siyuan-url-plugin" | "open-siyuan-url-block" |
-    "input-search" |
-    "loaded-protyle" | "loaded-protyle-dynamic" |
-    "destroy-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 {
+    }
+}
+
+type TEventBus = keyof IEventBusMap
 
 type TCardType = "doc" | "notebook" | "all"
 
@@ -25,10 +26,125 @@ type TProtyleAction = "cb-get-append" | // 向下滚动加载
     "cb-get-html" | // 直接渲染，不需要再 /api/block/getDocInfo，否则搜索表格无法定位
     "cb-get-history" // 历史渲染
 
-declare global {
-    interface Window {
-        Lute: Lute
+type TOperation =
+    "insert"
+    | "update"
+    | "delete"
+    | "move"
+    | "foldHeading"
+    | "unfoldHeading"
+    | "setAttrs"
+    | "updateAttrs"
+    | "append"
+    | "insertAttrViewBlock"
+    | "removeAttrViewBlock"
+    | "addAttrViewCol"
+    | "removeAttrViewCol"
+    | "addFlashcards"
+    | "removeFlashcards"
+    | "updateAttrViewCell"
+    | "updateAttrViewCol"
+    | "sortAttrViewRow"
+    | "sortAttrViewCol"
+    | "setAttrViewColHidden"
+    | "setAttrViewColWrap"
+    | "setAttrViewColWidth"
+    | "updateAttrViewColOptions"
+    | "removeAttrViewColOption"
+    | "updateAttrViewColOption"
+    | "setAttrViewName"
+    | "setAttrViewFilters"
+    | "setAttrViewSorts"
+    | "setAttrViewColCalc"
+    | "updateAttrViewColNumberFormat"
+
+type TAVCol =
+    "text"
+    | "date"
+    | "number"
+    | "relation"
+    | "rollup"
+    | "select"
+    | "block"
+    | "mSelect"
+    | "url"
+    | "email"
+    | "phone"
+
+interface Global {
+    Lute: Lute;
+}
+
+interface IEventBusMap {
+    "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 {
@@ -98,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：正则表达式
@@ -118,6 +237,7 @@ interface ISearchOption {
         codeBlock: boolean
         htmlBlock: boolean
         embedBlock: boolean
+        databaseBlock: boolean
     }
 }
 
@@ -141,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,
@@ -208,6 +329,25 @@ interface IProtyleOption {
     after?(protyle: Protyle): void;
 }
 
+interface IOperation {
+    action: TOperation, // move， delete 不需要传 data
+    id?: string,
+    avID?: string,  // av
+    format?: string // updateAttrViewColNumberFormat 专享
+    keyID?: string // updateAttrViewCell 专享
+    rowID?: string // updateAttrViewCell 专享
+    data?: any, // updateAttr 时为  { old: IObject, new: IObject }, updateAttrViewCell 时为 {TAVCol: {content: string}}
+    parentID?: string
+    previousID?: string
+    retData?: any
+    nextID?: string // insert 专享
+    srcIDs?: string[] // insertAttrViewBlock 专享
+    name?: string // addAttrViewCol 专享
+    type?: TAVCol // addAttrViewCol 专享
+    deckID?: string // add/removeFlashcards 专享
+    blockIDs?: string[] // add/removeFlashcards 专享
+}
+
 export function fetchPost(url: string, data?: any, callback?: (response: IWebSocketData) => void, headers?: IObject): void;
 
 export function fetchSyncPost(url: string, data?: any): Promise<IWebSocketData>;
@@ -375,27 +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
-}
-
 export class Setting {
     constructor(options: {
         height?: string,
@@ -415,13 +534,25 @@ export class Setting {
 }
 
 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;
+    on<
+        K extends TEventBus,
+        D = IEventBusMap[K],
+    >(type: K, listener: (event: CustomEvent<D>) => any): void;
+
+    once<
+        K extends TEventBus,
+        D = IEventBusMap[K],
+    >(type: K, listener: (event: CustomEvent<D>) => any): void;
+
+    off<
+        K extends TEventBus,
+        D = IEventBusMap[K],
+    >(type: K, listener: (event: CustomEvent<D>) => any): void;
+
+    emit<
+        K extends TEventBus,
+        D = IEventBusMap[K],
+    >(type: K, detail?: D): boolean;
 }
 
 export class Dialog {
@@ -447,6 +578,8 @@ export class Dialog {
 export class Menu {
     constructor(id?: string, closeCallback?: () => void);
 
+    element: HTMLElement;
+
     showSubMenu(subMenuElement: HTMLElement): void;
 
     addItem(options: IMenuItemOption): HTMLElement;
@@ -463,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

@@ -0,0 +1,8 @@
+import type {IProtyle} from "./protyle";
+import {EventMenu} from "./../siyuan";
+
+interface IMenuBaseDetail {
+    menu: EventMenu,
+    protyle: IProtyle,
+    element: HTMLElement,
+}

package/types/protyle.d.ts

@@ -0,0 +1,213 @@
+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 {
+    app: App;
+    transactionTime: number;
+    id: string;
+    block: {
+        id?: string;
+        scroll?: boolean;
+        parentID?: string;
+        parent2ID?: string;
+        rootID?: string;
+        showAll?: boolean;
+        mode?: number;
+        blockCount?: number;
+        action?: string[];
+    };
+    disabled: boolean;
+    selectElement?: HTMLElement;
+    ws?: any;
+    notebookId?: string;
+    path?: string;
+    model?: any;
+    updated: boolean;
+    element: HTMLElement;
+    scroll?: any;
+    gutter?: any;
+    breadcrumb?: {
+        id: string;
+        element: HTMLElement;
+    };
+    title?: {
+        editElement: HTMLElement;
+        element: HTMLElement;
+    };
+    background?: {
+        element: HTMLElement;
+        ial: Record<string, string>;
+        iconElement: HTMLElement;
+        imgElement: HTMLElement;
+        tagsElement: HTMLElement;
+        transparentData: string;
+    };
+    contentElement?: HTMLElement;
+    options: any;
+    lute?: Lute;
+    toolbar?: any;
+    preview?: any;
+    hint?: any;
+    upload?: any;
+    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;
+}