siyuan 0.7.2 → 0.7.4

package/CHANGELOG.md

@@ -0,0 +1,49 @@
+# Changelog
+
+## v0.7.4 2023-06-13
+1. [Add `beforeDestroy`](https://github.com/siyuan-note/siyuan/issues/8467)
+
+## v0.7.2
+1. 更换为 SiYuan 官方 API
+
+## v0.7.0
+1. 添加版本自动判断
+2. 添加插件系统内置配置页面支持插件注入
+3. 修复export classes
+
+## v0.5.0
+1. 插件系统国际化
+2. 插件支持卸载
+3. 插件商店预览功能
+
+## v0.4.0
+1. 插件系统已支持浏览器使用，需思源2.8.1及以上版本。 **注意：大量插件目前对web的支持并不好，需要等待插件开发者进行适配。建议还是在桌面端使用。**
+2. 升级过程中将原版代码挂件loader迁移到挂件版路径，但不会下载挂件。
+3. 挂件版用户记得更新到最新版本挂件
+
+## v0.3.21
++ 挂件版本不进行自动升级，即使勾选了自动升级功能
+
+## v0.3.20
++ 新增功能：命令面板
++ 重构：修改vite构建脚本，移除dist
+
+## v0.3.19
++ 修改图标
++ eslint重构代码
+
+## v0.3.13
++ 增加插件商店，并可配置插件商店地址
++ 暴露PluginSystem及Ioc容器到window对象
+
+## v0.3.12
++ 重构API接口，支持自动化导出api类型声明
+
+## v0.3.11
++ 增加通过Plugin继承调用registerCommand，实现插件快捷键注册。未来将通过此方式开发命令面板。
+
+## v0.3.10
++ 修复没有plugins时初次安装遇到的问题
+
+## v0.3.9
++ 适配思源2.7.7，调整配置界面布局

package/README.md

@@ -1,3 +1,3 @@
-# Siyuan Plugin API
+# SiYuan Plugin API
 
-This is Siyuan Plugin System API. Only types declaration here.
+Here is the API declaration of SiYuan Plugin System, usages please refer to  [SiYuan plugin sample](https://github.com/siyuan-note/plugin-sample).

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "siyuan",
-    "author": ["zuoez02", "Vanessa"],
+    "contributors": ["zuoez02", "Vanessa"],
     "types": "siyuan.d.ts",
-    "version": "0.7.2",
-    "repository": "https://github.com/siyuan-note/petal/type"
+    "version": "0.7.4",
+    "repository": "https://github.com/siyuan-note/petal"
 }

package/siyuan.d.ts

@@ -1,5 +1,5 @@
 type TEventBus = "ws-main" | "click-blockicon" | "click-editorcontent" | "click-pdf" |
-    "click-editortitleicon" | "open-noneditableblock"
+    "click-editortitleicon" | "open-noneditableblock" | "loaded-protyle"
 
 type TCardType = "doc" | "notebook" | "all"
 
@@ -79,7 +79,7 @@ interface IWebSocketData {
     sid: string
 }
 
-declare interface IPluginDockTab {
+interface IPluginDockTab {
     position: "LeftTop" | "LeftBottom" | "RightTop" | "RightBottom" | "BottomLeft" | "BottomRight",
     size: { width: number, height: number },
     icon: string,
@@ -190,6 +190,7 @@ export abstract class Plugin {
     name: string;
     app: App;
     commands: ICommandOption[];
+    setting: Setting;
 
     constructor(options: {
         app: App,
@@ -206,6 +207,7 @@ export abstract class Plugin {
     /**
      * Must be executed before the synchronous function.
      * @param {string} [options.position=right]
+     * @param {string} options.icon - Support svg id or svg tag.
      */
     addTopBar(options: {
         icon: string,
@@ -238,6 +240,7 @@ export abstract class Plugin {
      */
     addTab(options: {
         type: string,
+        beforeDestroy?: () => void,
         destroy?: () => void,
         resize?: () => void,
         update?: () => void,
@@ -268,6 +271,24 @@ export abstract class Plugin {
     }): void
 }
 
+export class Setting {
+    constructor(options: {
+        height?: string,
+        width?: string,
+        destroyCallback?: () => void
+        confirmCallback?: () => void
+    })
+
+    addItem(options: {
+        title: string
+        description?: string
+        actionElement?: HTMLElement
+        createActionElement?(): HTMLElement
+    }): void;
+
+    open(name: string): void;
+}
+
 export class EventBus {
     on(type: TEventBus, listener: (event: CustomEvent<any>) => void): void;
 
@@ -317,7 +338,7 @@ export class Menu {
     close(): void;
 }
 
-declare class Lute {
+export class Lute {
     public static WalkStop: number;
     public static WalkSkipChildren: number;
     public static WalkContinue: number;