siyuan 0.7.3 → 0.7.5

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v0.7.5
+
+* [Add protyleSlash to the plugin](https://github.com/siyuan-note/siyuan/issues/8599)
+* [Add plugin API protyle ](https://github.com/siyuan-note/siyuan/issues/8445)
+* [Add ICommand.langText and change the type of i18n](https://github.com/siyuan-note/petal/pull/11)
+
+## v0.7.4 2023-06-13
+1. [Add `beforeDestroy`](https://github.com/siyuan-note/siyuan/issues/8467)
+
 ## v0.7.2
 1. 更换为 SiYuan 官方 API
 

package/package.json

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

package/siyuan.d.ts

@@ -35,6 +35,10 @@ interface IObject {
     [key: string]: string;
 }
 
+interface I18N {
+    [key: string]: any;
+}
+
 interface ILuteNode {
     TokensStr: () => string;
     __internal_object__: {
@@ -107,7 +111,8 @@ interface IMenuItemOption {
 }
 
 interface ICommandOption {
-    langKey: string, // 多语言 key
+    langKey: string, // 用于区分不同快捷键的 key
+    langText?: string, // 快捷键功能描述文本
     /**
      * 目前需使用 MacOS 符号标识，顺序按照 ⌥⇧⌘，入 ⌥⇧⌘A
      * "Ctrl": "⌘",
@@ -126,6 +131,35 @@ interface ICommandOption {
     dockCallback?: (element: HTMLElement) => void
 }
 
+interface IProtyleOption {
+    action?: string[],
+    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 function fetchPost(url: string, data?: any, callback?: (response: IWebSocketData) => void, headers?: IObject): void;
 
 export function fetchSyncPost(url: string, data?: any): Promise<IWebSocketData>;
@@ -185,17 +219,23 @@ export class App {
 
 export abstract class Plugin {
     eventBus: EventBus;
-    i18n: IObject;
+    i18n: I18N;
     data: any;
     name: string;
     app: App;
     commands: ICommandOption[];
     setting: Setting;
+    protyleSlash: {
+        filter: string[],
+        html: string,
+        id: string
+        callback(protyle: Protyle): void
+    }[];
 
     constructor(options: {
         app: App,
         name: string,
-        i18n: IObject
+        i18n: I18N
     })
 
     onload(): void;
@@ -240,6 +280,7 @@ export abstract class Plugin {
      */
     addTab(options: {
         type: string,
+        beforeDestroy?: () => void,
         destroy?: () => void,
         resize?: () => void,
         update?: () => void,
@@ -270,6 +311,24 @@ export abstract class Plugin {
     }): void
 }
 
+export class Protyle {
+    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,