siyuan 1.2.1 → 1.2.2

package/types/index.d.ts

@@ -14,6 +14,7 @@ import {Wnd} from "./layout/Wnd";
 import {Tab} from "./layout/Tab";
 import {BlockPanel} from "./block/Panel";
 import {Inbox} from "./layout/dock/Inbox";
+import {Files} from "./layout/dock/Files";
 import {MobileOutline} from "./mobile/dock/MobileOutline";
 import {MobileFiles} from "./mobile/dock/MobileFiles";
 import {MobileBookmarks} from "./mobile/dock/MobileBookmarks";
@@ -22,6 +23,7 @@ import {MobileBacklinks} from "./mobile/dock/MobileBacklinks";
 
 export * from "./config";
 export * from "./events";
+export * from "./kernel";
 export * from "./protyle";
 export * from "./response";
 export * from "./constants";
@@ -40,6 +42,9 @@ export * as platformUtils from "./platformUtils";
 
 
 type TDockPosition = "Left" | "Right" | "Bottom"
+type TBazaarType = "templates" | "icons" | "widgets" | "themes" | "plugins"
+type TRecentDocsSort = "viewedAt" | "closedAt" | "openAt" | "updated"
+type TPublishAccessLevel = "public" | "protected" | "hidden" | "private" | "forbidden"
 type TAVView = "table" | "gallery" | "kanban"
 type TAVFilterOperator =
     "="
