🎨 siyuan-note/siyuan#9172

Author: Vanessa219

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## 0.8.4 2023-09
 
+* [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)

siyuan.d.ts

@@ -1,7 +1,9 @@
 import type * as types from "./types";
+import {IProtyle} from "./types/protyle";
 
 declare global {
-    interface Window extends Global { }
+    interface Window extends Global {
+    }
 }
 
 type TEventBus = keyof IEventBusMap
@@ -23,6 +25,51 @@ type TProtyleAction = "cb-get-append" | // 向下滚动加载
     "cb-get-html" | // 直接渲染，不需要再 /api/block/getDocInfo，否则搜索表格无法定位
     "cb-get-history" // 历史渲染
 
+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;
 }
@@ -227,6 +274,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>;
@@ -293,6 +359,8 @@ export function confirm(title: string, text: string, confirmCallback?: (dialog:
  */
 export function showMessage(text: string, timeout?: number, type?: "info" | "error", id?: string): void;
 
+export function transaction(protyle: IProtyle, doOperations: IOperation[], undoOperations: IOperation[]): void;
+
 export class App {
     plugins: Plugin[];
 }

types/events.d.ts

@@ -1,9 +1,9 @@
-import type siyuan from "./../siyuan";
 import type { IProtyle } from "./protyle";
+import {Menu} from "./../siyuan";
 
 //#region click-block-icon
 interface IBlockIconDetail {
-    menu: InstanceType<typeof siyuan.Menu>;
+    menu: InstanceType<typeof Menu>;
     protyle: IProtyle;
     data?: IDocumentData;
     blockElements?: HTMLElement[];
@@ -121,7 +121,7 @@ export interface IInputSearchDetail {
 
 //#region open-menu
 interface IMenuBaseDetail {
-    menu: InstanceType<typeof siyuan.Menu>;
+    menu: InstanceType<typeof Menu>;
     protyle: IProtyle;
 }
 

types/protyle.d.ts

@@ -1,8 +1,8 @@
-import type siyuan from "./../siyuan";
+import {App, Lute} from "./../siyuan";
 
 // REF: https://github.com/siyuan-note/siyuan/blob/dev/app/src/types/protyle.d.ts
 export interface IProtyle {
-    app: any;
+    app: App;
     transactionTime: number;
     id: string;
     block: {
@@ -44,7 +44,7 @@ export interface IProtyle {
     };
     contentElement?: HTMLElement;
     options: any;
-    lute?: siyuan.Lute;
+    lute?: Lute;
     toolbar?: any;
     preview?: any;
     hint?: any;