siyuan 0.8.2 → 0.8.4

package/CHANGELOG.md

@@ -1,6 +1,16 @@
 # Changelog
 
-## 0.8.3 2023-09
+## 0.8.5 2023-09
+
+## 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
+
+* [Plugin API add openWindow and command.globalCallback](https://github.com/siyuan-note/siyuan/issues/9032)
 
 ## 0.8.2 2023-08-29
 

package/package.json

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

package/siyuan.d.ts

@@ -1,12 +1,12 @@
-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 type * as types from "./types";
+import {IProtyle} from "./types/protyle";
+
+declare global {
+    interface Window extends Global {
+    }
+}
+
+type TEventBus = keyof IEventBusMap
 
 type TCardType = "doc" | "notebook" | "all"
 
@@ -25,10 +25,76 @@ 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": 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;
 }
 
 interface ITab {
@@ -51,6 +117,7 @@ interface IModel {
     app: App;
     reqId: number;
     parent: ITab | any;
+
     send(cmd: string, param: Record<string, unknown>, process?: boolean): void;
 }
 
@@ -59,10 +126,15 @@ interface ICustomModel extends IModel {
     data: any;
     type: string;
     element: HTMLElement;
+
     init(): void;
+
     update?(): void;
+
     resize?(): void;
+
     beforeDestroy?(): void;
+
     destroy?(): void;
 }
 
@@ -166,10 +238,11 @@ interface ICommandOption {
      */
     hotkey: string,
     customHotkey?: string,
-    callback?: () => void
-    fileTreeCallback?: (file: any) => void
-    editorCallback?: (protyle: any) => void
-    dockCallback?: (element: HTMLElement) => void
+    callback?: () => void   // 其余回调存在时将不会触
+    globalCallback?: () => void // 焦点不在应用内时执行的回调
+    fileTreeCallback?: (file: any) => void // 焦点在文档树上时执行的回调
+    editorCallback?: (protyle: any) => void     // 焦点在编辑器上时执行的回调
+    dockCallback?: (element: HTMLElement) => void    // 焦点在 dock 上时执行的回调
 }
 
 interface IProtyleOption {
@@ -201,12 +274,44 @@ 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>;
 
 export function fetchGet(url: string, callback: (response: IWebSocketData) => void): void;
 
+export function openWindow(options: {
+    position?: {
+        x: number,
+        y: number,
+    },
+    height?: number,
+    width?: number,
+    tab?: ITab,
+    doc?: {
+        id: string,     // 块 id
+    },
+}): void;
+
 export function openTab(options: {
     app: App,
     doc?: {
@@ -374,6 +479,8 @@ export class Protyle {
      * @param {boolean} [useProtyleRange=false]
      */
     insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
+
+    transaction(doOperations: IOperation[], undoOperations?: IOperation[]): void;
 }
 
 export class Setting {
@@ -395,13 +502,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 {
@@ -427,6 +546,8 @@ export class Dialog {
 export class Menu {
     constructor(id?: string, closeCallback?: () => void);
 
+    element: HTMLElement;
+
     showSubMenu(subMenuElement: HTMLElement): void;
 
     addItem(options: IMenuItemOption): HTMLElement;

package/types/events.d.ts

@@ -0,0 +1,237 @@
+import type { IProtyle } from "./protyle";
+import {Menu} 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
+}
+//#endregion ws-main

package/types/index.d.ts

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

package/types/protyle.d.ts

@@ -0,0 +1,54 @@
+import {App, Lute} 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;
+}