siyuan 0.9.1 → 0.9.2

package/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
-## 0.9.2 2024-01
+## 0.9.3 2024-01
 
 
+## 0.9.2 2024-01-09
+
+* [Add plugin `protyleOptions`](https://github.com/siyuan-note/siyuan/issues/10090)
+* [Add plugin api `uninstall`](https://github.com/siyuan-note/siyuan/issues/10063)
+* [Add plugin method `updateCards`](https://github.com/siyuan-note/siyuan/issues/10065)
+* [Add plugin function `lockScreen`](https://github.com/siyuan-note/siyuan/issues/10063)
+* [Add plugin event bus `lock-screen`](https://github.com/siyuan-note/siyuan/pull/9967)
+* [Add plugin event bus `open-menu-inbox`](https://github.com/siyuan-note/siyuan/pull/9967)
+
 ## 0.9.1 2023-12-26
 
 * [Set `plugin.name` to read-only](https://github.com/siyuan-note/siyuan/issues/9943)
@@ -10,7 +19,7 @@
 
 ## 0.9.0 2023-12-05
 
-* [Add plugin eventbus `sync-start`, `sync-end`, and `sync-fail`](https://github.com/siyuan-note/siyuan/issues/9798)
+* [Add plugin event bus `sync-start`, `sync-end`, and `sync-fail`](https://github.com/siyuan-note/siyuan/issues/9798)
 * [Add plugin event bus `mobile-keyboard-show` and `mobile-keyboard-hide`](https://github.com/siyuan-note/siyuan/issues/9773)
 * [Add some `Protyle` methods to the plugin API](https://github.com/siyuan-note/petal/issues/21)
 

package/package.json

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

package/siyuan.d.ts

@@ -1,6 +1,6 @@
 export * from "./types";
 
-import {IProtyle, Lute, Protyle, Toolbar} from "./types/protyle";
+import {IProtyle, Lute, Protyle, Toolbar, IProtyleOption} from "./types/protyle";
 import {IMenuBaseDetail} from "./types/events";
 import {IGetDocInfo, IGetTreeStat} from "./types/response";
 
@@ -19,21 +19,6 @@ export type TTurnInto = "Blocks2Ps" | "Blocks2Hs"
 
 export type TCardType = "doc" | "notebook" | "all"
 
-export 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" // 历史渲染
-
 export type TOperation =
     "insert"
     | "update"
@@ -169,6 +154,11 @@ export interface IEventBusMap {
         elements: NodeListOf<HTMLElement>,
         type: "doc" | "docs" | "notebook",
     };
+    "open-menu-inbox": {
+        menu: EventMenu,
+        element: HTMLElement,
+        ids: string[],
+    };
     "open-noneditableblock": {
         protyle: IProtyle,
         toolbar: Toolbar,
@@ -194,6 +184,7 @@ export interface IEventBusMap {
     "sync-start": IWebSocketData;
     "sync-end": IWebSocketData;
     "sync-fail": IWebSocketData;
+    "lock-screen": void;
     "mobile-keyboard-show": void;
     "mobile-keyboard-hide": void;
 }
@@ -362,38 +353,11 @@ export interface ICommandOption {
     dockCallback?: (element: HTMLElement) => void // 焦点在 dock 上时执行的回调
 }
 
-export interface IProtyleOption {
-    action?: TProtyleAction[];
-    mode?: "preview" | "wysiwyg";
-    blockId: string;
-    key?: string;
-    scrollAttr?: {
-        rootId: string,
-        startId: string,
-        endId: string,
-        scrollTop: number,
-        focusId?: string,
-        focusStart?: number,
-        focusEnd?: number,
-        zoomInId?: string,
-    };
-    defId?: string;
-    render?: {
-        background?: boolean,
-        title?: boolean,
-        gutter?: boolean,
-        scroll?: boolean,
-        breadcrumb?: boolean,
-        breadcrumbDocName?: boolean,
-    };
-    typewriterMode?: boolean;
-
-    after?(protyle: Protyle): void;
-}
-
 export interface IOperation {
     action: TOperation; // move， delete 不需要传 data
     id?: string;
+    isTwoWay?: boolean; // 是否双向关联
+    backRelationKeyID?: string; // 双向关联的目标关联列 ID
     avID?: string; // av
     format?: string; // updateAttrViewColNumberFormat 专享
     keyID?: string; // updateAttrViewCell 专享
@@ -403,6 +367,7 @@ export interface IOperation {
     previousID?: string;
     retData?: any;
     nextID?: string; // insert 专享
+    isDetached?: boolean; // insertAttrViewBlock 专享
     srcIDs?: string[]; // insertAttrViewBlock 专享
     name?: string; // addAttrViewCol 专享
     type?: TAVCol; // addAttrViewCol 专享
@@ -410,6 +375,20 @@ export interface IOperation {
     blockIDs?: string[]; // add/removeFlashcards 专享
 }
 
+export interface ICard {
+    deckID: string
+    cardID: string
+    blockID: string
+    nextDues: IObject
+}
+
+export interface ICardData {
+    cards: ICard[],
+    unreviewedCount: number
+    unreviewedNewCardCount: number
+    unreviewedOldCardCount: number
+}
+
 export function fetchPost(url: string, data?: any, callback?: (response: IWebSocketData) => void, headers?: IObject): void;
 
 export function fetchSyncPost(url: string, data?: any): Promise<IWebSocketData>;
@@ -466,6 +445,8 @@ export function openTab(options: {
 
 export function getFrontend(): "desktop" | "desktop-window" | "mobile" | "browser-desktop" | "browser-mobile";
 
+export function lockScreen(app: App): void
+
 export function getBackend(): "windows" | "linux" | "darwin" | "docker" | "android" | "ios";
 
 export function adaptHotkey(hotkey: string): string;
@@ -498,6 +479,7 @@ export abstract class Plugin {
         id: string,
         callback(protyle: Protyle): void,
     }[];
+    protyleOptions: IProtyleOption;
 
     constructor(options: {
         app: App,
@@ -509,6 +491,8 @@ export abstract class Plugin {
 
     onunload(): void;
 
+    uninstall(): void;
+
     onLayoutReady(): void;
 
     /**
@@ -578,6 +562,8 @@ export abstract class Plugin {
         y?: number,
         targetElement?: HTMLElement
     }): void;
+
+    updateCards(options: ICardData): Promise<ICardData> | ICardData;
 }
 
 export class Setting {

package/types/protyle.d.ts

@@ -4,11 +4,70 @@ import {
     IObject,
     IOperation,
     IPosition,
-    IProtyleOption, TTurnInto,
+    TTurnInto,
     TTurnIntoOne,
     TTurnIntoOneSub
 } from "./../siyuan";
 
+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" // 历史渲染
+
+interface IToolbarItem {
+    /** 唯一标示 */
+    name: string;
+    /** 提示 */
+    tip?: string;
+    /** svg 图标 */
+    icon: string;
+    /** 快捷键 */
+    hotkey?: string;
+    /** 提示位置 */
+    tipPosition: string;
+    click?(protyle: Protyle): void;
+}
+
+export interface IProtyleOption {
+    action?: TProtyleAction[];
+    mode?: "preview" | "wysiwyg";
+    toolbar?: Array<string | IToolbarItem>;
+    blockId?: string;
+    key?: string;
+    scrollAttr?: {
+        rootId: string,
+        startId: string,
+        endId: string,
+        scrollTop: number,
+        focusId?: string,
+        focusStart?: number,
+        focusEnd?: number,
+        zoomInId?: string,
+    };
+    defId?: string;
+    render?: {
+        background?: boolean,
+        title?: boolean,
+        gutter?: boolean,
+        scroll?: boolean,
+        breadcrumb?: boolean,
+        breadcrumbDocName?: boolean,
+    };
+    typewriterMode?: boolean;
+
+    after?(protyle: Protyle): void;
+}
+
 // REF: https://github.com/siyuan-note/siyuan/blob/dev/app/src/types/protyle.d.ts
 export interface IProtyle {
     app: App;
@@ -54,7 +113,7 @@ export interface IProtyle {
     contentElement?: HTMLElement;
     options: any;
     lute?: Lute;
-    toolbar?: any;
+    toolbar?: Toolbar;
     preview?: any;
     hint?: any;
     upload?: any;