siyuan 0.8.9 → 0.9.1

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 
-## 0.9.0 2023-12
+## 0.9.2 2024-01
+
+
+## 0.9.1 2023-12-26
+
+* [Set `plugin.name` to read-only](https://github.com/siyuan-note/siyuan/issues/9943)
+* [Support `Dock Plugin` and `Command Palette` on mobile](https://github.com/siyuan-note/siyuan/issues/9926)
+
+## 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 `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)
 
 ## 0.8.9 2023-11-28
 
@@ -78,49 +90,62 @@
 * [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
 
 ## 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/package.json

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

package/siyuan.d.ts

@@ -11,6 +11,12 @@ declare global {
 
 export type TEventBus = keyof IEventBusMap
 
+export type TTurnIntoOne = "BlocksMergeSuperBlock" | "Blocks2ULs" | "Blocks2OLs" | "Blocks2TLs" | "Blocks2Blockquote"
+
+export type TTurnIntoOneSub = "row" | "col"
+
+export type TTurnInto = "Blocks2Ps" | "Blocks2Hs"
+
 export type TCardType = "doc" | "notebook" | "all"
 
 export type TProtyleAction = "cb-get-append" | // 向下滚动加载
@@ -185,6 +191,11 @@ export interface IEventBusMap {
         files: FileList | DataTransferItemList;
     }
     "ws-main": IWebSocketData;
+    "sync-start": IWebSocketData;
+    "sync-end": IWebSocketData;
+    "sync-fail": IWebSocketData;
+    "mobile-keyboard-show": void;
+    "mobile-keyboard-hide": void;
 }
 
 export interface IPosition {
@@ -418,7 +429,7 @@ export function openWindow(options: {
     },
 }): void;
 
-export function openMobileFileById(app: App, id: string, action: string[]): void;
+export function openMobileFileById(app: App, id: string, action?: string[]): void;
 
 export function openTab(options: {
     app: App,
@@ -477,7 +488,7 @@ export abstract class Plugin {
     i18n: I18N;
     data: any;
     displayName: string;
-    name: string;
+    readonly name: string;
     app: App;
     commands: ICommandOption[];
     setting: Setting;
@@ -555,7 +566,7 @@ export abstract class Plugin {
         destroy?: (this: IDockModel) => void,
         resize?: (this: IDockModel) => void,
         update?: (this: IDockModel) => void,
-        init: (this: IDockModel) => void,
+        init: (this: IDockModel, dock: IDockModel) => void,
     }): { config: IPluginDockTab, model: IDockModel };
 
     addCommand(options: ICommandOption): void;

package/types/protyle.d.ts

@@ -1,4 +1,13 @@
-import {App, ILuteNode, IObject, IOperation, IPosition, IProtyleOption} from "./../siyuan";
+import {
+    App,
+    ILuteNode,
+    IObject,
+    IOperation,
+    IPosition,
+    IProtyleOption, TTurnInto,
+    TTurnIntoOne,
+    TTurnIntoOneSub
+} from "./../siyuan";
 
 // REF: https://github.com/siyuan-note/siyuan/blob/dev/app/src/types/protyle.d.ts
 export interface IProtyle {
@@ -74,6 +83,33 @@ export class Protyle {
     insert(html: string, isBlock?: boolean, useProtyleRange?: boolean): void
 
     transaction(doOperations: IOperation[], undoOperations?: IOperation[]): void;
+
+    /**
+     * 多个块转换为一个块
+     * @param {TTurnIntoOneSub} [subType] type 为 "BlocksMergeSuperBlock" 时必传
+     */
+    public turnIntoOneTransaction(selectsElement: Element[], type: TTurnIntoOne, subType?: TTurnIntoOneSub): void
+
+    /**
+     * 多个块转换
+     * @param {Element} [nodeElement] 优先使用包含 protyle-wysiwyg--select 的块，否则使用 nodeElement 单块
+     * @param type
+     * @param {number} [subType] type 为 "Blocks2Hs" 时必传
+     */
+    public turnIntoTransaction(nodeElement: Element, type: TTurnInto, subType?: number): void
+
+    public updateTransaction(id: string, newHTML: string, html: string): void
+
+    public updateBatchTransaction(nodeElements: Element[], cb: (e: HTMLElement) => void): void
+
+    public getRange(element: Element): Range
+
+    public hasClosestBlock(element: Node): false | HTMLElement
+
+    /**
+     * @param {boolean} [toStart=true]
+     */
+    public focusBlock(element: Element, toStart?: boolean): false | Range
 }
 
 export class Toolbar {