@@ -86,6 +91,7 @@ interface ILayoutOptions {
 }
 
 interface IOperationSrcs {
+    itemID: string,
     id: string,
     content?: string,
     isDetached: boolean
@@ -175,6 +181,12 @@ interface IAVTable extends IAVView {
     rowCount: number,
 }
 
+interface IAVVirtualData {
+    renderedStart: number;
+    renderedEnd: number;
+    topSpacerHeight: number;
+}
+
 interface IAVGallery extends IAVView {
     coverFrom: number;    // 0：无，1：内容图，2：资源字段，3：内容块
     coverFromAssetKeyID?: string;
@@ -188,13 +200,29 @@ interface IAVGallery extends IAVView {
     cardCount: number,
 }
 
+interface IAVKanban extends IAVView {
+    coverFrom: number;    // 0：无，1：内容图，2：资源字段，3：内容块
+    coverFromAssetKeyID?: string;
+    cardSize: number;   // 0：小卡片，1：中卡片，2：大卡片
+    cardAspectRatio: number;
+    displayFieldName: boolean;
+    fitImage: boolean;
+    cards: IAVGalleryItem[],
+    desc: string
+    fields: IAVColumn[]
+    cardCount: number,
+    fillColBackgroundColor: boolean
+}
+
 interface IAVFilter {
-    column: string,
-    operator: TAVFilterOperator,
-    quantifier?: string,
-    value: IAVCellValue,
-    relativeDate?: IAVRelativeDate
-    relativeDate2?: IAVRelativeDate
+    column?: string,                                  // 叶子节点：字段（列）ID
+    operator?: TAVFilterOperator,                     // 叶子节点：操作符
+    quantifier?: string,                              // 叶子节点：量词
+    value?: IAVCellValue,                             // 叶子节点：过滤值
+    relativeDate?: IAVRelativeDate,                   // 叶子节点：相对时间
+    relativeDate2?: IAVRelativeDate,                  // 叶子节点：第二个相对时间
+    combination?: "and" | "or",                       // 分组节点：子条件组合方式
+    filters?: IAVFilter[],                            // 分组节点：子节点（递归）
 }
 
 interface IAVRelativeDate {
@@ -360,12 +388,14 @@ interface IAVCellRollupValue {
 
 interface IAVCalc {
     operator?: string,
+    template?: string,
     result?: IAVCellValue
 }
 
 export interface IOperation {
     action: TOperation, // move， delete 不需要传 data
     id?: string,
+    context?: IObject,  // focusId, message, ignoreProcess, setRange
     blockID?: string,
     isTwoWay?: boolean, // 是否双向关联
     backRelationKeyID?: string, // 双向关联的目标关联列 ID
@@ -379,14 +409,18 @@ export interface IOperation {
     retData?: any
     nextID?: string // insert 专享
     isDetached?: boolean // insertAttrViewBlock 专享
-    ignoreFillFilter?: boolean // insertAttrViewBlock 专享
     srcIDs?: string[] // removeAttrViewBlock 专享
     srcs?: IOperationSrcs[] // insertAttrViewBlock 专享
+    ignoreDefaultFill?: boolean // insertAttrViewBlock 专享
+    viewID?: string // 多个属性视图操作使用，用于推送时不影响其他视图
     name?: string // addAttrViewCol 专享
     type?: TAVCol // addAttrViewCol 专享
     deckID?: string // add/removeFlashcards 专享
     blockIDs?: string[] // add/removeFlashcards 专享
     removeDest?: boolean // removeAttrViewCol 专享
+    layout?: string // addAttrViewView 专享
+    groupID?: string // insertAttrViewBlock, sortAttrViewRow 专享
+    targetGroupID?: string // sortAttrViewRow 专享
 }
 
 export interface IRefDefs {
@@ -407,11 +441,7 @@ export interface ISiyuan {
     storage?: {
         [key: string]: any
     },
-    transactions?: {
-        protyle: IProtyle,
-        doOperations: IOperation[],
-        undoOperations: IOperation[]
-    }[]
+    closedTabs?: ILayoutJSON[]
     reqIds: {
         [key: string]: number
     },
@@ -421,6 +451,18 @@ export interface ISiyuan {
     emojis?: IEmoji[],
     backStack?: IBackStack[],
     mobile?: {
+        touchRange?: Range
+        size: {
+            isLandscape?: boolean,
+            landscape?: {
+                height1: number,
+                height2: number,    // 键盘弹起时的高度
+            }, // 横屏
+            portrait?: {
+                height1: number,
+                height2: number,
+            }
+        }
         editor?: Protyle
         popEditor?: Protyle
         docks?: {
@@ -439,11 +481,31 @@ export interface ISiyuan {
         userHomeBImgURL: string
         userIntro: string
         userNickname: string
-        userSiYuanOneTimePayStatus: number  // 0 未付费；1 已付费
-        userSiYuanProExpireTime: number // -1 终身会员；0 普通用户；> 0 过期时间
-        userSiYuanSubscriptionPlan: number // 0 年付订阅/终生；1 教育优惠；2 订阅试用
-        userSiYuanSubscriptionType: number // 0 年付；1 终生；2 月付
-        userSiYuanSubscriptionStatus: number // -1：未订阅，0：订阅可用，1：订阅封禁，2：订阅过期
+        /**
+         * 功能特性付费状态
+         * 0 未付费，1 已付费
+         */
+        userSiYuanOneTimePayStatus: number
+        /**
+         * 会员过期时间
+         * -1 终身会员；0 未订阅或订阅已过期；>0 订阅到期时间（时间戳，毫秒）
+         */
+        userSiYuanProExpireTime: number
+        /**
+         * 订阅计划类型
+         * 0 年付订阅/终生；1 教育优惠；2 订阅试用
+         */
+        userSiYuanSubscriptionPlan: number
+        /**
+         * 订阅类型
+         * 0 年付；1 终生；2 月付
+         */
+        userSiYuanSubscriptionType: number
+        /**
+         * 订阅状态
+         * -1 未订阅，0 订阅可用，1 订阅封禁，2 订阅过期（包括付费订阅过期和试用订阅过期）
+         */
+        userSiYuanSubscriptionStatus: number
         userToken: string
         userTitles: {
             name: string,
@@ -452,7 +514,10 @@ export interface ISiyuan {
         }[]
     },
     dragElement?: HTMLElement,
+    dragTitle?: string,
     currentDragOverTabHeadersElement?: HTMLElement
+    touchDragActive?: boolean,
+    touchDragGhost?: HTMLElement | null,
     layout?: {
         layout?: Layout,
         centerLayout?: Layout,
@@ -505,24 +570,64 @@ export interface IMenu {
     index?: number
     element?: HTMLElement
     ignore?: boolean
-    waring?: boolean
-}
-
-export interface IPosition {
-    x: number,
-    y: number,
-    w?: number,
-    h?: number,
-    isLeft?: boolean
+    warning?: boolean
+}
+
+interface ILayoutJSON extends ILayoutOptions {
+    scrollAttr?: {
+        rootId: string,
+        startId?: string,
+        endId?: string
+        scrollTop?: number,
+        focusId?: string,
+        focusStart?: number
+        focusEnd?: number
+        zoomInId?: string
+    },
+    instance?: string,
+    width?: string,
+    height?: string,
+    title?: string,
+    lang?: string
+    docIcon?: string
+    page?: string
+    path?: string
+    blockId?: string
+    mode?: TEditorMode
+    action?: TProtyleAction
+    icon?: string
+    rootId?: string
+    active?: boolean
+    pin?: boolean
+    isPreview?: boolean
+    customModelData?: any
+    customModelType?: string
+    config?: Config.IUILayoutTabSearchConfig
+    children?: ILayoutJSON[] | ILayoutJSON
+}
+
+export interface IModels {
+    editor: Editor[],
+    graph: Model[],
+    outline: Model[],
+    backlink: Model[],
+    inbox: Inbox[],
+    files: Files[],
+    bookmark: Model[],
+    tag: Model[],
+    asset: Model[],
+    search: Model[],
+    custom: Custom[],
 }
 
 export interface IWebSocketData {
-    cmd: string;
+    cmd?: string;
     callback?: string;
-    data: any;
+    data?: any;
     msg: string;
     code: number;
-    sid: string;
+    sid?: string;
+    context?: any;
 }
 
 export interface IObject {
@@ -587,7 +692,7 @@ export declare class Editor extends Model {
         blockId: string;
         rootId: string;
         mode?: TEditorMode;
-        action?: string[];
+        action?: TProtyleAction[];
     });
 
     private initProtyle;

package/types/kernel.d.ts

@@ -0,0 +1,120 @@
+/**
+ * 内核插件状态
+ * - `-1`: inactive 内核插件未安装或不可用
+ * - `0`: ready 内核插件已安装但未启动
+ * - `1`: loading 内核插件正在启动
+ * - `2`: running 内核插件正在运行, 可正常使用
+ * - `3`: stopping 内核插件正在停止
+ * - `4`: stopped 内核插件已停止
+ * - `5`: error 内核插件出现不可恢复的错误
+ */
+export type TKernelPluginState = -1 | 0 | 1 | 2 | 3 | 4 | 5
+
+export type TJsonRpcId = string | number;
+export type TJsonRpcMethod = string;
+export type TJsonRpcPositionalParams = any[];
+export type TJsonRpcNamedParams = Record<string, any>;
+export type TJsonRpcParams = TJsonRpcPositionalParams | TJsonRpcNamedParams | undefined;
+export type TJsonRpcMethodParams = TJsonRpcPositionalParams | [TJsonRpcNamedParams] | [];
+export type TJsonRpcHandler<T = any> = (...args: TJsonRpcMethodParams) => Promise<T> | T;
+
+
+export interface IKernelPlugin {
+    /**
+     * 内核插件的状态管理接口
+     */
+    state: IKernelPluginState;
+
+    /**
+     * 内核插件的 JSON-RPC 调用接口
+     */
+    rpc: IKernelPluginRpc;
+}
+
+export interface IKernelPluginState {
+    /**
+     * 内核插件的当前状态
+     */
+    code: TKernelPluginState;
+
+    /**
+     * 内核插件状态的描述信息
+     */
+    description: string;
+}
+
+export interface IKernelPluginRpcCall {
+    /**
+     * JSON-RPC 2.0 中 method 必须是 string，且插件开发者需要保证传入的方法名与内核插件绑定的方法名一致，否则可能会导致调用失败
+     */
+    method: TJsonRpcMethod;
+
+    /**
+     * JSON-RPC 2.0 中 id 可以是 string、number 或 null，但为了兼容性和实用性，插件系统中不允许使用 null 作为 id
+     * 
+     * 不设置时且 notification 不为 true 时会自动生成一个唯一的 id，设置时必须保证 id 的唯一性，否则可能会导致响应错误或混乱
+     */
+    id?: TJsonRpcId;
+
+    /**
+     * JSON-RPC 2.0 中 params 可以是 array 或 object，插件开发者需要自行保证传入参数与内核插件绑定的方法参数一致
+     */
+    params?: any[] | Record<string, any>;
+
+    /**
+     * 是否为通知，通知不会有响应，且不应传入 id
+     * @defaultValue false
+     */
+    notification?: boolean;
+}
+
+export interface IKernelPluginRpcRequest extends IKernelPluginRpcCall {
+    jsonrpc: "2.0";
+}
+
+export interface IKernelPluginRpcBaseResponse {
+    jsonrpc: "2.0";
+}
+
+export interface IKernelPluginRpcResultResponse extends IKernelPluginRpcBaseResponse {
+    id: TJsonRpcId;
+    result?: any;
+}
+
+export interface IKernelPluginRpcErrorResponse extends IKernelPluginRpcBaseResponse {
+    id: TJsonRpcId | null;
+    error?: any;
+}
+
+export interface IKernelPluginRpcError {
+    code: number;
+    message: string;
+    data?: any;
+}
+
+export interface IKernelPluginRpc {
+    /**
+     * 通过 {@link Proxy} 实现的动态方法调用，插件开发者可以直接调用 `call.方法名(params)` 来调用内核插件暴露的方法，无需关心 JSON-RPC 的细节
+     */
+    call: Record<TJsonRpcMethod, (...args: TJsonRpcMethodParams) => Promise<any>>;
+
+    /**
+     * 通过 {@link Proxy} 实现的动态方法调用，插件开发者可以直接调用 `notify.方法名(...args)` 来发送通知给内核插件，无需关心 JSON-RPC 的细节
+     */
+    notify: Record<TJsonRpcMethod, (...args: TJsonRpcMethodParams) => void>;
+
+    /**
+     * 批量调用方法，接受一个方法调用数组，返回一个结果数组，结果数组中的每一项对应方法调用数组中非通知的每一项，包含成功的结果或错误信息
+     */
+    batch: (...calls: IKernelPluginRpcCall[]) => Promise<IKernelPluginRpcError | (IKernelPluginRpcResultResponse | IKernelPluginRpcErrorResponse)[]>;
+
+    /**
+     * 绑定内核插件调用时的事件处理函数，插件开发者可以通过 `bind("方法名", handler)` 来监听内核插件通过 JSON-RPC 推送到客户端插件的通知
+     */
+    bind: (method: TJsonRpcMethod, handler: TJsonRpcHandler<void>) => void;
+
+    /**
+     * 解绑事件处理函数，插件开发者可以通过 `unbind("方法名", handler)` 来停止监听内核插件通过 JSON-RPC 推送到客户端插件的通知
+     */
+    unbind: (method: TJsonRpcMethod, handler: TJsonRpcHandler<void>) => void;
+}

package/types/layout/Model.d.ts

@@ -1,6 +1,6 @@
 import {App, IWebSocketData, Tab} from "../../siyuan";
 
-type TWS = "main" | "filetree" | "protyle"
+type TWS = "main" | "filetree" | "protyle" | "backlink" | "bookmark" | "graph" | "outline" | "tag" | "agentChat"
 
 export declare class Model {
     public ws: WebSocket;

package/types/layout/dock/Files.d.ts

@@ -10,6 +10,7 @@ interface IFile {
     bookmark: string;
     path: string;
     name: string;
+    titleEmpty?: boolean;
     hMtime: string;
     hCtime: string;
     hSize: string;

package/types/platformUtils.ts

@@ -15,6 +15,8 @@ export declare const updateHotkeyTip: (hotkey: string) => string;
 export declare const getLocalStorage: (cb: () => void) => void;
 export declare const setStorageVal: (key: string, val: any, cb?: () => void) => void;
 
+export declare const getStorageVal: (key: string) => any;
+
 /**
  * @param {string} [options.timeoutType="defalut"] 仅在 Windows 和 Linux 有效，"default" 表示使用默认的超时机制，"never" 表示通知将一直显示，直到用户手动关闭它。
  * @returns 通知 id
@@ -26,4 +28,5 @@ export declare const sendNotification: (options: {
     channel?: string,
     timeoutType?: "default" | "never"
 }) => Promise<number>;
+
 export declare const cancelNotification: (id: number) => void;

package/types/protyle.d.ts

@@ -276,8 +276,13 @@ export class Protyle {
      */
     public turnIntoTransaction(nodeElement: Element, type: TTurnInto, subType?: number): void
 
+    /**
+     * @deprecated 将在 3.7.1 版本中移除。请改用 {@link updateTransactionElement}。
+     */
     public updateTransaction(id: string, newHTML: string, html: string): void
 
+    public updateTransactionElement(element: Element, oldHTML: string): void;
+
     public updateBatchTransaction(nodeElements: Element[], cb: (e: HTMLElement) => void): void
 
     public getRange(element: Element): Range
@@ -379,7 +384,7 @@ interface ILuteNode {
 
 type THintSource = "search" | "av" | "hint";
 
-type TTurnIntoOne = "BlocksMergeSuperBlock" | "Blocks2ULs" | "Blocks2OLs" | "Blocks2TLs" | "Blocks2Blockquote"
+type TTurnIntoOne = "BlocksMergeSuperBlock" | "Blocks2ULs" | "Blocks2OLs" | "Blocks2TLs" | "Blocks2Blockquote" | "Blocks2Callout"
 
 type TTurnIntoOneSub = "row" | "col"
 
@@ -406,7 +411,8 @@ export type TProtyleAction = "cb-get-append" | // 向下滚动加载
     "cb-get-rootscroll" | // 如果为 rootID 就滚动到指定位置，必有 rootID
     "cb-get-html" | // 直接渲染，不需要再 /api/block/getDocInfo，否则搜索表格无法定位
     "cb-get-history" | // 历史渲染
-    "cb-get-opennew"  // 编辑器只读后新建文件需为临时解锁状态 & https://github.com/siyuan-note/siyuan/issues/12197
+    "cb-get-opennew" | // 编辑器只读后新建文件需为临时解锁状态 & https://github.com/siyuan-note/siyuan/issues/12197
+    "cb-get-av-no-create"  // 属性视图不自动创建
 
 /** @link https://ld246.com/article/1588412297062 */
 interface ILuteRender {
@@ -592,6 +598,8 @@ export class Lute {
 
     public SetSuperBlock(enable: boolean): void;
 
+    public SetCallout(enable: boolean): void;
+
     public SetTag(enable: boolean): void;
 
     public SetInlineMath(enable: boolean): void;
@@ -638,6 +646,8 @@ export class Lute {
 
     public Md2BlockDOM(html: string): string;
 
+    public Md2BlockDOMWithAutoLink(html: string): string;
+
     public SetProtyleWYSIWYG(wysiwyg: boolean): void;
 
     public MarkdownStr(name: string, md: string): string;
@@ -653,6 +663,14 @@ export class Lute {
     public HTML2BlockDOM(html: string): string;
 
     public SetUnorderedListMarker(marker: string): void;
+
+    public SetDataTask(marker: boolean): void;
+
+    public SetExportNormalizeTaskListMarker(marker: boolean): void;
+
+    public SetArbitraryTaskListItemMarker(marker: boolean): void;
+
+    public SetEnsureListItemParagraph(enable: boolean): void;
 }
 
 declare const webkitAudioContext: {
@@ -711,9 +729,9 @@ interface IUpload {
 
 interface IScrollAttr {
     rootId: string,
-    startId: string,
-    endId: string
-    scrollTop: number,
+    startId?: string,
+    endId?: string
+    scrollTop?: number,
     focusId?: string,
     focusStart?: number
     focusEnd?: number
@@ -872,12 +890,12 @@ export interface IProtyle {
     observerLoad?: ResizeObserver,
     observer?: ResizeObserver,
     app: App,
-    transactionTime: number,
     id: string,
     query?: {
         key: string,
         method: number
         types: Config.IUILayoutTabSearchConfigTypes
+        subTypes: Config.IUILayoutTabSearchConfigSubTypes
     },
     block: {
         id?: string,
@@ -888,7 +906,7 @@ export interface IProtyle {
         showAll?: boolean
         mode?: number
         blockCount?: number
-        action?: string[]
+        action?: TProtyleAction[]
     },
     disabled: boolean,
     selectElement?: HTMLElement,