siyuan 0.8.1 → 0.8.3

package/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
-## 0.8.2 2023-08
+## 0.8.4 2023-09
+
+## 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
+
+* [Improve IModel type definitions](https://github.com/siyuan-note/petal/pull/14)
+* [Add plugin type `TProtyleAction`](https://github.com/siyuan-note/siyuan/issues/8988)
+* [Add plugin event bus `destroy-protyle`](https://github.com/siyuan-note/siyuan/issues/9033)
+* [Add plugin event bus `loaded-protyle-dynamic`](https://github.com/siyuan-note/siyuan/issues/9021)
 
 ## 0.8.1 2023-08-21
 

package/package.json

@@ -2,6 +2,6 @@
     "name": "siyuan",
     "contributors": ["zuoez02", "Vanessa"],
     "types": "siyuan.d.ts",
-    "version": "0.8.1",
+    "version": "0.8.3",
     "repository": "https://github.com/siyuan-note/petal"
 }

package/siyuan.d.ts

@@ -5,10 +5,26 @@ type TEventBus = "ws-main" |
     "open-menu-av" | "open-menu-content" | "open-menu-breadcrumbmore" |
     "open-siyuan-url-plugin" | "open-siyuan-url-block" |
     "input-search" |
-    "loaded-protyle"
+    "loaded-protyle" | "loaded-protyle-dynamic" |
+    "destroy-protyle"
 
 type TCardType = "doc" | "notebook" | "all"
 
+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-all" | // 获取所有块
+    "cb-get-backlink" | // 悬浮窗为传递型需展示上下文
+    "cb-get-unundo" | // 不需要记录历史
+    "cb-get-scroll" | // 滚动到指定位置
+    "cb-get-context" | // 包含上下文
+    "cb-get-html" | // 直接渲染，不需要再 /api/block/getDocInfo，否则搜索表格无法定位
+    "cb-get-history" // 历史渲染
+
 declare global {
     interface Window {
         Lute: Lute
@@ -31,10 +47,35 @@ interface ITab {
 }
 
 interface IModel {
-    element: Element;
+    ws: WebSocket;
+    app: App;
+    reqId: number;
+    parent: ITab | any;
+
+    send(cmd: string, param: Record<string, unknown>, process?: boolean): void;
+}
+
+interface ICustomModel extends IModel {
     tab: ITab;
     data: any;
     type: string;
+    element: HTMLElement;
+
+    init(): void;
+
+    update?(): void;
+
+    resize?(): void;
+
+    beforeDestroy?(): void;
+
+    destroy?(): void;
+}
+
+interface IDockModel extends Omit<ICustomModel, "beforeDestroy"> {
+}
+
+interface ITabModel extends ICustomModel {
 }
 
 interface IObject {
@@ -131,14 +172,15 @@ 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 {
-    action?: string[],
+    action?: TProtyleAction[],
     mode?: "preview" | "wysiwyg",
     blockId: string
     key?: string
@@ -172,11 +214,24 @@ 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?: {
         id: string,     // 块 id
-        action?: string [] // cb-get-all：获取所有内容；cb-get-focus：打开后光标定位在 id 所在的块；cb-get-hl: 打开后 id 块高亮
+        action?: string[] // cb-get-all：获取所有内容；cb-get-focus：打开后光标定位在 id 所在的块；cb-get-hl: 打开后 id 块高亮
         zoomIn?: boolean // 是否缩放
     },
     pdf?: {
@@ -197,7 +252,7 @@ export function openTab(options: {
         title: string,
         icon: string,
         data?: any
-        id: string,
+        id: string, // 插件名称+页签类型：plugin.name + tab.type
     }
     position?: "right" | "bottom",
     keepCursor?: boolean // 是否跳转到新 tab 上
@@ -282,19 +337,19 @@ export abstract class Plugin {
 
     addIcons(svg: string): void;
 
-    getOpenedTab(): { [key: string]: IModel[] } ;
+    getOpenedTab(): { [key: string]: ICustomModel[] };
 
     /**
      * Must be executed before the synchronous function.
      */
     addTab(options: {
         type: string,
-        beforeDestroy?: () => void,
-        destroy?: () => void,
-        resize?: () => void,
-        update?: () => void,
-        init: () => void
-    }): () => IModel
+        beforeDestroy?: (this: ITabModel) => void,
+        destroy?: (this: ITabModel) => void,
+        resize?: (this: ITabModel) => void,
+        update?: (this: ITabModel) => void,
+        init: (this: ITabModel) => void
+    }): () => ITabModel
 
     /**
      * Must be executed before the synchronous function.
@@ -303,11 +358,11 @@ export abstract class Plugin {
         config: IPluginDockTab,
         data: any,
         type: string,
-        destroy?: () => void,
-        resize?: () => void,
-        update?: () => void,
-        init: () => void
-    }): { config: IPluginDockTab, model: IModel }
+        destroy?: (this: IDockModel) => void,
+        resize?: (this: IDockModel) => void,
+        update?: (this: IDockModel) => void,
+        init: (this: IDockModel) => void
+    }): { config: IPluginDockTab, model: IDockModel }
 
     addCommand(options: ICommandOption): void