siyuan 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Changelog
 
-## v1.1.1 2025-03
+## v1.1.2 2025-07-22
+
+* [Add plugin option `IProtyleOptions.click.preventInsetEmptyBlock`](https://github.com/siyuan-note/siyuan/issues/15303)
+* [Add plugin function `saveLayout`](https://github.com/siyuan-note/siyuan/issues/15308)
+* [Add config.query to `input-search` event bus](https://github.com/siyuan-note/siyuan/issues/15285)
+* [Update plugin `addDock` callback parameter scope](https://github.com/siyuan-note/siyuan/issues/14752)
+* [Add `cb-get-outline` to `TProtyleAction`](https://github.com/siyuan-note/siyuan/issues/14725)
+
+## v1.1.1 2025-04-08
+
+* [Add plugin function `globalCommand`](https://github.com/siyuan-note/siyuan/issues/14499)
+* [Add plugin function `openAttributePanel`](https://github.com/siyuan-note/siyuan/issues/14276)
 
 ## v1.1.0 2025-03-04
 

package/package.json

@@ -12,7 +12,7 @@
         "README.md",
         "siyuan.d.ts"
     ],
-    "version": "1.1.0",
+    "version": "1.1.2",
     "repository": {
         "type": "git",
         "url": "git+https://github.com/siyuan-note/petal.git"

package/siyuan.d.ts

@@ -20,7 +20,7 @@ import {
     App,
     Files,
     Tab, Model,
-    IMenuItem, IRefDefs,
+    IMenuItem, IRefDefs, MobileCustom,
 } from "./types";
 
 export * from "./types";
@@ -56,8 +56,11 @@ export type TOperation =
     | "removeFlashcards"
     | "updateAttrViewCell"
     | "updateAttrViewCol"
+    | "updateAttrViewColTemplate"
     | "sortAttrViewRow"
     | "sortAttrViewCol"
+    | "sortAttrViewKey"
+    | "setAttrViewColPin"
     | "setAttrViewColHidden"
     | "setAttrViewColWrap"
     | "setAttrViewColWidth"
@@ -65,10 +68,39 @@ export type TOperation =
     | "removeAttrViewColOption"
     | "updateAttrViewColOption"
     | "setAttrViewName"
+    | "doUpdateUpdated"
+    | "duplicateAttrViewKey"
+    | "setAttrViewColIcon"
     | "setAttrViewFilters"
     | "setAttrViewSorts"
     | "setAttrViewColCalc"
     | "updateAttrViewColNumberFormat"
+    | "replaceAttrViewBlock"
+    | "addAttrViewView"
+    | "setAttrViewViewName"
+    | "removeAttrViewView"
+    | "setAttrViewViewIcon"
+    | "duplicateAttrViewView"
+    | "sortAttrViewView"
+    | "setAttrViewPageSize"
+    | "updateAttrViewColRelation"
+    | "moveOutlineHeading"
+    | "updateAttrViewColRollup"
+    | "hideAttrViewName"
+    | "setAttrViewCardSize"
+    | "setAttrViewCardAspectRatio"
+    | "setAttrViewCoverFrom"
+    | "setAttrViewCoverFromAssetKeyID"
+    | "setAttrViewFitImage"
+    | "setAttrViewShowIcon"
+    | "setAttrViewWrapField"
+    | "setAttrViewColDate"
+    | "unbindAttrViewBlock"
+    | "setAttrViewViewDesc"
+    | "setAttrViewColDesc"
+    | "setAttrViewBlockView"
+    | "setAttrViewGroup"
+    | "syncAttrViewTableColWidth"
 
 export interface Global {
     Lute: typeof Lute;
@@ -162,7 +194,7 @@ export interface IEventBusMap {
         textPlain: string,
         siyuanHTML: string,
         files: FileList | DataTransferItemList | string[]; // 读取本地文件时为 string[]
-    }
+    };
     "ws-main": IWebSocketData;
     "sync-start": IWebSocketData;
     "sync-end": IWebSocketData;
@@ -204,14 +236,14 @@ export interface ICommand {
 }
 
 export interface ICard {
-    deckID: string
-    cardID: string
-    blockID: string
-    nextDues: IObject
-    lapses: number  // 遗忘次数
-    lastReview: number  // 最后复习时间
-    reps: number  // 复习次数
-    state: number   // 卡片状态 0：新卡
+    deckID: string;
+    cardID: string;
+    blockID: string;
+    nextDues: IObject;
+    lapses: number;  // 遗忘次数
+    lastReview: number;  // 最后复习时间
+    reps: number;  // 复习次数
+    state: number;   // 卡片状态 0：新卡
 }
 
 export interface ICardData {
@@ -309,7 +341,33 @@ export function openSetting(app: App): Dialog | undefined;
 export function getModelByDockType(type: TDock | string): Model | any;
 
 /**
- * @param timeout - ms. 0: manual close；-1: always show; 6000: default
+ * @param {IObject} [options.data] - 块属性值
+ * @param {HTMLElement} [options.nodeElement] - 块元素
+ * @param {"bookmark" | "name" | "alias" | "memo" | "av" | "custom"} [options.focusName="bookmark"] - av 为数据库页签，custom 为自定义页签，其余为内置输入框
+ * @param {IProtyle} [options.protyle] - 有数据库时需要传入 protyle
+ */
+export function openAttributePanel(options: {
+    data?: IObject
+    nodeElement?: HTMLElement,
+    focusName: "bookmark" | "name" | "alias" | "memo" | "av" | "custom",
+    protyle?: IProtyle,
+}): void;
+
+/**
+ * 保存布局
+ * @param {function} [cb] - 保存后的回调函数
+ */
+export function saveLayout(cb: () => void): void;
+
+/**
+ * 全局命令
+ * @param {string} command - 命令名称 https://github.com/siyuan-note/siyuan/blob/master/app/src/boot/globalEvent/command/global.ts#L71
+ * @param {App} app
+ */
+export function globalCommand(command: string, app: App): void;
+
+/**
+ * @param {number} [timeout=6000] - ms. 0: manual close；-1: always show;
  * @param {string} [type=info]
  */
 export function showMessage(text: string, timeout?: number, type?: "info" | "error", id?: string): void;
@@ -391,17 +449,18 @@ export abstract class Plugin {
     }): () => Custom;
 
     /**
+     * Add Custom to Dock.
      * Must be executed before the synchronous function.
      */
     addDock(options: {
         config: IPluginDockTab,
         data: any,
         type: string,
-        destroy?: (this: Dock) => void,
-        resize?: (this: Dock) => void,
-        update?: (this: Dock) => void,
-        init: (this: Dock, dock: Dock) => void,
-    }): { config: IPluginDockTab, model: Dock };
+        destroy?: (this: Custom | MobileCustom) => void,
+        resize?: (this: Custom | MobileCustom) => void,
+        update?: (this: Custom | MobileCustom) => void,
+        init: (this: Custom | MobileCustom, dock: Custom | MobileCustom) => void,
+    }): { config: IPluginDockTab, model: Custom | MobileCustom };
 
     addCommand(options: ICommand): void;
 

package/types/config.d.ts

@@ -35,8 +35,8 @@ export namespace Config {
         bazaar: IBazaar;
         /**
          * Cloud Service Provider Region
-         * - `0`: Chinese mainland
-         * - `1`: North America
+         * - `0`: Chinese mainland (LianDi)
+         * - `1`: North America (LiuYun)
          */
         cloudRegion: number;
         editor: IEditor;
@@ -273,16 +273,18 @@ export namespace Config {
      */
     export type TLang =
         "en_US"
+        | "ar_SA"
+        | "de_DE"
         | "es_ES"
         | "fr_FR"
-        | "zh_CHT"
-        | "zh_CN"
-        | "ja_JP"
-        | "it_IT"
-        | "de_DE"
         | "he_IL"
+        | "it_IT"
+        | "ja_JP"
+        | "pl_PL"
+        | "pt_BR"
         | "ru_RU"
-        | "pl_PL";
+        | "zh_CN"
+        | "zh_CHT";
 
     /**
      * SiYuan bazaar related configuration
@@ -330,6 +332,10 @@ export namespace Config {
          * Whether to enable the inline strikethrough
          */
         inlineStrikethrough: boolean;
+        /**
+         * Whether to enable the inline mark
+         */
+        inlineMark: boolean;
     }
 
     /**
@@ -537,6 +543,10 @@ export namespace Config {
          * Whether to add YAML Front Matter when exporting to Markdown
          */
         markdownYFM: boolean;
+        /**
+         * Whether to export the inline memo
+         */
+        inlineMemo: boolean;
         /**
          * Pandoc executable file path
          */
@@ -887,6 +897,7 @@ export namespace Config {
         showInFolder: IKey;
         spaceRepetition: IKey;
         switchReadonly: IKey;
+        switchAdjust: IKey;
         undo: IKey;
         vLayout: IKey;
         wysiwyg: IKey;
@@ -1124,10 +1135,18 @@ export namespace Config {
          */
         key: string;
         /**
-         * Synchronous index timing, if it exceeds this time, the user is prompted that the index
+         * Sync index timing, if it exceeds this time, the user is prompted that the index
          * performance is degraded (unit: milliseconds)
          */
         syncIndexTiming: number;
+        /**
+         * Automatic purge for local data repo index retention days
+         */
+        indexRetentionDays: number;
+        /**
+         * Automatic purge for local data repo indexes retention daily
+         */
+        retentionIndexesDaily: number;
     }
 
     /**
@@ -1344,6 +1363,10 @@ export namespace Config {
          * - `3`: Completely manual synchronization
          */
         mode: number;
+        /**
+         * Synchronization interval (unit: seconds)
+         */
+        interval: number;
         /**
          * Whether to enable synchronization perception
          */
@@ -1353,6 +1376,7 @@ export namespace Config {
          * - `0`: SiYuan official cloud storage service
          * - `2`: Object storage service compatible with S3 protocol
          * - `3`: Network storage service using WebDAV protocol
+         * - `4`: Local file system
          */
         provider: number;
         s3: ISyncS3;
@@ -1365,6 +1389,7 @@ export namespace Config {
          */
         synced: number;
         webdav: ISyncWebDAV;
+        local: ISyncLocal;
     }
 
     /**
@@ -1439,6 +1464,28 @@ export namespace Config {
         username: string;
     }
 
+    /**
+     * Local file system related configuration
+     */
+    export interface ISyncLocal {
+        /**
+         * The full path of local directory
+         *
+         * Examples:
+         * - Windows: `"D:/path/to/repos/directory"`
+         * - Unix: `"/path/to/repos/directory"`
+         */
+        endpoint: string;
+        /**
+         * Timeout (unit: seconds)
+         */
+        timeout: number;
+        /**
+         * Concurrent requests.
+         */
+        concurrentReqs: number;
+    }
+
     /**
      * System related information
      */
@@ -1463,6 +1510,7 @@ export namespace Config {
          * - `docker`: Docker container
          * - `android`: Android device
          * - `ios`: iOS device
+         * - `harmony`: HarmonyOS device
          * - `std`: Desktop Electron environment
          */
         container: TSystemContainer;
@@ -1470,10 +1518,6 @@ export namespace Config {
          * The absolute path of the `data` directory of the current workspace
          */
         dataDir: string;
-        /**
-         * Whether to disable Google Analytics
-         */
-        disableGoogleAnalytics: boolean;
         /**
          * Whether to automatically download the installation package for the new version
          */
@@ -1531,6 +1575,10 @@ export namespace Config {
          * The absolute path of the workspace directory
          */
         workspaceDir: string;
+        /**
+         * Disabled features.
+         */
+        disabledFeatures: string[];
     }
 
     /**
@@ -2013,6 +2061,10 @@ export namespace Config {
      * SiYuan search tab configuration
      */
     export interface IUILayoutTabSearchConfig {
+        /**
+         * 搜索传入的查询内容
+         */
+        query?: string;
         /**
          * Grouping strategy
          * - `0`: No grouping
@@ -2149,6 +2201,10 @@ export namespace Config {
          * @default false
          */
         blockRef?: boolean;
+        /**
+         * Replace file annotation refs
+         */
+        fileAnnotationRef?: boolean;
         /**
          * Replace kdb elements
          * @default true

package/types/index.d.ts

@@ -390,6 +390,25 @@ export declare class Dock {
     genButton(data: Config.IUILayoutDockTab[], index: number, tabIndex?: number): void;
 }
 
+export declare class MobileCustom {
+    public element: Element;
+    public data: any;
+    public type: string;
+    public init: (custom: MobileCustom) => void;
+    public destroy: () => void;
+    public update: () => void;
+
+    constructor(options: {
+        element: Element,
+        type: string,
+        data: any,
+        destroy?: () => void,
+        update?: () => void,
+        init: (custom: MobileCustom) => void
+    })
+}
+
+
 export declare class Custom extends Model {
     element: Element;
     tab: Tab;

package/types/protyle.d.ts

@@ -19,7 +19,8 @@ export type TProtyleAction = "cb-get-append" | // 向下滚动加载
     "cb-get-hl" | // 高亮
     "cb-get-focus" | // 光标定位
     "cb-get-focusfirst" | // 动态定位到第一个块
-    "cb-get-setid" | // 重置 blockid
+    "cb-get-setid" | // 无折叠大纲点击 重置 blockid
+    "cb-get-outline" | // 大纲点击
     "cb-get-all" | // 获取所有块
     "cb-get-backlink" | // 悬浮窗为传递型需展示上下文
     "cb-get-unundo" | // 不需要记录历史
@@ -77,8 +78,8 @@ interface IHintData {
     id?: string;
     html: string;
     value: string;
-    filter?: string[]
-    focus?: boolean
+    filter?: string[];
+    focus?: boolean;
 }
 
 export interface IProtyleOptions {
@@ -120,6 +121,10 @@ export interface IProtyleOptions {
     classes?: {
         preview?: string;
     };
+    click?: {
+        /** 点击末尾是否阻止插入新块 */
+        preventInsetEmptyBlock?: boolean
+    }
 
     /** 编辑器异步渲染完成后的回调方法 */
     after?(protyle: Protyle): void;